Downloading the source code: Difference between revisions
Itsmeowdev (talk | contribs) (Update database link and git guide link) |
Itsmeowdev (talk | contribs) m (→Downloading: Add note on how to download zip) |
||
| Line 5: | Line 5: | ||
We use GitHub to host our project. | We use GitHub to host our project. | ||
A zip download is available here: [https://github.com/BeeStation/BeeStation-Hornet] | A zip download is available here: [https://github.com/BeeStation/BeeStation-Hornet] (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. | 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. | ||
| Line 32: | Line 32: | ||
== Setting up the database == | == Setting up the database == | ||
'''See [[Working with the database]].''' | '''See [[Working with the database]].''' | ||
{{Contribution guides}} | {{Contribution guides}} | ||
[[Category:Guides]] [[Category:Game Resources]] | [[Category:Guides]] [[Category:Game Resources]] | ||
Revision as of 21:24, 27 March 2023
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 BeeStation source code is under GNU AGPL v3 license and the assets are CC-BY-SA.
Downloading
We use GitHub to host our project.
A zip download is available here: [1] (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.
"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
If you're using git reset hard against the BeeStation upstream master branch and then recompile
Hosting a server
To get a simple server running first
- Download the source code as explained above
- Run BUILD.bat
- Wait until it compiles. Once it does a new file "beestation.dmb" will be created in the same folder where "beestation.dme" is. The dmb file has an orange icon. Compile time usually takes between 1 and 3 minutes, depending on your computer.
- Open dream daemon (Win7: start menu > all programs > BYOND > Dream Daemon; Win8/10: start > type Dream Daemon > Dream Daemon)
- 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 button (former "...") to auto-join
- Left click the link (byond://xxx.xxx.xxx.xxx:xxxxx) to copy it to clipboard
- 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, edit the hub config option https://github.com/BeeStation/BeeStation-Hornet/blob/master/config/config.txt#L26
Setting up the database
See Working with the database.
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 |