45 lines
1.4 KiB
Markdown
45 lines
1.4 KiB
Markdown
|
# New RPG Content Editor V2.1
|
||
|
|
|
||
|
|
Canonical React + TypeScript content editor and API for New RPG (V2.1 branch).
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
- Load content types from `/api/types`.
|
||
|
|
- Load selected content payload from `/api/content/:type`.
|
||
|
|
- Edit raw JSON.
|
||
|
|
- Save JSON back to `/api/content/:type`.
|
||
|
|
- Serve wiki at `/wiki`.
|
||
|
|
|
||
|
|
## Runtime
|
||
|
|
|
||
|
|
- Vite dev server runs on `http://localhost:4170`.
|
||
|
|
- API/app server runs on `http://localhost:5180` from `server.js` in this folder.
|
||
|
|
- `vite.config.ts` proxies `/api` and `/wiki` to `http://localhost:5180`.
|
||
|
|
- Override the API/app port with `PORT=<port>` when needed.
|
||
|
|
|
||
|
|
## Content Location
|
||
|
|
|
||
|
|
- Preferred: place content beside `server.js` at `tools/content-editor-v2/content/`.
|
||
|
|
- Required image folder for `/api/images`: `tools/content-editor-v2/content/Images/` (capital `I`).
|
||
|
|
- Optional override: set `CONTENT_ROOT=/absolute/path/to/content` before starting the API.
|
||
|
|
- Fallbacks remain for legacy layouts, but local `tools/content-editor-v2/content` is checked first.
|
||
|
|
|
||
|
|
## Local development
|
||
|
|
|
||
|
|
From this folder:
|
||
|
|
|
||
|
|
1. `npm install`
|
||
|
|
2. In one terminal: `npm run dev:api`
|
||
|
|
3. In another terminal: `npm run dev`
|
||
|
|
|
||
|
|
## Build
|
||
|
|
|
||
|
|
- `npm run build`
|
||
|
|
- `npm run clean:workspace` removes generated bundles/logs and trims backup history to a small recent set.
|
||
|
|
|
||
|
|
## Scope guardrails
|
||
|
|
|
||
|
|
- Keep files small and modular.
|
||
|
|
- No cross-file autofix/migration tooling in V2.1.
|
||
|
|
- Finish core CRUD + validation workflows before adding advanced UX.
|