From 74da1af12ffd079cc16bba8cb3e19b983a194071 Mon Sep 17 00:00:00 2001 From: Sainan <63328889+Sainan@users.noreply.github.com> Date: Tue, 28 Oct 2025 08:56:19 +0100 Subject: [PATCH] Guide: Add docker variant --- guide.php | 119 ++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 89 insertions(+), 30 deletions(-) diff --git a/guide.php b/guide.php index 7ecf999..7219c52 100644 --- a/guide.php +++ b/guide.php @@ -9,30 +9,57 @@
-

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. -
  2. Open the SpaceNinjaServer folder (cd SpaceNinjaServer)
    3. -
  3. Copy config-vanilla.json to create a config.json
    4. -
  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. -
  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. -
  6. Run npm install --omit=dev --omit=optional to install library dependencies
    7. -
  7. Now you can run npm run raw to start the server anytime
    8. -
-

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. -
  2. (Optional) If you have the stripped assets, run git pull in the static/data/0 folder
    3. -
  3. Run npm install --omit=dev --omit=optional to synchronize library dependencies
    4. -
  4. Now you can use npm run raw to start the server again
    5. -
+

Guide Settings

+
+ + +
+
+

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. +
  2. Open the SpaceNinjaServer folder
    3. +
  3. Copy config-vanilla.json to create a config.json
    4. +
  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. +
  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. +
  6. Run npm install --omit=dev --omit=optional to install library dependencies
    7. +
  7. Now you can run npm run raw to start the server anytime
    8. +
+

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. +
  2. (Optional) If you have the stripped assets, run git pull in the static/data/0 folder
    3. +
  3. Run npm install --omit=dev --omit=optional to synchronize library dependencies
    4. +
  4. Now you can use npm run raw to start the server again
    5. +
+
+
+

Server Prerequisites

+ +

Server Installation

+
    +
  1. Run git clone https://onlyg.it/OpenWF/Docker-AIO "OpenWF Dockerized Server" to set up an OpenWF Dockerized Server folder in the working directory
    2. +
  2. Open the OpenWF Dockerized Server folder
    3. +
  3. (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
    4. +
  4. Now you can run docker compose up to start the server anytime
    5. +
+

Server Update

+
    +
  1. Run docker compose pull in the OpenWF Dockerized Server folder
    2. +
  2. (Optional) If you have the stripped assets, run git pull in the static-data/0 folder
    3. +
  3. Now you can use docker compose up to start the server again
    4. +
+

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 " target="_blank">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:

- +
+

IRC Server

+

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

+ +
+