Wiki Director
287
edits
imported>RubbedMC (Adding important information to the hub guide.) |
m (Minor adjustments to page, creation of prompt for coders / Admins to contribute to actual operation of servers from their end) |
||
(22 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
{{Needs revision|reason=Staff/Coder consultation needed for in-server control panels operation|user=[[User:Anvilman|Anvilman6]]}} | |||
This page contains the information and steps needed to download the latest version of the code, compile it and host your own server. | This page contains the information and steps needed to download the latest version of the code, compile it and host your own server. | ||
<!-- | |||
== Licensing == | == Licensing == | ||
The | The /tg/station 13 source code is under [http://www.gnu.org/licenses/agpl-3.0.html GNU AGPL v3 license] and the assets are [http://freedomdefined.org/Licenses/CC-BY-SA CC-BY-SA]. | ||
--> | |||
== Downloading == | == Downloading == | ||
We use GitHub to host our project. | We use GitHub to host our project. | ||
A zip download is available here: [https://github.com/yogstation13/Yogstation-TG] | |||
If you don't want to download 30MB of data every time an update is made, you can [[Setting up git|follow this guide]] to set up TortoiseGit. | |||
[[File:Download za git.png]] | |||
== Hosting a server == | == Hosting a server == | ||
To get a simple server running | To get a simple server running: | ||
* Download the source code as explained above | * Download the source code as explained [[Downloading_the_source_code#Downloading|above]] | ||
* Open | * Open yogstation.dme in dream maker (double click it) | ||
* Once it opens select Build > Compile | * Once it opens select Build > Compile | ||
* Wait until it compiles. Once it does a new file " | * Wait until it compiles. Once it does a new file "Yogstation.dmb" will be created in the same folder where "yogstation.dme" is. The dmb file has an orange icon. Compile time usually takes between 1 and 10 minutes, depending on your computer. Dream maker will show as 'not responding' during this time, but it is compiling. | ||
* Open dream daemon (Win7: start menu > all programs > BYOND > Dream Daemon; Win8: start > type Dream Daemon > Dream Daemon) | * Open dream daemon (Win7: start menu > all programs > BYOND > Dream Daemon; Win8: start > type Dream Daemon > Dream Daemon) | ||
* Select the "..." in the lower right corner and select the file " | * Select the "..." in the lower right corner and select the file "yogstation.dmb". | ||
* Click the "GO" button and wait until it changes to a red "stop" button. Starting the server usually takes between 1 and 5 minutes. It is fully started once you can normally interact with Dream Daemon and a byond://xxx.xxx.xxx.xxx:xxxxx link is present at the bottom. | * Click the "GO" button and wait until it changes to a red "stop" button. Starting the server usually takes between 1 and 5 minutes. It is fully started once you can normally interact with Dream Daemon and a byond://xxx.xxx.xxx.xxx:xxxxx link is present at the bottom. | ||
* Click the yellow button (former "...") to auto-join | * Click the yellow button (former "...") to auto-join | ||
Line 67: | Line 32: | ||
* Paste the link (ctrl+v) to your friends so they can join. | * Paste the link (ctrl+v) to your friends so they can join. | ||
== Making your server visible on byond.com == | <!-- == Making your server visible on byond.com == | ||
You '''DO NOT NEED''' to pay for membership to make your server visible on byond.com! | You '''DO NOT NEED''' to pay for membership to make your server visible on byond.com! | ||
Line 73: | Line 38: | ||
To make your server show up, go to the /code/hub file. That file contains information on how to make your server visible. Be sure to edit that file '''BEFORE''' you compile. If this doesn't work, you may ask for help on our [irc://irc.rizon.net/tgstation13 IRC]. | To make your server show up, go to the /code/hub file. That file contains information on how to make your server visible. Be sure to edit that file '''BEFORE''' you compile. If this doesn't work, you may ask for help on our [irc://irc.rizon.net/tgstation13 IRC]. | ||
--> | |||
== Setting up the database == | == Setting up the database == | ||
Line 103: | Line 65: | ||
=== Database based banning === | === Database based banning === | ||
Offers temporary jobbans, admin bans, cross-server bans, keeps bans logged even after they've expired or were unbanned, and allows for the use of the off-server | Offers temporary jobbans, admin bans, cross-server bans, keeps bans logged even after they've expired or were unbanned, and allows for the use of the off-server ban log. | ||
To enable database based banning: | To enable database based banning: | ||
Line 109: | Line 71: | ||
* Open config/config.txt | * Open config/config.txt | ||
* Add a # in front of BAN_LEGACY_SYSTEM, so the line looks like "#BAN_LEGACY_SYSTEM" | * Add a # in front of BAN_LEGACY_SYSTEM, so the line looks like "#BAN_LEGACY_SYSTEM" | ||
* Done. Note that any legacy bans are no longer enforced once this is done! So it's a good idea to do it when you're starting up. | * Done. Note that any legacy bans are no longer enforced once this is done! So it's a good idea to do it when you're starting up. | ||
=== Database based administration === | === Database based administration === | ||
<font color='red'>'''DATABASE BASED ADMINISTRATION CURRENTLY DOES NOT WORK.'''</font> | |||
The rest of this section remains for when it gets fixed. | |||
<div class="toccolours mw-collapsible mw-collapsed" style="width:600px"> | |||
Offers a changelog for changes done to admins, which increases accountability (adding/removing admins, adding/removing permissions, changing ranks); allows admins with +PERMISSIONS to edit other admins' permissions ingame, meaning they don't need remote desktop access to edit admins; Allows for custom ranks, with permissions not being tied to ranks, offering a better ability for the removal or addition of permissions to certain admins, if they need to be punished, or need extra permissions. Enabling this can be done any time, it's just a bit tedious the first time you do it, if you don't have direct access to the database. | Offers a changelog for changes done to admins, which increases accountability (adding/removing admins, adding/removing permissions, changing ranks); allows admins with +PERMISSIONS to edit other admins' permissions ingame, meaning they don't need remote desktop access to edit admins; Allows for custom ranks, with permissions not being tied to ranks, offering a better ability for the removal or addition of permissions to certain admins, if they need to be punished, or need extra permissions. Enabling this can be done any time, it's just a bit tedious the first time you do it, if you don't have direct access to the database. | ||
Line 122: | Line 89: | ||
* Done. Note that anyone in admins.txt lost admin status, including you! So do the step above! You can repeat it for everyone, as it's a lot easier to do that and just correct permissions with the ingame panel called 'permissions panel'. | * Done. Note that anyone in admins.txt lost admin status, including you! So do the step above! You can repeat it for everyone, as it's a lot easier to do that and just correct permissions with the ingame panel called 'permissions panel'. | ||
* If your database ever dies, your server will revert to the old admin system, so it is a good idea to have admins.txt and admin_ranks.txt set up with some admins too, just so the loss of the database doesn't completely destroy everything. | * If your database ever dies, your server will revert to the old admin system, so it is a good idea to have admins.txt and admin_ranks.txt set up with some admins too, just so the loss of the database doesn't completely destroy everything. | ||
</div> | |||
If you need more help contact [[Community|#coderbus]]. | |||
For additional database-related tutorials, see [[Working with the database]]. | |||
==In-server administrative operation and tips== | |||
[To be filled by administration / coders] | |||
{{Contribution guides}} | {{Contribution guides}} | ||
[[Category:Guides]] [[Category:Game Resources]] | [[Category:Guides]] [[Category:Game Resources]] |