Reference
Overview
What Aura is, what it needs, and where each part is documented. Pick a document on the left; the content shows on the right, in place.
The documents
- Installation
- Python, a model, the first run, the Minecraft mod, and what usually goes wrong.
- Configuration
- Every section of config.yaml with the default 0.1.4 ships with.
- Tests and results
- What the suite and the real model measured, and the list of what is still unverified.
- Privacy
- What is kept, what "forget me" does, her right to stop, and what never leaves the machine.
Before you start
- A computer
- Apple silicon, an NVIDIA or AMD card, or a plain CPU. One machine is enough.
- Python
- 3.9 or newer.
- A model
- One OpenAI-compatible backend: Ollama, LM Studio, llama.cpp, or a cloud endpoint.
- A way to talk to her
- A Discord bot token, or switches.hub: true to keep everything in the browser.
Option names and defaults stay in English — they are what you type.
Where the rest lives
The long documents are in the repository: DEPLOYMENT.md, HARDWARE.md, VOICE_STREAMING.md, MEMORY_HUMAN.md, PRIVACY.md, REST.md, GAMES.md, MCP_INTERFACE.md, INTEGRATIONS.md, MODEL_CHOICE.md, QUALITY.md and COMPARISON.md. The repository is private; these pages are a summary for readers who do not have it yet.