# PrimoEngine creator docs

> PrimoEngine is a native macOS 26+ animated-wallpaper app. Anyone can create wallpapers as
> `.livewallpaper` files (a ZIP with manifest.json + content/) of type "metal" (MSL fragment
> shader), "web" (offline sandboxed HTML/Canvas/WebGL) or "video" (Premium), then import them with
> the + button in the Installed tab or share them peer-to-peer. Format v1 is frozen.

For generating a wallpaper, read llms-full.txt first: it is the complete spec, contract, rules,
error list and working examples in one plain-markdown file.

## Docs

- [llms-full.txt](https://engine.oprimo.dev/docs/llms-full.txt): everything below in a single file
- [Guide (en)](https://engine.oprimo.dev/docs/en/guide.md): shader, web, video, settings, packaging, sharing, with complete examples
- [Reference (en)](https://engine.oprimo.dev/docs/en/reference.md): manifest fields, Metal Uniforms contract, web API, limits, exact validation errors
- [AI prompts (en)](https://engine.oprimo.dev/docs/en/prompt.md): copy-paste prompts that yield a valid package
- [Guia (pt-BR)](https://engine.oprimo.dev/docs/pt-br/guia.md): versão em português do guia
- [Referência (pt-BR)](https://engine.oprimo.dev/docs/pt-br/referencia.md): versão em português da referência
- [Prompts de IA (pt-BR)](https://engine.oprimo.dev/docs/pt-br/prompt.md): prompts prontos em português

## Tools and examples

- [pack.py](https://engine.oprimo.dev/docs/tools/pack.py): validates a folder, computes the checksum, writes the .livewallpaper
- [hello-shader](https://engine.oprimo.dev/docs/examples/hello-shader/): minimal Metal wallpaper (manifest.json + content/shader.metal)
- [hello-web](https://engine.oprimo.dev/docs/examples/hello-web/): minimal Canvas wallpaper with settings (manifest.json + content/web/index.html)