pbwraith/osrs-codex

Fork 0

Client-agnostic source of truth for everything botable in OSRS: activities, ordering, actions, requirements. AI agents translate entries into client APIs.

Go to file

Claude 8a8cc0d6b3 fix(codex): F2P maple path, XP/income mode, executable bank loop, combat gate (issue #3 ) Governor-review bounce (PR #12) fixes on issue-3: 1. Maple IS F2P — restored as an optional level-45 tier. The only F2P maples are the 4 trees in the Corsair Cove Resource Area (requires Dragon Slayer I to enter), per the Free-to-play Woodcutting training guide and Maple tree page (members1=No @ Corsair Cove). Entry no longer labels Maple itself members-only; the quest gate is in accounts.requires_quest and the tier route table. 2. XP-versus-income mode is now explicit: state machine and a1 gate-tier take a mode parameter — XP mode stays on Willow (or Maple with Dragon Slayer I) after 60; income mode selects Yew at Edgeville. The guide: yew logs 'earn a profit' but 'it is recommended to cut willow or maple trees for experience'. Default is XP mode; income must be an explicit run parameter. 3. Bank loop is now executable and tier-specific: actions split into walk-to-bank (a5) + deposit-logs (a6) + walk-back-to-trees (a7), and the state machine pins chop -> walk_to_bank -> deposit_logs -> walk_back -> chop with dedicated states. Per-tier tree+bank routes (Lumbridge/Draynor/Edgeville/Corsair Cove) replace the hardcoded Draynor-for-everything; Yew is routed to Edgeville (guide: 'best place to chop yew trees is south of Edgeville bank'). 4. Combat gate instead of a false no-combat claim: the Draynor willow spot sits between two aggressive level-7 Dark Wizards that attack players under combat 15 (Draynor Village wiki page). Accounts below combat 15 are routed to the single Edgeville willow (bank adjacent); relog/respawn N/A now scoped to the gated routes only, and the risk notes call out Draynor as a combat zone for low-level accounts. Tests: python3 tools/validate.py -> 2 entries, 0 errors, 1 pre-existing warning (researched flag on low-alch-f2p, owned by issue #5's PR); merged-tree check (main `79cab78` + head) keeps the issue-6 catalog, gate clean; git diff --check clean.		2026-08-27 12:55:50 -05:00
codex	fix(codex): F2P maple path, XP/income mode, executable bank loop, combat gate (issue #3 )	2026-08-27 12:55:50 -05:00
docs	Codex skeleton: schema contract, action grammar, data-sources rules, JSON schema, validator, golden example (low-alch-f2p, wiki+price verified), README	2026-08-27 02:59:55 -05:00
schemas	Codex skeleton: schema contract, action grammar, data-sources rules, JSON schema, validator, golden example (low-alch-f2p, wiki+price verified), README	2026-08-27 02:59:55 -05:00
tools	Codex skeleton: schema contract, action grammar, data-sources rules, JSON schema, validator, golden example (low-alch-f2p, wiki+price verified), README	2026-08-27 02:59:55 -05:00
README.md	Codex skeleton: schema contract, action grammar, data-sources rules, JSON schema, validator, golden example (low-alch-f2p, wiki+price verified), README	2026-08-27 02:59:55 -05:00

README.md

OSRS Codex

One source of truth for everything that can be botted in OSRS.

Every bot-able activity — alching, mining, slayer, bosses, trading — is described here once, in a strict client-agnostic YAML structure: requirements, execution order (state machine), the exact action sequence, economics, best-in-class setup, and anti-ban notes.

AI agents building scripts do not re-learn the game. They read a codex entry and translate it into the target client API (DreamBot / Microbot / Storm / RuneLite plugins / …). The game knowledge lives in this repo; the client glue lives in whatever script is being written.

client-agnostic                client-specific (NOT in this repo)
+----------------+             +-------------------+
| codex entry    |  translate  | DreamBot Java     |
| (YAML, strict) |  ---------> | Microbot JS       |
| actions: verbs |             | RuneLite plugin   |
+----------------+             +-------------------+

Layout

codex/<domain>/<entry-id>.yaml   # one entry per activity
  economy/       trading, alching, flipping
  training/      skill grinds (magic, mining, woodcutting, ...)
  combat/        bosses
  combat-slayers/
  quests/        quest entries (referenced by requires_quest)
  transport/     teleport/teleport-reach recipes (shared by many entries)
  meta/          account rotation, world hopping, break scheduling
docs/schema.md         # the entry contract (read this first)
docs/action-grammar.md # the universal verb vocabulary
docs/data-sources.md   # where every fact must come from + how to verify
schemas/entry.schema.json
tools/validate.py      # the gate: python3 tools/validate.py (must exit 0)

The rules (short version)

One entry = one activity. State machine + action list, both mandatory.
Every fact carries a source. Wiki-cited or researched <date> (a TODO: follow-up issue must land the proper citation). Live prices are re-verified against prices.runescape.wiki on every bump.
Best-in-class setup is mandatory (best_practice). Top-operator execution: staff of fire for alchemy, noted items, shortest routes. Translators adopt it by default; deviating requires improvised: true.
Anti-ban is first-class. Every action declares delay bounds and movement style; entries carry risk.ban_level + notes.
The gate must pass before a PR merges: python3 tools/validate.py.
Never mix in client knowledge. No DreamBot/Microbot/Storm API names in entries. Translations live in script repos, referencing the entry id.

Entry lifecycle

draft → verified (all facts sourced, prices re-checked, validator clean) → stale (facts > 30d old or prices moved materially). Stale entries are skipped by translators unless explicitly allowed.

Contributing

This repo is issue-driven: all content is specified in Gitea issues (acceptance criteria + source URLs + expected output path), implemented in branches, and gated by tools/validate.py in CI. No direct pushes.