Part Base

Overview

The part-base schematic generates the foundational folder structure for a NanoForge client or server part. It creates example components and systems, the .nanoforge save file used to track ECS state, and optionally lifecycle init functions.

Usage

schematics @nanoforge-dev/schematics:part-base --part=client

Options

Option	Type	Default	Description
`part`	`"client" \| "server"`	(required)
`directory`	`string`	`.`	Destination directory for the generated files
`language`	`"ts" \| "js"`	`ts`	Language to use for generated source files
`server`	`boolean`	`false`
`initFunctions`	`boolean`	`false`

Generated structure

{directory}/
├── {part}/
│   ├── components/
│   │   └── example.component.ts
│   ├── systems/
│   │   └── example.system.ts
│   └── init/                    # if initFunctions: true
│       ├── before-init.ts
│       ├── after-init.ts
│       ├── before-registry-init.ts
│       ├── after-registry-init.ts
│       ├── before-run.ts
│       └── after-run.ts
└── .nanoforge/
    └── {part}.save.json

Save file

The .nanoforge/{part}.save.json file is the source of truth for ECS state. It lists the libraries, components, systems, and entities registered for this part. The part-main schematic reads this file to generate the main.ts entry point.

{
  "libraries": [ ... ],
  "components": [
    {
      "name": "ExampleComponent",
      "path": "./components/example.component.ts",
      "paramsNames": ["paramA", "paramB", "paramC"]
    }
  ],
  "systems": [
    {
      "name": "exampleSystem",
      "path": "./systems/example.system.ts"
    }
  ],
  "entities": [
    {
      "id": "exampleEntity",
      "components": {
        "ExampleComponent": { "paramA": "example", "paramB": 10 }
      }
    }
  ]
}

Init functions

When initFunctions is true, the following lifecycle hooks are scaffolded:

File	Hook	Called
`before-init.ts`	`beforeInit`	Before the app initializes
`after-init.ts`	`afterInit`	After the app initializes
`before-registry-init.ts`	`beforeRegistryInit`	Before the ECS registry initializes
`after-registry-init.ts`	`afterRegistryInit`	After the ECS registry initializes
`before-run.ts`	`beforeRun`	Before the game loop starts
`after-run.ts`	`afterRun`	After the game loop ends

Examples

Generate a TypeScript client part:

schematics @nanoforge-dev/schematics:part-base --part=client

Generate a server part with init hooks:

schematics @nanoforge-dev/schematics:part-base \
  --part=server \
  --initFunctions=true

Generate a JavaScript client in a specific directory:

schematics @nanoforge-dev/schematics:part-base \
  --part=client \
  --language=js \
  --directory=./my-game

Commands

Configuration

Getting-Started

Schematics

Overview

Usage

Options

Generated structure

Save file

Init functions

Examples

​Overview

​Usage

​Options

​Generated structure

​Save file

​Init functions

​Examples

Overview

Usage

Options

Generated structure

Save file

Init functions

Examples