WAYNEKO(1)

🐾 wayneko(1) — Neko on Wayland 🐾

✨ NAME ✨

wayneko — Neko on Wayland 🐱

okay bestie, this is the manual page for wayneko, straight out of the General Commands Manual, and she is literally a Neko on Wayland. Periodt. 💅

🌈 SYNOPSIS 🌈

wayneko [-h] [--help] [-?]

wayneko [--background-colour 0xRRGGBB[AA]]
        [--outline-colour 0xRRGGBB[AA]] [--type neko|inu|random]
        [--idle-sleep seconds] [--sleepiness num]
        [--sleepiness-night num] [--layer background|bottom|top|overlay]
        [--follow-pointer true|false] [--survive-close]

💖 DESCRIPTION 💖

okay so, wayneko displays an animated neko cat on the bottom of an output. She responds to the pointer being near the bottom edge of that output. no cap. Most cats are usually active at night, but wayneko likes to mostly sleep when it’s late, only occasionally waking. 💤

Requirement check, bestie: it requires the Wayland server to implement zwlr-layer-shell-unstable-v1. That’s the whole vibe. ✨

🎀 OPTIONS 🎀

• -h, --help, -? — Print help text and exit. iconic.
• --background-colour 0xRRGGBB[AA] — Set the background fill colour using a hexadecimal colour code prefixed by '0x'. Alpha value is optional. slay.
• --outline-colour 0xRRGGBB[AA] — Set the outline colour using a hexadecimal colour code prefixed by '0x'. Alpha value is optional. obsessed.
• --type neko|inu|random — This option lets you choose between neko and her friend inu. The accepted values are exactly neko|inu|random. 🐱🐶
• --idle-sleep seconds — Set the time in seconds after which neko will go to sleep when the user is idle. 😴
• --sleepiness num — Set neko’s sleepiness as an integer (greater than 0). Higher values make neko more sleepy. Defaults to 4. iykyk.
• --sleepiness-night num — Set neko’s sleepiness at night as an integer (greater than 0). Higher values make neko more sleepy. This setting acts as an additional sleepiness on top of the normal sleepiness. Defaults to 5. 🌙
• --layer background|bottom|top|overlay — Set the layer for the surface. Defaults to bottom. Bottom is typically beneath regular windows and top above them. Overlay is usually displayed even over fullscreen windows. Background may conflict with wallpaper clients. vibe check.
• --follow-pointer true|false — Set whether neko follows the pointer when it approaches the bottom of the output. 🫶
• --survive-close — If this flag is used, wayneko will recreate the surface after it has been closed. This allows neko to migrate outputs should the one she is currently on be disconnected, but may cause some undesired behaviour should the server try to close the surface for a different reason. lowkey important, bestie.

👑 AUTHOR 👑

Code by Leon Henrik Plickat. ✨ Neko bitmaps taken from public domain. 🎨🫶

okay bestie, that’s the whole page 💅 source/version: git.sr.ht/~leon_plickat/wayneko, dated 2024-03-24. mwah 🦋