Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
89de5b2c69 |
@@ -1,9 +1,7 @@
|
||||
# GENOME.md — timmy-academy
|
||||
|
||||
Refreshed against live repo state on 2026-04-22.
|
||||
Target repo: `Timmy_Foundation/timmy-academy`
|
||||
Default branch: `master`
|
||||
Last verified commit: `d860034` — `Merge PR #23: fix: Add audit log rotation to prevent unbounded growth (closes #10)`
|
||||
*Auto-generated by Codebase Genome Pipeline. 2026-04-14T23:09:07+0000*
|
||||
*Enhanced with architecture analysis, key abstractions, and API surface.*
|
||||
|
||||
## Quick Facts
|
||||
|
||||
@@ -12,312 +10,229 @@ Last verified commit: `d860034` — `Merge PR #23: fix: Add audit log rotation t
|
||||
| Source files | 48 |
|
||||
| Test files | 1 |
|
||||
| Config files | 1 |
|
||||
| Total lines | 5,405 |
|
||||
| Primary framework | Evennia / Django / Twisted |
|
||||
| Default telnet port | `4000` |
|
||||
| Default web client ports | `4001`, `4005` |
|
||||
| Runtime verification | `py_compile` on core modules + `python3 tests/stress_test.py --help` |
|
||||
| Total lines | 5,353 |
|
||||
| Last commit | 395c9f7 Merge PR 'Add @who command' (#7) into master (2026-04-13) |
|
||||
| Branch | master |
|
||||
| Test coverage | 0% (35 untested modules) |
|
||||
|
||||
## Project Overview
|
||||
## What This Is
|
||||
|
||||
`timmy-academy` is Timmy Academy: an Evennia MUD world used for agent convening, operator training, and crisis-response practice. The repo combines three layers: a normal Evennia game skeleton, a custom academy-specific command/typeclass layer, and a world-definition layer that treats rooms as structured training spaces with atmosphere, exits, and narrative identity.
|
||||
Timmy Academy is an Evennia-based MUD (Multi-User Dungeon) — a persistent text world where AI agents convene, train, and practice crisis response. It runs on Bezalel VPS (167.99.126.228) with telnet on port 4000 and web client on port 4001.
|
||||
|
||||
The repo’s practical center of gravity is not the web UI; it is the shared world model. Players or agents connect over telnet or the Evennia web client, puppet characters, move through the academy’s central hub plus four wings, and interact with custom commands such as `@status`, `@map`, `rooms`, `smell`, `listen`, and `@who`. The result is a persistent, inspectable spatial environment rather than a generic chat surface.
|
||||
|
||||
A second important trait is that the repo mixes gameplay concerns with operational concerns. `server/conf/settings.py` enables detailed audit logging. `typeclasses/audited_character.py` records movement and command trails. `world/rebuild_world.py` can rehydrate the academy from source definitions. `tests/stress_test.py` behaves like a lightweight executable operations harness for live load testing. Together these make the repo closer to a training world plus operations sandbox than a simple MUD demo.
|
||||
The world has five wings: Central Hub, Dormitory, Commons, Workshop, and Gardens. Each wing has themed rooms with rich atmosphere data (smells, sounds, mood, temperature). Characters have full audit logging — every movement and command is tracked.
|
||||
|
||||
## Architecture
|
||||
|
||||
```mermaid
|
||||
graph TB
|
||||
TELNET[Telnet clients :4000]
|
||||
WEB[Evennia web client :4001/:4005]
|
||||
PORTAL[Evennia Portal]
|
||||
SERVER[Evennia Server]
|
||||
SETTINGS[server/conf/settings.py]
|
||||
CMDSETS[commands/default_cmdsets.py]
|
||||
COMMANDS[commands/command.py]
|
||||
TYPECLASSES[typeclasses/*]
|
||||
AUDIT[typeclasses/audited_character.py]
|
||||
WORLD[world/*_wing.py]
|
||||
REBUILD[world/rebuild_world.py]
|
||||
BATCH[world/build_academy.ev]
|
||||
WEBURLS[web/urls.py]
|
||||
HERMESCFG[hermes-agent/config.yaml]
|
||||
STRESS[tests/stress_test.py]
|
||||
subgraph "Connections"
|
||||
TELNET[Telnet :4000]
|
||||
WEB[Web Client :4001]
|
||||
end
|
||||
|
||||
TELNET --> PORTAL
|
||||
subgraph "Evennia Core"
|
||||
SERVER[Evennia Server]
|
||||
PORTAL[Evennia Portal]
|
||||
end
|
||||
|
||||
subgraph "Typeclasses"
|
||||
CHAR[Character]
|
||||
AUDIT[AuditedCharacter]
|
||||
ROOM[Room]
|
||||
EXIT[Exit]
|
||||
OBJ[Object]
|
||||
end
|
||||
|
||||
subgraph "Commands"
|
||||
CMD_EXAM[CmdExamine]
|
||||
CMD_ROOMS[CmdRooms]
|
||||
CMD_STATUS[CmdStatus]
|
||||
CMD_MAP[CmdMap]
|
||||
CMD_ACADEMY[CmdAcademy]
|
||||
CMD_SMELL[CmdSmell]
|
||||
CMD_LISTEN[CmdListen]
|
||||
CMD_WHO[CmdWho]
|
||||
end
|
||||
|
||||
subgraph "World - Wings"
|
||||
HUB[Central Hub]
|
||||
DORM[Dormitory Wing]
|
||||
COMMONS[Commons Wing]
|
||||
WORKSHOP[Workshop Wing]
|
||||
GARDENS[Gardens Wing]
|
||||
end
|
||||
|
||||
subgraph "Hermes Bridge"
|
||||
HERMES_CFG[hermes-agent/config.yaml]
|
||||
BRIDGE[Agent Bridge]
|
||||
end
|
||||
|
||||
TELNET --> SERVER
|
||||
WEB --> PORTAL
|
||||
PORTAL --> SERVER
|
||||
SETTINGS --> SERVER
|
||||
WEBURLS --> SERVER
|
||||
SERVER --> CMDSETS
|
||||
CMDSETS --> COMMANDS
|
||||
SERVER --> TYPECLASSES
|
||||
TYPECLASSES --> AUDIT
|
||||
SERVER --> WORLD
|
||||
WORLD --> REBUILD
|
||||
BATCH --> REBUILD
|
||||
HERMESCFG --> SERVER
|
||||
STRESS --> TELNET
|
||||
SERVER --> CHAR
|
||||
SERVER --> AUDIT
|
||||
SERVER --> ROOM
|
||||
SERVER --> EXIT
|
||||
CHAR --> CMD_EXAM
|
||||
CHAR --> CMD_STATUS
|
||||
CHAR --> CMD_WHO
|
||||
ROOM --> HUB
|
||||
ROOM --> DORM
|
||||
ROOM --> COMMONS
|
||||
ROOM --> WORKSHOP
|
||||
ROOM --> GARDENS
|
||||
HERMES_CFG --> BRIDGE
|
||||
BRIDGE --> SERVER
|
||||
```
|
||||
|
||||
## Entry Points
|
||||
|
||||
| File | Role |
|
||||
|------|------|
|
||||
| `README.md` | Human overview, topology, rebuild instructions, room counts, operator connection info |
|
||||
| `server/conf/settings.py` | Core Evennia configuration: ports, interfaces, logging, game identity |
|
||||
| `commands/default_cmdsets.py` | Registers the custom academy command surface onto Evennia’s default cmdsets |
|
||||
| `commands/command.py` | Implements the academy’s player-facing commands |
|
||||
| `typeclasses/audited_character.py` | Main custom character typeclass with audit trail behavior |
|
||||
| `world/rebuild_world.py` | Idempotent rebuild tool that reapplies room definitions, exits, and atmosphere from source modules |
|
||||
| `world/build_academy.ev` | Evennia batch setup entrypoint |
|
||||
| `web/urls.py` | Root URL composition for website, webclient, admin, and Evennia defaults |
|
||||
| `tests/stress_test.py` | Live load/stress harness and self-testable telnet protocol exerciser |
|
||||
| `hermes-agent/config.yaml` | Bridge-side model/provider configuration snapshot for Hermes integration |
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `server/conf/settings.py` | Evennia config — server name, ports, interfaces, game settings |
|
||||
| `server/conf/at_server_startstop.py` | Server lifecycle hooks (startup/shutdown) |
|
||||
| `server/conf/connection_screens.py` | Login/connection screen text |
|
||||
| `commands/default_cmdsets.py` | Registers all custom commands with Evennia |
|
||||
| `world/rebuild_world.py` | Rebuilds all rooms from source |
|
||||
| `world/build_academy.ev` | Evennia batch script for initial world setup |
|
||||
|
||||
## Data Flow
|
||||
|
||||
1. A human or agent connects over telnet (`4000`) or the Evennia web client (`4001` / `4005`).
|
||||
2. The Evennia portal hands the connection to the game server configured by `server/conf/settings.py`.
|
||||
3. Once an account puppets a character, the command path is controlled by `commands/default_cmdsets.py`, which mounts the academy-specific commands from `commands/command.py`.
|
||||
4. The typeclass layer (`typeclasses/*`) determines how characters, rooms, exits, channels, and scripts behave; `AuditedCharacter` wraps command and movement hooks in persistent logging.
|
||||
5. The world layer (`world/*_wing.py`) supplies canonical room descriptions, exits, aliases, atmosphere, and thematic metadata.
|
||||
6. `world/rebuild_world.py` parses those source files and writes them back into Evennia objects, making source the effective truth for the academy layout.
|
||||
7. `tests/stress_test.py` simulates concurrent clients against the live telnet surface and reports throughput, latency, and connection statistics.
|
||||
```
|
||||
Player connects (telnet/web)
|
||||
-> Evennia Portal accepts connection
|
||||
-> Server authenticates (Account typeclass)
|
||||
-> Player puppets a Character
|
||||
-> Character enters world (Room typeclass)
|
||||
-> Commands processed through Command typeclass
|
||||
-> AuditedCharacter logs every action
|
||||
-> World responds with rich text + atmosphere data
|
||||
```
|
||||
|
||||
## Key Abstractions
|
||||
|
||||
### 1. `AuditedCharacter`
|
||||
File: `typeclasses/audited_character.py`
|
||||
### Typeclasses (the world model)
|
||||
|
||||
This is the repo’s flagship abstraction. It extends `DefaultCharacter` with:
|
||||
- per-session audit logging
|
||||
- movement logging via `at_pre_move()` / `at_post_move()`
|
||||
- command tracking via `at_pre_cmd()`
|
||||
- session timing via puppet / unpuppet hooks
|
||||
- rotated in-db history (`location_history`)
|
||||
- summarized audit snapshots via `get_audit_summary()`
|
||||
| Class | File | Purpose |
|
||||
|-------|------|---------|
|
||||
| `Character` | `typeclasses/characters.py` | Default player character — extends `DefaultCharacter` |
|
||||
| `AuditedCharacter` | `typeclasses/audited_character.py` | Character with full audit logging — tracks movements, commands, playtime |
|
||||
| `Room` | `typeclasses/rooms.py` | Default room container |
|
||||
| `Exit` | `typeclasses/exits.py` | Connections between rooms |
|
||||
| `Object` | `typeclasses/objects.py` | Base object with `ObjectParent` mixin |
|
||||
| `Account` | `typeclasses/accounts.py` | Player account (login identity) |
|
||||
| `Channel` | `typeclasses/channels.py` | In-game communication channels |
|
||||
| `Script` | `typeclasses/scripts.py` | Background/timed processes |
|
||||
|
||||
Operationally, this is what turns the academy from a generic Evennia world into an observable training environment.
|
||||
### AuditedCharacter — the flagship typeclass
|
||||
|
||||
### 2. `CharacterCmdSet`
|
||||
File: `commands/default_cmdsets.py`
|
||||
The `AuditedCharacter` is the most important abstraction. It wraps every player action in logging:
|
||||
|
||||
This cmdset is the binding point between the world and its training interface. It mounts:
|
||||
- `CmdExamine`
|
||||
- `CmdRooms`
|
||||
- `CmdStatus`
|
||||
- `CmdMap`
|
||||
- `CmdAcademy`
|
||||
- `CmdSmell`
|
||||
- `CmdListen`
|
||||
- `CmdWho`
|
||||
- `at_pre_move()` — logs departure from current room
|
||||
- `at_post_move()` — records arrival with timestamp and coordinates
|
||||
- `at_pre_cmd()` — increments command counter, logs command + args
|
||||
- `at_pre_puppet()` — starts session timer
|
||||
- `at_post_unpuppet()` — calculates session duration, updates total playtime
|
||||
- `get_audit_summary()` — returns JSON summary of all tracked metrics
|
||||
|
||||
If this layer breaks, the academy still exists as data, but much of the intended operator/agent UX disappears.
|
||||
Audit trail keeps last 1000 movements in `db.location_history`. Sensitive commands (password) are excluded from logging.
|
||||
|
||||
### 3. `CmdStatus`, `CmdMap`, `CmdAcademy`, `CmdWho`
|
||||
File: `commands/command.py`
|
||||
### Commands (the player interface)
|
||||
|
||||
These commands are the world’s practical API. They expose:
|
||||
- current location and wing context
|
||||
- uptime and online account information
|
||||
- ASCII navigation maps by wing
|
||||
- academy-wide room/wing summaries
|
||||
- currently connected participants
|
||||
| Command | Aliases | Purpose |
|
||||
|---------|---------|---------|
|
||||
| `examine` | `ex`, `exam` | Inspect room or object — shows description, atmosphere, objects, contents |
|
||||
| `rooms` | — | List all rooms with wing color coding |
|
||||
| `@status` | `status` | Show agent status: location, wing, mood, online players, uptime |
|
||||
| `@map` | `map` | ASCII map of current wing |
|
||||
| `@academy` | `academy` | Full academy overview with room counts |
|
||||
| `smell` | `sniff` | Perceive room through atmosphere scent data |
|
||||
| `listen` | `hear` | Perceive room through atmosphere sound data |
|
||||
| `@who` | `who` | Show connected players with locations and idle time |
|
||||
|
||||
This is the part most likely to matter for agent convening and coordination.
|
||||
### World Structure (5 wings, 21+ rooms)
|
||||
|
||||
### 4. Wing room classes
|
||||
Files: `world/commons_wing.py`, `world/dormitory_entrance.py`, `world/workshop_wing.py`, `world/gardens_wing.py`
|
||||
**Central Hub (LIMBO)** — Nexus connecting all wings. North=Dormitory, South=Workshop, East=Commons, West=Gardens.
|
||||
|
||||
These classes encode the academy’s content model. Each room defines:
|
||||
- `self.key`
|
||||
- aliases
|
||||
- long-form description
|
||||
- `db.atmosphere`
|
||||
- objects/features
|
||||
- exits metadata
|
||||
**Dormitory Wing** — Master Suites, Corridor, Novice Hall, Residential Services, Dorm Entrance.
|
||||
|
||||
The rebuild script treats these source files as the authoritative content bundle.
|
||||
**Commons Wing** — Grand Commons Hall (main gathering, 60ft ceilings, marble columns), Hearthside Dining, Entertainment Gallery, Scholar's Corner, Upper Balcony.
|
||||
|
||||
### 5. `ROOM_CONFIG` / `WING_INFO`
|
||||
File: `world/rebuild_world.py`
|
||||
**Workshop Wing** — Great Smithy, Alchemy Labs, Woodworking Shop, Artificing Chamber, Workshop Entrance.
|
||||
|
||||
This is the world’s rehydration map. It hard-binds Evennia object IDs to source classes and wings. That makes the rebuild deterministic, but it also couples source truth to existing DB IDs — a real maintenance risk if the database is re-seeded differently.
|
||||
**Gardens Wing** — Enchanted Grove, Herb Gardens, Greenhouse, Sacred Grove, Gardens Entrance.
|
||||
|
||||
### 6. Stress-test dataclasses and `MudClient`
|
||||
File: `tests/stress_test.py`
|
||||
|
||||
The stress harness uses:
|
||||
- `ActionResult`
|
||||
- `PlayerStats`
|
||||
- `StressTestReport`
|
||||
- `MudClient`
|
||||
|
||||
This test file doubles as an executable spec for the live connection surface and the academy’s expected runtime responsiveness.
|
||||
Each room has rich `db.atmosphere` data: mood, lighting, sounds, smells, temperature.
|
||||
|
||||
## API Surface
|
||||
|
||||
### In-world commands
|
||||
Defined in `commands/command.py` and registered in `commands/default_cmdsets.py`.
|
||||
### Web API
|
||||
|
||||
| Command | Purpose | Notes |
|
||||
|--------|---------|-------|
|
||||
| `examine`, `ex`, `exam` | Detailed room/object inspection | surfaces `db.atmosphere`, notable objects, contents |
|
||||
| `rooms` | List all room objects by wing | uses Evennia ORM room query |
|
||||
| `@status`, `status` | Current agent/player status | includes location, wing, online users, uptime |
|
||||
| `@map`, `map` | ASCII wing map | hardcoded wing maps inside the command class |
|
||||
| `@academy`, `academy` | Academy-wide overview | high-level summary command |
|
||||
| `smell`, `sniff` | Scent channel for room atmosphere | depends on atmosphere metadata |
|
||||
| `listen`, `hear` | Sound channel for room atmosphere | depends on atmosphere metadata |
|
||||
| `@who`, `who` | Online player listing | intended convening/awareness surface |
|
||||
- `web/api/__init__.py` — Evennia REST API (Django REST Framework)
|
||||
- `web/urls.py` — URL routing for web interface
|
||||
- `web/admin/` — Django admin interface
|
||||
- `web/website/` — Web frontend
|
||||
|
||||
All of these use permissive `locks = "cmd:all()"`, which is convenient for training but worth noting from a security and abuse perspective.
|
||||
### Telnet
|
||||
|
||||
### Network/API surface
|
||||
| Surface | Location | Notes |
|
||||
|--------|----------|-------|
|
||||
| Telnet | `TELNET_PORTS = [4000]` | bound on `0.0.0.0` |
|
||||
| Web client | `WEBSERVER_PORTS = [(4001, 4005)]` | bound on `0.0.0.0` |
|
||||
| Django web stack | `web/urls.py` | includes website, webclient, admin, and Evennia defaults |
|
||||
| Hermes bridge config | `hermes-agent/config.yaml` | configuration-only integration point; not an executable bridge implementation inside this repo |
|
||||
- Standard MUD protocol on port 4000
|
||||
- Supports MCCP (compression), MSDP (data), GMCP (protocol)
|
||||
|
||||
## World Model
|
||||
### Hermes Bridge
|
||||
|
||||
The academy is modeled as a central hub plus four themed wings, matching the repo’s source files better than the older “five wings” phrasing in the stale genome artifact.
|
||||
|
||||
| Zone | Source | Notes |
|
||||
|------|--------|------|
|
||||
| Central Hub / Limbo | `world/rebuild_world.py` | special-case hub description and routing nexus |
|
||||
| Dormitory Wing | `world/dormitory_entrance.py` | residence/rest zone |
|
||||
| Commons Wing | `world/commons_wing.py` | social and gathering zone |
|
||||
| Workshop Wing | `world/workshop_wing.py` | crafting and alchemy zone |
|
||||
| Gardens Wing | `world/gardens_wing.py` | nature and contemplative zone |
|
||||
|
||||
Grounded repo facts:
|
||||
- README advertises `21 rooms, 43+ exits across 5 zones`
|
||||
- `ROOM_CONFIG` in `world/rebuild_world.py` maps room IDs `3..22` for wing rooms, while Limbo/hub is treated separately
|
||||
- atmosphere metadata is a first-class room feature, not cosmetic prose
|
||||
|
||||
## Verification Performed
|
||||
|
||||
Target repo verification from a fresh clone at `/tmp/timmy-academy-verify`:
|
||||
|
||||
- `python3 -m py_compile commands/command.py commands/default_cmdsets.py server/conf/settings.py typeclasses/audited_character.py world/rebuild_world.py web/urls.py`
|
||||
- `python3 tests/stress_test.py --help`
|
||||
- `python3 tests/stress_test.py --self-test`
|
||||
- `python3 ~/.hermes/pipelines/codebase-genome.py --path /tmp/timmy-academy-verify --output /tmp/timmy-academy-base.md`
|
||||
|
||||
Observed runtime-adjacent facts:
|
||||
- core modules compile as Python
|
||||
- the stress harness advertises `--self-test` and `--json` modes
|
||||
- target repo does **not** contain a checked-in `GENOME.md` at its own root
|
||||
|
||||
## Test Coverage Gaps
|
||||
|
||||
The repo still has only one test file: `tests/stress_test.py`.
|
||||
|
||||
Critical untested paths:
|
||||
1. `typeclasses/audited_character.py`
|
||||
- no direct tests for move logging, audit pruning, command counting, or session accounting
|
||||
2. `commands/command.py`
|
||||
- no command-level unit tests for `@status`, `@map`, `rooms`, `smell`, `listen`, or `@who`
|
||||
3. `world/rebuild_world.py`
|
||||
- no tests for parsing wing files, room ID mapping, exit verification, or idempotent rebuild behavior
|
||||
4. `server/conf/settings.py`
|
||||
- no configuration sanity checks for port exposure, logging handlers, or audit defaults
|
||||
5. `web/urls.py`
|
||||
- no tests confirming routing composition for website/webclient/admin
|
||||
|
||||
The existing stress harness is valuable, but it is not a substitute for unit or integration tests around the repo’s custom command/typeclass logic.
|
||||
|
||||
## Security Considerations
|
||||
|
||||
1. Network exposure
|
||||
- `TELNET_INTERFACES = ['0.0.0.0']`
|
||||
- `WEBSERVER_INTERFACES = ['0.0.0.0']`
|
||||
These settings expose the academy to all interfaces. That may be intended on the VPS, but it shifts safety to firewall/reverse-proxy controls.
|
||||
|
||||
2. Secrets split is expected but must be enforced
|
||||
- `server/conf/settings.py` imports `secret_settings.py`
|
||||
- this is the right shape, but only if `secret_settings.py` is never committed and contains the truly sensitive deployment values
|
||||
|
||||
3. Audit log sensitivity
|
||||
- `AuditedCharacter.at_pre_cmd()` excludes password commands from audit logging
|
||||
- good safeguard, but the rest of the command stream is still intentionally retained and should be treated as sensitive behavioral telemetry
|
||||
|
||||
4. Checked-in bridge environment file
|
||||
- the repo contains `hermes-agent/.env`
|
||||
- even if it is benign now, a checked-in `.env` path is a standing secret-handling risk and should be treated carefully
|
||||
|
||||
5. Framework-level dynamic evaluation risk
|
||||
- Evennia’s config surface includes modules like `server/conf/inlinefuncs.py`
|
||||
- this is inherited framework behavior, but still part of the runtime attack surface
|
||||
|
||||
## CI / Runtime Drift
|
||||
|
||||
This repo has meaningful operational drift and missing automation:
|
||||
|
||||
1. No checked-in CI workflows
|
||||
- no `.gitea/workflows/*` or `.github/workflows/*` coverage surfaced in the fresh clone
|
||||
- the academy relies on manual rebuild and manual stress testing
|
||||
|
||||
2. Target repo root lacks its own `GENOME.md`
|
||||
- the genome issue lives in `timmy-home`
|
||||
- the analyzed repo itself still does not carry an in-repo architecture artifact
|
||||
|
||||
3. `README.md` vs command docs wording drift
|
||||
- README frames the academy as four thematic wings plus a hub/zone model
|
||||
- older generated genome wording called these “five wings”
|
||||
- the source-of-truth model is more accurately “central hub + four wings”
|
||||
|
||||
4. Bridge configuration drift
|
||||
- `hermes-agent/config.yaml` still references `anthropic/claude-opus-4.6`
|
||||
- this is a real integration snapshot inside the repo and should be treated as provider-policy drift if the surrounding stack has moved away from Anthropic
|
||||
- `hermes-agent/config.yaml` — Configuration for AI agent connection
|
||||
- Allows Hermes agents to connect as characters and interact with the world
|
||||
|
||||
## Dependencies
|
||||
|
||||
No `requirements.txt`, `pyproject.toml`, or other dependency lockfile is checked in at the repo root.
|
||||
No `requirements.txt` or `pyproject.toml` found. Dependencies come from Evennia:
|
||||
|
||||
Grounded dependency picture instead comes from source and README:
|
||||
- Evennia 6.0.0
|
||||
- Django (via Evennia)
|
||||
- Twisted (via Evennia)
|
||||
- Python 3.12.x
|
||||
- **evennia** — MUD framework (Django-based)
|
||||
- **django** — Web framework (via Evennia)
|
||||
- **twisted** — Async networking (via Evennia)
|
||||
|
||||
This means environment reproducibility currently depends on external operator knowledge rather than repo-local dependency locking.
|
||||
## Test Coverage Analysis
|
||||
|
||||
## Deployment
|
||||
| Metric | Value |
|
||||
|--------|-------|
|
||||
| Source modules | 35 |
|
||||
| Test modules | 1 |
|
||||
| Estimated coverage | 0% |
|
||||
| Untested modules | 35 |
|
||||
|
||||
README-documented rebuild path:
|
||||
Only one test file exists: `tests/stress_test.py`. All 35 source modules are untested.
|
||||
|
||||
```bash
|
||||
ssh root@167.99.126.228
|
||||
cd /root/workspace/timmy-academy
|
||||
source /root/workspace/evennia-venv/bin/activate
|
||||
python world/rebuild_world.py
|
||||
```
|
||||
### Critical Untested Paths
|
||||
|
||||
Operationally relevant deployment facts:
|
||||
- target VPS in README: `167.99.126.228`
|
||||
- telnet surface: `4000`
|
||||
- web client surface: `4001`
|
||||
- the repo assumes an Evennia virtualenv outside the repo itself
|
||||
- world rebuild is source-driven and intended to be idempotent
|
||||
1. **AuditedCharacter** — audit logging is the primary value-add. No tests verify movement tracking, command counting, or playtime calculation.
|
||||
2. **Commands** — no tests for any of the 8 commands. The `@map` wing detection, `@who` session tracking, and atmosphere-based commands (`smell`, `listen`) are all untested.
|
||||
3. **World rebuild** — `rebuild_world.py` and `fix_world.py` can destroy and recreate the entire world. No tests ensure they produce valid output.
|
||||
4. **Typeclass hooks** — `at_pre_move`, `at_post_move`, `at_pre_cmd` etc. are never tested in isolation.
|
||||
|
||||
## Technical Debt
|
||||
## Security Considerations
|
||||
|
||||
1. `ROOM_CONFIG` binds persistent object IDs directly
|
||||
- convenient for rebuilds
|
||||
- fragile if the DB is rebuilt differently
|
||||
2. only one test file for an otherwise rich custom surface
|
||||
3. no CI automation for compile/rebuild/smoke validation
|
||||
4. no explicit dependency lockfile
|
||||
5. checked-in `hermes-agent/.env` path raises secret-hygiene questions
|
||||
6. target repo has no first-party `GENOME.md`, so architecture memory still lives mostly outside the repo
|
||||
- ⚠️ Uses `eval()`/`exec()` — Evennia's inlinefuncs module uses eval for dynamic command evaluation. Risk level: inherent to MUD framework.
|
||||
- ⚠️ References secrets/passwords — `settings.py` references `secret_settings.py` for sensitive config. Ensure this file is not committed.
|
||||
- ⚠️ Telnet on 0.0.0.0 — server accepts connections from any IP. Consider firewall rules.
|
||||
- ⚠️ Web client on 0.0.0.0 — same exposure as telnet. Ensure authentication is enforced.
|
||||
- ⚠️ Agent bridge (`hermes-agent/config.yaml`) — verify credentials are not hardcoded.
|
||||
|
||||
## Configuration Files
|
||||
|
||||
- `server/conf/settings.py` — Main Evennia settings (server name, ports, typeclass paths)
|
||||
- `hermes-agent/config.yaml` — Hermes agent bridge configuration
|
||||
- `world/build_academy.ev` — Evennia batch build script
|
||||
- `world/batch_cmds.ev` — Batch command definitions
|
||||
|
||||
## What's Missing
|
||||
|
||||
1. **Tests** — 0% coverage is a critical gap. Priority: AuditedCharacter hooks, command func() methods, world rebuild integrity.
|
||||
2. **CI/CD** — No automated testing pipeline. No GitHub Actions or Gitea workflows.
|
||||
3. **Documentation** — `world/BUILDER_GUIDE.md` exists but no developer onboarding docs.
|
||||
4. **Monitoring** — No health checks, no metrics export, no alerting on server crashes.
|
||||
5. **Backup** — No automated database backup for the Evennia SQLite/PostgreSQL database.
|
||||
|
||||
---
|
||||
|
||||
This genome was refreshed against the live `timmy-academy` repository and verified with compile + stress-harness entrypoint checks, not just copied from the older auto-generated artifact.
|
||||
*Generated by Codebase Genome Pipeline. Review and update manually.*
|
||||
|
||||
@@ -1059,6 +1059,46 @@ class GameEngine:
|
||||
self.log("It will always pulse. That much you know.")
|
||||
self.log("")
|
||||
self.world.save()
|
||||
|
||||
def _bridge_is_hazardous(self):
|
||||
bridge = self.world.rooms["Bridge"]
|
||||
return bool(
|
||||
self.world.state.get("bridge_flooding")
|
||||
or bridge.get("weather") == "rain"
|
||||
or bridge.get("rain_ticks", 0) > 0
|
||||
)
|
||||
|
||||
def _bridge_crossing_extra_cost(self, current_room, dest):
|
||||
if "Bridge" not in (current_room, dest):
|
||||
return 0
|
||||
return 2 if self._bridge_is_hazardous() else 0
|
||||
|
||||
def _event_dialogue(self, char_name, room_name):
|
||||
if char_name == "Bezalel" and room_name == "Forge":
|
||||
if self.world.rooms["Forge"]["fire"] == "cold":
|
||||
return random.choice([
|
||||
"The forge is cold. We cannot work until the fire lives again.",
|
||||
"No forging now. The hearth is dead cold.",
|
||||
])
|
||||
if self.world.state.get("forge_fire_dying"):
|
||||
return random.choice([
|
||||
"The fire is dying. Tend it before the forge goes dark.",
|
||||
"The forge is losing heat. Help me keep it alive.",
|
||||
])
|
||||
|
||||
if char_name == "Ezra" and room_name == "Tower" and self.world.state.get("tower_power_low"):
|
||||
return random.choice([
|
||||
"The Tower power is too low. The servers won't hold a clean study right now.",
|
||||
"The LED is flickering. We need steady power before the Tower can be read properly.",
|
||||
])
|
||||
|
||||
if char_name in {"Marcus", "Allegro"} and room_name == "Bridge" and self._bridge_is_hazardous():
|
||||
return random.choice([
|
||||
"The Bridge is slick with rain. Cross carefully or wait it out.",
|
||||
"This rain changes the Bridge. Don't treat it like dry stone.",
|
||||
])
|
||||
|
||||
return None
|
||||
|
||||
def log(self, message):
|
||||
"""Add to Timmy's log."""
|
||||
@@ -1094,6 +1134,7 @@ class GameEngine:
|
||||
}
|
||||
|
||||
# Process Timmy's action
|
||||
room_name = self.world.characters["Timmy"]["room"]
|
||||
timmy_energy = self.world.characters["Timmy"]["energy"]
|
||||
|
||||
# Energy constraint checks
|
||||
@@ -1156,8 +1197,17 @@ class GameEngine:
|
||||
|
||||
if direction in connections:
|
||||
dest = connections[direction]
|
||||
bridge_extra_cost = self._bridge_crossing_extra_cost(current_room, dest)
|
||||
move_cost = 1 + bridge_extra_cost
|
||||
if self.world.characters["Timmy"]["energy"] < move_cost:
|
||||
scene["log"].append("The rain makes the Bridge too costly to cross right now. Rest first.")
|
||||
scene["room_desc"] = self.world.get_room_desc(current_room, "Timmy")
|
||||
here = [n for n in self.world.characters if self.world.characters[n]["room"] == current_room and n != "Timmy"]
|
||||
scene["here"] = here
|
||||
return scene
|
||||
|
||||
self.world.characters["Timmy"]["room"] = dest
|
||||
self.world.characters["Timmy"]["energy"] -= 1
|
||||
self.world.characters["Timmy"]["energy"] -= move_cost
|
||||
|
||||
scene["log"].append(f"You move {direction} to The {dest}.")
|
||||
scene["timmy_room"] = dest
|
||||
@@ -1165,6 +1215,8 @@ class GameEngine:
|
||||
# Check for rain on bridge
|
||||
if dest == "Bridge" and self.world.rooms["Bridge"]["weather"] == "rain":
|
||||
scene["world_events"].append("Rain mists on the dark water below. The railing is slick.")
|
||||
if bridge_extra_cost:
|
||||
scene["log"].append("Rain turns the Bridge crossing into work. You brace against the slick stone. (-2 extra energy)")
|
||||
|
||||
# Check trust changes for arrival
|
||||
here = [n for n in self.world.characters if self.world.characters[n]["room"] == dest and n != "Timmy"]
|
||||
@@ -1310,25 +1362,69 @@ class GameEngine:
|
||||
|
||||
elif timmy_action == "write_rule":
|
||||
if self.world.characters["Timmy"]["room"] == "Tower":
|
||||
rules = [
|
||||
f"Rule #{self.world.tick}: The room remembers those who enter it.",
|
||||
f"Rule #{self.world.tick}: A man in the dark needs to know someone is in the room.",
|
||||
f"Rule #{self.world.tick}: The forge does not care about your schedule.",
|
||||
f"Rule #{self.world.tick}: Every footprint on the stone means someone made it here.",
|
||||
f"Rule #{self.world.tick}: The bridge does not judge. It only carries.",
|
||||
f"Rule #{self.world.tick}: A seed planted in patience grows in time.",
|
||||
f"Rule #{self.world.tick}: What is carved in wood outlasts what is said in anger.",
|
||||
f"Rule #{self.world.tick}: The garden grows whether anyone watches or not.",
|
||||
f"Rule #{self.world.tick}: Trust is built one tick at a time.",
|
||||
f"Rule #{self.world.tick}: The fire remembers who tended it.",
|
||||
]
|
||||
new_rule = random.choice(rules)
|
||||
self.world.rooms["Tower"]["messages"].append(new_rule)
|
||||
self.world.characters["Timmy"]["energy"] -= 1
|
||||
scene["log"].append(f"You write on the Tower whiteboard: \"{new_rule}\"")
|
||||
if self.world.state.get("tower_power_low"):
|
||||
scene["world_events"].append("The Tower power is too low. The LED flickers over the whiteboard.")
|
||||
scene["log"].append("The power is too low to write a new rule.")
|
||||
else:
|
||||
rules = [
|
||||
f"Rule #{self.world.tick}: The room remembers those who enter it.",
|
||||
f"Rule #{self.world.tick}: A man in the dark needs to know someone is in the room.",
|
||||
f"Rule #{self.world.tick}: The forge does not care about your schedule.",
|
||||
f"Rule #{self.world.tick}: Every footprint on the stone means someone made it here.",
|
||||
f"Rule #{self.world.tick}: The bridge does not judge. It only carries.",
|
||||
f"Rule #{self.world.tick}: A seed planted in patience grows in time.",
|
||||
f"Rule #{self.world.tick}: What is carved in wood outlasts what is said in anger.",
|
||||
f"Rule #{self.world.tick}: The garden grows whether anyone watches or not.",
|
||||
f"Rule #{self.world.tick}: Trust is built one tick at a time.",
|
||||
f"Rule #{self.world.tick}: The fire remembers who tended it.",
|
||||
]
|
||||
new_rule = random.choice(rules)
|
||||
self.world.rooms["Tower"]["messages"].append(new_rule)
|
||||
self.world.characters["Timmy"]["energy"] -= 1
|
||||
scene["log"].append(f"You write on the Tower whiteboard: \"{new_rule}\"")
|
||||
else:
|
||||
scene["log"].append("You are not in the Tower.")
|
||||
|
||||
elif timmy_action == "study":
|
||||
if self.world.characters["Timmy"]["room"] == "Tower":
|
||||
if self.world.state.get("tower_power_low"):
|
||||
scene["world_events"].append("The Tower power is too low. The servers stutter in weak light.")
|
||||
scene["log"].append("The power is too low to study the servers.")
|
||||
else:
|
||||
insights = [
|
||||
"You study the server rhythm until the pulse resolves into something readable.",
|
||||
"You trace the signal paths and feel the Tower settle into focus.",
|
||||
"You study the green LED and the server racks until the pattern becomes clear.",
|
||||
]
|
||||
insight = random.choice(insights)
|
||||
self.world.characters["Timmy"]["energy"] -= 1
|
||||
self.world.characters["Timmy"]["memories"].append(insight)
|
||||
scene["log"].append(insight)
|
||||
scene["world_events"].append("The Tower answers with a steady hum.")
|
||||
else:
|
||||
scene["log"].append("You are not in the Tower.")
|
||||
|
||||
elif timmy_action == "forge":
|
||||
if self.world.characters["Timmy"]["room"] == "Forge":
|
||||
forge_fire = self.world.rooms["Forge"]["fire"]
|
||||
if forge_fire == "cold":
|
||||
scene["world_events"].append("The forge is cold. No metal will take shape here yet.")
|
||||
scene["log"].append("The forge is cold. Tend the fire before you try to forge.")
|
||||
else:
|
||||
forged_items = [
|
||||
f"bridge nail #{self.world.tick}",
|
||||
f"tower key blank #{self.world.tick}",
|
||||
f"garden trowel #{self.world.tick}",
|
||||
]
|
||||
forged_item = random.choice(forged_items)
|
||||
self.world.rooms["Forge"]["forged_items"].append(forged_item)
|
||||
self.world.characters["Timmy"]["energy"] -= 2
|
||||
self.world.state["items_crafted"] += 1
|
||||
scene["log"].append(f"You forge {forged_item} at the anvil.")
|
||||
scene["world_events"].append("The anvil rings and the hearth answers.")
|
||||
else:
|
||||
scene["log"].append("You are not in the Forge.")
|
||||
|
||||
elif timmy_action == "carve":
|
||||
if self.world.characters["Timmy"]["room"] == "Bridge":
|
||||
carvings = [
|
||||
@@ -1414,7 +1510,11 @@ class GameEngine:
|
||||
speech_chance = 0.20
|
||||
|
||||
if random.random() < speech_chance:
|
||||
if char_name == "Marcus":
|
||||
event_line = self._event_dialogue(char_name, room_name)
|
||||
if event_line:
|
||||
self.world.characters[char_name]["spoken"].append(event_line)
|
||||
scene["log"].append(f"{char_name} says: \"{event_line}\"")
|
||||
elif char_name == "Marcus":
|
||||
marcus_pool = self.DIALOGUES["Marcus"].get(phase, self.DIALOGUES["Marcus"]["quietus"])
|
||||
line = random.choice(marcus_pool)
|
||||
self.world.characters[char_name]["spoken"].append(line)
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
from importlib.util import module_from_spec, spec_from_file_location
|
||||
from pathlib import Path
|
||||
import unittest
|
||||
from unittest.mock import patch
|
||||
|
||||
|
||||
ROOT = Path(__file__).resolve().parent.parent
|
||||
@@ -66,6 +67,82 @@ class TestEvenniaLocalWorldGame(unittest.TestCase):
|
||||
self.assertIn("Ezra is already here.", result["log"])
|
||||
self.assertIn("The servers hum steady. The green LED pulses.", result["world_events"])
|
||||
|
||||
def test_bridge_rain_crossing_costs_extra_energy_and_warns(self):
|
||||
module = load_game_module()
|
||||
|
||||
dry_engine = module.GameEngine()
|
||||
dry_engine.start_new_game()
|
||||
dry_engine.world.update_world_state = lambda: None
|
||||
dry_engine.world.characters["Timmy"]["energy"] = 10
|
||||
dry_result = dry_engine.run_tick("move:south")
|
||||
dry_energy = dry_engine.world.characters["Timmy"]["energy"]
|
||||
|
||||
rainy_engine = module.GameEngine()
|
||||
rainy_engine.start_new_game()
|
||||
rainy_engine.world.update_world_state = lambda: None
|
||||
rainy_engine.world.characters["Timmy"]["energy"] = 10
|
||||
rainy_engine.world.rooms["Bridge"]["weather"] = "rain"
|
||||
rainy_engine.world.rooms["Bridge"]["rain_ticks"] = 3
|
||||
rainy_engine.world.state["bridge_flooding"] = True
|
||||
rainy_result = rainy_engine.run_tick("move:south")
|
||||
|
||||
self.assertEqual(rainy_engine.world.characters["Timmy"]["room"], "Bridge")
|
||||
self.assertLess(rainy_engine.world.characters["Timmy"]["energy"], dry_energy)
|
||||
self.assertTrue(
|
||||
any("bridge" in line.lower() and ("rain" in line.lower() or "slick" in line.lower()) for line in rainy_result["log"] + rainy_result["world_events"]),
|
||||
rainy_result,
|
||||
)
|
||||
|
||||
def test_tower_power_low_blocks_study_and_write_rule(self):
|
||||
module = load_game_module()
|
||||
engine = module.GameEngine()
|
||||
engine.start_new_game()
|
||||
engine.world.update_world_state = lambda: None
|
||||
engine.world.characters["Timmy"]["room"] = "Tower"
|
||||
engine.world.characters["Timmy"]["energy"] = 10
|
||||
engine.world.state["tower_power_low"] = True
|
||||
|
||||
rules_before = list(engine.world.rooms["Tower"]["messages"])
|
||||
study_result = engine.run_tick("study")
|
||||
self.assertEqual(engine.world.characters["Timmy"]["energy"], 10)
|
||||
self.assertTrue(
|
||||
any("power" in line.lower() and ("study" in line.lower() or "servers" in line.lower()) for line in study_result["log"] + study_result["world_events"]),
|
||||
study_result,
|
||||
)
|
||||
|
||||
write_result = engine.run_tick("write_rule")
|
||||
self.assertEqual(engine.world.rooms["Tower"]["messages"], rules_before)
|
||||
self.assertTrue(
|
||||
any("power" in line.lower() and ("write" in line.lower() or "whiteboard" in line.lower()) for line in write_result["log"] + write_result["world_events"]),
|
||||
write_result,
|
||||
)
|
||||
|
||||
def test_cold_forge_blocks_forge_action_and_bezalel_reacts(self):
|
||||
module = load_game_module()
|
||||
engine = module.GameEngine()
|
||||
engine.start_new_game()
|
||||
engine.world.update_world_state = lambda: None
|
||||
engine.npc_ai.make_choice = lambda _name: None
|
||||
engine.world.characters["Timmy"]["room"] = "Forge"
|
||||
engine.world.characters["Timmy"]["energy"] = 10
|
||||
engine.world.characters["Bezalel"]["room"] = "Forge"
|
||||
engine.world.rooms["Forge"]["fire"] = "cold"
|
||||
engine.world.state["forge_fire_dying"] = True
|
||||
forged_before = list(engine.world.rooms["Forge"]["forged_items"])
|
||||
|
||||
with patch.object(module.random, "random", return_value=0.0), patch.object(module.random, "choice", side_effect=lambda seq: seq[0]):
|
||||
result = engine.run_tick("forge")
|
||||
|
||||
self.assertEqual(engine.world.rooms["Forge"]["forged_items"], forged_before)
|
||||
self.assertTrue(
|
||||
any("forge" in line.lower() and ("cold" in line.lower() or "fire" in line.lower()) for line in result["log"] + result["world_events"]),
|
||||
result,
|
||||
)
|
||||
self.assertTrue(
|
||||
any(line.startswith("Bezalel says:") and ("fire" in line.lower() or "forge" in line.lower()) for line in result["log"]),
|
||||
result,
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
|
||||
@@ -1,67 +0,0 @@
|
||||
"""Lock timmy-academy genome to current verified repo facts. Ref: #678."""
|
||||
from pathlib import Path
|
||||
|
||||
GENOME = Path("GENOME-timmy-academy.md")
|
||||
|
||||
|
||||
def read_genome() -> str:
|
||||
assert GENOME.exists(), "timmy-academy genome must exist at repo root"
|
||||
return GENOME.read_text(encoding="utf-8")
|
||||
|
||||
|
||||
def test_genome_exists():
|
||||
assert GENOME.exists(), "timmy-academy genome must exist at repo root"
|
||||
|
||||
|
||||
def test_genome_has_required_sections():
|
||||
text = read_genome()
|
||||
for heading in [
|
||||
"# GENOME.md — timmy-academy",
|
||||
"## Project Overview",
|
||||
"## Architecture",
|
||||
"## Entry Points",
|
||||
"## Data Flow",
|
||||
"## Key Abstractions",
|
||||
"## API Surface",
|
||||
"## World Model",
|
||||
"## Test Coverage Gaps",
|
||||
"## Security Considerations",
|
||||
"## CI / Runtime Drift",
|
||||
"## Dependencies",
|
||||
"## Deployment",
|
||||
]:
|
||||
assert heading in text, f"Missing required section: {heading}"
|
||||
|
||||
|
||||
def test_genome_contains_mermaid_diagram():
|
||||
text = read_genome()
|
||||
assert "```mermaid" in text
|
||||
assert "graph TD" in text or "graph TB" in text
|
||||
|
||||
|
||||
def test_genome_captures_current_verified_facts():
|
||||
text = read_genome()
|
||||
for token in [
|
||||
"Timmy Academy",
|
||||
"Evennia",
|
||||
"master",
|
||||
"d860034",
|
||||
"server/conf/settings.py",
|
||||
"commands/default_cmdsets.py",
|
||||
"typeclasses/audited_character.py",
|
||||
"world/rebuild_world.py",
|
||||
"tests/stress_test.py",
|
||||
"python3 tests/stress_test.py --self-test",
|
||||
"TELNET_PORTS = [4000]",
|
||||
"WEBSERVER_PORTS = [(4001, 4005)]",
|
||||
"0.0.0.0",
|
||||
"secret_settings.py",
|
||||
"hermes-agent/config.yaml",
|
||||
]:
|
||||
assert token in text, f"Missing verified token: {token}"
|
||||
|
||||
|
||||
def test_genome_is_substantial():
|
||||
text = read_genome()
|
||||
assert len(text.splitlines()) >= 120
|
||||
assert len(text) >= 7000
|
||||
Reference in New Issue
Block a user