cyberpresidentvanellope/CHOMPStation2
1
0
Fork 0
mirror of https://github.com/CHOMPStation2/CHOMPStation2.git synced 2025-12-10 10:12:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated README.md to reflect name

Browse Source
This commit is contained in:
Arokha Sieyes
2016-05-07 14:18:24 -04:00
parent 454cc25cba
commit cc83aadca1
1 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -1,13 +1,13 @@
# polaris
# vorestation
[Forums](http://ss13polaris.com/forums/) - [Wiki](http://ss13polaris.com/wiki/doku.php)
[Forums](http://forum.vore-station.net/) - [Wiki](http://wiki.vore-station.net/)
Polaris is a fork of the Baystation12 code branch for the game Spacestation13.
VOREStation is a fork of the Polaris code branch, itself a fork of the Baystation12 code branch, for the game Spacestation13.
---
### LICENSE
Polaris is licensed under the GNU Affero General Public License version 3, which can be found in full in LICENSE-AGPL3.txt.
VOREStation is licensed under the GNU Affero General Public License version 3, which can be found in full in LICENSE-AGPL3.txt.
Commits with a git authorship date prior to `1420675200 +0000` (2015/01/08 00:00) are licensed under the GNU General Public License version 3, which can be found in full in LICENSE-GPL3.txt.
@@ -20,11 +20,11 @@ See [here](https://www.gnu.org/licenses/why-affero-gpl.html) for more informatio
### GETTING THE CODE
The simplest way to obtain the code is using the github .zip feature.
Click [here](https://github.com/PolarisSS13/Polaris/archive/master.zip) to get the latest code as a .zip file, then unzip it to wherever you want.
Click [here](https://github.com/VOREStation/VOREStation/archive/master.zip) to get the latest code as a .zip file, then unzip it to wherever you want.
The more complicated and easier to update method is using git. You'll need to download git or some client from [here](http://git-scm.com/). When that's installed, right click in any folder and click on "Git Bash". When that opens, type in:
git clone https://github.com/PolarisSS13/Polaris.git
git clone https://github.com/VOREStation/VOREStation.git
(hint: hold down ctrl and press insert to paste into git bash)
@@ -32,20 +32,20 @@ This will take a while to download, but it provides an easier method for updatin
Once the repository is in place, run this command:
```bash
cd Polaris
git update-index --assume-unchanged polaris.int
cd VOREStation
git update-index --assume-unchanged vorestation.int
```
Now git will ignore changes to the file polaris.int.
Now git will ignore changes to the file vorestation.int.
### INSTALLATION
First-time installation should be fairly straightforward. First, you'll need BYOND installed. You can get it from [here](http://www.byond.com/).
This is a sourcecode-only release, so the next step is to compile the server files. Open polaris.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:
This is a sourcecode-only release, so the next step is to compile the server files. Open vorestation.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 polaris.dmb (DEBUG mode)
saving vorestation.dmb (DEBUG mode)
polaris.dmb - 0 errors, 0 warnings
vorestation.dmb - 0 errors, 0 warnings
If you see any errors or warnings, something has gone wrong - possibly a corrupt download or the files extracted wrong, or a code issue on the main repo. Ask on IRC.
@@ -57,7 +57,7 @@ You'll also want to edit admins.txt to remove the default admins and add your ow
where the BYOND key must be in lowercase and the admin rank must be properly capitalised. There are a bunch more admin ranks, but these two should be enough for most servers, assuming you have trustworthy admins.
Finally, to start the server, run Dream Daemon and enter the path to your compiled polaris.dmb file. Make sure to set the port to the one you 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.
Finally, to start the server, run Dream Daemon and enter the path to your compiled vorestation.dmb file. Make sure to set the port to the one you 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.
---