This project offers an unofficial Linux port of MateEngine, a desktop pet software supporting custom VRM models. It aims to provide a lightweight, customizable virtual companion on Linux, featuring transparent backgrounds, AI chat, and mouse tracking.

How It Works

Built with Unity, the engine allows VRM model import as desktop companions. It utilizes X11 desktop environments with compositing for transparent backgrounds and window-on-top. Experimental features include audio-reactive dancing and AI chat integration requiring a specific Llama model. The port emphasizes lower RAM usage than its Windows counterpart.

Quick Start & Requirements

Installation involves downloading pre-built binaries from Releases, decompressing, and running install.sh. Arch Linux users can use yay -S mateengine. Prerequisites include a GNU/Linux distro, X11 desktop with compositing, and libraries like libpulse0, libgtk-3-0t64, and libayatana-appindicator. Building from source requires Unity 6000.2.6f2 and manual StandaloneFileBrowser plugin compilation.

Highlighted Details

• Custom VRM model support for desktop pets.
• Transparent backgrounds with cutoff effects.
• Window always-on-top functionality.
• Experimental audio-synchronized dancing.
• AI Chat integration (requires specific GGUF model).
• Mouse tracking for interactive pet behavior.
• Discord Rich Presence integration.

Maintenance & Community

Maintained by a high school student, development and responses may be slow (1-4 weeks) due to academics. Contributions via Pull Requests and discussions in "Discussions" are encouraged. The project explicitly states it "lacks further testing and updates."

Licensing & Compatibility

The license is not explicitly stated in the README. Compatibility for commercial use or closed-source linking is undetermined due to missing license information.

Limitations & Caveats

Window snapping and dock integration fail on XWayland. Interface mods load improperly with a delayed fix. Steam API removed, disabling workshop support. The project is noted as lacking further testing and updates.