Example Scripts¶
This directory contains example scripts demonstrating various MAID features.
Running the Examples¶
Most examples are standalone Python scripts or batch files:
# Run a Python example
uv run python docs/examples/basic_argument_parsing.py
# Execute a batch file against a running server
uv run maid server start # in one terminal
@batch docs/examples/world_setup.batch # in the game client
Batch files (.batch) are meant to be fed to the @batch admin command
from inside a running MAID session. Python scripts can be run directly
with uv run python.
Batch Command Examples¶
- world_setup.batch - Example world creation script
- migration_example.batch - Database migration example
Command System Examples¶
- basic_argument_parsing.py - Basic argument parsing examples
- pattern_parsing.py - Pattern-based command parsing
- hook_registration.py - Command hook registration
- custom_lock_function.py - Custom lock function examples