Installing SSX Connector - ServerSelectorX/ServerSelectorX GitHub Wiki

• This guide is for ServerSelectorX-Premium 2.1.4-3.1.0 with ServerSelectorX-Connector 2.1.2. It may be inaccurate for older or newer versions.

SSX-Connector is responsible for sending information about a server to ServerSelectorX. This is required to display whether the server is online, how many players are online, and anything else you want to show.

It should be installed on all servers visible in a menu. For example, if you have ServerSelectorX installed on your hub server with a plotworld and survival server in the menu, install SSX-Connector on plotworld and survival, and configure them to send data to ServerSelectorX in the hub server.

To receive data from SSX-Connector, ServerSelectorX needs a network port. This port is configurable in api.yml. By default it's set to 9782, but it can be set to any other free port. If you use ServerSelectorX on more than one server, every instance of ServerSelectorX needs its own port. If you are using shared hosting you need to ask your host which port you can use.

After changing the port, use /ssx reload to reload the configuration file.

SSX-Connector needs to be configured to send data to your ServerSelectorX instance(s). Enter the address(es) of your ServerSelectorX instance(s) in config.yml.

• If you host all servers on the same machine, use localhost. For example if SSX is set to port 9782, add localhost:9782 to the addresses: list in the SSX-Connector configuration file.
• If you use shared hosting (where you only get access to a control panel, not to a full linux machine), you need to ask your server host for an extra port to use for ServerSelectorX. When you have one, add the hub IP address with the SSX port to the SSX-Connector configuration file.
• If you use Pterodactyl panel, see this wiki page.
• If you use docker-compose, use the service name as a hostname. You're using docker-compose, you know how this stuff works.
• If ServerSelectorX is installed on more than one server, you will need to add multiple addresses to the SSX-Configuration file.

Finally, set the server name option (this must match the BungeeCord server name exactly) and use /ssxc reload to reload the configuration file.

Check that SSX-Connector is sending data to ServerSelectorX using the /ssxc status command. Check that ServerSelectorX is receiving data using the /ssx status command. If it doesn't work, see the troubleshooting steps below

Addons provide more placeholders, mainly placeholders from other plugins. You should only install addons you'll actually use and remove addons if you no longer use them, to reduce performance impact. Addons do not work on Sponge, only on Spigot.

1. Download the latest addons archive
2. Addons consist of a .class file and optionally a .yml file. You can ignore any other files, unless you know what they are for and need them. The README.md file contains information on how to write an addon.
3. Look through the list of addons to see if you want to install any on your server. For those addons, drag the .class file, and .yml file if they have one, to the plugins/SSX-Connector/addons folder. Again, make sure to only install addons you actually need. Do not simply copy the entire directory contents.
4. Run /ssxc reload (or restart the server if you are using SSX-Connector 2.1.2 or older)
5. Use /ssxc addons to check if the addons were installed successfully. Use /ssxc placeholders <addon> to see which placeholders the addon has added.
6. Change configuration files for addons to your liking, and use /ssxc reload to reload.

• The port you have entered in api.yml must not be used by anything else. Don't use your Minecraft server port.
• In the connector config file, enter the SSX port, not the Minecraft server port. Does SSX-Connector give an "unexpected end of file" or "response code -1" error? You have accidentally entered the Minecraft server port.
• If you're using Pterodactyl panel see this wiki page
• Is host configured properly in api.yml? Usually it should be set to 0.0.0.0 for shared hosting, or 127.0.0.1 if you're hosting servers yourself on the same machine (without containers). Don't set it to anything else unless you really know what binding to an interface means.

• The Sponge version was made to be as similar to the spigot version as possible. You should be able to follow this guide for setting it up, except for a few minor differences such as HOCON vs YAML configuration format.
• Addons made for Spigot will not work on Sponge.
• Download here: https://cloud.rkslot.nl/s/6s2LsiFREEXG7sS