diff --git a/README.md b/README.md new file mode 100644 index 0000000..517cde6 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# Jianghu Chronicles — Road of the Wandering Blade + +An **original open-world wuxia browser RPG**: walk a living jianghu, befriend +(and romance) companions, master six weapon schools down to their tier-V +ultimates, and unravel the Iron Umbrella Society across a six-chapter story. +All names, characters, techniques and lore are original works of fiction. + +## Play + +Any static server pointed at this folder works: + +```bash +python3 -m http.server 8917 # or: node server.js +# open http://127.0.0.1:8917 +``` + +Opening `index.html` directly from disk (`file://`) also works — no modules, +no fetches. + +## Controls + +| Input | Action | +|---|---| +| Click / tap map | Walk there; tap near NPC/portal to auto-interact | +| WASD / Arrows / ZQSD | Move (Shift = run) | +| E / Enter | Talk · gather · use spots · portals | +| D-pad (bottom-right) | Touch controls | +| Glowing ➜ arches | Travel between locations | + +Combat is turn-based tactics on a 10×7 grid: move + act each turn, click a +move then a highlighted tile. Battles pause the world; winning clears the +roamer that ambushed you. + +## Features + +- 12 hand-styled locations, day/night cycle, ambient particles, minimap +- 6 weapon types × 5 tiers of techniques, internals cultivation, lightness arts +- Full gear: weapon / head / body / feet / 2 accessories, smithing upgrades +- 6-chapter main quest, job-board side jobs, bounty hunts, weekly tournament +- Companions with chemistry passives, affection, three romances, four sect paths +- Alchemy, fishing, gambling, pickpocketing (infamy has consequences) +- Achievements, monster codex, four endings, autosave + 3 slots + export + +## Tests + +```bash +node test/smoke.mjs +``` + +25 headless tests load every script into a VM with DOM stubs and exercise +character creation, battles (AI and player-driven), quests, economy, crafting, +save/load, world-map generation invariants, achievements, equipment stats and +side-job lifecycles. diff --git a/index.html b/index.html index 86478b0..ad82838 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@