mirror of
https://github.com/merlinhu1/codex-game-studio.git
synced 2026-08-25 07:54:34 +02:00
27 lines
578 B
Markdown
27 lines
578 B
Markdown
# Setup
|
|
|
|
Install and verify with Node 20 or newer:
|
|
|
|
```bash
|
|
npm install
|
|
npm run typecheck
|
|
npm run build
|
|
npm test
|
|
npm run validate
|
|
```
|
|
|
|
Local development scripts build first and then run `node dist/cli.js`.
|
|
|
|
```bash
|
|
npm run init -- --name "My Game" --engine godot --mode prototype --non-interactive --competitor "Mini Metro" --engine-version "4.4.1"
|
|
npm run templates -- list
|
|
npm run validate -- --project projects/my-game
|
|
```
|
|
|
|
After build/link/install, the package bin is available:
|
|
|
|
```bash
|
|
npm exec open-gamestudio -- --help
|
|
npm exec open-gamestudio -- templates show gdd
|
|
```
|