/tg/station 13 v1.0 - 6 October 2010



Website: http://ss13.eu

Code: https://github.com/tgstation/-tg-station

IRC: irc://irc.rizon.net/coderbus



================================================================================

DOWNLOADING

================================================================================

There are a number of ways to download the source code. Some are described here, an alternative all-inclusive guide is also located at http://wiki.ss13.eu/index.php/Downloading_the_source_code



Option 1: Download the source code as a zip by clicking the ZIP button in the

code tab of https://github.com/tgstation/-tg-station

(note: this will use a lot of bandwidth if you wish to update and is a lot of

hassle if you want to make any changes at all, so it's not recommended.)



(Options 2/3): Install Git-scm from here first: http://git-scm.com/download/win



Option 2:

Install GitHub::windows from http://windows.github.com/

It handles most of the setup and configuraton of Git for you.

Then you simply search for the -tg-station repository and click the big clone

button.



Option 3:

Follow this: http://wiki.ss13.eu/index.php/Setting_up_git

(It's recommended that you use git-scm, as above, rather than the git CLI

suggested by the guide)



================================================================================

INSTALLATION

================================================================================



First-time installation should be fairly straightforward.  First, you'll need

BYOND installed.  You can get it from http://www.byond.com/.  Once you've done 

that, extract the game files to wherever you want to keep them.  This is a

sourcecode-only release, so the next step is to compile the server files.

Open tgstation.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 tgstation.dmb (DEBUG mode)



tgstation.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. If problems persist, ask for assistance

in irc://irc.rizon.net/coderbus



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, 

except Extended, as they have various issues and aren't currently being tested,

so they may have unknown and bizarre bugs.  Extended is essentially no mode, and

isn't in the Secret rotation by default as it's just not very fun.



You'll also want to edit config/admins.txt to remove the default admins and add

your own.  "Game Master" is the highest level of access, and probably the one

you'll want to use for now.  You can set up your own ranks and find out more in

config/admin_ranks.txt



The format is



byondkey = Rank



where the admin rank must be properly capitalised.



Finally, to start the server, run Dream Daemon and enter the path to your

compiled tgstation.dmb file.  Make sure to set the port to the one you 

specified in the config.txt, and set the Security box to 'Safe'.  Then press GO

and the server should start up and be ready to join.



================================================================================

UPDATING

================================================================================



To update an existing installation, first back up your /config and /data folders

as these store your server configuration, player preferences and banlist.



Then, extract the new files (preferably into a clean directory, but updating in

place should work fine), copy your /config and /data folders back into the new

install, overwriting when prompted except if we've specified otherwise, and

recompile the game.  Once you start the server up again, you should be running

the new version.



================================================================================

SQL SETUP

================================================================================



The SQL backend for the library and stats tracking requires a 

MySQL server.  Your server details go in /config/dbconfig.txt, and the SQL 

schema is in /SQL/tgstation_schema.sql.  More detailed setup instructions are located here: http://wiki.ss13.eu/index.php/Downloading_the_source_code#Setting_up_the_database



================================================================================

IRC BOT SETUP

================================================================================



Included in the SVN is an IRC bot capable of relaying adminhelps to a specified

IRC channel/server (thanks to Skibiliano).

Instructions for bot setup are included in the /bot folder along with the script

itself





================================================================================

LICENSE

================================================================================



All code is under a GNU GPL v3 license (http://www.gnu.org/licenses/gpl.html),

including tools unless their readme specifies otherwise.

All content including icons and sound is under a Creative Commons 3.0 BY-SA

license (http://creativecommons.org/licenses/by-sa/3.0/).