create

Overview

nf create scaffolds a single ECS component or system in your project. By default it creates files for the client; pass --server to target the server instead.

Usage

nf create <type>

<type> is component, system, or plugin (an editor plugin, a project of its own).

Options

Option	Description
`<type>`	The type to create: `component`, `system` or `plugin`.
`-d, --directory <directory>`	Working directory of the command.
`-c, --config <config>`	Path to the configuration file.
`-n, --name <name>`	Name of the component or system.
`-s, --server`	Create on the server instead of the client. Default: `false`.
`-p, --path <path>`	Path to the component/system folder, or the plugin’s folder.
`-t, --template <template>`	Plugins: `panel` (default) or `theme` (a color theme, no code).

Examples

Create a client component:

nf create component --name Position

Create a server system:

nf create system --name Movement --server

Create an editor plugin:

nf create plugin --name @acme/score-board

Create an editor theme (a manifest with a color theme and an icon, no code):

nf create plugin --name @acme/forest --template theme
cd forest && node build.mjs --watch
DEV_PLUGINS=$(pwd) nf editor ../my-game  # in another terminal: the editor reloads the theme

CLI

Loader

Overview

Usage

Options

Examples

​Overview

​Usage

​Options

​Examples

Overview

Usage

Options

Examples