oneko, but for the KDE Wayland compositor

QML 92.5%
Makefile 4.9%
GLSL 2.6%

Find a file

snow flurry 2c058a666c Add per-animal framerates This is still 125 by default, but allows for BSD Daemon to have its custom ~3.33fps. Fixes #4		2026-05-23 09:32:23 -07:00
glsl	Initial commit	2026-05-22 13:45:51 -07:00
package	Add per-animal framerates	2026-05-23 09:32:23 -07:00
.gitignore	Initial commit	2026-05-22 13:45:51 -07:00
LICENSE	Initial commit	2026-05-22 13:45:51 -07:00
Makefile	Makefile: include clean-qsb	2026-05-22 13:48:03 -07:00
README.md	README: fix wording	2026-05-22 20:19:51 -07:00
TODO.txt	Actor: per-animal offsets	2026-05-22 14:39:30 -07:00

README.md

koneko

Via JMdict:

子 (ko) 猫 (neko)

(n.) kitten

(n.) small cat

koneko is a KWin Script with the goal of emulating oneko-sakura in a way that's usable on Wayland.

Installing

Easiest route is to just run make install.

Note: Custom foreground/background color support requires a GPU shader. To make installation easier I've left the compiled shader in this repository, but you can compile it yourself if you'd like (requires the Qt Shader Baker):

make clean-qsb
make qsb

This compiles the shader at glsl/default.frag. If the QSB file isn't available, make install will automatically compile the QSB for you.

This does also mean custom colors requires your KWin compositor is hardware rendered. This is the only route I found that didn't require writing the plugin in C++. If you know of a better way, please submit a PR!

Usage

koneko can be enabled from System Settings, under Window Management > KWin Scripts. You can also change settings from there.

Credits and Prior Art

For a proper history, see Neko: History of a Software Pet by Eliot Akira.

The copyright and history for oneko-sakura are available in Japanese here.

Some shorter credits follow. If there's anyone I missed, please submit an issue or PR.

Neko sprites are from the Neko DA program, by Kenji Gotoh.
The original xneko was written by Masayuki Koba.
oneko-2.0 was written by Tatsuya Kato, and added the ability to let Neko run across the X root window.
The dog sprites were created by John Lerchey and Eric Anderson.
oneko-sakura is a patch to oneko by Kiichiroh Mukose, which includes sprites of Sakura and Tomoyo from Cardcaptor Sakura.

Prior Art

There are other ports to Wayland which are worth checking out:

https://git.sr.ht/~leon_plickat/wayneko - Uses the wlr-layer-shell-unstable-v1 Wayland protocol, which is usable in more compositors than just KWin.
https://github.com/rileyaft/KNeko - A similar effort for KWin.

License

As this script uses logic taken directly from oneko, and in the spirit of previous implementations, this software is provided under the terms of the CC0 1.0 license. That said, please consider including attributions to the previous creators' works if you make anything derived from this.

All sprites are copyright of their original authors.

Sakura Kinomoto and Tomoyo Daidouji are characters from Cardcaptor Sakura, created by and copyright CLAMP and Kodansha.