Project · Documentation · User Guide · FAQ · Contributing · Status · Releases
This directory contains the maintained documentation for BatLLM. Each page has one primary purpose so that setup instructions, game rules, development notes, release planning, and historical records do not compete with one another.
| You need to… | Read… |
|---|---|
| understand the project or install it | Project README |
| play a first game or understand the rules | User Guide |
| answer a recurring practical question | FAQ |
| work on the codebase | Contributing |
| see what is currently working or still pending | STATUS.md |
| report a vulnerability | Security policy |
- User Guide: installation choices, first game, game structure, commands, screens, saved sessions, the Game Analyzer, and Ollama controls.
- FAQ: concise answers to questions that recur across play and development.
- Credits: authorship, institutional context, and funding support.
- Contributing: development setup, architecture, configuration, tests, CI, packaging, release work, and troubleshooting.
- Installation channels and mutable state: where configuration and sessions are written in source, packaged, Homebrew, and test environments.
- Maintainer audit checklist: compact pre-release and high-risk-change checks.
- Homebrew packaging: formula generation, local tap validation, and publication.
- Roadmap: the remaining local-desktop work and the planned networked architecture.
- 1.0 release criteria: release gates rather than release notes.
- First-run and release checklist: manual validation to perform on release candidates.
- UI unification plan: the remaining interface-consistency work.
- Changelog: historical and unreleased changes.
The implementation and reproducibility material for the URUCON 2026 work is under research/urucon2026. The editable manuscript is intentionally maintained in the separate academic-writing repository; this repository contains the software and research artefact only.
- Python
3.10–3.12; Python3.12is recommended. - macOS, Linux, and Windows source and release-bundle workflows.
- Apple Silicon macOS Homebrew formula.
- Local Ollama model runtime through
modelito. - Saved-session schema v2 for the user-facing Game Analyzer.
- Schema v3 for the headless URUCON research runtime and verifier.
The repository version is recorded in VERSION. Current validation and unresolved manual checks are recorded once, in STATUS.md, rather than repeated throughout the documentation.