Compare commits
2 Commits
fix/528-v2
...
fix/678
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
375a45e0ae | ||
|
|
952a604e1c |
@@ -1,7 +1,9 @@
|
||||
# GENOME.md — timmy-academy
|
||||
|
||||
*Auto-generated by Codebase Genome Pipeline. 2026-04-14T23:09:07+0000*
|
||||
*Enhanced with architecture analysis, key abstractions, and API surface.*
|
||||
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)`
|
||||
|
||||
## Quick Facts
|
||||
|
||||
@@ -10,229 +12,312 @@
|
||||
| Source files | 48 |
|
||||
| Test files | 1 |
|
||||
| Config files | 1 |
|
||||
| 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) |
|
||||
| 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` |
|
||||
|
||||
## What This Is
|
||||
## Project Overview
|
||||
|
||||
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.
|
||||
`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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Architecture
|
||||
|
||||
```mermaid
|
||||
graph TB
|
||||
subgraph "Connections"
|
||||
TELNET[Telnet :4000]
|
||||
WEB[Web Client :4001]
|
||||
end
|
||||
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 "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
|
||||
TELNET --> PORTAL
|
||||
WEB --> PORTAL
|
||||
PORTAL --> SERVER
|
||||
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
|
||||
SETTINGS --> SERVER
|
||||
WEBURLS --> SERVER
|
||||
SERVER --> CMDSETS
|
||||
CMDSETS --> COMMANDS
|
||||
SERVER --> TYPECLASSES
|
||||
TYPECLASSES --> AUDIT
|
||||
SERVER --> WORLD
|
||||
WORLD --> REBUILD
|
||||
BATCH --> REBUILD
|
||||
HERMESCFG --> SERVER
|
||||
STRESS --> TELNET
|
||||
```
|
||||
|
||||
## Entry Points
|
||||
|
||||
| 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 |
|
||||
| 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 |
|
||||
|
||||
## Data Flow
|
||||
|
||||
```
|
||||
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
|
||||
```
|
||||
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.
|
||||
|
||||
## Key Abstractions
|
||||
|
||||
### Typeclasses (the world model)
|
||||
### 1. `AuditedCharacter`
|
||||
File: `typeclasses/audited_character.py`
|
||||
|
||||
| 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 |
|
||||
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()`
|
||||
|
||||
### AuditedCharacter — the flagship typeclass
|
||||
Operationally, this is what turns the academy from a generic Evennia world into an observable training environment.
|
||||
|
||||
The `AuditedCharacter` is the most important abstraction. It wraps every player action in logging:
|
||||
### 2. `CharacterCmdSet`
|
||||
File: `commands/default_cmdsets.py`
|
||||
|
||||
- `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
|
||||
This cmdset is the binding point between the world and its training interface. It mounts:
|
||||
- `CmdExamine`
|
||||
- `CmdRooms`
|
||||
- `CmdStatus`
|
||||
- `CmdMap`
|
||||
- `CmdAcademy`
|
||||
- `CmdSmell`
|
||||
- `CmdListen`
|
||||
- `CmdWho`
|
||||
|
||||
Audit trail keeps last 1000 movements in `db.location_history`. Sensitive commands (password) are excluded from logging.
|
||||
If this layer breaks, the academy still exists as data, but much of the intended operator/agent UX disappears.
|
||||
|
||||
### Commands (the player interface)
|
||||
### 3. `CmdStatus`, `CmdMap`, `CmdAcademy`, `CmdWho`
|
||||
File: `commands/command.py`
|
||||
|
||||
| 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 |
|
||||
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
|
||||
|
||||
### World Structure (5 wings, 21+ rooms)
|
||||
This is the part most likely to matter for agent convening and coordination.
|
||||
|
||||
**Central Hub (LIMBO)** — Nexus connecting all wings. North=Dormitory, South=Workshop, East=Commons, West=Gardens.
|
||||
### 4. Wing room classes
|
||||
Files: `world/commons_wing.py`, `world/dormitory_entrance.py`, `world/workshop_wing.py`, `world/gardens_wing.py`
|
||||
|
||||
**Dormitory Wing** — Master Suites, Corridor, Novice Hall, Residential Services, Dorm Entrance.
|
||||
These classes encode the academy’s content model. Each room defines:
|
||||
- `self.key`
|
||||
- aliases
|
||||
- long-form description
|
||||
- `db.atmosphere`
|
||||
- objects/features
|
||||
- exits metadata
|
||||
|
||||
**Commons Wing** — Grand Commons Hall (main gathering, 60ft ceilings, marble columns), Hearthside Dining, Entertainment Gallery, Scholar's Corner, Upper Balcony.
|
||||
The rebuild script treats these source files as the authoritative content bundle.
|
||||
|
||||
**Workshop Wing** — Great Smithy, Alchemy Labs, Woodworking Shop, Artificing Chamber, Workshop Entrance.
|
||||
### 5. `ROOM_CONFIG` / `WING_INFO`
|
||||
File: `world/rebuild_world.py`
|
||||
|
||||
**Gardens Wing** — Enchanted Grove, Herb Gardens, Greenhouse, Sacred Grove, Gardens 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.
|
||||
|
||||
Each room has rich `db.atmosphere` data: mood, lighting, sounds, smells, temperature.
|
||||
### 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.
|
||||
|
||||
## API Surface
|
||||
|
||||
### Web API
|
||||
### In-world commands
|
||||
Defined in `commands/command.py` and registered in `commands/default_cmdsets.py`.
|
||||
|
||||
- `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
|
||||
| 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 |
|
||||
|
||||
### Telnet
|
||||
All of these use permissive `locks = "cmd:all()"`, which is convenient for training but worth noting from a security and abuse perspective.
|
||||
|
||||
- Standard MUD protocol on port 4000
|
||||
- Supports MCCP (compression), MSDP (data), GMCP (protocol)
|
||||
### 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 |
|
||||
|
||||
### Hermes Bridge
|
||||
## World Model
|
||||
|
||||
- `hermes-agent/config.yaml` — Configuration for AI agent connection
|
||||
- Allows Hermes agents to connect as characters and interact with the world
|
||||
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.
|
||||
|
||||
## Dependencies
|
||||
| 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 |
|
||||
|
||||
No `requirements.txt` or `pyproject.toml` found. Dependencies come from Evennia:
|
||||
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
|
||||
|
||||
- **evennia** — MUD framework (Django-based)
|
||||
- **django** — Web framework (via Evennia)
|
||||
- **twisted** — Async networking (via Evennia)
|
||||
## Verification Performed
|
||||
|
||||
## Test Coverage Analysis
|
||||
Target repo verification from a fresh clone at `/tmp/timmy-academy-verify`:
|
||||
|
||||
| Metric | Value |
|
||||
|--------|-------|
|
||||
| Source modules | 35 |
|
||||
| Test modules | 1 |
|
||||
| Estimated coverage | 0% |
|
||||
| Untested modules | 35 |
|
||||
- `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`
|
||||
|
||||
Only one test file exists: `tests/stress_test.py`. All 35 source modules are untested.
|
||||
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
|
||||
|
||||
### Critical Untested Paths
|
||||
## Test Coverage Gaps
|
||||
|
||||
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.
|
||||
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
|
||||
|
||||
- ⚠️ 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.
|
||||
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.
|
||||
|
||||
## Configuration Files
|
||||
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
|
||||
|
||||
- `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
|
||||
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
|
||||
|
||||
## What's Missing
|
||||
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
|
||||
|
||||
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.
|
||||
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
|
||||
|
||||
## Dependencies
|
||||
|
||||
No `requirements.txt`, `pyproject.toml`, or other dependency lockfile is checked in at the repo root.
|
||||
|
||||
Grounded dependency picture instead comes from source and README:
|
||||
- Evennia 6.0.0
|
||||
- Django (via Evennia)
|
||||
- Twisted (via Evennia)
|
||||
- Python 3.12.x
|
||||
|
||||
This means environment reproducibility currently depends on external operator knowledge rather than repo-local dependency locking.
|
||||
|
||||
## Deployment
|
||||
|
||||
README-documented rebuild path:
|
||||
|
||||
```bash
|
||||
ssh root@167.99.126.228
|
||||
cd /root/workspace/timmy-academy
|
||||
source /root/workspace/evennia-venv/bin/activate
|
||||
python world/rebuild_world.py
|
||||
```
|
||||
|
||||
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
|
||||
|
||||
## Technical Debt
|
||||
|
||||
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
|
||||
|
||||
---
|
||||
|
||||
*Generated by Codebase Genome Pipeline. Review and update manually.*
|
||||
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.
|
||||
|
||||
@@ -1,281 +0,0 @@
|
||||
# LAB-003: Truck Battery Disconnect Switch Installation
|
||||
|
||||
**Issue:** [timmy-home#528](https://forge.alexanderwhitestone.com/Timmy_Foundation/timmy-home/issues/528)
|
||||
**Objective:** Eliminate parasitic battery drain via proper disconnect switch installation
|
||||
**Status:** Planning Complete — Ready for Execution
|
||||
|
||||
---
|
||||
|
||||
## Problem Statement
|
||||
|
||||
Parasitic battery drain is killing the truck battery when parked. This is critical for operational mobility in a rural location where the truck is essential for:
|
||||
- Supply runs to Newport/Claremont
|
||||
- Emergency egress
|
||||
- Equipment transport
|
||||
|
||||
The battery has likely been damaged from repeated deep discharges and may need replacement.
|
||||
|
||||
---
|
||||
|
||||
## Pre-Installation Checklist
|
||||
|
||||
### Diagnostic Steps (Do These First)
|
||||
|
||||
1. **Verify parasitic drain with multimeter:**
|
||||
- Set multimeter to DC Amps (10A scale)
|
||||
- Disconnect negative battery terminal
|
||||
- Connect multimeter in series between battery negative and cable
|
||||
- Normal drain: <50mA (0.05A)
|
||||
- Problem drain: >100mA (0.1A)
|
||||
- Record reading: __________ mA
|
||||
|
||||
2. **Identify the culprit (if drain is high):**
|
||||
- While monitoring current, pull fuses one at a time
|
||||
- When current drops, you've found the circuit
|
||||
- Common culprits: aftermarket radio, alarm system, interior lights, OBD-II tracker
|
||||
|
||||
3. **Test battery health:**
|
||||
- With engine off, battery voltage should be ~12.6V
|
||||
- With engine running, alternator should show ~13.7-14.7V
|
||||
- If voltage <12.4V when "fully charged," battery is degraded
|
||||
|
||||
---
|
||||
|
||||
## Shopping List
|
||||
|
||||
### Required Items
|
||||
|
||||
| Item | Purpose | Est. Cost | Stores |
|
||||
|------|---------|-----------|--------|
|
||||
| Battery disconnect switch (side-post or top-post) | Isolate battery when parked | $8-15 | AutoZone, Advance, O'Reilly, NAPA |
|
||||
| Terminal shim/post riser (if needed) | Ensure proper terminal clearance | $3-8 | Same as above |
|
||||
| Dielectric grease | Prevent corrosion on terminals | $3-5 | Same as above |
|
||||
| Battery terminal cleaner brush | Clean posts before install | $2-4 | Same as above |
|
||||
| **Total Estimated** | | **$15-30** | |
|
||||
|
||||
### Product Recommendations
|
||||
|
||||
#### Option 1: Top Terminal Post Mount (Most Common)
|
||||
- **Recommended:** Battery Doctor Knife Switch #20138 (Advance Auto)
|
||||
- $12-15
|
||||
- 250A continuous, 1000A surge
|
||||
- Easy quarter-turn operation
|
||||
- No tools needed to operate
|
||||
|
||||
- **Alternative:** EverStart Battery Disconnect Switch (Walmart/AutoZone)
|
||||
- $8-12
|
||||
- 125A continuous
|
||||
- Twist-knob style
|
||||
|
||||
#### Option 2: Side Terminal Mount (GM Vehicles)
|
||||
- **Recommended:** Battery Doctor Side Terminal Switch #20140
|
||||
- $12-18
|
||||
- Designed for GM-style side terminals
|
||||
- Requires terminal shim for proper fit
|
||||
|
||||
#### Option 3: Quick-Disconnect (Side Post with Cable)
|
||||
- **Recommended:** Quick Cable Battery Disconnect #5091
|
||||
- $10-15
|
||||
- Works with existing cable ends
|
||||
- Marine-grade (good for NH weather)
|
||||
|
||||
### Store Locations (Newport/Claremont Area)
|
||||
|
||||
**AutoZone — Newport**
|
||||
- 65 Main St, Newport, NH 03773
|
||||
- (603) 863-5040
|
||||
- Hours: M-Sat 7:30AM-9PM, Sun 9AM-8PM
|
||||
|
||||
**Advance Auto Parts — Newport**
|
||||
- 71 Main St, Newport, NH 03773
|
||||
- (603) 863-2860
|
||||
- Hours: M-Sat 7:30AM-9PM, Sun 9AM-7PM
|
||||
|
||||
**O'Reilly Auto Parts — Claremont**
|
||||
- 385 Washington St, Claremont, NH 03743
|
||||
- (603) 542-4635
|
||||
- Hours: M-Sat 7:30AM-9PM, Sun 9AM-8PM
|
||||
|
||||
**NAPA Auto Parts — Newport**
|
||||
- 29 John Stark Hwy, Newport, NH 03773
|
||||
- (603) 863-5500
|
||||
- Hours: M-F 7:30AM-6PM, Sat 7:30AM-4PM, Sun Closed
|
||||
|
||||
---
|
||||
|
||||
## Installation Procedure
|
||||
|
||||
### Tools Required
|
||||
- 10mm wrench (for most battery terminals)
|
||||
- 13mm wrench (if GM side terminals)
|
||||
- Wire brush or terminal cleaner
|
||||
- Shop rags
|
||||
- Optional: zip ties for cable management
|
||||
|
||||
### Step-by-Step Installation
|
||||
|
||||
1. **Safety First**
|
||||
- Park on level ground
|
||||
- Engage parking brake
|
||||
- Remove keys from ignition
|
||||
- Wear safety glasses
|
||||
|
||||
2. **Disconnect Battery**
|
||||
- **CRITICAL:** Disconnect NEGATIVE (-) terminal FIRST
|
||||
- This prevents short circuits if wrench touches frame
|
||||
- Loosen 10mm nut, wiggle terminal off post
|
||||
- Tuck cable away so it can't touch battery post
|
||||
|
||||
3. **Clean Terminals**
|
||||
- Use terminal brush to clean inside of cable clamp
|
||||
- Clean battery post until shiny
|
||||
- Apply thin layer of dielectric grease to post
|
||||
|
||||
4. **Install Disconnect Switch**
|
||||
|
||||
**For Top Post Batteries:**
|
||||
- Remove battery cable end from switch (if pre-attached)
|
||||
- Slide switch onto battery negative post
|
||||
- Re-attach cable to other side of switch
|
||||
- Tighten securely (don't overtighten — battery posts strip easily)
|
||||
|
||||
**For Side Terminal (GM) Batteries:**
|
||||
- May need terminal shim/post riser for clearance
|
||||
- Install shim on negative side terminal
|
||||
- Mount switch to shim
|
||||
- Connect cable to switch
|
||||
|
||||
**For Cable-End Style:**
|
||||
- Cut existing negative cable near battery (leave enough slack)
|
||||
- Strip 1/2" of insulation from both ends
|
||||
- Install in quick-disconnect connector
|
||||
- Crimp or bolt securely per manufacturer instructions
|
||||
|
||||
5. **Test Installation**
|
||||
- Switch should rotate/turn smoothly
|
||||
- No binding or interference with battery hold-down
|
||||
- Cable has enough slack for switch operation
|
||||
- Switch in "ON" position: truck electronics work
|
||||
- Switch in "OFF" position: no power to truck
|
||||
|
||||
6. **Reconnect and Verify**
|
||||
- Switch to ON position
|
||||
- Attempt to start truck — should start normally
|
||||
- Check all electronics function
|
||||
- Switch to OFF position
|
||||
- Verify no interior lights, radio, etc.
|
||||
|
||||
---
|
||||
|
||||
## Testing Protocol
|
||||
|
||||
### Immediate Test (Same Day)
|
||||
- [ ] Start truck with switch ON — engine starts normally
|
||||
- [ ] Turn switch OFF while running — engine dies (expected)
|
||||
- [ ] Switch OFF, wait 30 seconds, attempt start — no response (expected)
|
||||
- [ ] Switch ON, attempt start — starts normally
|
||||
|
||||
### Overnight Test (Critical)
|
||||
- [ ] Park truck with switch in OFF position
|
||||
- [ ] Note battery voltage: __________ V
|
||||
- [ ] Wait 24 hours
|
||||
- [ ] Next day, switch ON, attempt start
|
||||
- [ ] Record result: □ Started normally □ Slow crank □ No start
|
||||
- [ ] If started, check voltage: __________ V
|
||||
|
||||
### 48-Hour Test (If Battery Healthy)
|
||||
- [ ] Repeat overnight test with 48-hour duration
|
||||
- [ ] If truck starts normally, installation is successful
|
||||
- [ ] If truck fails to start, battery replacement needed
|
||||
|
||||
---
|
||||
|
||||
## If Battery Needs Replacement
|
||||
|
||||
### Symptoms of Bad Battery
|
||||
- Voltage <12.4V after "charging" overnight
|
||||
- Slow cranking even with switch disconnected
|
||||
- Battery case bulging or terminals corroded
|
||||
- Battery >4 years old
|
||||
|
||||
### Replacement Battery Shopping
|
||||
|
||||
**Common Truck Batteries (Group Size):**
|
||||
- Measure existing battery or check current battery label
|
||||
- Common truck sizes: Group 24F, 27F, 31, 65, 78
|
||||
|
||||
**Recommended:**
|
||||
- **DieHard Platinum AGM** (Advance Auto) — $200-250
|
||||
- Best cold cranking amps (CCA) for NH winters
|
||||
- AGM handles deep discharges better
|
||||
- 3-year full replacement warranty
|
||||
|
||||
- **EverStart Maxx** (Walmart) — $100-150
|
||||
- Budget option
|
||||
- Check CCA rating matches or exceeds old battery
|
||||
|
||||
- **Optima YellowTop** (Pep Boys/Amazon) — $300+
|
||||
- Deep cycle + starting
|
||||
- Best for vehicles with parasitic drain issues
|
||||
- Handles repeated discharge cycles
|
||||
|
||||
---
|
||||
|
||||
## Documentation Requirements
|
||||
|
||||
Per issue #528 acceptance criteria, upload to Gitea:
|
||||
|
||||
- [ ] Photo of installed disconnect switch (close-up)
|
||||
- [ ] Photo of receipt from parts store
|
||||
- [ ] Photo of truck odometer (optional, for record)
|
||||
- [ ] Note of test results (overnight start success/failure)
|
||||
- [ ] Note of battery voltage readings (before/after)
|
||||
|
||||
Upload via:
|
||||
1. Open issue #528 in browser
|
||||
2. Comment with photos attached
|
||||
3. Check off acceptance criteria
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
| Problem | Cause | Solution |
|
||||
|---------|-------|----------|
|
||||
| Switch won't tighten on post | Wrong terminal type | Get side-terminal adapter or different switch style |
|
||||
| Switch hits battery hold-down | Clearance issue | Add terminal shim to raise switch, or relocate hold-down |
|
||||
| Cable too short | Switch adds height | Get battery cable extension or longer replacement cable |
|
||||
| Still drains with switch OFF | Switch installed on wrong terminal | Move to NEGATIVE terminal only |
|
||||
| Switch gets hot | Loose connection | Tighten terminal nuts; check for corrosion |
|
||||
| Truck won't start even with switch ON | Battery too dead | Jump start, then evaluate if battery needs replacement |
|
||||
|
||||
---
|
||||
|
||||
## Cold Weather Considerations (NH)
|
||||
|
||||
- Batteries lose ~50% capacity at 0°F
|
||||
- Disconnect switch prevents drain but doesn't prevent cold damage
|
||||
- If storing truck long-term:
|
||||
- Switch to OFF
|
||||
- Consider battery maintainer (trickle charger)
|
||||
- Or remove battery and store in heated space
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
This installation is straightforward and should take 30-60 minutes including store run. The key steps:
|
||||
|
||||
1. **Diagnose first** — verify parasitic drain, check battery health
|
||||
2. **Buy the right switch** — match your battery terminal type (top vs side)
|
||||
3. **Install on NEGATIVE terminal only** — this is critical for safety
|
||||
4. **Test thoroughly** — overnight test proves the fix worked
|
||||
5. **Document** — photos and receipts to close the issue
|
||||
|
||||
**Estimated total time:** 2-3 hours (including store run)
|
||||
**Estimated cost:** $15-30 (switch only) or $100-300 (if battery replacement needed)
|
||||
|
||||
---
|
||||
|
||||
*Prepared for: timmy-home#528*
|
||||
*Last updated: 2026-04-22*
|
||||
@@ -1,109 +0,0 @@
|
||||
# LAB-003 Verification Report Template
|
||||
|
||||
**Issue:** [timmy-home#528](https://forge.alexanderwhitestone.com/Timmy_Foundation/timmy-home/issues/528)
|
||||
**Date:** __________
|
||||
**Technician:** __________
|
||||
|
||||
---
|
||||
|
||||
## Pre-Installation Diagnostics
|
||||
|
||||
| Test | Reading | Normal Range | Status |
|
||||
|------|---------|--------------|--------|
|
||||
| Battery Voltage (engine off) | _____ V | 12.4-12.7V | □ Pass □ Fail |
|
||||
| Parasitic Current | _____ mA | <50mA | □ Pass □ Fail |
|
||||
| Battery Voltage (engine running) | _____ V | 13.7-14.7V | □ Pass □ Fail |
|
||||
|
||||
**Battery Health Assessment:** □ Good □ Fair □ Replace
|
||||
|
||||
---
|
||||
|
||||
## Parts Purchased
|
||||
|
||||
| Item | Store | Cost |
|
||||
|------|-------|------|
|
||||
| Battery Disconnect Switch | _________ | $_____ |
|
||||
| Dielectric Grease | _________ | $_____ |
|
||||
| Terminal Cleaner | _________ | $_____ |
|
||||
| Other: _________ | _________ | $_____ |
|
||||
| **Total** | | **$_____** |
|
||||
|
||||
---
|
||||
|
||||
## Installation Checklist
|
||||
|
||||
- [ ] Negative terminal disconnected first
|
||||
- [ ] Terminals cleaned
|
||||
- [ ] Dielectric grease applied
|
||||
- [ ] Switch installed on NEGATIVE terminal
|
||||
- [ ] All connections tight
|
||||
- [ ] Switch operates smoothly (no tools needed)
|
||||
- [ ] No interference with hood/battery hold-down
|
||||
|
||||
---
|
||||
|
||||
## Post-Installation Tests
|
||||
|
||||
### Immediate Tests
|
||||
- [ ] Truck starts with switch ON
|
||||
- [ ] No power with switch OFF
|
||||
- [ ] All electronics function normally (switch ON)
|
||||
|
||||
### 24-Hour Test
|
||||
- [ ] Parked with switch OFF for 24+ hours
|
||||
- [ ] Truck started normally next day
|
||||
- [ ] Battery voltage before test: _____ V
|
||||
- [ ] Battery voltage after test: _____ V
|
||||
|
||||
### 48-Hour Test (if applicable)
|
||||
- [ ] Parked with switch OFF for 48+ hours
|
||||
- [ ] Truck started normally
|
||||
|
||||
---
|
||||
|
||||
## Photos Required
|
||||
|
||||
Upload these to issue #528:
|
||||
|
||||
- [ ] Photo of installed disconnect switch (close-up)
|
||||
- [ ] Photo of receipt from parts store
|
||||
- [ ] Photo showing switch in OFF position
|
||||
- [ ] Photo of truck dashboard (optional, for records)
|
||||
|
||||
---
|
||||
|
||||
## Results Summary
|
||||
|
||||
| Acceptance Criterion | Status |
|
||||
|---------------------|--------|
|
||||
| Disconnect switch installed and physically secure | □ Pass □ Fail |
|
||||
| Truck starts reliably after 24+ hours with switch disconnected | □ Pass □ Fail |
|
||||
| No special tools required to operate the disconnect | □ Pass □ Fail |
|
||||
| Receipt uploaded to issue | □ Pass □ Fail |
|
||||
|
||||
**Overall Status:** □ Complete - All criteria met
|
||||
□ Partial - See notes
|
||||
□ Failed - Requires follow-up
|
||||
|
||||
---
|
||||
|
||||
## Notes / Issues Encountered
|
||||
|
||||
_________________________________________________________________
|
||||
|
||||
_________________________________________________________________
|
||||
|
||||
_________________________________________________________________
|
||||
|
||||
---
|
||||
|
||||
## Follow-up Actions (if needed)
|
||||
|
||||
- [ ] Replace battery (if tests failed)
|
||||
- [ ] Exchange switch for different style (if fitment issue)
|
||||
- [ ] Troubleshoot remaining parasitic drain
|
||||
- [ ] Other: _____________________________________________
|
||||
|
||||
---
|
||||
|
||||
*Fill out this template during installation and upload to issue #528*
|
||||
@@ -1,215 +0,0 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# LAB-003 Battery Disconnect Installation Helper
|
||||
# Reference: timmy-home#528
|
||||
#
|
||||
# Usage:
|
||||
# bash scripts/lab_003_battery_disconnect.sh diagnose # Test battery before install
|
||||
# bash scripts/lab_003_battery_disconnect.sh checklist # Print installation checklist
|
||||
# bash scripts/lab_003_battery_disconnect.sh verify # Post-install verification
|
||||
#
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
LOG_FILE="$SCRIPT_DIR/../logs/lab_003_$(date +%Y%m%d_%H%M%S).log"
|
||||
ISSUE_URL="https://forge.alexanderwhitestone.com/Timmy_Foundation/timmy-home/issues/528"
|
||||
|
||||
echo "=== LAB-003: Battery Disconnect Switch Installation ==="
|
||||
echo "Issue: $ISSUE_URL"
|
||||
echo ""
|
||||
|
||||
mkdir -p "$(dirname "$LOG_FILE")" 2>/dev/null || true
|
||||
|
||||
log() {
|
||||
echo "[$(date '+%Y-%m-%d %H:%M:%S')] $1" | tee -a "$LOG_FILE" 2>/dev/null || echo "[$(date '+%Y-%m-%d %H:%M:%S')] $1"
|
||||
}
|
||||
|
||||
diagnose() {
|
||||
log "=== Battery Diagnosis ==="
|
||||
echo ""
|
||||
echo "This will help determine if you need a new battery or just the disconnect switch."
|
||||
echo ""
|
||||
|
||||
echo "Step 1: Check battery voltage with multimeter"
|
||||
echo " - Set multimeter to DC Volts (20V scale)"
|
||||
echo " - Red probe to battery positive (+)"
|
||||
echo " - Black probe to battery negative (-)"
|
||||
echo ""
|
||||
read -p "Enter voltage reading (e.g., 12.6): " voltage
|
||||
log "Battery voltage: ${voltage}V"
|
||||
|
||||
if (( $(echo "$voltage >= 12.6" | bc -l) )); then
|
||||
echo "✓ Battery voltage is GOOD (≥12.6V)"
|
||||
log "Battery voltage GOOD"
|
||||
elif (( $(echo "$voltage >= 12.4" | bc -l) )); then
|
||||
echo "⚠ Battery voltage is FAIR (12.4-12.5V) - may need replacement soon"
|
||||
log "Battery voltage FAIR"
|
||||
else
|
||||
echo "✗ Battery voltage is LOW (<12.4V) - likely needs replacement"
|
||||
log "Battery voltage LOW - replacement recommended"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo "Step 2: Check for parasitic drain"
|
||||
echo " - Set multimeter to DC Amps (10A scale)"
|
||||
echo " - Disconnect negative battery cable"
|
||||
echo " - Connect multimeter between battery negative post and cable"
|
||||
echo " - Wait 2 minutes for modules to sleep"
|
||||
echo ""
|
||||
read -p "Enter current reading in milliamps (e.g., 50): " current
|
||||
log "Parasitic current: ${current}mA"
|
||||
|
||||
if (( $(echo "$current <= 50" | bc -l) )); then
|
||||
echo "✓ Parasitic drain is NORMAL (≤50mA)"
|
||||
log "Parasitic drain NORMAL"
|
||||
echo ""
|
||||
echo "NOTE: Normal drain means the disconnect switch may not be necessary"
|
||||
echo " unless you're storing the truck for weeks at a time."
|
||||
elif (( $(echo "$current <= 100" | bc -l) )); then
|
||||
echo "⚠ Parasitic drain is ELEVATED (50-100mA)"
|
||||
log "Parasitic drain ELEVATED"
|
||||
echo "Disconnect switch will help prevent dead battery."
|
||||
else
|
||||
echo "✗ Parasitic drain is HIGH (>100mA)"
|
||||
log "Parasitic drain HIGH - disconnect switch highly recommended"
|
||||
echo ""
|
||||
echo "You definitely need the disconnect switch!"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
log "Diagnosis complete. Log saved to: $LOG_FILE"
|
||||
}
|
||||
|
||||
checklist() {
|
||||
cat << 'EOF'
|
||||
=== LAB-003 Installation Checklist ===
|
||||
|
||||
BEFORE YOU GO:
|
||||
□ Determine battery terminal type (top post vs side terminal)
|
||||
□ Measure battery group size (look for label like "Group 24F")
|
||||
□ Check if you have 10mm and 13mm wrenches
|
||||
□ Verify multimeter has DC Volts and DC Amps capability
|
||||
|
||||
AT THE STORE:
|
||||
□ Purchase battery disconnect switch (match your terminal type)
|
||||
□ Purchase dielectric grease
|
||||
□ Purchase terminal cleaner brush (if you don't have one)
|
||||
□ Get receipt for documentation
|
||||
|
||||
INSTALLATION:
|
||||
□ Park on level ground, engage parking brake
|
||||
□ Disconnect NEGATIVE (-) terminal first
|
||||
□ Clean terminals with wire brush
|
||||
□ Apply dielectric grease
|
||||
□ Install switch on NEGATIVE terminal
|
||||
□ Reconnect and test operation
|
||||
|
||||
TESTING:
|
||||
□ Switch ON: truck starts normally
|
||||
□ Switch OFF: no power to truck
|
||||
□ Overnight test: switch OFF, verify start next day
|
||||
□ Document with photos
|
||||
□ Upload photos to issue #528
|
||||
|
||||
TROUBLESHOOTING:
|
||||
□ If switch doesn't fit: wrong terminal type - exchange at store
|
||||
□ If still drains overnight: battery needs replacement
|
||||
□ If slow crank with new switch: battery degraded - replace
|
||||
|
||||
EOF
|
||||
}
|
||||
|
||||
verify() {
|
||||
log "=== Post-Installation Verification ==="
|
||||
echo ""
|
||||
echo "Post-installation tests. Run these AFTER installing the disconnect switch."
|
||||
echo ""
|
||||
|
||||
read -p "Test 1 - Can you start the truck with the switch ON? (y/n): " t1
|
||||
if [[ "$t1" == "y" ]]; then
|
||||
log "Test 1 PASSED: Truck starts with switch ON"
|
||||
echo "✓ Test 1 PASSED"
|
||||
else
|
||||
log "Test 1 FAILED: Truck won't start with switch ON"
|
||||
echo "✗ Test 1 FAILED - Check installation and battery"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
read -p "Test 2 - With truck OFF and switch OFF, do interior lights/radio work? (y/n): " t2
|
||||
if [[ "$t2" == "n" ]]; then
|
||||
log "Test 2 PASSED: No power with switch OFF"
|
||||
echo "✓ Test 2 PASSED"
|
||||
else
|
||||
log "Test 2 FAILED: Power still on with switch OFF"
|
||||
echo "✗ Test 2 FAILED - Switch may be on wrong terminal or defective"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
read -p "Test 3 - Is the switch easy to operate by hand (no tools needed)? (y/n): " t3
|
||||
if [[ "$t3" == "y" ]]; then
|
||||
log "Test 3 PASSED: Switch operable without tools"
|
||||
echo "✓ Test 3 PASSED"
|
||||
else
|
||||
log "Test 3 WARNING: Switch may require tools"
|
||||
echo "⚠ Test 3 WARNING - Consider a different switch style"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo "=== 24-Hour Test ==="
|
||||
echo "Park truck with switch OFF. Tomorrow, try to start it."
|
||||
echo "Record result in issue #528: $ISSUE_URL"
|
||||
echo ""
|
||||
|
||||
read -p "Did the 24-hour test pass (truck started normally)? (y/n/skip): " t24
|
||||
case "$t24" in
|
||||
y)
|
||||
log "24-hour test PASSED"
|
||||
echo "✓ Installation SUCCESSFUL!"
|
||||
echo ""
|
||||
echo "Close issue #528 with:"
|
||||
echo " - Photo of installed switch"
|
||||
echo " - Photo of receipt"
|
||||
echo " - Note: '24-hour test passed, truck started normally'"
|
||||
;;
|
||||
n)
|
||||
log "24-hour test FAILED"
|
||||
echo "✗ Test FAILED - Battery likely needs replacement"
|
||||
echo ""
|
||||
echo "Next steps:"
|
||||
echo " 1. Jump start truck"
|
||||
echo " 2. Drive to store for battery replacement"
|
||||
echo " 3. Reference LAB-003-battery-disconnect-install.md for battery shopping guide"
|
||||
;;
|
||||
*)
|
||||
log "24-hour test pending"
|
||||
echo "Run this script again after 24 hours with: bash $0 verify"
|
||||
;;
|
||||
esac
|
||||
|
||||
echo ""
|
||||
log "Verification complete. Log saved to: $LOG_FILE"
|
||||
}
|
||||
|
||||
case "${1:-help}" in
|
||||
diagnose)
|
||||
diagnose
|
||||
;;
|
||||
checklist)
|
||||
checklist
|
||||
;;
|
||||
verify)
|
||||
verify
|
||||
;;
|
||||
*)
|
||||
echo "Usage: $0 {diagnose|checklist|verify}"
|
||||
echo ""
|
||||
echo " diagnose - Check battery voltage and parasitic drain"
|
||||
echo " checklist - Print installation checklist"
|
||||
echo " verify - Post-installation verification tests"
|
||||
echo ""
|
||||
echo "Full guide: docs/LAB-003-battery-disconnect-install.md"
|
||||
echo "Issue: $ISSUE_URL"
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
67
tests/test_timmy_academy_genome.py
Normal file
67
tests/test_timmy_academy_genome.py
Normal file
@@ -0,0 +1,67 @@
|
||||
"""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