Install

ME1312 edited this page Sep 8, 2018 · 26 revisions

This page explains how to install SubServers 2 Add-ons. If you are having problems starting SubServers, be sure to check that your configs are up-to-date.

Prerequisites

These are the general requirements of SubServers for most platforms. Machines running SubServers apps should be up to these standards.

Windows:

MacOS/Linux:

  • Java JDK 8 or above
  • Make sure the following commands are available on your system:
    • curl (or wget)
    • git

SubServers.Bungee

The main SubServers 2 add-on is known as SubServers.Bungee. If you came from that page, this is probably what you're looking for.

  1. Download BungeeCord (Link)
  2. Name it BungeeCord.jar (case-sensitive)
  3. Download your favorite commit of SubServers.Bungee (Click Here for the latest commit)
  4. Put them both in a folder together
  5. You can now launch SubServers via your terminal: java -jar SubServers.Bungee.jar
  6. All commands can be accessed in console using /sub help

Patching in BungeeCord

This is an extra set of steps you may need to do if SubServers.Bungee cannot find BungeeCord.jar, despite it clearly being there. (This problem most commonly occurs in multicraft panels)

  1. For Windows users, put the path to your JDK in your PATH variable. (Click Here for a tutorial)
  2. Download SubServers.Patcher (Click Here for the latest commit)
  3. Open Bash in this folder and run this command: sh SubServers.Patcher.sh BungeeCord.jar SubServers.Bungee.jar
  4. Once finished, you should be able to use the SubServers.Patched.jar on it's own

SubServers.Host

This installation can be confusing to those who are not tech savvy, so a video version of these instructions is available here.

  1. Download GalaxiEngine (Link)
  2. Name it GalaxiEngine.jar (case-sensitive)
  3. Download your favorite commit of SubServers.Host (Click Here for the latest commit)
  4. Put them both in a folder together
  5. Start SubServers.Host (it should give you an error)
  6. If your on a different network than SubServers.Bungee:
    6.1. Port forward the SubData Direct port (default 4391).
    6.2. Port forward a range of ports to use with servers hosted by SubServers.Host
  7. Open config.yml for SubServers.Bungee
  8. Copy and Paste the default host config to add another host (optional)
  9. Change Driver to NETWORK
  10. Change Address to the address of where SubServers.Host will be
  11. Open config.yml for SubServers.Host
  12. Enter your SubData Direct info
    12.1. Change Settings > SubData > Name to whatever you named this host in SubServers.Bungee's config.yml
  13. You can now startup your host
  14. All SubServers.Host commands can be accessed in console by using /help

Patching in GalaxiEngine

This is an extra set of steps you may need to do if SubServers.Host cannot find GalaxiEngine.jar, despite it clearly being there. (This problem most commonly occurs in multicraft panels)

  1. For Windows users, put the path to your JDK in your PATH variable. (Click Here for a tutorial)
  2. Download SubServers.Patcher (Click Here for the latest commit)
  3. Open Bash in this folder and run this command: sh SubServers.Patcher.sh GalaxiEngine.jar SubServers.Host.jar
  4. Once finished, you should be able to use the SubServers.Patched.jar on it's own

SubServers.Sync

  1. Download BungeeCord (Link)
  2. Name it BungeeCord.jar (case-sensitive)
  3. Download your favorite commit of SubServers.Sync (Click Here for the latest commit)
  4. Put them both in a folder together
  5. Start SubServers.Sync (it should give you an error)
  6. Enter your SubData Direct info in ~/SubServers/sync.yml
  7. You can now launch SubServers via your terminal: java -jar SubServers.Sync.jar
  8. All commands can be accessed in console using /sub help

Patching in BungeeCord

This is an extra set of steps you may need to do if SubServers.Sync cannot find BungeeCord.jar, despite it clearly being there. (This problem most commonly occurs in multicraft panels)

  1. For Windows users, put the path to your JDK in your PATH variable. (Click Here for a tutorial)
  2. Download SubServers.Patcher (Click Here for the latest commit)
  3. Open Bash in this folder and run this command: sh SubServers.Patcher.sh BungeeCord.jar SubServers.Sync.jar
  4. Once finished, you should be able to use the SubServers.Patched.jar on it's own

SubServers.Client

  1. Download your favorite commit of SubServers.Client (Click Here for the latest commit)
  2. Put SubServers.Client into your server's plugins folder
  3. Start, then stop your server
  4. Open config.yml
  5. Enter your SubData Direct info
    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)
  6. You can now startup your server
  7. All SubServers.Client commands can be accessed in-game by using /sub help

SubServers.Console

  1. Download your favorite commit of SubServers.Console (Click Here for the latest commit)
  2. Put SubServers.Console into your proxy's plugins
  3. Start your proxy
  4. You can now access the commands /popouts and /popoutc for subservers and subcreator instances respectively
Clone this wiki locally
You can’t perform that action at this time.
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.
Press h to open a hovercard with more details.