cyberpresidentvanellope/Yogstation
1
0
Fork 0
mirror of https://github.com/yogstation13/Yogstation.git synced 2025-02-26 09:04:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md (#11501)

Browse Source 
* Update README.md

* Update README.md
This commit is contained in:
TheGamerdk
2021-06-01 18:39:50 +02:00
committed by GitHub
parent ae3c0ef400
commit 047ead7f77
1 changed files with 16 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -35,24 +35,30 @@ code tab of https://github.com/yogstation13/Yogstation
(note: this will use a lot of bandwidth if you wish to update and is a lot of
hassle if you want to make any changes at all, so it's not recommended.)
## The Yogstation codebase does NOT support compiling on BYOND versions above [513.1538](http://www.byond.com/download/build/513/)
## :exclamation: How to compile :exclamation:
Recently we have changed the way to compile the codebase.
Find `BUILD.bat` here in the root folder of yogstation, and double click it to initiate the build. It consists of multiple steps and might take around 1-5 minutes to compile.
After it finishes, you can then setup the server normally by opening `yogstation.dmb` in DreamDaemon. See further down for instructions
**Building yogstation in DreamMaker directly is now deprecated and might produce errors**, such as `'tgui.bundle.js': cannot find file`.
## INSTALLATION
First-time installation should be fairly straightforward. First, you'll need
BYOND installed. You can get it from https://www.byond.com/download. Once you've done
that, extract the game files to wherever you want to keep them. This is a
sourcecode-only release, so the next step is to compile the server files.
Open yogstation.dme by double-clicking it, open the Build menu, and click
compile. This'll take a little while, and if everything's done right you'll get
a message like this:
```
saving yogstation.dmb (DEBUG mode)
yogstation.dmb - 0 errors, 0 warnings
```
Follow the above steps to do this.
If you see any errors or warnings, something has gone wrong - possibly a corrupt
download or the files extracted wrong. If problems persist, ask for assistance
in irc://irc.rizon.net/coderbus or in #development-public on discord.
in #development-public on discord.
Once that's done, open up the config folder. You'll want to edit config.txt to
set the probabilities for different gamemodes in Secret and to set your server
@@ -82,7 +88,7 @@ repo](https://github.com/tgstation/rust-g).
Finally, to start the server, run Dream Daemon and enter the path to your
compiled yogstation.dmb file. Make sure to set the port to the one you
specified in the config.txt, and set the Security box to 'Safe'. Then press GO
specified in the config.txt, and set the Security box to 'Trusted'. Then press GO
and the server should start up and be ready to join. It is also recommended that
you set up the SQL backend (see below).