neon-sprawl/content/README.md

4.0 KiB

Content data

Data-driven definitions (skills, items, recipes, quests) validated in CI with JSON Schema.

Path Purpose
schemas/ JSON Schema files (*.schema.json)
skills/ Skill catalogs; each row matches schemas/skill-def.schema.jsonstable id, allowedXpSourceKinds for E2.M1 / E2.M2
mastery/ Mastery catalogs; each file matches schemas/mastery-catalog.schema.jsonstable branchId / perkId, tier gates via skill level (E2.M3)
items/ Item catalogs; each row matches schemas/item-def.schema.jsonstable id, stackMax, inventorySlotKind for E3.M3
resource-nodes/ Resource node + yield catalogs; node rows match schemas/resource-node-def.schema.json, yield rows match schemas/resource-yield-row.schema.jsonstable nodeDefId, gatherLens, maxGathers for E3.M1

Prototype Slice 1 (NEO-33): CI expects exactly three skill rows with ids salvage, refine, intrusion (gather + process + tech). Each row must declare allowedXpSourceKinds (non-empty); see E2.M1 — Designer note: allowedXpSourceKinds for what each kind means for grant wiring.

Prototype Slice 2 — resource nodes (NEO-57): CI expects exactly four nodeDefId values aligned to E3.M1 gather lens freeze — one row per gatherLens; exactly one yield row per node referencing scrap_metal_bulk only. Do not rename nodeDefId after ship. See E3M1-prototype-backlog.md and NEO-57 plan.

Prototype Slice 1 — items (NEO-50): CI expects exactly six item rows with ids scrap_metal_bulk, refined_plate_stock, field_stim_mk0, survey_drone_kit, contract_handoff_token, prototype_armor_shell — one row per prototypeRole (material through equip_stub). Do not rename ids after ship—change displayName only. See E3.M3 — Designer note and freeze table.

Prototype Slice 4 (NEO-45): CI expects exactly one MasteryTrack for salvage only (refine / intrusion have no mastery rows yet). Tier 1 @ skill level 2 is a mutually exclusive branch pick (scrap_efficiency vs bulk_haul) with no perks; tier 2 @ level 4 unlocks one perk per branch path. Do not rename branchId / perkId after ship—change displayName only. See E2.M3 — Designer note and freeze table.

Server load path and hot-reload policy are TBD; keep files versioned here as the source of truth.

Validate locally (same as PR gate):

pip install -r scripts/requirements-content.txt
python scripts/validate_content.py
python scripts/check_decomposition_language.py