Butts
DM JavaScript HTML CSS Python Shell
Permalink
Failed to load latest commit information.
.github IN BODY PR CHANGELOGS! (#12311) Oct 22, 2016
SQL Attempts to make movement with high ping easier (#12846) Dec 27, 2016
__DEFINES Logs artifact finding, breaking, effects, anomaly batteries use and h… Jan 19, 2017
bot Add MediaWiki and GitHub plugins, based on a bot from Mloc. Feb 8, 2015
code Ports moving/lying/dead diona nymph sprites from Eris/Bay (#13555) Jan 21, 2017
config-example updates poll.dm (#11966) Sep 21, 2016
config Various Bugfixes (#12296) Oct 24, 2016
data The Big Blob update, Part 1 (#9735) Apr 29, 2016
docs More work on Saycode, add graphical documentation. Oct 8, 2015
goon Revert "[Goonchat] Pause button" Jan 12, 2017
html Automatic changelog update. Jan 21, 2017
icons Ports moving/lying/dead diona nymph sprites from Eris/Bay (#13555) Jan 21, 2017
interface Okay (#12368) Oct 27, 2016
libs updated markdown to have more extensions available + added readme for… Sep 5, 2016
maprendering Revert snowmap. Goddamnit. (#13059) Dec 25, 2016
maps Revert "Removes nikita missiles from vault until a fix is in for IEDs… Jan 21, 2017
maptools Revert snowmap. Goddamnit. (#13059) Dec 25, 2016
nano Autobackup for Genetics colored SE tabs (#12770) Dec 21, 2016
scripts Copy only logs that need to be copied. Dec 1, 2014
sound RATTLE ME BONES (#13521) Jan 20, 2017
tools In which /vg/station13 gets high. (#13270) Jan 11, 2017
.gitattributes Ports DMItool from bay (#12784) Dec 22, 2016
.gitconfig Ports DMItool from bay (#12784) Dec 22, 2016
.gitignore Permanently end the shitlery of /data/investigate (#10372) Jun 3, 2016
.gitlab-ci.yml wololo Aug 10, 2015
.travis.yml Fixed Travis script not checking all maps in folder. Jan 19, 2017
BUILDING_ICONS.md Test commit. Aug 7, 2015
Bayupdate.WinMerge Return of the boxing ring. Nov 13, 2013
CONTRIBUTING.md Somewhat updates the contrib guidelines that no one reads (#9764) May 7, 2016
COPYING Made readme use markdown. May 2, 2013
LICENSE-GPL3.txt Updated license files. Nov 11, 2012
OLDVG.WinMerge Return of the boxing ring. Nov 13, 2013
README.md Update the readme a tad. (#13228) Jan 3, 2017
TGupdate.WinMerge Return of the boxing ring. Nov 13, 2013
btime.dll burn it down Aug 3, 2015
buildIcons.bat Add new pre-compiled icons to the BYONDTools DMI builder. Mar 6, 2015
cleanLogs.bat Return of the boxing ring. Nov 13, 2013
dm.sh Fix linux grep for travis (#10715) Jun 22, 2016
dmi_config.yml Add new pre-compiled icons to the BYONDTools DMI builder. Mar 6, 2015
install-byond.sh Possible fix to travis thinking that BYOND install is downloaded when… Oct 19, 2016
libmysql.dll Added libmysql.dll, a required file many lack to get the MySQL functi… Sep 1, 2010
makeChangelog-DRY_RUN.bat Update changelog, add dry-run mode. Aug 7, 2015
makeChangelog.bat Removal of some debugging. Aug 17, 2014
max_tech_origins.txt Update tech origin list. Oct 3, 2015
players2_empty.sqlite browser datums, git being dumb, and a .sql file update May 1, 2015
scanResourcePaths.bat Add batchfile for fixing resource paths. Sep 29, 2013
tech_origin_list.csv Update tech origin list. Oct 3, 2015
vgstation13.dme RATTLE ME BONES (#13521) Jan 20, 2017

README.md

vgstation

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/d3athrow/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.


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.