Setup

« Back to PlayerServers Wiki

Installation »

If BungeeCord is in online mode, make sure BungeeCord & your Spigot servers are setup correctly to get online-mode UUIDs! Spigot-side permissions, server ownership detection, and other UUID-based things will break otherwise!

1. Put PlayerServers.jar into the BungeeCord plugins folder.

2. Symlink (recommended) OR copy PlayerServers.jar into all your existing Spigot server plugin folders. (or at least to your hub/any servers you want people to be able to start PlayerServers from, use join/template GUIs, get bukkit permissions, etc).

3. Start and stop BungeeCord to generate plugin config & folders.

4. Setup default template in plugins/PlayersServers/templates/default folder

   • Make sure to at LEAST put a spigot.jar in the default template folder, or nothing will work.
   • Change name and other settings in the templates PlayerServers.yml to your liking.
   • It is up to you to supply your own spigot.jar

5. Restart Spigot servers to load PlayerServers helper plugin (the same PlayerServers.jar, install on your hub/other servers as mentioned in step 2). Startup BungeeCord and create your own server (/ps create) to test.

Done!

Optional steps & suggestions »

• When updating spigot.jar or plugin .jars in the template folder KEEP THE NAME EXACTLY THE SAME. I suggest removing version strings, etc from plugin file names, ie name them "Essentials.jar"
• If you have something else running on port 5155 and are using the 'default' wrapper, be sure to change the wrapper-control-port setting in config.yml!
• If you want to use the default server wrapper (aka PSWrapper.jar), you should use the Java version required for your Player Server!
• If you want to use screen as your server wrapper, ensure screen is installed with the commands below and set wrapper in config.yml to 'screen'.
  • Debian/Ubuntu: run sudo apt-get install screen
  • CentOS/Fedora: run sudo yum install screen
• For using the remote wrapper, launch it with java 8 via java -jar wrapper.jar 5155 debug(optional)
• Edit messages.yml to your liking. (replace all "server" to "empire" for example, if you want to call PlayerServers "Empires")
• Create multiple templates by copying the default template, customizing it, and modifying its PlayerServers.yml
• If you want to store player servers in a place other than the PlayerServers plugin folder, edit the servers-folder option in the config BEFORE creating servers or you'll have to manually move them.
• Startup & stop scripts are found in the plugins/PlayerServers/scripts folder and can be customized to your liking, using the variables listed at the top of them. These are only used when the wrapper is set to 'screen'.