Paradise Station's GitHub main repository.
Switch branches/tags
Nothing to show
Clone or download
Permalink
Failed to load latest commit information.
.github Minor contribution fix Sep 16, 2018
DLLSocket Fixed a derp in DLLSocket.dll Jun 26, 2012
SQL Added missing prefix in CREATE Statement Aug 11, 2018
_maps space turfs Sep 24, 2018
bot Quick fix for a bot-crashing issue resolving youtube links due to wha… Oct 16, 2012
code Merge pull request #9596 from Birdtalon/secconsole Sep 25, 2018
config Adds a small description to custom sprites Sep 16, 2018
data urgh Jan 7, 2017
fonts Broken font shit? Feb 4, 2014
goon Abductor Update Jul 24, 2018
html Automatic changelog compile, [ci skip] Sep 25, 2018
icons Merge pull request #9390 from shazbot194/Lumi_screen Sep 16, 2018
interface Merge pull request #9406 from Fox-McCloud/4K Sep 25, 2018
nano adds <i> Sep 18, 2018
scripts Removes Unused Script Dec 2, 2017
sound Medical Hypospray Aug 3, 2018
strings Wordlist Tweak Mar 31, 2017
tools let's unfuck those sprites Aug 28, 2018
.gitignore Updates gitignore to be python friendly Jan 19, 2017
.travis.yml Travis #3: Build stages! May 19, 2018
COPYING Update COPYING Sep 21, 2016
LICENSE-AGPL3.txt Clarity Enhancement Jan 5, 2015
LICENSE-CC-BY-NC-SA.txt Create LICENSE-CC-BY-NC-SA.txt Sep 21, 2016
LICENSE-GPL3.txt Clarity Enhancement Jan 5, 2015
README.md Fixed website link Jun 5, 2017
dm.sh please god tell me i fixed the morgue conflict Aug 4, 2016
install-byond.sh Ports changelog system from /tg/station and updates Travis Jan 5, 2016
libmysql.dll Added libmysql.dll, a required file many lack to get the MySQL functi… Sep 1, 2010
paradise.dme Remove swapmaps Aug 17, 2018
rust_g.dll Rust-G integration. Makes logging procs 2-3 times less expensive (EVE… Apr 19, 2018

README.md

Paradise

Build Status Average time to resolve an issue Percentage of issues still open Krihelimeter

forthebadge forthebadge forthebadge

Website - Code - Discord


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/ParadiseSS13/Paradise.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 paradise.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 paradise.dmb (DEBUG mode)

paradise.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 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 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 paradise.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 and stats tracking requires a MySQL server.
Your server details go in /config/dbconfig.txt, and the SQL schema is in /SQL/paradise_schema.sql or /SQL/paradise_schema_prefix.sql, depending on if you want table prefixes.
More detailed setup instructions are located on /tg/station's wiki: http://www.tgstation13.org/wiki/Downloading_the_source_code#Setting_up_the_database


IRC Bot Setup

Included in the repo 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 bot/relay script itself.

LICENSE

Paradise is licensed under the GNU Affero General Public License version 3. As of 5th January 2015 any new contributions are licensed under the AGPL as well, if you wish to submit code under the GPL v3 then commits and files must be marked as such in comments. If you wish to use our code in a closed source manner you may use anything before commit 445615b8439bf606ff204a42c8e7b6b69d983255, which is licensed under GPL v3. The major change here is that if you host a server using any code licensed under AGPL you are required to provide full source code for your servers users as well, including addons and modifications you have made.

See this for more information.

Any files located in the Paradise/goon, Paradise/icons/goonstation, or Paradise/sound/goonstation directories, or any subdirectories of mentioned directories are licensed under the Creative Commons 3.0 BY-NC-SA license (https://creativecommons.org/licenses/by-nc-sa/3.0)

All other assets including icons and sound files are licensed under the Creative Commons 3.0 BY-SA license (https://creativecommons.org/licenses/by-sa/3.0/), unless otherwise indicated.