mirror of
https://github.com/Such-Software/wownerogue.git
synced 2026-10-20 07:38:34 +02:00
jwinterm
343c1f689b
Hand-authored architecture docs (the 'why'/seams that autodocs can't capture):
- docs/ARCHITECTURE.md index + system map + the 5 pillars + chain profiles + conventions
- docs/CHAT_AND_NOSTR.md ChatProvider seam, bridge vs per-player signing, two-relay
tier model, verifyChatEvent impersonation guard, relay policy
- docs/PAYMENTS.md provider contract + registry, BTCPay/checkout/native, hot path
- docs/RULESETS.md Ruleset data object, win-condition strategies, PvP, MatchRoom seam
- docs/MONETIZATION.md credits, cosmetic_catalog, the four-way unlock rule, premium->tier
Autodocs (reference layer): added a docs:api npm script (jsdoc-to-markdown) that
regenerates docs/API.md from the existing JSDoc. Enable with 'cd src && npm install'
then 'npm run docs:api'. Hybrid by design — auto reference + hand-authored architecture.
No runtime code changed. Suite 56 suites / 407 tests green.
52 lines
1.4 KiB
JSON
52 lines
1.4 KiB
JSON
{
|
|
"name": "wownerogue",
|
|
"version": "1.0.0",
|
|
"description": "",
|
|
"main": "index.js",
|
|
"scripts": {
|
|
"start": "NODE_ENV=production node index.js",
|
|
"dev": "NODE_ENV=development node index.js",
|
|
"debug": "NODE_ENV=debug node index.js",
|
|
"test": "jest --runInBand",
|
|
"db:create": "node scripts/setup_db.js",
|
|
"db:drop": "node scripts/setup_db.js drop",
|
|
"db:reset": "npm run db:drop && npm run db:create",
|
|
"docs:api": "jsdoc2md --files game/**/*.js network/**/*.js payments/**/*.js multiplayer/*.js chain/*.js utils/*.js money/*.js services/*.js config/*.js > ../docs/API.md"
|
|
},
|
|
"config": {
|
|
"debug": {
|
|
"enabled": true,
|
|
"console_logging": true,
|
|
"debug_hotkeys": true,
|
|
"simulated_blocks": false
|
|
},
|
|
"production": {
|
|
"enabled": true,
|
|
"console_logging": false,
|
|
"debug_hotkeys": false,
|
|
"simulated_blocks": false
|
|
}
|
|
},
|
|
"author": "",
|
|
"license": "MIT",
|
|
"dependencies": {
|
|
"axios": "^1.9.0",
|
|
"dotenv": "^16.0.3",
|
|
"express": "^4.21.3",
|
|
"node-pg-migrate": "^8.0.4",
|
|
"nostr-tools": "^2.23.9",
|
|
"pg": "^8.15.5",
|
|
"qrcode": "^1.5.3",
|
|
"resend": "^4.0.0",
|
|
"socket.io": "^4.8.1",
|
|
"socket.io-client": "^4.8.1",
|
|
"tweetnacl": "^1.0.3",
|
|
"uuid": "^9.0.0"
|
|
},
|
|
"devDependencies": {
|
|
"jest": "^29.7.0",
|
|
"jsdoc-to-markdown": "^9.1.1",
|
|
"playwright-core": "^1.61.1"
|
|
}
|
|
}
|