Server Prerequisites

Server Installation

  1. Run git clone https://openwf.io/SpaceNinjaServer.git in a command prompt to download SpaceNinjaServer in the current working directory
  2. Open the SpaceNinjaServer folder (cd SpaceNinjaServer)
  3. Copy config-vanilla.json to create a config.json
  4. (Optional) Edit the config.json to match your MongoDB settings (if not default) and however else you would like to configure the server
  5. (Optional) If you have a GB of free space, you might want to download stripped assets such as ability videos so the client can request them on-demand: Run git clone https://openwf.io/0.git in the static/data folder
  6. Run npm install --omit=dev --omit=optional to install library dependencies
  7. Now you can run npm run raw to start the server anytime

Server Update

You can simply run the UPDATE AND START SERVER script for this, but otherwise the steps are pretty simple:

  1. Run git pull in the SpaceNinjaServer folder
  2. (Optional) If you have the stripped assets, run git pull in the static/data/0 folder
  3. Run npm install --omit=dev --omit=optional to synchronize library dependencies
  4. Now you can use npm run raw to start the server again

Client Patch

In order to connect to custom servers, the client needs to be patched, which is what the boostrapper is for.

The bootstrapper is fully documented here, but the most important point is that, while the game is running, you can visit http://localhost:6155/ to manage options, cheats, and scripts.

IRC Server

In addition to SpaceNinjaServer, you can also set up an IRC server for the in-game chat: