Downloading the source code: Difference between revisions

From BeeStation Wiki
Jump to navigation Jump to search
(improved formatting and added tips for using the server for gameplay testing if you are a casual user)
m (title case and small formatting)
Line 1: Line 1:
== Download and License ==
== Download and License ==
This page contains the information and steps needed to download the latest version of the code, compile it and host your own server. The BeeStation source code is under [https://www.gnu.org/licenses/agpl-3.0.html GNU AGPL v3 license] and the assets are [https://freedomdefined.org/Licenses/CC-BY-SA CC-BY-SA]. We use GitHub to host our project. A zip download is available here: [https://github.com/BeeStation/BeeStation-Hornet '''DOWNLOAD'''] (Press Code -> '''Download''' ZIP) If you don't want to download 30MB of data every time an update is made, you can [[Guide to git|follow this guide]] to set up and use Git.
This page contains the information and steps needed to download the latest version of the code, compile it and host your own server. The BeeStation source code is under [https://www.gnu.org/licenses/agpl-3.0.html GNU AGPL v3 license] and the assets are [https://freedomdefined.org/Licenses/CC-BY-SA CC-BY-SA]. We use GitHub to host our project. A zip download is available here: [https://github.com/BeeStation/BeeStation-Hornet '''DOWNLOAD'''] (Press Code -> '''Download''' ZIP) If you don't want to download 30MB of data every time an update is made, you can [[Guide to git|follow this guide]] to set up and use Git.
== Hosting your server ==
== Hosting Your Server ==
To get a simple server running first
To get a simple server running first
* Download the source code as explained [[Downloading_the_source_code#Downloading|above]].
* Download the source code as explained above.
* Run '''BUILD.bat''' and wait (1-3 minutes) until it's complies. You should see file with an orange icon called "beestation.dmb."
* Run '''BUILD.bat''' and wait (1-3 minutes) until it's complies. You should see file with an orange icon called "beestation.dmb."
* Open Dream Daemon located in your BYOND install directory.
* Open Dream Daemon located in your BYOND install directory.
Line 10: Line 10:
* Click the yellow arrow button join
* Click the yellow arrow button join
* Left click the (byond://xxx.xxx.xxx.xxx:xxxxx) link to copy it to clipboard and then paste it to your friends so they can join.
* Left click the (byond://xxx.xxx.xxx.xxx:xxxxx) link to copy it to clipboard and then paste it to your friends so they can join.
== Setting up the database ==
== Setting Up the Database ==
See [[Working with the database]]. This is not required if you are just planing locally sandboxing for the purposes of testing.
See [[working with the database]] guide. This is not required if you are just planing locally sandboxing for the purposes of testing.
 
== Tips for Using the Server for Sandboxing ==
== Tips for using the server for sandboxing ==
 
* There is a secret menu in the adminbus panel that lets you fully power all areas and the SMES.
* There is a secret menu in the adminbus panel that lets you fully power all areas and the SMES.
* If your hotkeys don’t work, try going into preferences and resetting to default.
* If your hotkeys don’t work, try going into preferences and resetting to default.
Line 22: Line 20:
* Right click on a tile and use “Jump to turf” to teleport.
* Right click on a tile and use “Jump to turf” to teleport.
* If all the extra tabs and options are distracting, you can use the deadmin command to become a normal player. You can readmin at any time.
* If all the extra tabs and options are distracting, you can use the deadmin command to become a normal player. You can readmin at any time.
== FAQ and Troubleshooting ==
== FAQ and Troubleshooting ==
==== "I did not change anything, but the code does not work anymore!" ====
==== "I did not change anything, but the code does not work anymore!" ====
This is likely due to corrupted files.
This is likely due to corrupted files.
Line 32: Line 28:
*Clean compile
*Clean compile
If you're using git reset hard against the BeeStation upstream master branch and then recompile.
If you're using git reset hard against the BeeStation upstream master branch and then recompile.
==== Do I need to for a BYOND membership to make my server visible? ====
==== Do I need to for a BYOND membership to make my server visible? ====
You '''DO NOT NEED''' to pay for membership to make your server visible on byond.com! To make your server show up, edit the hub config option https://github.com/BeeStation/BeeStation-Hornet/blob/master/config/config.txt#L26
You '''DO NOT NEED''' to pay for membership to make your server visible on byond.com! To make your server show up [[beerepo:blob/master/config/config.txt#L26|change this hub config option]].




{{Contribution guides}}
{{Contribution guides}}
[[Category:Guides]] [[Category:Game Resources]]
[[Category:Guides]] [[Category:Game Resources]]

Revision as of 13:36, 3 June 2023

Download and License

This page contains the information and steps needed to download the latest version of the code, compile it and host your own server. The BeeStation source code is under GNU AGPL v3 license and the assets are CC-BY-SA. We use GitHub to host our project. A zip download is available here: DOWNLOAD (Press Code -> Download ZIP) If you don't want to download 30MB of data every time an update is made, you can follow this guide to set up and use Git.

Hosting Your Server

To get a simple server running first

  • Download the source code as explained above.
  • Run BUILD.bat and wait (1-3 minutes) until it's complies. You should see file with an orange icon called "beestation.dmb."
  • Open Dream Daemon located in your BYOND install directory.
  • Select the "..." in the lower right corner and select the file "beestation.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 yellow arrow button join
  • Left click the (byond://xxx.xxx.xxx.xxx:xxxxx) link to copy it to clipboard and then paste it to your friends so they can join.

Setting Up the Database

See working with the database guide. This is not required if you are just planing locally sandboxing for the purposes of testing.

Tips for Using the Server for Sandboxing

  • There is a secret menu in the adminbus panel that lets you fully power all areas and the SMES.
  • If your hotkeys don’t work, try going into preferences and resetting to default.
  • If you want to spawn something, use the Spawn command in the textbox. Just type the item name or what you think the name is and a menu will pop up with all the things in the game with that word in their name. For example: Spawn “spare” - will show a menu from where you can spawn the spare Capitan’s ID. Another use is Spawn “trit” - which will spawn a full Tritium canister if you want to test maxcaps.
  • Right click on a tile and use “Jump to turf” to teleport.
  • If all the extra tabs and options are distracting, you can use the deadmin command to become a normal player. You can readmin at any time.

FAQ and Troubleshooting

"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 and data folder
  • Clean compile

If you're using git reset hard against the BeeStation upstream master branch and then recompile.

Do I need to for a BYOND membership to make my server visible?

You DO NOT NEED to pay for membership to make your server visible on byond.com! To make your server show up change this hub config option.


Contribution guides
General Development, Downloading the source code / hosting a server, Guide to git, Game resources category, Guide to changelogs
Database (MySQL) Setting up the database, MySQL
Coding Understanding SS13 code, SS13 for experienced programmers, Binary flags‎, Text Formatting, Guide to signals
Mapping Guide to mapping, Map merger, Exploration Ruins
Spriting Guide to spriting
Wiki Guide to contributing to the wiki, Wikicode