The code for Baystation12's branch of SS13
Clone or download
Permalink
Failed to load latest commit information.
.github Update CODE_OF_CONDUCT.md Sep 16, 2018
code Merge pull request #23171 from BloodyMan/flop Sep 23, 2018
config Add missing circuit printing config option Sep 7, 2018
fonts/Shage Adds the Shage language Jan 2, 2018
html Automatic changelog update [ci skip] Sep 23, 2018
icons Janitor Tools Merged Commit Sep 21, 2018
ingame_manuals Implements github suggestions May 23, 2015
interface adds icon scaling and moves menu around Aug 7, 2018
maps Merge pull request #23177 from comma/aliexit Sep 23, 2018
nano UI issues, map changes, fixes, lighting fix. Sep 17, 2018
news_articles Marshals to Agents; removes references of Colonial Marshals and switc… Jul 19, 2018
scripts Change default map used by server.sh Apr 20, 2018
sound Added a bunch of music files from Europa. Sep 15, 2018
sql Add SQL migrate thing Apr 7, 2018
test Backported the codex from Europa. Replaces extended examined text. Sep 21, 2018
tgui SStgui Jul 4, 2018
tools The transliterator now works properly Apr 23, 2018
~code Adjusts space uses. Sep 15, 2017
.dockerignore Dockerize database and gameserver Dec 18, 2017
.editorconfig Edits .editorconfig. Feb 3, 2017
.gitattributes Adds the .gitattribute newline enforcement. Jan 17, 2017
.gitignore Add editor-specific files/dirs to gitignore Mar 1, 2018
.travis.yml Make Travis use OpenJDK8 Jun 19, 2018
COPYING clear up licensing situation Jan 6, 2015
Dockerfile Sync Dockerfile with what's on the box Aug 22, 2018
LICENSE-AGPL3.txt Changes Baystation12 to now be licensed under AGPL. Jan 5, 2015
LICENSE-GPL3.txt clear up licensing situation Jan 6, 2015
README.md Add Discord invite to readme Aug 8, 2018
baystation12.dme Janitor Tools Merged Commit Sep 21, 2018
cloudbuild.yaml Add a cloudbuild.yaml file Aug 21, 2018
docker-compose.yml Dockerize database and gameserver Dec 18, 2017
docker-entrypoint.sh Sync Dockerfile with what's on the box Aug 22, 2018
flyway.conf Use flyway for SQL setup/migration Feb 9, 2016
install-byond.sh Add fancy testing script, make Travis use it Mar 31, 2017
libmysql.dll Added libmysql.dll, a required file many lack to get the MySQL functi… Sep 1, 2010

README.md

baystation12

Website - Code - Discord - IRC


LICENSE

The code for Baystation12 is licensed under the GNU Affero General Public License v3, which can be found in full in LICENSE-AGPL3.txt.

Code with a git authorship date prior to 1420675200 +0000 (2015/01/08 00:00) is licensed under the GNU General Public License version 3, which can be found in full in LICENSE-GPL3.txt.

All code where the authorship dates are not prior to 1420675200 +0000 is assumed to be licensed under AGPL v3, if you wish to license under GPL v3 please make this clear in the commit message and any added files.

If you wish to develop and host this codebase in a closed source manner you may use all commits prior to 1420675200 +0000, which are licensed under GPL v3. The major change here is that if you host a server using any code licensed under AGPLv3 you are required to provide full source code for your servers users as well including addons and modifications you have made.

See here for more information.

tgui clientside is licensed as a subproject under the MIT license. Font Awesome font files, used by tgui, are licensed under the SIL Open Font License v1.1 tgui assets are licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

See tgui/LICENSE.md for the MIT license. See tgui/assets/fonts/SIL-OFL-1.1-LICENSE.md for the SIL Open Font License.

All assets including icons and sound are under a Creative Commons 3.0 BY-SA license unless otherwise indicated.

GETTING THE CODE

The simplest way to obtain the code is using the github .zip feature.

Click here to get the latest 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://github.com/Baystation12/Baystation12.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.


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

baystation12.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.

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. "Game Master" is the highest level of access, and the other recommended admin levels for now are "Game Admin" and "Moderator". The format is:

byondkey - Rank

where the BYOND key must be in lowercase and the admin rank must be properly capitalised. 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 baystation12.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.


UPDATING

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.


Configuration

For a basic setup, simply copy every file from config/example to config.


SQL Setup

The SQL backend for the library/stats and bans requires a MySQL server. Your server details go in config/dbconfig.txt.

For initial setup and migrations refer to sql/README.md