Project

Overview

The project schematic generates a complete client or server project under directory (e.g. apps/client) inside a workspace: its own package.json, nanoforge.config.ts, tsconfig.json, example ECS component and system, src/main.ts entry point, and optionally a Dockerfile and lifecycle init functions. directory is the full destination path — it isn’t appended with part automatically, so generating a client and a server side by side means passing e.g. --directory=apps/client and --directory=apps/server in two separate invocations. For a standalone project (workspace: false), engine dependency versions are pinned to the newest release published at least 48h ago, mirroring pnpm’s own minimumReleaseAge supply-chain protection. @nanoforge-dev/ecs and @nanoforge-dev/network are resolved directly under those same names — no aliasing to a different registry package. A standalone project also generates its own allowBuilds config (pnpm-workspace.yaml’s allowBuilds map, package.json’s allowScripts or trustedDependencies, depending on packageManager) since it has no parent workspace root to provide one — see allowBuilds below. Engine packages are declared as devDependencies, except @nanoforge-dev/network on a server project, which is declared in dependencies because the server needs it at runtime. Every project gets @nanoforge-dev/cli, @nanoforge-dev/core, @nanoforge-dev/common, @nanoforge-dev/config, @nanoforge-dev/asset and @nanoforge-dev/ecs; a client project additionally gets @nanoforge-dev/env, @nanoforge-dev/graphics-2d, @nanoforge-dev/input and @nanoforge-dev/network. The engine packages (core, common, config, asset, env) share a single version, resolved from @nanoforge-dev/core.

Usage

schematics @nanoforge-dev/schematics:project --part=client --workspaceName=my-game --directory=apps/client

Options

Option	Type	Default	Description
`part`	`"client" \| "server"`	(required)
`workspaceName`	`string`	(required)
`directory`	`string`	`apps`
`language`	`"ts" \| "js"`	`ts`	Language to use for generated source files
`strict`	`boolean`	`true`	Enable strict mode
`packageManager`	`"npm" \| "yarn" \| "pnpm" \| "bun"`	`npm`
`workspace`	`boolean`	`true`
`initFunctions`	`boolean`	`false`
`hasServer`	`boolean`	`false`
`docker`	`boolean`	`false`
`editor`	`boolean`	`false`	Reserved for future editor build support
`libs`	`string[]`	`[]`	Relative paths to shared libs this project depends on, written into `nanoforge.config.ts`
`allowBuilds`	`string[]`	`[]`

Generated structure

<directory>/
├── package.json
├── tsconfig.json           # TypeScript only
├── jsconfig.json           # JavaScript only
├── nanoforge.config.ts     # (or .js)
├── pnpm-workspace.yaml     # if !workspace && packageManager: pnpm && allowBuilds.length > 0
├── Dockerfile              # if docker: true
├── .dockerignore           # if docker: true
├── src/
│   ├── main.ts
│   ├── components/
│   │   ├── position-2d.component.ts             # both parts
│   │   └── drawable-circle-2d.component.ts       # client only
│   └── systems/
│       ├── draw-2d.system.ts                     # client only
│       ├── position-sync.system.ts               # client only, if hasServer: true
│       └── move-2d.system.ts                     # server only
└── assets/

Examples

Generate a client project:

schematics @nanoforge-dev/schematics:project --part=client --workspaceName=my-game --directory=apps/client

Generate a server project with Docker, syncing position with the client:

schematics @nanoforge-dev/schematics:project \
  --part=server \
  --workspaceName=my-game \
  --directory=apps/server \
  --docker=true

Generate a client that syncs its position from that server:

schematics @nanoforge-dev/schematics:project \
  --part=client \
  --workspaceName=my-game \
  --directory=apps/client \
  --hasServer=true

Generate a JavaScript client depending on a shared lib:

schematics @nanoforge-dev/schematics:project \
  --part=client \
  --workspaceName=my-game \
  --directory=apps/client \
  --language=js \
  --libs=../../libs/shared

Commands

Configuration

Getting-Started

Schematics

Overview

Usage

Options

Generated structure

Examples

​Overview

​Usage

​Options

​Generated structure

​Examples

Overview

Usage

Options

Generated structure

Examples