Documentation
Get it running, then make it yours
Guides adapted from the documentation in the animaEngine repository, checked against release 1.5.1. Each page links to its source.
Guides
- Installation Install animaEngine from a release package on Linux or Windows, check the download, or build it from source.
- Getting started Edit mode, adding characters, everyday actions and the supported file formats.
- Configuration Where animaEngine keeps its settings, how hot reload works, and the environment variables it reads.
- Linux desktops and Wayland The default X11/XWayland backend, the opt-in native Wayland backend for wlroots compositors, and what each supports.
- FAQ and known problems Answers to the questions people ask most about animaEngine, the problems known today, and how to remove it.
Reference in the repository
The detailed documents live next to the code on GitHub.
- Configuration reference Every field of config.toml.
- Wayland setup sway, Hyprland and river snippets for shortcuts.
- Accessibility Screen readers, keyboard reference, themes.
- Behaviour scripts Example Rhai scripts for characters.
- Stability policy What stays the same across 1.x releases.
- Architecture How the engine is put together.
- Threat model The security invariants the app keeps.
- Contributing Building, testing and sending changes.
Stuck? Read the FAQ, then open an issue with the diagnostic report from Appearance → About.