Upstream
/
SubServers-2
mirror of https://github.com/ME1312/SubServers-2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Page: Installation
Pages
Commands and Permissions Configuration Designing Your Network Home How It Works Installation Integrations SubAPI SubCreator SubData
25 Installation
ME1312 edited this page 2022-04-10 00:40:57 -04:00
Unescape Escape
Table of Contents
This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

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

Topics on This Page:
SubServers.Bungee
SubServers.Host
SubServers.Sync
SubServers.Client
SubServers.Console

System Requirements

These are the general requirements for running SubServers apps on popular platforms.

Requirements for Windows systems

Java doesn't install itself correctly on Windows.
So, if you're having trouble using SubServers, make sure your system doesn't have the following issues:

If you have a 64-bit system and downloaded from java.com, you will have received 32-bit java – which will cause you problems down the line. See if this happened to you by running /sub version and verifying that the value in [brackets] is the same for both Windows and Java. If it is not, download the right version for your system from oracle.com directly.

Java does not make all development commands accessible in the command prompt like it does on other platforms for some reason. As such, commands like jar, that are used by the SubServers Library Patcher, will fail to work properly. To correct this issue, follow this instructional video on how to add the missing commands to your system's PATH variable.

Requirements for MacOS and Unix-based systems

  • Java Development Kit 8+
  • The following additional commands need to be available in the command line:
    • curl or wget
    • git
    • bash
    • setsid (optional)

SubServers.Bungee

The main SubServers 2 app is known as SubServers.Bungee. If you came from that page, this is what you're looking for.
Please make sure your system meets the requirements above before continuing.

  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.Bungee via your terminal: java -jar SubServers.Bungee.jar
  6. All commands can be accessed in console using /sub help

Tips for first-time users of SubServers

  • The host included by default is ~
  • The first server you create should be named Lobby so that we know where to send players when they first join. You can change this setting in BungeeCord's own config.yml

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 its 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 your favorite commit of SubServers.Host (Click Here for the latest commit)
  2. Put it in a folder
  3. Start SubServers.Host (it should give you an error)
  4. If your on a different network than SubServers.Bungee:
    4.1. Port forward the SubData Direct port (default 4391).
    4.2. Port forward a range of ports to use with servers hosted by SubServers.Host
  5. Open config.yml for SubServers.Bungee
  6. Copy and Paste the default host config to add another host (optional)
  7. Change Driver to NETWORK
  8. Change Address to the address of where SubServers.Host will be
  9. Open config.yml for SubServers.Host
  10. Tell it how to connect to SubData
    10.1. Don't forget the extra encryption instructions provided to you by SubServers.Bungee at startup
    10.2. Change Settings > SubData > Name to whatever you named this host in SubServers.Bungee's config.yml
  11. You can now start up your host
  12. All SubServers.Host commands can be accessed in console by using /help

SubServers.Sync

Velocity Instructions

  1. Download your favorite commit of SubServers.Sync (Click Here for the latest commit)
  2. Put it in Velocity's plugins folder
  3. Start, then stop your proxy
  4. Open sync.yml
  5. Tell it how to connect to SubData
    5.1. Don't forget the extra encryption instructions provided to you by SubServers.Bungee at startup
    5.2. Change Settings > SubData > Name to whatever you want this proxy to be called (optional)
  6. You can now start up your proxy
  7. All commands can be accessed in console using /sub help

BungeeCord Instructions

  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. Open sync.yml
  7. Tell it how to connect to SubData
    7.1. Don't forget the extra encryption instructions provided to you by SubServers.Bungee at startup
    7.2. Change Settings > SubData > Name to whatever you want this proxy to be called (optional)
  8. You can now launch SubServers.Sync via your terminal: java -jar SubServers.Sync.jar
  9. 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 its 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. Tell it how to connect to SubData
    5.1. Don't forget the extra encryption instructions provided to you by SubServers.Bungee at startup
    5.2. Change Settings > SubData > Name to whatever you named this server in BungeeCord/SubServers (optional, unless otherwise specified)
  6. You can now start up 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. You can now start up your proxy
  4. You can now access the commands /popout and /autopopout