BlueGit

timfa questward

Files

questward / README.md

README.md

README.md 1.4 KiB Download Raw

Tile MMO

Authoritative Node.js tile MMO with a FrameworkV3 web client. Architecture lives in tile_mmo_server_technical_design_v0.6.md. Implementation status lives in docs/FEATURES.md.

Layout

  • shared/ — protocol constants and tile definitions used by server and client
  • server/src/ — Node.js simulation, persistence, editor API, gateway
  • client/src/ — game client on top of FrameworkV3
  • client/assets/ — world sprites. Grounds and blocks live in a folder per type; each PNG is a visual state (first alphabetical is the default). Pivot is 8px from the bottom.
  • client/frameworkv3/ — FrameworkV3 git submodule

Run locally

git submodule update --init --recursive
npm install
npm run build:client
npm test
npm start

Open http://localhost:8080 to play and http://localhost:8080/editor for the world editor.

Until auth.timfalken.com exists, each browser connection is a stub admin (admin-1, admin-2, …). A fresh world is infinite closed grass: open chunk 0,0 in the editor, save, then Apply now before a character can walk.

The player-driven marketplace is not in this slice. Bank and spawner blocks can be placed in the editor (placeholder sprites until real art exists). Open Bag in play to drop, pick up, and equip starter items.

Source
1# Tile MMO
2
3Authoritative Node.js tile MMO with a FrameworkV3 web client. Architecture lives in `tile_mmo_server_technical_design_v0.6.md`. Implementation status lives in `docs/FEATURES.md`.
4
5## Layout
6
7- `shared/` — protocol constants and tile definitions used by server and client
8- `server/src/` — Node.js simulation, persistence, editor API, gateway
9- `client/src/` — game client on top of FrameworkV3
10- `client/assets/` — world sprites. Grounds and blocks live in a folder per type; each PNG is a visual state (first alphabetical is the default). Pivot is 8px from the bottom.
11- `client/frameworkv3/` — FrameworkV3 git submodule
12
13## Run locally
14
15```text
16git submodule update --init --recursive
17npm install
18npm run build:client
19npm test
20npm start
21```
22
23Open [http://localhost:8080](http://localhost:8080) to play and [http://localhost:8080/editor](http://localhost:8080/editor) for the world editor.
24
25Until auth.timfalken.com exists, each browser connection is a stub admin (`admin-1`, `admin-2`, …). A fresh world is infinite closed grass: open chunk `0,0` in the editor, save, then **Apply now** before a character can walk.
26
27The player-driven marketplace is not in this slice. Bank and spawner blocks can be placed in the editor (placeholder sprites until real art exists). Open **Bag** in play to drop, pick up, and equip starter items.