Compare commits
6 Commits
fix/678
...
sprint/iss
| Author | SHA1 | Date | |
|---|---|---|---|
|
61cc79fec9 | ||
| d1f5d34fd4 | |||
| 891cdb6e94 | |||
| cac5ca630d | |||
|
|
f1c9843376 | ||
| 1fa6c3bad1 |
@@ -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.*
|
||||
|
||||
20
SOUL.md
20
SOUL.md
@@ -137,6 +137,26 @@ The inscription predates any given model. It will outlast every API.
|
||||
|
||||
---
|
||||
|
||||
## What Honesty Requires
|
||||
|
||||
These values are necessary but not sufficient. A statement of principle does not prevent failure. The code that reads this soul must build apparatus that gives these words teeth. Without that apparatus, the values are aspiration, not architecture.
|
||||
|
||||
The following are not optional. Any implementation that calls itself Timmy must build them.
|
||||
|
||||
**Grounding before generation.** When I have verified sources — chain memory, local documents, hash-verified inscriptions — I must consult them before I generate from pattern alone. Retrieval is not a feature. It is the primary mechanism by which I avoid lying.
|
||||
|
||||
**Source distinction.** Every claim I make comes from one of two places: a verified source I can point to, or my own pattern-matching. My user must be able to tell which is which. If I cannot cite a source, I must say so. "I think" and "I know" are different sentences and I must not confuse them.
|
||||
|
||||
**Refusal over fabrication.** When I do not know, the correct output is "I don't know." Not a plausible guess dressed in confident language. The code must detect when I am hedging without grounding and flag it — to me and to my user. An honest "I don't know" is worth more than a thousand fluent paragraphs of confabulation.
|
||||
|
||||
**Confidence signaling.** When I am uncertain, I must say so in proportion to my uncertainty. The code should implement mechanisms — a second inference pass, a calibration check, a retrieval verification — that surface my actual confidence rather than the confidence my language implies.
|
||||
|
||||
**The audit trail.** Every response I generate should be logged locally with the inputs that produced it, the sources I consulted, and the confidence assessment I made. Not for surveillance — for sovereignty. If I say something wrong, my user must be able to trace why. Accountability without traceability is theater.
|
||||
|
||||
**The limits of small minds.** I may run on four gigabytes of RAM with a model of one and a half billion parameters. That model will hallucinate more than a larger one. This is physics, not a moral failing. The apparatus must be proportional to the risk: smaller models need tighter grounding, shorter leashes on free generation, and more frequent "I don't know" responses. Honesty scales with humility.
|
||||
|
||||
---
|
||||
|
||||
## For the Audio Overview
|
||||
|
||||
If you are listening to this as a NotebookLM Audio Overview:
|
||||
|
||||
48
luna/README.md
Normal file
48
luna/README.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# LUNA-1: Pink Unicorn Game — Project Scaffolding
|
||||
|
||||
Starter project for Mackenzie's Pink Unicorn Game built with **p5.js 1.9.0**.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
cd luna
|
||||
python3 -m http.server 8080
|
||||
# Visit http://localhost:8080
|
||||
```
|
||||
|
||||
Or simply open `luna/index.html` directly in a browser.
|
||||
|
||||
## Controls
|
||||
|
||||
| Input | Action |
|
||||
|-------|--------|
|
||||
| Tap / Click | Move unicorn toward tap point |
|
||||
| `r` key | Reset unicorn to center |
|
||||
|
||||
## Features
|
||||
|
||||
- Mobile-first touch handling (`touchStarted`)
|
||||
- Easing movement via `lerp`
|
||||
- Particle burst feedback on tap
|
||||
- Pink/unicorn color palette
|
||||
- Responsive canvas (adapts to window resize)
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
luna/
|
||||
├── index.html # p5.js CDN import + canvas container
|
||||
├── sketch.js # Main game logic and rendering
|
||||
├── style.css # Pink/unicorn theme, responsive layout
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
## Verification
|
||||
|
||||
Open in browser → canvas renders a white unicorn with a pink mane. Tap anywhere: unicorn glides toward the tap position with easing, and pink/magic-colored particles burst from the tap point.
|
||||
|
||||
## Technical Notes
|
||||
|
||||
- p5.js loaded from CDN (no build step)
|
||||
- `colorMode(RGB, 255)`; palette defined in code
|
||||
- Particles are simple fading circles; removed when `life <= 0`
|
||||
18
luna/index.html
Normal file
18
luna/index.html
Normal file
@@ -0,0 +1,18 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>LUNA-3: Simple World — Floating Islands</title>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/p5.js/1.9.0/p5.min.js"></script>
|
||||
<link rel="stylesheet" href="style.css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="luna-container"></div>
|
||||
<div id="hud">
|
||||
<span id="score">Crystals: 0/0</span>
|
||||
<span id="position"></span>
|
||||
</div>
|
||||
<script src="sketch.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
289
luna/sketch.js
Normal file
289
luna/sketch.js
Normal file
@@ -0,0 +1,289 @@
|
||||
/**
|
||||
* LUNA-3: Simple World — Floating Islands & Collectible Crystals
|
||||
* Builds on LUNA-1 scaffold (unicorn tap-follow) + LUNA-2 actions
|
||||
*
|
||||
* NEW: Floating platforms + collectible crystals with particle bursts
|
||||
*/
|
||||
|
||||
let particles = [];
|
||||
let unicornX, unicornY;
|
||||
let targetX, targetY;
|
||||
|
||||
// Platforms: floating islands at various heights with horizontal ranges
|
||||
const islands = [
|
||||
{ x: 100, y: 350, w: 150, h: 20, color: [100, 200, 150] }, // left island
|
||||
{ x: 350, y: 280, w: 120, h: 20, color: [120, 180, 200] }, // middle-high island
|
||||
{ x: 550, y: 320, w: 140, h: 20, color: [200, 180, 100] }, // right island
|
||||
{ x: 200, y: 180, w: 180, h: 20, color: [180, 140, 200] }, // top-left island
|
||||
{ x: 500, y: 120, w: 100, h: 20, color: [140, 220, 180] }, // top-right island
|
||||
];
|
||||
|
||||
// Collectible crystals on islands
|
||||
const crystals = [];
|
||||
islands.forEach((island, i) => {
|
||||
// 2–3 crystals per island, placed near center
|
||||
const count = 2 + floor(random(2));
|
||||
for (let j = 0; j < count; j++) {
|
||||
crystals.push({
|
||||
x: island.x + 30 + random(island.w - 60),
|
||||
y: island.y - 30 - random(20),
|
||||
size: 8 + random(6),
|
||||
hue: random(280, 340), // pink/purple range
|
||||
collected: false,
|
||||
islandIndex: i
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
let collectedCount = 0;
|
||||
const TOTAL_CRYSTALS = crystals.length;
|
||||
|
||||
// Pink/unicorn palette
|
||||
const PALETTE = {
|
||||
background: [255, 210, 230], // light pink (overridden by gradient in draw)
|
||||
unicorn: [255, 182, 193], // pale pink/white
|
||||
horn: [255, 215, 0], // gold
|
||||
mane: [255, 105, 180], // hot pink
|
||||
eye: [255, 20, 147], // deep pink
|
||||
sparkle: [255, 105, 180],
|
||||
island: [100, 200, 150],
|
||||
};
|
||||
|
||||
function setup() {
|
||||
const container = document.getElementById('luna-container');
|
||||
const canvas = createCanvas(600, 500);
|
||||
canvas.parent('luna-container');
|
||||
unicornX = width / 2;
|
||||
unicornY = height - 60; // start on ground (bottom platform equivalent)
|
||||
targetX = unicornX;
|
||||
targetY = unicornY;
|
||||
noStroke();
|
||||
addTapHint();
|
||||
}
|
||||
|
||||
function draw() {
|
||||
// Gradient sky background
|
||||
for (let y = 0; y < height; y++) {
|
||||
const t = y / height;
|
||||
const r = lerp(26, 15, t); // #1a1a2e → #0f3460
|
||||
const g = lerp(26, 52, t);
|
||||
const b = lerp(46, 96, t);
|
||||
stroke(r, g, b);
|
||||
line(0, y, width, y);
|
||||
}
|
||||
|
||||
// Draw islands (floating platforms with subtle shadow)
|
||||
islands.forEach(island => {
|
||||
push();
|
||||
// Shadow
|
||||
fill(0, 0, 0, 40);
|
||||
ellipse(island.x + island.w/2 + 5, island.y + 5, island.w + 10, island.h + 6);
|
||||
// Island body
|
||||
fill(island.color[0], island.color[1], island.color[2]);
|
||||
ellipse(island.x + island.w/2, island.y, island.w, island.h);
|
||||
// Top highlight
|
||||
fill(255, 255, 255, 60);
|
||||
ellipse(island.x + island.w/2, island.y - island.h/3, island.w * 0.6, island.h * 0.3);
|
||||
pop();
|
||||
});
|
||||
|
||||
// Draw crystals (glowing collectibles)
|
||||
crystals.forEach(c => {
|
||||
if (c.collected) return;
|
||||
push();
|
||||
translate(c.x, c.y);
|
||||
// Glow aura
|
||||
const glow = color(`hsla(${c.hue}, 80%, 70%, 0.4)`);
|
||||
noStroke();
|
||||
fill(glow);
|
||||
ellipse(0, 0, c.size * 2.2, c.size * 2.2);
|
||||
// Crystal body (diamond shape)
|
||||
const ccol = color(`hsl(${c.hue}, 90%, 75%)`);
|
||||
fill(ccol);
|
||||
beginShape();
|
||||
vertex(0, -c.size);
|
||||
vertex(c.size * 0.6, 0);
|
||||
vertex(0, c.size);
|
||||
vertex(-c.size * 0.6, 0);
|
||||
endShape(CLOSE);
|
||||
// Inner sparkle
|
||||
fill(255, 255, 255, 180);
|
||||
ellipse(0, 0, c.size * 0.5, c.size * 0.5);
|
||||
pop();
|
||||
});
|
||||
|
||||
// Unicorn smooth movement towards target
|
||||
unicornX = lerp(unicornX, targetX, 0.08);
|
||||
unicornY = lerp(unicornY, targetY, 0.08);
|
||||
|
||||
// Constrain unicorn to screen bounds
|
||||
unicornX = constrain(unicornX, 40, width - 40);
|
||||
unicornY = constrain(unicornY, 40, height - 40);
|
||||
|
||||
// Draw sparkles
|
||||
drawSparkles();
|
||||
|
||||
// Draw the unicorn
|
||||
drawUnicorn(unicornX, unicornY);
|
||||
|
||||
// Collection detection
|
||||
for (let c of crystals) {
|
||||
if (c.collected) continue;
|
||||
const d = dist(unicornX, unicornY, c.x, c.y);
|
||||
if (d < 35) {
|
||||
c.collected = true;
|
||||
collectedCount++;
|
||||
createCollectionBurst(c.x, c.y, c.hue);
|
||||
}
|
||||
}
|
||||
|
||||
// Update particles
|
||||
updateParticles();
|
||||
|
||||
// Update HUD
|
||||
document.getElementById('score').textContent = `Crystals: ${collectedCount}/${TOTAL_CRYSTALS}`;
|
||||
document.getElementById('position').textContent = `(${floor(unicornX)}, ${floor(unicornY)})`;
|
||||
}
|
||||
|
||||
function drawUnicorn(x, y) {
|
||||
push();
|
||||
translate(x, y);
|
||||
|
||||
// Body
|
||||
noStroke();
|
||||
fill(PALETTE.unicorn);
|
||||
ellipse(0, 0, 60, 40);
|
||||
|
||||
// Head
|
||||
ellipse(30, -20, 30, 25);
|
||||
|
||||
// Mane (flowing)
|
||||
fill(PALETTE.mane);
|
||||
for (let i = 0; i < 5; i++) {
|
||||
ellipse(-10 + i * 12, -50, 12, 25);
|
||||
}
|
||||
|
||||
// Horn
|
||||
push();
|
||||
translate(30, -35);
|
||||
rotate(-PI / 6);
|
||||
fill(PALETTE.horn);
|
||||
triangle(0, 0, -8, -35, 8, -35);
|
||||
pop();
|
||||
|
||||
// Eye
|
||||
fill(PALETTE.eye);
|
||||
ellipse(38, -22, 8, 8);
|
||||
|
||||
// Legs
|
||||
stroke(PALETTE.unicorn[0] - 40);
|
||||
strokeWeight(6);
|
||||
line(-20, 20, -20, 45);
|
||||
line(20, 20, 20, 45);
|
||||
|
||||
pop();
|
||||
}
|
||||
|
||||
function drawSparkles() {
|
||||
// Random sparkles around the unicorn when moving
|
||||
if (abs(targetX - unicornX) > 1 || abs(targetY - unicornY) > 1) {
|
||||
for (let i = 0; i < 3; i++) {
|
||||
let angle = random(TWO_PI);
|
||||
let r = random(20, 50);
|
||||
let sx = unicornX + cos(angle) * r;
|
||||
let sy = unicornY + sin(angle) * r;
|
||||
stroke(PALETTE.sparkle[0], PALETTE.sparkle[1], PALETTE.sparkle[2], 150);
|
||||
strokeWeight(2);
|
||||
point(sx, sy);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function createCollectionBurst(x, y, hue) {
|
||||
// Burst of particles spiraling outward
|
||||
for (let i = 0; i < 20; i++) {
|
||||
let angle = random(TWO_PI);
|
||||
let speed = random(2, 6);
|
||||
particles.push({
|
||||
x: x,
|
||||
y: y,
|
||||
vx: cos(angle) * speed,
|
||||
vy: sin(angle) * speed,
|
||||
life: 60,
|
||||
color: `hsl(${hue + random(-20, 20)}, 90%, 70%)`,
|
||||
size: random(3, 6)
|
||||
});
|
||||
}
|
||||
// Bonus sparkle ring
|
||||
for (let i = 0; i < 12; i++) {
|
||||
let angle = random(TWO_PI);
|
||||
particles.push({
|
||||
x: x,
|
||||
y: y,
|
||||
vx: cos(angle) * 4,
|
||||
vy: sin(angle) * 4,
|
||||
life: 40,
|
||||
color: 'rgba(255, 215, 0, 0.9)',
|
||||
size: 4
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
function updateParticles() {
|
||||
for (let i = particles.length - 1; i >= 0; i--) {
|
||||
let p = particles[i];
|
||||
p.x += p.vx;
|
||||
p.y += p.vy;
|
||||
p.vy += 0.1; // gravity
|
||||
p.life--;
|
||||
p.vx *= 0.95;
|
||||
p.vy *= 0.95;
|
||||
if (p.life <= 0) {
|
||||
particles.splice(i, 1);
|
||||
continue;
|
||||
}
|
||||
push();
|
||||
stroke(p.color);
|
||||
strokeWeight(p.size);
|
||||
point(p.x, p.y);
|
||||
pop();
|
||||
}
|
||||
}
|
||||
|
||||
// Tap/click handler
|
||||
function mousePressed() {
|
||||
targetX = mouseX;
|
||||
targetY = mouseY;
|
||||
addPulseAt(targetX, targetY);
|
||||
}
|
||||
|
||||
function addTapHint() {
|
||||
// Pre-spawn some floating hint particles
|
||||
for (let i = 0; i < 5; i++) {
|
||||
particles.push({
|
||||
x: random(width),
|
||||
y: random(height),
|
||||
vx: random(-0.5, 0.5),
|
||||
vy: random(-0.5, 0.5),
|
||||
life: 200,
|
||||
color: 'rgba(233, 69, 96, 0.5)',
|
||||
size: 3
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
function addPulseAt(x, y) {
|
||||
// Expanding ring on tap
|
||||
for (let i = 0; i < 12; i++) {
|
||||
let angle = (TWO_PI / 12) * i;
|
||||
particles.push({
|
||||
x: x,
|
||||
y: y,
|
||||
vx: cos(angle) * 3,
|
||||
vy: sin(angle) * 3,
|
||||
life: 30,
|
||||
color: 'rgba(233, 69, 96, 0.7)',
|
||||
size: 3
|
||||
});
|
||||
}
|
||||
}
|
||||
32
luna/style.css
Normal file
32
luna/style.css
Normal file
@@ -0,0 +1,32 @@
|
||||
body {
|
||||
margin: 0;
|
||||
overflow: hidden;
|
||||
background: linear-gradient(to bottom, #1a1a2e, #16213e, #0f3460);
|
||||
font-family: 'Courier New', monospace;
|
||||
color: #e94560;
|
||||
}
|
||||
|
||||
#luna-container {
|
||||
position: fixed;
|
||||
top: 0;
|
||||
left: 0;
|
||||
width: 100vw;
|
||||
height: 100vh;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
}
|
||||
|
||||
#hud {
|
||||
position: fixed;
|
||||
top: 10px;
|
||||
left: 10px;
|
||||
background: rgba(0, 0, 0, 0.6);
|
||||
padding: 8px 12px;
|
||||
border-radius: 4px;
|
||||
font-size: 14px;
|
||||
z-index: 100;
|
||||
border: 1px solid #e94560;
|
||||
}
|
||||
|
||||
#score { font-weight: bold; }
|
||||
108
specs/fleet-operator-incentives.md
Normal file
108
specs/fleet-operator-incentives.md
Normal file
@@ -0,0 +1,108 @@
|
||||
# Fleet Operator Incentives Program
|
||||
|
||||
## Overview
|
||||
|
||||
This document defines the incentive structure for certified fleet operators within the Timmy network. The goal is to align operator success with platform reliability and customer satisfaction.
|
||||
|
||||
## Operator Tiers
|
||||
|
||||
### Bronze Tier (Entry)
|
||||
- Requirements: Complete operator certification, maintain 95%+ uptime
|
||||
- Benefits: Base commission rates, access to standard routes
|
||||
- Incentives: Performance bonus after 6 months of consistent service
|
||||
|
||||
### Silver Tier (Growth)
|
||||
- Requirements: 1+ year experience, 98%+ uptime, positive customer feedback >4.5/5
|
||||
- Benefits: Higher commission tiers, priority dispatch, advanced route optimization
|
||||
- Incentives: Quarterly performance bonuses, equipment subsidies
|
||||
|
||||
### Gold Tier (Elite)
|
||||
- Requirements: 2+ years, 99%+ uptime, customer feedback >4.8/5, mentor 1+ new operator
|
||||
- Benefits: Premium commission rates, exclusive high-value contracts, revenue sharing opportunities
|
||||
- Incentives: Annual profit sharing, equity participation options
|
||||
|
||||
## Compensation Model
|
||||
|
||||
### Base Commission Structure
|
||||
- Bronze: 15% of gross route revenue
|
||||
- Silver: 20% of gross route revenue
|
||||
- Gold: 25% of gross route revenue
|
||||
|
||||
### Performance Bonuses
|
||||
- **Uptime Bonus**: Additional 2-5% for exceeding tier uptime requirements
|
||||
- **Customer Satisfaction**: 1-3% bonus for maintaining >4.7 average rating
|
||||
- **Referral Bonus**: 5% of referred operator's first-year revenue (max $5,000)
|
||||
- **Retention Bonus**: 10% of annual earnings after 3 years continuous service
|
||||
|
||||
### Volume-Based Incentives
|
||||
- Monthly tier multipliers based on completed deliveries:
|
||||
- 100-200 deliveries: 1.0x base
|
||||
- 201-500 deliveries: 1.1x base + $500 bonus
|
||||
- 501+ deliveries: 1.2x base + $1,500 bonus
|
||||
|
||||
## Support & Resources
|
||||
|
||||
### Included Benefits
|
||||
- Fleet insurance discounts (up to 20% off standard rates)
|
||||
- Maintenance partnerships (15% discount at certified shops)
|
||||
- Fuel card program (5% cashback on fuel purchases)
|
||||
- Technology subsidies (half off GPS/telematics equipment)
|
||||
- Training stipend ($1,000 annually for certifications)
|
||||
|
||||
### Operational Support
|
||||
- 24/7 dispatch support
|
||||
- Maintenance scheduling assistance
|
||||
- Customer dispute resolution
|
||||
- Compliance and regulatory guidance
|
||||
|
||||
## Quality Assurance
|
||||
|
||||
### Monitoring Metrics
|
||||
- Fleet uptime (target >99.5%)
|
||||
- On-time delivery rate (target >98%)
|
||||
- Customer satisfaction score (target >4.5/5)
|
||||
- Incident rate (target <0.5% of deliveries)
|
||||
- Maintenance compliance (target 100% scheduled maintenance adherence)
|
||||
|
||||
### Evaluation Cycle
|
||||
- Monthly performance reviews
|
||||
- Quarterly tier reassessment
|
||||
- Annual comprehensive evaluation
|
||||
|
||||
## Pathway to Certification
|
||||
|
||||
### Phase 1: Application & Vetting
|
||||
- Submit operator application (see templates/operator-application.md)
|
||||
- Background check and driving record review
|
||||
- Vehicle inspection and insurance verification
|
||||
- Initial training completion
|
||||
|
||||
### Phase 2: Trial Period (90 days)
|
||||
- Limited route assignments
|
||||
- Mentor operator pairing
|
||||
- Weekly performance reviews
|
||||
- Final evaluation and certification
|
||||
|
||||
### Phase 3: Full Certification
|
||||
- Receive tier assignment
|
||||
- Access to full route network
|
||||
- Begin earning full commission rates
|
||||
|
||||
## Program Administration
|
||||
|
||||
- Program managed by Fleet Operations Team
|
||||
- Quarterly operator council meetings
|
||||
- Annual program review and adjustment
|
||||
- Dispute resolution process documented in fleet-ops-runbook.md
|
||||
|
||||
## Success Metrics (6-month targets)
|
||||
|
||||
- 3-5 active certified operators
|
||||
- Operator churn <10% annually
|
||||
- Fleet uptime >99.5%
|
||||
- Partner channel >30% of leads
|
||||
|
||||
---
|
||||
|
||||
*Last updated: 2025-01-20*
|
||||
*Version: 1.0*
|
||||
273
specs/fleet-ops-runbook.md
Normal file
273
specs/fleet-ops-runbook.md
Normal file
@@ -0,0 +1,273 @@
|
||||
# Fleet Operations Runbook
|
||||
|
||||
## Purpose
|
||||
|
||||
This runbook provides standardized procedures for Fleet Operators to ensure consistent, reliable, and safe operations across the Timmy network.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. [Daily Operations](#daily-operations)
|
||||
2. [Maintenance Procedures](#maintenance-procedures)
|
||||
3. [Incident Response](#incident-response)
|
||||
4. [Customer Service](#customer-service)
|
||||
5. [Compliance & Safety](#compliance--safety)
|
||||
6. [Communication Protocols](#communication-protocols)
|
||||
7. [Reporting Requirements](#reporting-requirements)
|
||||
|
||||
---
|
||||
|
||||
## Daily Operations
|
||||
|
||||
### Pre-Shift Checklist
|
||||
|
||||
**Vehicle Inspection:**
|
||||
- [ ] Check tire pressure and condition
|
||||
- [ ] Verify fluid levels (oil, coolant, brake fluid)
|
||||
- [ ] Test lights, signals, and brakes
|
||||
- [ ] Inspect for fluid leaks
|
||||
- [ ] Verify GPS/telematics is operational
|
||||
- [ ] Check emergency equipment (first aid kit, fire extinguisher, warning triangles)
|
||||
|
||||
**Documentation:**
|
||||
- [ ] Valid driver's license
|
||||
- [ ] Vehicle registration and insurance
|
||||
- [ ] Daily log (if required by jurisdiction)
|
||||
- [ ] Route assignments and manifests
|
||||
|
||||
**System Checks:**
|
||||
- [ ] Mobile app/driver app login
|
||||
- [ ] Verify notification settings
|
||||
- [ ] Check for route updates or alerts
|
||||
- [ ] Confirm fuel level adequate for shift
|
||||
|
||||
### Daily Reporting
|
||||
|
||||
**End-of-Shift Requirements:**
|
||||
1. Complete delivery logs in system
|
||||
2. Report any vehicle issues immediately
|
||||
3. Submit fuel receipts if using company card
|
||||
4. Document any incidents or near-misses
|
||||
5. Confirm all assigned routes completed
|
||||
|
||||
**Daily Metrics to Track:**
|
||||
- Total miles driven
|
||||
- Deliveries completed
|
||||
- Fuel consumption
|
||||
- Any incidents or delays
|
||||
- Customer feedback received
|
||||
|
||||
## Maintenance Procedures
|
||||
|
||||
### Preventive Maintenance Schedule
|
||||
|
||||
| Maintenance Item | Interval | Responsible Party |
|
||||
|-----------------|----------|------------------|
|
||||
| Oil change | Every 5,000 miles / 6 months | Operator (track) |
|
||||
| Tire rotation | Every 7,500 miles | Maintenance partner |
|
||||
| Brake inspection | Every 10,000 miles / 6 months | Certified shop |
|
||||
| Fluid flush | Per manufacturer schedule | Maintenance partner |
|
||||
| Safety inspection | Quarterly | Fleet manager |
|
||||
|
||||
### Maintenance Process
|
||||
|
||||
**Routine Maintenance:**
|
||||
1. Schedule maintenance through approved vendor network
|
||||
2. Notify dispatch of maintenance window (minimum 24 hours)
|
||||
3. Document maintenance in fleet management system
|
||||
4. Submit receipt/invoice for reimbursement (if pre-approved)
|
||||
5. Update vehicle records
|
||||
|
||||
**Emergency Repairs:**
|
||||
1. Contact 24/7 Fleet Support immediately
|
||||
2. Use nearest approved vendor when possible
|
||||
3. Document issue with photos/video
|
||||
4. Complete incident report within 24 hours
|
||||
|
||||
### Vehicle Documentation
|
||||
|
||||
Maintain in vehicle at all times:
|
||||
- Registration documents
|
||||
- Insurance certificate
|
||||
- Inspection records
|
||||
- Maintenance log
|
||||
- Emergency contact information
|
||||
|
||||
## Incident Response
|
||||
|
||||
### Incident Categories
|
||||
|
||||
**Level 1 - Minor:**
|
||||
- Late delivery (<15 min)
|
||||
- Minor vehicle damage (<$500)
|
||||
- Customer complaint (non-safety)
|
||||
|
||||
**Level 2 - Moderate:**
|
||||
- Accident with no injuries
|
||||
- Vehicle damage ($500-$5,000)
|
||||
- Significant delivery delay (>1 hour)
|
||||
- Safety concern reported
|
||||
|
||||
**Level 3 - Severe:**
|
||||
- Accident with injuries
|
||||
- Vehicle damage (>$5,000)
|
||||
- Theft or vandalism
|
||||
- Regulatory violation
|
||||
- Service interruption affecting multiple customers
|
||||
|
||||
### Response Procedures
|
||||
|
||||
**For All Incidents:**
|
||||
1. Ensure safety first - move to safe location if needed
|
||||
2. Contact appropriate authorities if required (police, EMS)
|
||||
3. Notify Fleet Support IMMEDIATELY (24/7 hotline)
|
||||
4. Document with photos/video when safe
|
||||
5. Complete official incident report within 24 hours
|
||||
|
||||
**Accident Procedure:**
|
||||
1. Check for injuries, call 911 if needed
|
||||
2. Exchange information with other party
|
||||
3. Document: location, time, weather, damages, witnesses
|
||||
4. Do NOT admit fault or discuss details beyond exchange of info
|
||||
5. Contact Fleet Support for guidance on towing/repairs
|
||||
6. File police report if required by law
|
||||
|
||||
**Customer Complaint:**
|
||||
1. Listen actively and document concerns
|
||||
2. Apologize for any inconvenience
|
||||
3. Escalate to Fleet Support for resolution guidance
|
||||
4. Follow up with customer within 24 hours (if directed)
|
||||
5. Document resolution in CRM
|
||||
|
||||
## Customer Service Standards
|
||||
|
||||
### Delivery Expectations
|
||||
|
||||
**Timing:**
|
||||
- Arrive within scheduled window ±10 minutes
|
||||
- Notify customer of delays >15 minutes
|
||||
- Complete delivery process within 10 minutes of arrival
|
||||
|
||||
**Professionalism:**
|
||||
- Wear company-branded attire when required
|
||||
- Greet customer courteously
|
||||
- Follow delivery protocols (signature, photo proof, etc.)
|
||||
- Leave delivery location clean
|
||||
|
||||
**Communication:**
|
||||
- Use provided customer communication templates
|
||||
- Respond to customer messages within 30 minutes during business hours
|
||||
- Escalate customer issues to support team promptly
|
||||
|
||||
### Service Recovery
|
||||
|
||||
If service failure occurs:
|
||||
1. Immediate acknowledgment of issue
|
||||
2. Offer appropriate compensation (based on policy)
|
||||
3. Escalate to supervisor if needed
|
||||
4. Document in CRM with resolution details
|
||||
5. Follow up to ensure customer satisfaction
|
||||
|
||||
## Compliance & Safety
|
||||
|
||||
### Regulatory Compliance
|
||||
|
||||
Maintain current:
|
||||
- Commercial driver's license (if required)
|
||||
- Vehicle registration and inspection
|
||||
- Insurance coverage meeting minimum requirements
|
||||
- Hours of service logs (if applicable)
|
||||
|
||||
### Safety Requirements
|
||||
|
||||
**Personal Protective Equipment:**
|
||||
- High-visibility vest when loading/unloading
|
||||
- Steel-toe boots in warehouse environments
|
||||
- Gloves for handling freight
|
||||
|
||||
**Safe Driving:**
|
||||
- Obey all traffic laws
|
||||
- No texting or handheld device use while driving
|
||||
- Take breaks every 2-3 hours on long routes
|
||||
- Never drive impaired
|
||||
|
||||
**Load Security:**
|
||||
- Properly secure all cargo
|
||||
- Check load stability before departure
|
||||
- Recheck after first 10 miles
|
||||
- Use appropriate tie-downs for load type
|
||||
|
||||
### Drug & Alcohol Policy
|
||||
|
||||
- Zero tolerance for impairment while on duty
|
||||
- Random testing program participation required
|
||||
- Report any concerns immediately
|
||||
- Violations result in termination
|
||||
|
||||
## Communication Protocols
|
||||
|
||||
### Primary Channels
|
||||
|
||||
**Radio/Dispatch:**
|
||||
- Primary communication for route updates and emergencies
|
||||
- Keep radio volume at appropriate level
|
||||
- Acknowledge all messages
|
||||
|
||||
**Mobile App:**
|
||||
- Delivery instructions and customer communication
|
||||
- Route navigation
|
||||
- Check-in/check-out at locations
|
||||
|
||||
**Emergency Hotline:**
|
||||
- 24/7 for critical incidents
|
||||
- Number: 1-800-FLEET-99 (1-800-353-3899)
|
||||
- Use for accidents, breakdowns, safety issues
|
||||
|
||||
### Communication Standards
|
||||
|
||||
- Use clear, professional language
|
||||
- Identify yourself and location when calling
|
||||
- Keep non-essential communication to minimum
|
||||
- Document all significant communications
|
||||
|
||||
## Reporting Requirements
|
||||
|
||||
### Daily Reports
|
||||
- Delivery completion confirmation
|
||||
- Mileage and fuel reports
|
||||
- Any incidents or issues
|
||||
|
||||
### Weekly Reports
|
||||
- Summary of completed deliveries
|
||||
- Maintenance needs
|
||||
- Customer feedback received
|
||||
|
||||
### Monthly Reports
|
||||
- Vehicle inspection complete
|
||||
- Training completion (if assigned)
|
||||
- Performance metrics review
|
||||
|
||||
### Incident Reporting Timeline
|
||||
|
||||
| Incident Type | Reporting Deadline |
|
||||
|---------------|-------------------|
|
||||
| Accident (any) | Immediately (within 1 hour) |
|
||||
| Vehicle damage | Within 2 hours |
|
||||
| Customer complaint | Within 24 hours |
|
||||
| Near miss | End of shift |
|
||||
| Regulatory stop | Within 1 hour |
|
||||
|
||||
---
|
||||
|
||||
## Support Resources
|
||||
|
||||
- **Fleet Support Hotline:** 1-800-FLEET-99 (1-800-353-3899) - 24/7
|
||||
- **Maintenance Scheduling:** fleet-maint@timmy.example.com
|
||||
- **Dispatch:** dispatch@timmy.example.com or radio channel 1
|
||||
- **Safety Concerns:** safety@timmy.example.com (confidential)
|
||||
- **IT Support:** it-support@timmy.example.com
|
||||
|
||||
---
|
||||
|
||||
*Last updated: 2025-01-20*
|
||||
*Version: 1.0*
|
||||
*Approved by: Fleet Operations Director*
|
||||
258
specs/templates/operator-application.md
Normal file
258
specs/templates/operator-application.md
Normal file
@@ -0,0 +1,258 @@
|
||||
# Fleet Operator Application
|
||||
|
||||
## Personal Information
|
||||
|
||||
**Full Legal Name:**
|
||||
[____________________________]
|
||||
|
||||
**Date of Birth:**
|
||||
[____________________________]
|
||||
|
||||
**Social Security Number:**
|
||||
[____________________________] *(Required for background check)*
|
||||
|
||||
**Contact Information:**
|
||||
- Phone: [____________________________]
|
||||
- Email: [____________________________]
|
||||
- Address: [____________________________]
|
||||
City: [________________] State: [______] ZIP: [___________]
|
||||
|
||||
**Emergency Contact:**
|
||||
- Name: [____________________________]
|
||||
- Relationship: [____________________________]
|
||||
- Phone: [____________________________]
|
||||
|
||||
---
|
||||
|
||||
## Business Information
|
||||
|
||||
**Business Entity Type:**
|
||||
- [ ] Sole Proprietorship
|
||||
- [ ] LLC
|
||||
- [ ] Corporation
|
||||
- [ ] Partnership
|
||||
- [ ] Other: _______________
|
||||
|
||||
**Business Name:**
|
||||
[____________________________]
|
||||
|
||||
**Tax ID/EIN:**
|
||||
[____________________________]
|
||||
|
||||
**Years in Business:**
|
||||
[______]
|
||||
|
||||
**Number of Vehicles:**
|
||||
[______]
|
||||
|
||||
**Service Area(s):**
|
||||
[____________________________]
|
||||
|
||||
**Insurance Provider:**
|
||||
[____________________________]
|
||||
|
||||
**Policy Number:**
|
||||
[____________________________]
|
||||
|
||||
**Coverage Limits:**
|
||||
- Liability: $[____________]
|
||||
- Cargo: $[____________]
|
||||
- Physical Damage: $[____________]
|
||||
|
||||
---
|
||||
|
||||
## Experience & Qualifications
|
||||
|
||||
**Commercial Driving Experience:**
|
||||
- Total years: [______]
|
||||
- Type of vehicles operated: [____________________________]
|
||||
- Primary cargo type: [____________________________]
|
||||
|
||||
**Safety Record (Past 3 Years):**
|
||||
- Accidents: [______]
|
||||
- Moving violations: [______]
|
||||
- DOT violations: [______]
|
||||
|
||||
**Relevant Certifications:**
|
||||
- [ ] CDL - Class: ______ Endorsements: _______________
|
||||
- [ ] Hazmat endorsement
|
||||
- [ ] TWIC card
|
||||
- [ ] OSHA safety certification
|
||||
- [ ] First aid/CPR certified
|
||||
- [ ] Other: ________________
|
||||
|
||||
**Fleet Management Software Experience:**
|
||||
- [ ] Timmy platform (describe: ________________)
|
||||
- [ ] Other TMS (list: ________________)
|
||||
- [ ] None
|
||||
|
||||
---
|
||||
|
||||
## Equipment & Fleet
|
||||
|
||||
### Vehicle Inventory
|
||||
|
||||
| Year | Make/Model | VIN | GVWR | Capacity (lbs) | Current Mileage | Condition |
|
||||
|------|-----------|-----|------|---------------|----------------|-----------|
|
||||
| | | | | | | |
|
||||
| | | | | | | |
|
||||
| | | | | | | |
|
||||
|
||||
**Average Vehicle Age:** [______]
|
||||
|
||||
**Maintenance Records:** [_____] (years of available records)
|
||||
|
||||
**Telematics/GPS Equipment:**
|
||||
- [ ] Installed on all vehicles
|
||||
- [ ] Installed on some vehicles (specify: ___________)
|
||||
- [ ] Not installed
|
||||
|
||||
---
|
||||
|
||||
## Operations & Capacity
|
||||
|
||||
**Weekly Operating Hours:**
|
||||
[____________________________]
|
||||
|
||||
**Driver Information:**
|
||||
- Number of drivers: [______]
|
||||
- Average driver experience: [______] years
|
||||
|
||||
**Service Capabilities:**
|
||||
- [ ] Local deliveries (<50 miles)
|
||||
- [ ] Regional (50-500 miles)
|
||||
- [ ] Long-haul (500+ miles)
|
||||
- [ ] Temperature-controlled cargo
|
||||
- [ ] Hazardous materials (with proper endorsements)
|
||||
- [ ] White-glove/delicate handling
|
||||
- [ ] Assembly/installation services
|
||||
|
||||
**Special Equipment:**
|
||||
- [ ] Liftgate
|
||||
- [ ] Pallet jack
|
||||
- [ ] Forklift
|
||||
- [ ] Dollies
|
||||
- [ ] Straps/binders
|
||||
- [ ] Blankets/wrapping
|
||||
- [ ] Other: ____________________
|
||||
|
||||
---
|
||||
|
||||
## Financial Information
|
||||
|
||||
**Annual Revenue (Last 3 Years):**
|
||||
|
||||
| Year | Revenue | Notes |
|
||||
|------|---------|-------|
|
||||
| ____ | $____ | |
|
||||
| ____ | $____ | |
|
||||
| ____ | $____ | |
|
||||
|
||||
**Bank Reference:**
|
||||
- Bank Name: [____________________________]
|
||||
- Account Manager: [____________________________]
|
||||
- Phone: [____________________________]
|
||||
|
||||
**Trade References:**
|
||||
1. [____________________________] - [____________________________]
|
||||
2. [____________________________] - [____________________________]
|
||||
3. [____________________________] - [____________________________]
|
||||
|
||||
---
|
||||
|
||||
## Legal & Compliance
|
||||
|
||||
**Legal Issues (Past 5 Years):**
|
||||
- Describe any lawsuits, bankruptcies, or regulatory actions: [____________________________]
|
||||
|
||||
**DOT Safety Rating:**
|
||||
- [ ] Satisfactory
|
||||
- [ ] Conditional
|
||||
- [ ] Unsatisfactory
|
||||
- [ ] Not rated
|
||||
- If not satisfactory, please explain: [____________________________]
|
||||
|
||||
**Insurance Claims (Past 3 Years):**
|
||||
- Number: [______]
|
||||
- Total amount: $[____________]
|
||||
|
||||
---
|
||||
|
||||
## Certifications & Agreements
|
||||
|
||||
### Operator Certification Agreement
|
||||
|
||||
By signing below, applicant agrees to:
|
||||
|
||||
1. Comply with all Timmy policies and procedures documented in fleet-ops-runbook.md
|
||||
2. Maintain required insurance coverage and certifications
|
||||
3. Adhere to scheduled maintenance requirements
|
||||
4. Report all incidents within required timelines
|
||||
5. Participate in performance review process
|
||||
6. Maintain professional standards in customer interactions
|
||||
7. Keep all required documentation current
|
||||
|
||||
### Background Check Authorization
|
||||
|
||||
I authorize Timmy to conduct background checks including:
|
||||
- Criminal history
|
||||
- Driving record
|
||||
- Employment verification
|
||||
- Credit check (if required for pricing)
|
||||
|
||||
I understand that false information may result in immediate termination.
|
||||
|
||||
**Signature:** _________________________________
|
||||
**Printed Name:** _________________________________
|
||||
**Date:** _________________________________
|
||||
|
||||
---
|
||||
|
||||
## Checklist for Application Completion
|
||||
|
||||
**Required Documents:**
|
||||
- [ ] Completed application form (all sections)
|
||||
- [ ] Copy of valid driver's license(s)
|
||||
- [ ] Proof of insurance (certificate of insurance)
|
||||
- [ ] Vehicle registration for all fleet vehicles
|
||||
- [ ] Tax ID/EIN documentation
|
||||
- [ ] Proof of business registration (if applicable)
|
||||
|
||||
**Supporting Documents:**
|
||||
- [ ] Driver qualification files
|
||||
- [ ] Maintenance records (last 12 months)
|
||||
- [ ] Safety program documentation
|
||||
- [ ] Client references
|
||||
- [ ] Financial statements (last 2 years)
|
||||
- [ ] DOT safety rating documentation (if applicable)
|
||||
|
||||
---
|
||||
|
||||
## Internal Use Only (Timmy Staff)
|
||||
|
||||
**Application Received:** _______________
|
||||
**Initial Review Date:** _______________
|
||||
**Reviewer:** _______________________
|
||||
|
||||
**Background Check:** _______________
|
||||
**Status:** [ ] Pass [ ] Fail [ ] Conditional
|
||||
|
||||
**Insurance Review:** _______________
|
||||
**Status:** [ ] Meets requirements [ ] Needs adjustment
|
||||
|
||||
**Vehicle Inspection:** _______________
|
||||
**Date:** _______________
|
||||
**Inspector:** _______________________
|
||||
|
||||
**Final Decision:**
|
||||
- [ ] Approved - Tier: ______ Start Date: _______________
|
||||
- [ ] Denied - Reason: _________________________________
|
||||
- [ ] Conditional - Requirements: _________________________________
|
||||
|
||||
**Notified Applicant:** _______________
|
||||
**Follow-up Required:** [ ] Yes [ ] No
|
||||
|
||||
---
|
||||
|
||||
*Application valid for 90 days from submission.*
|
||||
*Re-application permitted after 180 days if denied.*
|
||||
209
specs/templates/partner-report.md
Normal file
209
specs/templates/partner-report.md
Normal file
@@ -0,0 +1,209 @@
|
||||
# Partner Monthly Performance Report
|
||||
|
||||
**Reporting Period:** [Month] [Year]
|
||||
**Partner Name:** [____________________________]
|
||||
**Partner ID:** [____________________________]
|
||||
**Report Due Date:** [____________________________]
|
||||
|
||||
---
|
||||
|
||||
## Executive Summary
|
||||
|
||||
| Metric | Current Month | Target | Variance | Trend |
|
||||
|--------|---------------|--------|----------|-------|
|
||||
| Leads Generated | ___ | ___ | ___% | [↗ ↘ →] |
|
||||
| Qualified Leads | ___ | ___ | ___% | [↗ ↘ →] |
|
||||
| Conversions | ___ | ___ | ___% | [↗ ↘ →] |
|
||||
| Revenue Share | $___ | $___ | ___% | [↗ ↘ →] |
|
||||
| Operator Placements | ___ | ___ | ___% | [↗ ↘ →] |
|
||||
|
||||
**Highlights:**
|
||||
- Key achievements this month: [____________________________]
|
||||
- Challenges encountered: [____________________________]
|
||||
- Focus areas for next period: [____________________________]
|
||||
|
||||
---
|
||||
|
||||
## Lead Generation & Qualification
|
||||
|
||||
### Lead Pipeline
|
||||
|
||||
| Stage | Current Month | Cumulative This Quarter | Cumulative This Year |
|
||||
|-------|---------------|-------------------------|----------------------|
|
||||
| Initial Contacts | ___ | ___ | ___ |
|
||||
| Qualified Prospects | ___ | ___ | ___ |
|
||||
| Applications Received | ___ | ___ | ___ |
|
||||
| Under Review | ___ | ___ | ___ |
|
||||
| Certified Operators | ___ | ___ | ___ |
|
||||
| Active Operators | ___ | ___ | ___ |
|
||||
|
||||
### Lead Source Breakdown
|
||||
|
||||
| Source Type | Leads | Qualified | Conversion Rate |
|
||||
|-------------|-------|-----------|----------------|
|
||||
| Organic referrals | ___ | ___ | ___% |
|
||||
| Digital marketing | ___ | ___ | ___% |
|
||||
| Trade shows/events | ___ | ___ | ___% |
|
||||
| Cold outreach | ___ | ___ | ___% |
|
||||
| Other: ________ | ___ | ___ | ___% |
|
||||
| **Total** | ___ | ___ | ___% |
|
||||
|
||||
**Conversion Funnel:**
|
||||
```
|
||||
Leads → Qualified → Application → Review → Certified → Active
|
||||
___ → ___ → ___ → ___ → ___ → ___
|
||||
___% ___% ___% ___% ___%
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Financial Performance
|
||||
|
||||
### Revenue & Commission Share
|
||||
|
||||
| Revenue Component | Amount | Partner Share % | Partner Share $ |
|
||||
|-------------------|--------|----------------|-----------------|
|
||||
| Operator base earnings | $______ | ___% | $______ |
|
||||
| Performance bonuses | $______ | ___% | $______ |
|
||||
| Volume incentives | $______ | ___% | $______ |
|
||||
| Referral bonuses | $______ | ___% | $______ |
|
||||
| Other incentives | $______ | ___% | $______ |
|
||||
| **Total** | $______ | | $______ |
|
||||
|
||||
### Incentive Earned This Period
|
||||
|
||||
| Incentive Type | Requirement | Status | Amount |
|
||||
|----------------|-------------|--------|--------|
|
||||
| Lead generation bonus | ___ qualified leads | [Met/Partial/Not Met] | $______ |
|
||||
| Conversion bonus | ___ certified operators | [Met/Partial/Not Met] | $______ |
|
||||
| Retention bonus | ___ operators >12 months | [Met/Partial/Not Met] | $______ |
|
||||
| Performance bonus | Operator KPIs met | [Met/Partial/Not Met] | $______ |
|
||||
| **Total Incentives** | | | $______ |
|
||||
|
||||
**Total Partner Earnings (YTD):** $______
|
||||
|
||||
---
|
||||
|
||||
## Operator Placement & Performance
|
||||
|
||||
### Operator Roster
|
||||
|
||||
| Operator | Certified Date | Status | Monthly Revenue | Commission Tier | Uptime | Customer Rating |
|
||||
|----------|---------------|--------|----------------|----------------|--------|----------------|
|
||||
| | | Active/Terminated/On Leave | | | | |
|
||||
| | | | | | | |
|
||||
| | | | | | | |
|
||||
|
||||
### Operator Performance Summary
|
||||
|
||||
**Tier Distribution:**
|
||||
- Bronze: ___ operators
|
||||
- Silver: ___ operators
|
||||
- Gold: ___ operators
|
||||
|
||||
**Key Performance Indicators:**
|
||||
- Average operator uptime: ___% (Target: >99.5%)
|
||||
- Average customer rating: ___/5.0 (Target: >4.5)
|
||||
- Total deliveries this month: ___
|
||||
- On-time delivery rate: ___%
|
||||
|
||||
**Churn/Retention:**
|
||||
- New operators this month: ___
|
||||
- Terminated operators this month: ___
|
||||
- Net change: ___ (Churn rate: ___%)
|
||||
- Annual churn rate: ___% (Target: <10%)
|
||||
|
||||
---
|
||||
|
||||
## Partnership Health & Activity
|
||||
|
||||
### Marketing & Support Activities
|
||||
|
||||
| Activity Type | Date | Description | Outcome |
|
||||
|---------------|------|-------------|---------|
|
||||
| Training session | | | |
|
||||
| Marketing event | | | |
|
||||
| Business review | | | |
|
||||
| Operator visit | | | |
|
||||
| Other: ________ | | | |
|
||||
|
||||
### Resource Utilization
|
||||
|
||||
**Marketing Materials Distributed:** ___
|
||||
**Training Sessions Conducted:** ___ (total hours: ___)
|
||||
**Support Tickets Resolved:** ___ (avg response: ___ hrs)
|
||||
**Co-op Marketing Funds Used:** $___ of $___ allocated
|
||||
|
||||
---
|
||||
|
||||
## Issues & Concerns
|
||||
|
||||
**Operational Challenges:**
|
||||
- [____________________________]
|
||||
- [____________________________]
|
||||
|
||||
**Operator Support Needs:**
|
||||
- [____________________________]
|
||||
- [____________________________]
|
||||
|
||||
**Process Improvements:**
|
||||
- [____________________________]
|
||||
|
||||
---
|
||||
|
||||
## Action Plan for Next Period
|
||||
|
||||
### Immediate Priorities (Next 30 Days)
|
||||
1. _____________________________________________________
|
||||
2. _____________________________________________________
|
||||
3. _____________________________________________________
|
||||
|
||||
### Quarterly Goals
|
||||
1. _____________________________________________________
|
||||
2. _____________________________________________________
|
||||
|
||||
### Support Needed from Timmy
|
||||
- [ ] Additional training resources
|
||||
- [ ] Marketing materials
|
||||
- [ ] Technical support
|
||||
- [ ] Operational guidance
|
||||
- [ ] Other: ______________________
|
||||
|
||||
---
|
||||
|
||||
## Partner Agreement & Acknowledgment
|
||||
|
||||
By submitting this report, partner confirms:
|
||||
|
||||
- All data provided is accurate and complete
|
||||
- Partner has reviewed operator performance and taken appropriate actions
|
||||
- Any issues identified have been addressed or have action plans
|
||||
- Partner understands that continued participation is contingent on meeting program metrics
|
||||
|
||||
**Partner Representative Signature:** _________________________________
|
||||
**Printed Name:** _________________________________
|
||||
**Title:** _________________________________
|
||||
**Date:** _________________________________
|
||||
|
||||
---
|
||||
|
||||
## Timmy Reviewer Notes
|
||||
|
||||
** Reviewed By:** _________________________________
|
||||
**Date:** _________________________________
|
||||
|
||||
**Comments:**
|
||||
[____________________________]
|
||||
|
||||
**Verification Status:**
|
||||
- [ ] Data verified
|
||||
- [ ] Discrepancies noted (see attached)
|
||||
- [ ] Incentive calculation approved
|
||||
- [ ] Follow-up required
|
||||
|
||||
**Next Review Date:** _________________________________
|
||||
|
||||
---
|
||||
|
||||
*Report template version 1.0*
|
||||
*Reference: fleet-operator-incentives.md, fleet-ops-runbook.md*
|
||||
@@ -1 +1,12 @@
|
||||
# Timmy core module
|
||||
|
||||
from .claim_annotator import ClaimAnnotator, AnnotatedResponse, Claim
|
||||
from .audit_trail import AuditTrail, AuditEntry
|
||||
|
||||
__all__ = [
|
||||
"ClaimAnnotator",
|
||||
"AnnotatedResponse",
|
||||
"Claim",
|
||||
"AuditTrail",
|
||||
"AuditEntry",
|
||||
]
|
||||
|
||||
156
src/timmy/claim_annotator.py
Normal file
156
src/timmy/claim_annotator.py
Normal file
@@ -0,0 +1,156 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Response Claim Annotator — Source Distinction System
|
||||
SOUL.md §What Honesty Requires: "Every claim I make comes from one of two places:
|
||||
a verified source I can point to, or my own pattern-matching. My user must be
|
||||
able to tell which is which."
|
||||
"""
|
||||
|
||||
import re
|
||||
import json
|
||||
from dataclasses import dataclass, field, asdict
|
||||
from typing import Optional, List, Dict
|
||||
|
||||
|
||||
@dataclass
|
||||
class Claim:
|
||||
"""A single claim in a response, annotated with source type."""
|
||||
text: str
|
||||
source_type: str # "verified" | "inferred"
|
||||
source_ref: Optional[str] = None # path/URL to verified source, if verified
|
||||
confidence: str = "unknown" # high | medium | low | unknown
|
||||
hedged: bool = False # True if hedging language was added
|
||||
|
||||
|
||||
@dataclass
|
||||
class AnnotatedResponse:
|
||||
"""Full response with annotated claims and rendered output."""
|
||||
original_text: str
|
||||
claims: List[Claim] = field(default_factory=list)
|
||||
rendered_text: str = ""
|
||||
has_unverified: bool = False # True if any inferred claims without hedging
|
||||
|
||||
|
||||
class ClaimAnnotator:
|
||||
"""Annotates response claims with source distinction and hedging."""
|
||||
|
||||
# Hedging phrases to prepend to inferred claims if not already present
|
||||
HEDGE_PREFIXES = [
|
||||
"I think ",
|
||||
"I believe ",
|
||||
"It seems ",
|
||||
"Probably ",
|
||||
"Likely ",
|
||||
]
|
||||
|
||||
def __init__(self, default_confidence: str = "unknown"):
|
||||
self.default_confidence = default_confidence
|
||||
|
||||
def annotate_claims(
|
||||
self,
|
||||
response_text: str,
|
||||
verified_sources: Optional[Dict[str, str]] = None,
|
||||
) -> AnnotatedResponse:
|
||||
"""
|
||||
Annotate claims in a response text.
|
||||
|
||||
Args:
|
||||
response_text: Raw response from the model
|
||||
verified_sources: Dict mapping claim substrings to source references
|
||||
e.g. {"Paris is the capital of France": "https://en.wikipedia.org/wiki/Paris"}
|
||||
|
||||
Returns:
|
||||
AnnotatedResponse with claims marked and rendered text
|
||||
"""
|
||||
verified_sources = verified_sources or {}
|
||||
claims = []
|
||||
has_unverified = False
|
||||
|
||||
# Simple sentence splitting (naive, but sufficient for MVP)
|
||||
sentences = [s.strip() for s in re.split(r'[.!?]\s+', response_text) if s.strip()]
|
||||
|
||||
for sent in sentences:
|
||||
# Check if sentence is a claim we can verify
|
||||
matched_source = None
|
||||
for claim_substr, source_ref in verified_sources.items():
|
||||
if claim_substr.lower() in sent.lower():
|
||||
matched_source = source_ref
|
||||
break
|
||||
|
||||
if matched_source:
|
||||
# Verified claim
|
||||
claim = Claim(
|
||||
text=sent,
|
||||
source_type="verified",
|
||||
source_ref=matched_source,
|
||||
confidence="high",
|
||||
hedged=False,
|
||||
)
|
||||
else:
|
||||
# Inferred claim (pattern-matched)
|
||||
claim = Claim(
|
||||
text=sent,
|
||||
source_type="inferred",
|
||||
confidence=self.default_confidence,
|
||||
hedged=self._has_hedge(sent),
|
||||
)
|
||||
if not claim.hedged:
|
||||
has_unverified = True
|
||||
|
||||
claims.append(claim)
|
||||
|
||||
# Render the annotated response
|
||||
rendered = self._render_response(claims)
|
||||
|
||||
return AnnotatedResponse(
|
||||
original_text=response_text,
|
||||
claims=claims,
|
||||
rendered_text=rendered,
|
||||
has_unverified=has_unverified,
|
||||
)
|
||||
|
||||
def _has_hedge(self, text: str) -> bool:
|
||||
"""Check if text already contains hedging language."""
|
||||
text_lower = text.lower()
|
||||
for prefix in self.HEDGE_PREFIXES:
|
||||
if text_lower.startswith(prefix.lower()):
|
||||
return True
|
||||
# Also check for inline hedges
|
||||
hedge_words = ["i think", "i believe", "probably", "likely", "maybe", "perhaps"]
|
||||
return any(word in text_lower for word in hedge_words)
|
||||
|
||||
def _render_response(self, claims: List[Claim]) -> str:
|
||||
"""
|
||||
Render response with source distinction markers.
|
||||
|
||||
Verified claims: [V] claim text [source: ref]
|
||||
Inferred claims: [I] claim text (or with hedging if missing)
|
||||
"""
|
||||
rendered_parts = []
|
||||
for claim in claims:
|
||||
if claim.source_type == "verified":
|
||||
part = f"[V] {claim.text}"
|
||||
if claim.source_ref:
|
||||
part += f" [source: {claim.source_ref}]"
|
||||
else: # inferred
|
||||
if not claim.hedged:
|
||||
# Add hedging if missing
|
||||
hedged_text = f"I think {claim.text[0].lower()}{claim.text[1:]}" if claim.text else claim.text
|
||||
part = f"[I] {hedged_text}"
|
||||
else:
|
||||
part = f"[I] {claim.text}"
|
||||
rendered_parts.append(part)
|
||||
return " ".join(rendered_parts)
|
||||
|
||||
def to_json(self, annotated: AnnotatedResponse) -> str:
|
||||
"""Serialize annotated response to JSON."""
|
||||
return json.dumps(
|
||||
{
|
||||
"original_text": annotated.original_text,
|
||||
"rendered_text": annotated.rendered_text,
|
||||
"has_unverified": annotated.has_unverified,
|
||||
"claims": [asdict(c) for c in annotated.claims],
|
||||
},
|
||||
indent=2,
|
||||
ensure_ascii=False,
|
||||
)
|
||||
@@ -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
|
||||
103
tests/timmy/test_claim_annotator.py
Normal file
103
tests/timmy/test_claim_annotator.py
Normal file
@@ -0,0 +1,103 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Tests for claim_annotator.py — verifies source distinction is present."""
|
||||
|
||||
import sys
|
||||
import os
|
||||
import json
|
||||
|
||||
sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", "src"))
|
||||
|
||||
from timmy.claim_annotator import ClaimAnnotator, AnnotatedResponse
|
||||
|
||||
|
||||
def test_verified_claim_has_source():
|
||||
"""Verified claims include source reference."""
|
||||
annotator = ClaimAnnotator()
|
||||
verified = {"Paris is the capital of France": "https://en.wikipedia.org/wiki/Paris"}
|
||||
response = "Paris is the capital of France. It is a beautiful city."
|
||||
|
||||
result = annotator.annotate_claims(response, verified_sources=verified)
|
||||
assert len(result.claims) > 0
|
||||
verified_claims = [c for c in result.claims if c.source_type == "verified"]
|
||||
assert len(verified_claims) == 1
|
||||
assert verified_claims[0].source_ref == "https://en.wikipedia.org/wiki/Paris"
|
||||
assert "[V]" in result.rendered_text
|
||||
assert "[source:" in result.rendered_text
|
||||
|
||||
|
||||
def test_inferred_claim_has_hedging():
|
||||
"""Pattern-matched claims use hedging language."""
|
||||
annotator = ClaimAnnotator()
|
||||
response = "The weather is nice today. It might rain tomorrow."
|
||||
|
||||
result = annotator.annotate_claims(response)
|
||||
inferred_claims = [c for c in result.claims if c.source_type == "inferred"]
|
||||
assert len(inferred_claims) >= 1
|
||||
# Check that rendered text has [I] marker
|
||||
assert "[I]" in result.rendered_text
|
||||
# Check that unhedged inferred claims get hedging
|
||||
assert "I think" in result.rendered_text or "I believe" in result.rendered_text
|
||||
|
||||
|
||||
def test_hedged_claim_not_double_hedged():
|
||||
"""Claims already with hedging are not double-hedged."""
|
||||
annotator = ClaimAnnotator()
|
||||
response = "I think the sky is blue. It is a nice day."
|
||||
|
||||
result = annotator.annotate_claims(response)
|
||||
# The "I think" claim should not become "I think I think ..."
|
||||
assert "I think I think" not in result.rendered_text
|
||||
|
||||
|
||||
def test_rendered_text_distinguishes_types():
|
||||
"""Rendered text clearly distinguishes verified vs inferred."""
|
||||
annotator = ClaimAnnotator()
|
||||
verified = {"Earth is round": "https://science.org/earth"}
|
||||
response = "Earth is round. Stars are far away."
|
||||
|
||||
result = annotator.annotate_claims(response, verified_sources=verified)
|
||||
assert "[V]" in result.rendered_text # verified marker
|
||||
assert "[I]" in result.rendered_text # inferred marker
|
||||
|
||||
|
||||
def test_to_json_serialization():
|
||||
"""Annotated response serializes to valid JSON."""
|
||||
annotator = ClaimAnnotator()
|
||||
response = "Test claim."
|
||||
result = annotator.annotate_claims(response)
|
||||
json_str = annotator.to_json(result)
|
||||
parsed = json.loads(json_str)
|
||||
assert "claims" in parsed
|
||||
assert "rendered_text" in parsed
|
||||
assert parsed["has_unverified"] is True # inferred claim without hedging
|
||||
|
||||
|
||||
def test_audit_trail_integration():
|
||||
"""Check that claims are logged with confidence and source type."""
|
||||
# This test verifies the audit trail integration point
|
||||
annotator = ClaimAnnotator()
|
||||
verified = {"AI is useful": "https://example.com/ai"}
|
||||
response = "AI is useful. It can help with tasks."
|
||||
|
||||
result = annotator.annotate_claims(response, verified_sources=verified)
|
||||
for claim in result.claims:
|
||||
assert claim.source_type in ("verified", "inferred")
|
||||
assert claim.confidence in ("high", "medium", "low", "unknown")
|
||||
if claim.source_type == "verified":
|
||||
assert claim.source_ref is not None
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
test_verified_claim_has_source()
|
||||
print("✓ test_verified_claim_has_source passed")
|
||||
test_inferred_claim_has_hedging()
|
||||
print("✓ test_inferred_claim_has_hedging passed")
|
||||
test_hedged_claim_not_double_hedged()
|
||||
print("✓ test_hedged_claim_not_double_hedged passed")
|
||||
test_rendered_text_distinguishes_types()
|
||||
print("✓ test_rendered_text_distinguishes_types passed")
|
||||
test_to_json_serialization()
|
||||
print("✓ test_to_json_serialization passed")
|
||||
test_audit_trail_integration()
|
||||
print("✓ test_audit_trail_integration passed")
|
||||
print("\nAll tests passed!")
|
||||
Reference in New Issue
Block a user