Downloading the source code: Difference between revisions

From BeeStation Wiki
Jump to navigation Jump to search
m (updates to current file size)
 
(3 intermediate revisions by one other user not shown)
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 200MB 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 Local Server ==
== Hosting Your Server Local Server ==
To get a simple server running first
To get a simple server running first
Line 29: Line 29:
*You can disable random events in the server tab.
*You can disable random events in the server tab.
*You can instantly start the round with the "start now" button in the round tab.
*You can instantly start the round with the "start now" button in the round tab.
*You can give yourself loft of useful gear by using the debug option from the "select equipment" button when you right click on yourself.
*Use the "/mob/living/silicon/ai/spawned" in the game-panel to spawn a dummy AI to practice carding it.
== 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!" ====

Latest revision as of 11:04, 13 June 2024

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 200MB of data every time an update is made, you can follow this guide to set up and use Git.

Hosting Your Server Local 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".
  • Set the Security to "Trusted", to avoid excessive prompts from Dream Daemon. Only do this if you can verify that the source you have is official and safe - it is unlikely to be untrustworthy, but keep it in mind when working with any projects.
  • 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.
  • Hit Debug -> Debug-verbs Enable to get more verbs on the player's right click menu.
  • With debug verbs on, you can use the Select equipment verb on yourself to equip the Debug outfit, which has loads of useful tools and items.
  • You can spawn in /obj/item/disk/tech_disk/debug, or equip yourself with Debug stuff (rightclick, and under the lengthy menu and use Select Equipment) You can also spawn in just a box of debug tools with /obj/item/storage/box/debugtools, but I find changing equipment to be faster.
  • Right click on yourself and then go: Show player panel > Show traitor panel to make yourself an antag.
  • If you ghost you can click-drag anything to posses it.
  • Use spawn-human to, you guessed it, spawn a human.
  • You can disable random events in the server tab.
  • You can instantly start the round with the "start now" button in the round tab.
  • Use the "/mob/living/silicon/ai/spawned" in the game-panel to spawn a dummy AI to practice carding it.

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