Updated Install (markdown)

ME1312 2018-01-28 23:50:03 -05:00
parent 6a06ed7dc0
commit d8a08c02c6

@ -16,42 +16,44 @@ __MacOS/Linux__:
## SubServers.Bungee & SubServers.Sync ## SubServers.Bungee & SubServers.Sync
1. Download BungeeCord ([Link](https://www.spigotmc.org/link-forums/bungeecord.28/)) 1. Download BungeeCord ([Link](https://www.spigotmc.org/link-forums/bungeecord.28/))
2. Download your favorite commit of SubServers.Bungee/SubServers.Sync ([Click Here](https://github.com/ME1312/SubServers-2/tree/master/Artifacts) for the latest commit) 2. Download your favorite commit of SubServers.Bungee/SubServers.Sync ([Click Here](https://github.com/ME1312/SubServers-2/tree/master/Artifacts) for the latest commit)
3. Put them both in a folder together. It should now look like this:<br> 3. Put them both in a folder together
![Example Folder](https://s30.postimg.org/qhcx95jep/Screen_Shot_2016_12_15_at_4_30_15_PM.png) 4. For SubServers.Sync, you must enter your SubData Direct info in `~/SubServers/sync.yml`
4. For SubServers.Sync, you must enter your SubData Direct information in `~/SubServers/sync.yml`
5. You can now launch SubServers via your terminal: `java -jar SubServers.Bungee.jar` 5. You can now launch SubServers via your terminal: `java -jar SubServers.Bungee.jar`
6. All SubServers.Bungee commands can be accessed in console using `/sub help` 6. All commands can be accessed in console using `/sub help`
### Patching in BungeeCord ### Patching in BungeeCord
This is an extra set of steps you may need to do if SubServers cannot find BungeeCord.jar, despite it clearly being there. (This problem most commonly occurs in multicraft panels) This is an extra set of steps you may need to do if SubServers cannot find BungeeCord.jar, despite it clearly being there. (This problem most commonly occurs in multicraft panels)
1. Download SubServers.Bungee.Patcher ([Click Here](https://github.com/ME1312/SubServers-2/tree/master/Artifacts) for the latest commit) 1. Download SubServers.Bungee.Patcher ([Click Here](https://github.com/ME1312/SubServers-2/tree/master/Artifacts) for the latest commit)
2. Open Bash in this folder and run this command: `sh SubServers.Bungee.Patcher.sh BungeeCord.jar SubServers.Bungee.jar` 2. Open Bash in this folder and run this command: `sh SubServers.Bungee.Patcher.sh BungeeCord.jar SubServers.Bungee.jar`
3. Once finished, you should be able to use the SubServers.Patched.jar 3. Once finished, you should be able to use the SubServers.Patched.jar on it's own
## SubServers.Host ## SubServers.Host
1. Download your favorite commit of SubServers.Host ([Click Here](https://github.com/ME1312/SubServers-2/tree/master/Artifacts) for the latest commit) 1. Download your favorite commit of SubServers.Host ([Click Here](https://github.com/ME1312/SubServers-2/tree/master/Artifacts) for the latest commit)
2. Put it in it's own folder 2. Put it in it's own folder
3. Start SubServers.Host (it should give you an error) 3. Start SubServers.Host (it should give you an error)
4. If your on a different network than SubServers.Bungee, Port forward the SubData Direct port (default `4391`) and whatever ports you would like to use for your server. 4. If your on a different network than SubServers.Bungee:<br>
4.1. Port forward the SubData Direct port (default `4391`).<br>
4.2. Whitelist the machine running SubServers.Host in SubData<br>
4.3. Port forward a range of ports to use with servers hosted by SubServers.Host
5. Open config.yml for SubServers.Bungee 5. Open config.yml for SubServers.Bungee
6. Copy and Paste the default host config to add another host (optional) 6. Copy and Paste the default host config to add another host (optional)
7. Change `Driver` to `NETWORK` 7. Change `Driver` to `NETWORK`
8. Change `Address` to the address of where SubServers.Host will be 8. Change `Address` to the address of where SubServers.Host will be
9. Open config.yml for SubServers.Host 9. Open config.yml for SubServers.Host
10. Change `Settings > SubData > Name` to whatever you named this host in SubServers 10. Enter your SubData Direct info<br>
11. Make sure SubData Client can connect to your SubData Server (using the ip and password in the config) 10.1 Change `Settings > SubData > Name` to whatever you named this host in SubServers.Bungee's config.yml
12. You can now startup your host 11. You can now startup your host
13. All SubServers.Host commands can be accessed in console by using `/help` 12. All SubServers.Host commands can be accessed in console by using `/help`
## SubServers.Client ## SubServers.Client
1. Download your favorite commit of SubServers.Client ([Click Here](https://github.com/ME1312/SubServers-2/tree/master/Artifacts) for the latest commit) 1. Download your favorite commit of SubServers.Client ([Click Here](https://github.com/ME1312/SubServers-2/tree/master/Artifacts) for the latest commit)
2. Put SubServers.Client into your server's plugins 2. Put SubServers.Client into your server's plugins folder
3. Start, then stop your server 3. Start, then stop your server
4. Open config.yml 4. Open config.yml
5. Change `Settings > SubData > Name` to whatever you named this server in BungeeCord/SubServers 5. Enter your SubData Direct info<br>
6. Make sure SubData Client can connect to your SubData Server (using the ip and password in the config) 5.1. Change `Settings > SubData > Name` to whatever you named this server in BungeeCord/SubServers (only required if server cannot be auto-linked by subdata)
7. You can now startup your server 6. You can now startup your server
8. All SubServers.Client commands can be accessed in-game by using `/sub help` 7. All SubServers.Client commands can be accessed in-game by using `/sub help`
## SubServers.Console ## SubServers.Console
1. Download your favorite commit of SubServers.Console ([Click Here](https://github.com/ME1312/SubServers-2/tree/master/Artifacts) for the latest commit) 1. Download your favorite commit of SubServers.Console ([Click Here](https://github.com/ME1312/SubServers-2/tree/master/Artifacts) for the latest commit)