Downloading the source code: Difference between revisions

m
→‎Hosting a server: Removes duplicate info - you don't have to compile the dme twice
(adds run build.bat)
m (→‎Hosting a server: Removes duplicate info - you don't have to compile the dme twice)
 
Line 1: Line 1:
{{Needs revision|reason=Staff/Coder consultation needed for in-server control panels operation|user=[[User:Anvilman|Anvilman6]]}}
{{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 ==
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.


Line 17: Line 10:


[[File:Download za git.png]]
[[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 [[Downloading_the_source_code#Downloading|above]]
*Download the source code as explained [[Downloading_the_source_code#Downloading|above]]
*Run Build.bat
*Run Build.bat in the main folder
*Open yogstation.dme in dream maker (double click it)
*Once it opens select Build > Compile
*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.
*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)
Line 34: Line 22:
*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 ==
You '''DO NOT NEED''' to pay for membership to make your server visible on byond.com!
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==
Also see [[Working with the database]].
Also see [[Working with the database]].
*Download and install XAMPP ([http://www.apachefriends.org/en/xampp-windows.html Windows], [http://www.apachefriends.org/en/xampp-linux.html Linux]). Make sure you have both apache and mysql selected when you install it.
*Download and install XAMPP ([http://www.apachefriends.org/en/xampp-windows.html Windows], [http://www.apachefriends.org/en/xampp-linux.html Linux]). Make sure you have both apache and mysql selected when you install it.
*Run XAMPP Control Panel (Open start menu, type 'xampp' in the search field and run it)
*Run XAMPP Control Panel (Open start menu, type 'xampp' in the search field and run it)
Line 65: Line 45:
**FEEDBACK_PASSWORD mypass (where mypass is the password you set in the CREATE USER statement)
**FEEDBACK_PASSWORD mypass (where mypass is the password you set in the CREATE USER statement)
*The database is now set up for death logging, population logging, polls ([[Working with the database#Adding a new poll|Tutorial]]), library, privacy poll, connection logging and player logging. There are two more features which you should consider. And it's best to do so now, since adopting them later can be a pain.
*The database is now set up for death logging, population logging, polls ([[Working with the database#Adding a new poll|Tutorial]]), library, privacy poll, connection logging and player logging. There are two more features which you should consider. And it's best to do so now, since adopting them later can be a pain.
===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 ban log.  
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:
*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>
<font color="red">'''DATABASE BASED ADMINISTRATION CURRENTLY DOES NOT WORK.'''</font>


The rest of this section remains for when it gets fixed.
The rest of this section remains for when it gets fixed.
<div class="toccolours mw-collapsible  mw-collapsed" style="width:600px">
<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.


To enable database based administration:
To enable database based administration:
*Open config/config.txt
*Open config/config.txt
*Add a # in front of ADMIN_LEGACY_SYSTEM, so the line looks like "#ADMIN_LEGACY_SYSTEM"
*Add a # in front of ADMIN_LEGACY_SYSTEM, so the line looks like "#ADMIN_LEGACY_SYSTEM"
Line 96: Line 69:


For additional database-related tutorials, see [[Working with the database]].
For additional database-related tutorials, see [[Working with the database]].
==In-server administrative operation and tips==
==In-server administrative operation and tips==
[To be filled by administration / coders]
[To be filled by administration / coders]
Line 102: Line 74:


{{Contribution guides}}
{{Contribution guides}}
[[Category:Guides]]  
[[Category:Guides]]
[[Category:Game Resources]]
[[Category:Game Resources]]
Wiki Director
287

edits