Setting Up A Server

This is a direct copy of the ancient, ancient baystation setup guide, and needs to be brought into the modern age; it is here as part of game wiki housekeeping, and will receive love at some unspecified future time.

====== Guide_to_Setting_Up_a_Server ======

=Download, Compile, and Initial Setup=

• Install BYOND and create an account at http://www.byond.com/
• Checkout the source using http://git-scm.com/ or download it directly from the https://github.com/Baystation12/Baystation12/zipball/master and extract it into a folder of your choosing.
• Open baystation12.dme.
• In the menu at the top, select Build > Compile. #* Compile time depends on your computer specs. Expect to wait between 2-10 minutes. When it finishes you will see the following message: #; //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.
• Browse into the /config folder. In the sub-folder "example", there's an example set of config files; copy these into the main /config folder and edit them to taste. 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.
• Open admins.txt and remove the default admins to add your own. Some available levels (from highest to lowest) are: Game Master, Game Admin, Moderator. The Host level is the highest level and should let you use all available commands, and it's especially useful for creating a private server with which to test things. #* The admins.txt format is: #; byondkey - Rank # ...where the BYOND key must be in lowercase and the admin rank must be properly capitalized. Additional levels and specific commands accessible by each level can be seen in /code/modules/admin/admin_verbs.dm. (Check to be sure you've removed the # comment tag if you copy the format over from the example rank.)

=Starting the Server=

• To start the server, run the BYOND client, log in, and select File > "Start Dream Daemon..." from the menu.
• At the bottom of Dream Daemon, enter the path to your compiled baystation12.dmb file.
• Set Port to the one you specified in the config.txt. #* Note: If you are running it locally for testing, the port can be empty and one will be selected for you. However, choosing a port will prevent needing to edit your bookmark (below). A example testing port is 50000.
• Security: (Trusted is recommended. You can use Safe mode if you prefer, but you'll be clicking alert windows when the server needs to edit the info.json every time it boots up.) #* Trusted mode allows the game to access files, run system commands, and perform other actions without asking for permission. This is usually not a good idea except for games that you have created yourself, and even then it is not advisable. #* Safe mode is the default. File access is allowed within the same directory as the world's .dmb file, and any directories underneath that one. Most actions such as running a system command require your approval. #* Ultrasafe mode means that nothing that could affect your system in any way will be allowed without your permission. For games that use save files, this is usually not desirable.
• Visibility: (Invisible is recommended) #* Public mode is the default. The game will be seen by everyone on the http://www.byond.com/games/Exadv1/SpaceStation13. #* Private mode means your friends on the pager will see your game. However if they are logged in, it will also be visible on their pager. #* Invisible mode prevents the game from appearing on the hub or pager.
• Press the green GO button in the bottom-right. This step may take up to 10 minutes to complete as the world loads. If your Dream Daemon stops responding, simply wait longer.

=Logging In=

• In the BYOND client's menu, select Bookmarks > Add...
• URL: 127.0.0.1:12345 #*...where 12345 is the port you chose in the section above. You may also use the External IP address and port (shown as xxx.x.x.xxx:xxxxx) at the bottom of the Dream Daemon window after pressing "GO".
• Name: Test Server (or whatever you want to call it)
• Click OK
• Find your new Test Server bookmark in the Bookmarks menu and select it to start playing.

=Updating=

• Download a new .ZIP from the Baystation 12 Github site (as explained in the first section above).
• Backup your /config and /data folders. These store your server configuration, player preferences and ban list.
• Extract the new files (preferably into a clean directory, but replacing existing files should work fine).
• Copy your /config and /data folders back into the new install, overwriting when prompted except if we've specified otherwise
• Re-compile the game.

=MySQL 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.