table_of_contents.md

Atheriz Documentation - Table of Contents

Welcome to the Atheriz documentation. Atheriz is a Python framework built for creating multiplayer text-based games.

1. 01 Getting Started
   Overview, installation instructions, and how to initialize a new game folder.
2. 02 Core Concepts
   Fundamental entities: Objects, Nodes (Rooms), Accounts, and Channels.
3. 03 The Command System
   Writing commands, argument parsing, input permissions, and CmdSets.
4. 04 Scripts & the Hook System
   Attaching reusable logic scripts and utilizing hook decorators.
5. 05 Persistence & Serialization
   SQLite database architecture, custom object pickling, and relation resolution.
6. 06 Settings & Configuration
   System configuration overrides and the Class Injection mechanism.
7. 07 Mixins
   Utilizing Flags, modifying Access restrictions, and adding custom DbOps.
8. 08 Input Handling
   WebSocket connections, JSON message schemas, and creating custom input functions.
9. 09 The Time System
   Managing the game clock, responding to solar/lunar events, and scheduling alarms.
10. 10 Utility Functions & Advanced Topics
    Math/Map utilities, string formatters, FuncParser logic, and the hot-reloader.
11. 11 The AsyncThreadPool
    Understanding concurrency, worker threads, and fire-and-forget execution.
12. 12 The Webclient
    Internal "colon" commands and the server-to-client WebSocket protocol.
13. 13 The Menu Engine
    Creating interactive text menus using MenuEngine, Nodes, Choices, and Context.
14. 14 API Reference
    Auto-generated documentation outlining public classes, methods, and functions.
15. 15 Sound Propagation
    Acoustic system, BFS room traversal, loudness attenuation, and hooks for emitting and hearing sounds.