About

This repository contains the CLI of NanoForge. Check releases to see versions of the CLI. Nanoforge is a powerful game engine for web browser.

Usage

To use Nanoforge CLI, please refer to the CLI documentation !

First, install the CLI :

npm install -g @nanoforge-dev/cli

And then create a new project :

nf new

Documentation

The documentation for nanoforge cli can be found at : https://nanoforge-dev.github.io/docs/cli

Commands

The nanoforge client interface has multiple commands usable :

nf [command] [options]

build

Used to build your nanoforge project.

• -d, --directory [directory] specify the directory of the nanoforge project to build.
• -c, --config [config] path to the config file.
• --client-outDir [clientDirectory] specifies the client directory.
• --server-outDir [serverDirectory] specifies the server directory.

generate

Used to generate nanoforge project files from config

• -d, --directory [directory] specify the directory of the nanoforge project to build.
• -c, --config [config] path to the config file.

install or add

Used to add a nanoforge library to your project

• -d, --directory [directory] specify the directory of the nanoforge project to build.

new

Used to create a new nanoforge project

• -d, --directory [directory] specify the directory of your project
• --name [name] specify the name of your project
• --path [path] specify the path of your project
• --package-manager [packageManager] specify the package manager of your project
• --language [language] specify the language of your project
• --strict use strict mode
• --no-strict do not use strict mode
• --server create a server
• --no-server do not create a server
• --init-functions initialize functions
• --no-init-functions do not initialize functions
• --skip-install skip installing dependencies
• --no-skip-install do not skip installing dependencies

start

Used to start your nanoforge project

• -d, --directory [directory] specify the directory of your project
• -c, --config [config] path to the config file (default: "nanoforge.config.json")
• -p, --client-port [clientPort] specify the port of the loader (the website to load the game)
• --game-exposure-port [gameExposurePort] specify the port of the game exposure
• --server-port [serverPort] specify the port of the server

Contributing

Please read through our contribution guidelines before starting a pull request. We welcome contributions of all kinds, not just code! If you're stuck for ideas, look for the good first issue label on issues in the repository. If you have any questions about the project, feel free to ask them on Discussions. Before creating your own issue or pull request, always check to see if one already exists! Don't rush contributions, take your time and ensure you're doing it correctly.

Help

If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please ask on Discussions.

The config file schema can be found at : https://nanoforge-dev.github.io/docs/cli/config-schema.json