berkayylmao / setting-up-sbrw

A *brief* guide on how to set up a Soapbox Race World (SBRW) server for NFS: World. Should include everything you'll need.
GNU General Public License v3.0
19 stars 6 forks source link
core guide nfs sbrw server setup soapbox soapboxraceworld tutorial walkthrough

Disclaimer

I wrote this guide only to help people who didn't even know what to do with the code. I offer no support, so please do not contact me asking for help/support.

So you want to host an SBRW server?

You better buckle up, because this thing is as tedious as they get. This entire guide will focus on a Windows installation, although it shouldn't be any more difficult for a *nix user to follow.

Step 0. Foreshadowing

You should set this whole thing up in a VPS, but your computer at home will do just fine as well. A VPS will offer the ability of hosting this 24/7 and being able to handle many concurrent users, probably better server performance and a much better data security.

So you have two options from the get-go:

After you decide on that, you need to know that in this guide, you'll be required to download over 500MBs of source code and probably almost as much of applications. If you already have a VPS, follow the guide from within that.

Step 1. Setting up the environment

Get Git

You'll want to grab a Git shell first. This one is pretty popular and the one used in this guide as well. The installation offers many options, so just don't touch anything you don't know about. The default options work just fine. Just make sure to have Git add to PATH, like here:

Imgur

Set up project base

Next, find which one of your hard drives have the most space; you'll need at least 2 gigabytes of it. Now open up Command Prompt and switch to that drive. So if it's driver D:, just type in D:.

Imgur

Create a folder somewhere in that drive and copy its path, now do cd [space] [your path] in the command prompt.

For example, cd D:\Somewhere\Elsewhere.

Get the code

Time to get all them codes! Execute these commands on the command prompt (you can copy+paste them). The order is irrelevant and you can open multiple command prompts to have them all done at once, just make sure to cd into the directory you created previously.

Install and configure the necessary applications

You now have the code, but you'll need applications to make use of them. The following are merely suggestions, but are used in this guide, tested thoroughly and practically work out-of-the-box.

Step 2. Compiling the code

Imgur

Step 3. Setting up Openfire

Imgur

Imgur

Imgur

Imgur

Imgur

Imgur

Imgur

Imgur

Imgur

Imgur

Imgur

Imgur

Imgur

Imgur

Step 4. Finalizing server configuration

Step 5. Running the server

All that's left now is to run it. Go to the folder where you downloaded all the code. Run setting-up-sbrw/Files/start-sbrw.bat.

Imgur

If you did everything correctly and no breaking changes happened in SBRW after this guide was written, the server will start without any errors. You'll know if it ran successfully by seeing the statement Thorntail is Ready on the core server's console window.

Imgur

Step 6. Connecting to the server

Imgur

Imgur

Known issues

More information

Note: This is a very basic setup of the SBRW server. I only had the time to cover this much of it.

If you encounter any issues, please report it here for the community to discuss. Give as much detail as possible.

Any and all PRs are welcome.