Getting Started

COMPATIBILITY NOTE

FeniXCLI requires Node.js >= 8. & NPM >= 5.2

Installing Node & NPM

Node is a JavaScript runtime and NPM is a package manager, both are required to use FeniXCLI

Note: Skip to Install FeniXCLI if you already have NodeJS & npm installed.

For Windows

For Ubuntu 18.04

Note: Ubuntu versions lower than 18.04 need to follow this guide

sudo apt-get install nodejs
sudo apt-get install npm

Install FeniXCLI Globally

Installing FeniXCLI globally is recommended due to ease of use

npm install -g fenix-engine-cli

# Setup a new project
fenix

# Start the game server
fenix dev

# Build your plugins
fenix build

Install With An Existing Project

If you want to include a local copy in an already existing project. This setup allows you to use a CI or other services to deploy and push your plugins.

npm install -D fenix-engine-cli

Then you can add some helpful scripts to package.json:

{
  "scripts": {
    "dev": "fenix dev",
    "build": "fenix build"
  }
}

Now you can start FeniXCLI server with:

npm run dev

And to build your plugins, run:

npm run build

By default all files are built to game/js/plugins/, which can be configured using CLI options.

Setup A New Project

Before you can develop your plugins, you need to setup a brand new project. Nothing does that easier than FeniXCLI's guided setup. To activate the project setup guide, run the fenix command with no arguments or run fenix init.

TIP

For detailed information on the setup guide, take a look at the CLI Options