# Atari Mutineer Documentation

This directory is the source of truth for running, developing, packaging, and
testing Atari Mutineer. The docs describe current supported behavior; generated
build outputs and historical debug artifacts are not treated as editable source.

## Sysop Path

Read these when operating a board or customizing a live ATR:

- [Sysops Guide](MUTINEER_BBS_SYSOPS_GUIDE.md): install, boot, initialize,
  configure, run, back up, and maintain a board.
- [Altirra 850 Modem Reference](ALTIRRA_850_MODEM.md): emulator profile,
  modem listener, connection rate, and common launch variables.
- [Data Formats](DATA_FORMATS.md): live board files, message bases, file
  areas, users, doors, text assets, and app registry.
- [Troubleshooting](TROUBLESHOOTING.md): current symptoms, likely causes, and
  checks for emulator, modem, BASIC, MMS, and packaging problems.

## Developer Path

Read these when modifying the BBS, MMS, packaging, or tests:

- [Runtime Architecture](RUNTIME_ARCHITECTURE.md): boot flow, module switching,
  MMS session state, carrier handling, and app registry data flow.
- [Core Programmers Guide](MUTINEER_BBS_CORE_PROGRAMMERS_GUIDE.md): BASIC
  module contracts and subsystem responsibilities.
- [MMS Programmers Guide](MMS_PROGRAMMERS_GUIDE.md): MMS ABI, public blocks,
  service dispatcher, HATABS behavior, and baud control.
- [Doors Programmers Guide](MUTINEER_BBS_DOORS_PROGRAMMERS_GUIDE.md): door
  package layout, runtime contract, and install behavior.
- [Build and Packaging Reference](BUILD_AND_PACKAGING.md): Make targets,
  generated ATR layout, Franny, versioning, and staging rules.
- [Tools Reference](TOOLS_REFERENCE.md): host-side scripts, arguments, env
  vars, inputs, and outputs.
- [Testing and Evidence](TESTING_AND_EVIDENCE.md): static checks, probe ATRs,
  telnet/XMODEM tests, acceptance targets, and result files.
- [Linux Developers Guide](LINUX_DEVELOPERS_GUIDE.md): Linux, Wine,
  Altirra, and host dependency setup.

## Source Of Truth

- BASIC source: `source/text/*.bas`
- Static text source: `source/textfiles/ascii/` and `source/textfiles/atascii/`
- Build-time app registry: `source/config/MMSAPPS.CFG`
- Door packages: `source/doorgames/`
- MMS assembler: `mms/src/`
- Host tools: `tools/`
- Build/test orchestration: `Makefile`