Downloading the source code: Difference between revisions

Jump to navigation Jump to search

Downloading the source code (view source)

Revision as of 20:38, 3 May 2020

1,269 bytes removed ,  20:38, 3 May 2020
m
Minor adjustments to page, creation of prompt for coders / Admins to contribute to actual operation of servers from their end
imported>Errorage
m (Minor adjustments to page, creation of prompt for coders / Admins to contribute to actual operation of servers from their end)
(16 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 NT Station 13 source code is open. The license allows you to do most things, but if you're really interested in more, see below.
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].
 
-->
The license that we use allows you:
 
*to '''Share''' — to copy, distribute and transmit the work
*to '''Remix''' — to adapt the work
*to '''make commercial use''' of the work
 
Under the following conditions:
 
*'''Attribution''' —  You must attribute the work in the manner specified by the author or licensor (but not in any way that suggests that they endorse you or your use of the work).  
*'''Share Alike''' — If you alter, transform, or build upon this work, you may distribute the resulting work only under the same or similar license to this one.
 
== Downloading ==
== Downloading ==


We use GitHub to host our project. Read [[Setting up git|this guide]] on how to use GitHub.
We use GitHub to host our project.
 
* Go to [https://github.com/NTStation/NTstation13]
* Download the source code as a ZIP file, it is about 32MB


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 use [http://code.google.com/p/tortoisegit/ TortoiseGit].  
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.


#After installing it, go to the [https://github.com/NTStation/NTstation13 NT Station GitHub page].
[[File:Download za git.png]]
#Copy the HTTP link.
#In Windows Explorer, right-click the folder you wish to store the code in and click "Git Clone..."
#In the URL field, paste the HTTP link.
#Click OK. The code will begin downloading.
 
== Updating to the latest revision ==
 
If you have downloaded the source code using TortoiseGit, simply right-click the folder, go Git Sync..., and press the Pull button.
 
If you downloaded the code in a zip file, you need to download another zip file.
 
== "I did not change anything, but the code does not work anymore!" ==
 
This is likely due to corrupted files.
To fix this, you need to:
 
*Re-download everything
*Copy over your config folder and the data folder
*Clean compile
 
(There is no good alternative to this with TortoiseGit)


== Hosting a server ==
== Hosting a server ==


To get a simple server running first
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 NTstation13.dme in dream maker (double click it)
* 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 "NTstation13.dmb" will be created in the same folder where "NTstation13.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)
* Select the "..." in the lower right corner and select the file "NTstation13.dmb".
* 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 63: 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 69: 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 78: Line 48:
* Go to the following address in your browser: [http://localhost/phpmyadmin http://localhost/phpmyadmin] (will only work once you start up both Apache and MySQL in the XAMPP Control Panel)
* Go to the following address in your browser: [http://localhost/phpmyadmin http://localhost/phpmyadmin] (will only work once you start up both Apache and MySQL in the XAMPP Control Panel)
* Click on the button titled SQL in the row of buttons at the top.
* Click on the button titled SQL in the row of buttons at the top.
* Open the file 'SQL/tgstation_schema.sql' in notepad and copy its content. You can also find it [https://github.com/NTStation/NTstation13/blob/master/SQL/tgstation_schema.sql here], but it may be newer than the version you are using.
* Open the file 'SQL/tgstation_schema.sql' in notepad and copy its content. You can also find it [https://github.com/tgstation/-tg-station/blob/master/SQL/tgstation_schema.sql here], but it may be newer than the version you are using.
* Paste the file's content into the input field for sql in phpmyadmin and hit 'Execute' in the bottom right
* Paste the file's content into the input field for sql in phpmyadmin and hit 'Execute' in the bottom right
* Once you execute this, a new database should be added to the list on the left, called 'feedback'. If not, refresh the page. If you click on the database, it should show you all the tables it includes. At this point, you have created the database 'infrastructure'. You now have to create a user for it.
* Once you execute this, a new database should be added to the list on the left, called 'feedback'. If not, refresh the page. If you click on the database, it should show you all the tables it includes. At this point, you have created the database 'infrastructure'. You now have to create a user for it.
* Click on 'SQL' in the top again, and execute the following statement: CREATE USER 'myuser'@'localhost' IDENTIFIED BY 'mypass'; GRANT ALL ON feedback.* TO 'myuser'@'%'; Replace both instances of myuser with some username and mypass with some password. Be careful to copy all the apostrophes. This will create a new user and grant him all privileges for the feedback database.
* Click on 'SQL' in the top again, and execute the following statement: CREATE USER 'myuser'@'localhost' IDENTIFIED BY 'mypass'; GRANT ALL ON feedback.* TO 'myuser'@'%'; Replace both instances of myuser with some username and mypass with some password. Be careful to copy all the apostrophes. This will create a new user and grant him all privileges for the feedback database.
* Please keep phpmyadmin open for a while longer.
* Please keep phpmyadmin open for a while longer.
* Open the file: [https://github.com/NTStation/NTstation13/blob/master/config/dbconfig.txt config/dbconfig.txt] in notepad
* Open the file: [https://github.com/tgstation/-tg-station/blob/master/config/dbconfig.txt config/dbconfig.txt] in notepad
* Make sure to set it so that:
* Make sure to set it so that:
** SQL_ENABLED does not have a # in front of it
** SQL_ENABLED does not have a # in front of it
Line 95: 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 [http://www.ss13.eu/tgdb/banoverview.php ban log] (Arrange with errorage/rageroro in [[Community|#nanobus]]).  
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 120: Line 90:
* 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>
</div>
If you need more help contact '''Errorage/Rageroro''' in [[Community|#nanobus]].
If you need more help contact [[Community|#coderbus]].


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==
[To be filled by administration / coders]




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

edits

Retrieved from "https://wiki.yogstation.net/wiki/Special:MobileDiff/3595...31927"

Navigation menu