You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 626402d
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+66-14Lines changed: 66 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,10 @@ The simplest way to obtain the code is using the github .zip feature.
9
9
10
10
Click [here](https://github.com/ParadiseSS13/Paradise/archive/master.zip) to get the latest code as a .zip file, then unzip it to wherever you want.
11
11
12
-
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:
12
+
The more complicated and easier to update method is using git.
13
+
You'll need to download git or some client from [here](http://git-scm.com/).
14
+
When that's installed, right click in any folder and click on "Git Bash".
@@ -19,25 +22,45 @@ This will take a while to download, but it provides an easier method for updatin
19
22
20
23
### INSTALLATION
21
24
22
-
First-time installation should be fairly straightforward. First, you'll need BYOND installed. You can get it from [here](http://www.byond.com/).
25
+
First-time installation should be fairly straightforward.
26
+
First, you'll need BYOND installed.
27
+
You can get it from [here](http://www.byond.com/).
23
28
24
-
This is a sourcecode-only release, so the next step is to compile the server files. Open paradise.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:
29
+
This is a sourcecode-only release, so the next step is to compile the server files.
30
+
Open paradise.dme by double-clicking it, open the Build menu, and click compile.
31
+
This'll take a little while, and if everything's done right,
32
+
you'll get a message like this:
25
33
26
34
saving paradise.dmb (DEBUG mode)
27
-
35
+
28
36
paradise.dmb - 0 errors, 0 warnings
29
37
30
-
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.
38
+
If you see any errors or warnings,
39
+
something has gone wrong - possibly a corrupt download or the files extracted wrong,
40
+
or a code issue on the main repo. Ask on IRC.
31
41
32
-
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 location so that all your players don't get disconnected at the end of each round. It's recommended you don't turn on the gamemodes with probability 0, as they have various issues and aren't currently being tested, so they may have unknown and bizarre bugs.
42
+
Once that's done, open up the config folder.
43
+
You'll want to edit config.txt to set your server location,
44
+
so that all your players don't get disconnected at the end of each round.
45
+
It's recommended you don't turn on the gamemodes with probability 0,
46
+
as they have various issues and aren't currently being tested,
47
+
so they may have unknown and bizarre bugs.
33
48
34
-
You'll also want to edit admins.txt to remove the default admins and add your own. "Host" is the highest level of access, and the other recommended admin levels for now are "Game Admin" and "Moderator". The format is:
49
+
You'll also want to edit admins.txt to remove the default admins and add your own.
50
+
"Host" is the highest level of access, and the other recommended admin levels for now are
51
+
"Game Admin" and "Moderator". The format is:
35
52
36
53
byondkey - Rank
37
54
38
-
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.
55
+
where the BYOND key must be in lowercase and the admin rank must be properly capitalised.
56
+
There are a bunch more admin ranks, but these two should be enough for most servers,
57
+
assuming you have trustworthy admins.
39
58
40
-
Finally, to start the server, run Dream Daemon and enter the path to your compiled paradise.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.
59
+
Finally, to start the server,
60
+
run Dream Daemon and enter the path to your compiled paradise.dmb file.
61
+
Make sure to set the port to the one you specified in the config.txt,
62
+
and set the Security box to 'Trusted'.
63
+
Then press GO and the server should start up and be ready to join.
41
64
42
65
---
43
66
@@ -46,7 +69,9 @@ Finally, to start the server, run Dream Daemon and enter the path to your compil
46
69
To update an existing installation, first back up your /config and /data folders
47
70
as these store your server configuration, player preferences and banlist.
48
71
49
-
If you used the zip method, you'll need to download the zip file again and unzip it somewhere else, and then copy the /config and /data folders over.
72
+
If you used the zip method,
73
+
you'll need to download the zip file again and unzip it somewhere else,
74
+
and then copy the /config and /data folders over.
50
75
51
76
If you used the git method, you simply need to type this in to git bash:
52
77
@@ -66,16 +91,43 @@ For a basic setup, simply copy every file from config/example to config.
66
91
67
92
### SQL Setup
68
93
69
-
The SQL backend for the library and stats tracking requires a MySQL server. Your server details go in /config/dbconfig.txt, and the SQL schema is in /SQL/paradise_schema.sql and /SQL/paradise_schema_prefix.sql depending on if you want table prefixes. More detailed setup instructions are located on /tg/station's wiki: http://www.tgstation13.org/wiki/Downloading_the_source_code#Setting_up_the_database
94
+
The SQL backend for the library and stats tracking requires a MySQL server.
95
+
Your server details go in /config/dbconfig.txt,
96
+
and the SQL schema is in /SQL/paradise_schema.sql or /SQL/paradise_schema_prefix.sql,
97
+
depending on if you want table prefixes.
98
+
More detailed setup instructions are located on /tg/station's wiki: http://www.tgstation13.org/wiki/Downloading_the_source_code#Setting_up_the_database
70
99
71
100
---
72
101
73
102
### IRC Bot Setup
74
103
75
-
Included in the repo is an IRC bot capable of relaying adminhelps to a specified IRC channel/server (thanks to Skibiliano). Instructions for bot setup are included in the /bot/ folder along with the bot/relay script itself.
104
+
Included in the repo is an IRC bot capable of relaying adminhelps to a specified IRC
105
+
channel/server (thanks to Skibiliano).
106
+
Instructions for bot setup are included in the /bot/ folder,
107
+
along with the bot/relay script itself.
76
108
77
109
### LICENSE
78
110
79
-
Paradise is licensed under the GNU Affero General Public License version 3 as of 5th January 2015 any new contributions are licensed under the AGPL as well, if you wish to submit code under the GPL v3 then commits and files must be marked as so in comments. If you wish to use our code in a closed source manner you may use anything before commit 445615b8439bf606ff204a42c8e7b6b69d983255 which is licensed under GPL v3. The major change here is that if you host a server using any code licensed under AGPL you are required to provide full source code for your servers users as well including addons and modifications you have made.
111
+
Paradise is licensed under the GNU Affero General Public License version 3.
112
+
As of 5th January 2015 any new contributions are licensed under the AGPL as well,
113
+
if you wish to submit code under the GPL v3 then commits and files must be marked as such
114
+
in comments. If you wish to use our code in a closed source manner you may use anything
115
+
before commit 445615b8439bf606ff204a42c8e7b6b69d983255,
116
+
which is licensed under GPL v3.
117
+
The major change here is that if you host a server using any code licensed under AGPL you
118
+
are required to provide full source code for your servers users as well,
119
+
including addons and modifications you have made.
120
+
121
+
See [this](https://www.gnu.org/licenses/why-affero-gpl.html) for more information.
122
+
123
+
Any files located in the `Paradise/icons/goonstation` and `Paradise/sound/goonstation`
124
+
folders, and any of their subdirectories, are licensed under the
0 commit comments