Website - Code - IRC (irc.rizon.net #vgstation)
The simplest way to obtain the code is using the gitlab .zip feature.
Click here to get the latest stable code as a .zip file, then unzip it to wherever you want.
The more complicated and easier to update method is using git. You'll need to download git or some client from here. When that's installed, right click in any folder and click on "Git Bash". When that opens, type in:
git clone https://gitlab.com/vgstation/vgstation.git
(Hint: hold down ctrl and press insert to paste into git bash)
This will take a while to download, but it provides an easier method for updating.
Keep in mind that we have multiple branches for various purposes.
- master - "stable" code, it was used on the main server until we realized we like living on the edge 😎.
- Bleeding-Edge - The latest unstable code. Please do any development against this branch!
First-time installation should be fairly straightforward. First, you'll need BYOND installed. You can get it from here.
This is a sourcecode-only release, so the next step is to compile the server files. Open vgstation13.dme by double-clicking it, open the Build menu, and click compile. This'll take a little while, and if everything's done right you'll get a message like this:
saving vgstation13.dmb (DEBUG mode)
vgstation13.dmb - 0 errors, 0 warnings
If you see any errors or warnings, something has gone wrong - possibly a corrupt download or the files extracted wrong, or a code issue on the main repo. Ask on IRC.
To use the SQLite preferences, rename players2_empty.sqlite to players2.sqlite
Next, copy everything from config-example/ to config/ so you have some default configuration.
Once that's done, open up the config folder. You'll want to edit config.txt to set the probabilities for different gamemodes in Secret and to set your server location so that all your players don't get disconnected at the end of each round. It's recommended you don't turn on the gamemodes with probability 0, as they have various issues and aren't currently being tested, so they may have unknown and bizarre bugs.
You'll also want to edit admins.txt to remove the default admins and add your own. "Host" is the highest level of access, and the other recommended admin levels for now are "Game Master", "Game Admin" and "Moderator". The format is:
byondkey - Rank
where the BYOND key must be in lowercase and the admin rank must be properly capitalized. There are a bunch more admin ranks, but these two should be enough for most servers, assuming you have trustworthy admins.
Finally, to start the server, run Dream Daemon and enter the path to your compiled vgstation13.dmb file. Make sure to set the port to the one you specified in the config.txt, and set the Security box to 'Trusted'. Then press GO and the server should start up and be ready to join.
To update an existing installation, first back up your /config and /data folders as these store your server configuration, player preferences and banlist.
If you used the zip method, you'll need to download the zip file again and unzip it somewhere else, and then copy the /config and /data folders over.
If you used the git method, you simply need to type this in to git bash:
git pull
When this completes, copy over your /data and /config folders again, just in case.
When you have done this, you'll need to recompile the code, but then it should work fine.
For a basic setup, simply copy every file from config-example/ to config/ and then add yourself as admin via admins.txt.
The SQL backend for the library and stats tracking requires a MySQL server. (Linux servers will need to put libmysql.so into the same directory as vgstation13.dme.) Your server details go in /config/dbconfig.txt.
The database is automatically installed during server startup, but you need to ensure the database and user are present and have necessary permissions.
Included in the repo is an IRC bot capable of relaying adminhelps to a specified IRC channel/server (replaces the older one by Skibiliano). Instructions for bot setup are included in the /bot/ folder along with the bot/relay script itself.