DM JavaScript HTML CSS Python Java Other
Permalink
Failed to load latest commit information.
.github Removes (as the emoji) Oct 29, 2017
SQL Fixes that Intigracy wanted me to do in addition to the latest stab a… Jul 1, 2017
__DEFINES Mining mob tweaks (#18768) Jul 13, 2018
bot Add MediaWiki and GitHub plugins, based on a bot from Mloc. Feb 8, 2015
code Lube stops affecting you if you get locked to something mid-slip (#18827 Jul 15, 2018
config-example added skip_vault_generation to cfg-example (#16089) Sep 26, 2017
config Holoperson Tweaks (#16314) Oct 29, 2017
data Pomf do a code, fix projectiles hitting windows when they should hit … Jul 3, 2017
docs More work on Saycode, add graphical documentation. Oct 8, 2015
goon Clean up goonchat (#18478) Jun 11, 2018
html [ci skip] Automatic changelog update. Jul 15, 2018
icons Mining rigsuits have visual changes as they are upgraded (#18752) Jul 13, 2018
interface Shift-MMB on things at a distance makes you point at them. (#18487) Jun 12, 2018
libs updated markdown to have more extensions available + added readme for… Sep 5, 2016
libvg Make travis statically link libvg crt. (#15466) Jul 20, 2017
maprendering fixes map rendering by sorting planes correctly (#17679) Mar 2, 2018
maps A bunch of small fixes to metaclub. (#18779) Jul 12, 2018
maptools Removes bus and taxi from maptools Jul 27, 2017
nano Made plant_controller into a proper subsystem (#18733) Jul 6, 2018
scripts Copy only logs that need to be copied. Dec 1, 2014
sound Gravpults and some Centcomm detailling (#18688) Jul 4, 2018
tools Unit testing (#18329) May 31, 2018
.byond_version Create .byond_version Apr 5, 2017
.editorconfig More stuff Jul 26, 2017
.gitattributes Ports DMItool from bay (#12784) Dec 22, 2016
.gitconfig Ports DMItool from bay (#12784) Dec 22, 2016
.gitignore Added /data/statfiles to gitignore (#18713) Jul 3, 2018
.travis.yml Unit testing (#18329) May 31, 2018
CODE_OF_CONDUCT.md code of conduct - short and sweet edition (#17340) Feb 7, 2018
CONTRIBUTING.md formatting, expansion on server polls Jul 31, 2017
COPYING Made readme use markdown. May 2, 2013
LICENSE-GPL3.txt Updated license files. Nov 11, 2012
README.md fixes a typo (#17195) Jan 23, 2018
cleanLogs.bat Return of the boxing ring. Nov 13, 2013
libmysql.dll Added libmysql.dll, a required file many lack to get the MySQL functi… Sep 1, 2010
libvg.dll Statically link MSVCRT into libvg. (#14310) Mar 11, 2017
players2_empty.sqlite browser datums, git being dumb, and a .sql file update May 1, 2015
vgstation13.dme Moved blackbox functionality into a datum (#18772) Jul 13, 2018

README.md

/vg/station Build Status

forinfinityandbyond

Website - Code

IRC (irc.rizon.net #vgstation), here is an embedded link to it: Visit our IRC channel

Discord Coding Server Invite Link


GETTING THE CODE

The simplest but least useful way to obtain the code is using the Github .zip feature. You can click here to get the latest stable code as a .zip file, then unzip it to wherever you want. Alternatively, a much more useful method is to use a git client, the process for getting and using one is described below, (for more information our coders in IRC can tell you how to use one).

Git client

The more complicated but infinitely more useful way is to use a 'git' client.

We recommend and support our users using the smartgit client, obtainable at smartgit. After installing it, create a new file folder where you want to host the code, right click on that folder and click on "Open in Smartgit".

When that opens, click repository at the top left and choose 'clone'. You can either use the link for the main repository https://github.com/vgstation-coders/vgstation13.git, or to clone your own fork the format is https://github.com/USERNAME/REPONAME.git, just copy the URL at your fork and add .git.

Updating the Code

After you have cloned, make sure you have a remote to the main repository and your own forked repository by making a remote using the links above. By right clicking on your remote to this repo you can 'pull' the most recent version of the code from the main repository.

You can then create new branches of code directly from our Bleeding-Edge branch on your computer.

Warning: If you checkout different branches or update the code while Dream Maker is open, this can cause problems when someone adds/removes files or when one of the files changed is currently open.

Branches

Keep in mind that we have multiple branches for various purposes.

  • master - "stable" but ancient code, it was used on the main server until we realized we like living on the edge 😎.
  • Bleeding-Edge - The latest code, this code is run on the main server. Please do any development against this branch!

INSTALLATION

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.

Linux

We use a Rust library called libvg to handle some things like UTF-8 handling. A Windows build is shipped with the code (libvg.dll), however a Linux version is not. If you want to run /vg/station13 on Linux, you will have to compile this binary yourself (or ask for a build on Discord). See libvg/readme.md for details on how to compile it.


Configuration

For a basic setup, simply copy every file from config-example/ to config/ and then add yourself as admin via admins.txt.


SQL Setup

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.


IRC Bot Setup

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.