🌐First startup guide

WARNING: The configuration file undergoes many changes in updates, all aimed at making FallbackServer more user-friendly. If you find any discrepancies, feel free to contact us on our Discord server.

1) Choosing the appropriate plugin version

• Stop your proxy instance.

• Download the .zip archive and extract it, it will look like this.

• Get the appropriate version of the plugin, you can find help here.

• Now, put the .jar file inside your "plugins/" folder and start your proxy.

IMPORTANT: This step is crucial for the flawless operation of the plugin. Follow the instructions carefully.

2) Basic setup

• The plugin has now created the configuration folder, depending on your proxy type, you'll find the appropriate folder: - BungeeCord - Velocity

• Inside the folder, using a text editor, open the config.yml in edit mode.

• Search for fallback, you will see a bunch of pre-configured groups.

• Minimize your text editor and go to the root of your proxy, it will look like this: - Bungee - Velocity

• Based on your proxy type, you'll have to open the file called "config.yml" for BungeeCord or "velocity.toml" for Velocity.

• Copy the name of your hub(s), it will look similar to this: - Bungee - Velocity

• Please resume your text editor and, under the "fallback" section, add your server names to the "default" group, ensuring that the names are case-sensitive. You can find the example here.

• Maintain the configuration in "mode: DEFAULT," save all changes, and you will be prepared for the lobbies.

• As illustrated, the fallback section contains groups that allow you to customize the behavior of each server during a crash scenario. This concept is straightforward. To clarify further, I will provide an example here.

• After reviewing the previous example, your configuration should resemble the following. Please note that this is a sample intended to enhance your understanding of how the configuration operates, you can find the final example here.

• Once you have completed the necessary adjustments, simply restart your proxy or execute the command /fs reload in your console or as a player.

• You may now be wondering about the meaning of "mode: FALLBACK." The explanation is quite simple. In the event that your game servers shut down after a game concludes or if one of the servers crashes while players are still connected, FallbackServer will recognize this situation and sort your players to the lobbies you previously designated. If none of these lobbies are available or are at full capacity, the plugin will then allocate your players to the main lobbies defined under the "default" group, which you configured earlier, if none of the lobbies under "default" are available, those players will be directly disconnected.

NOTE: You are now prepared for the DEFAULT mode. If you wish to configure the RECONNECT mode, please follow the subsequent steps outlined in section 2.5.

2.5) Reconnect Mode

• Navigate to the "plugins/" directory within your proxy setup, and locate the "FallbackServer" or "FallbackServerVelocity" folder. Enter this folder and open the config.yml file using a text editor.

• Within the file, find the "fallback" section, where you will see the groups you previously configured. Decide which group will utilize reconnect mode and configure the appropriate servers. For instance, if you want all your survival servers (e.g., survival1, survival2) to use reconnect mode, list them under the "servers" section, being careful to match the exact capitalization of the server names.

• Next, under the "lobbies" section, add the lobbies where players will be sent if the reconnect fails. Again, ensure that the names are written with the correct capitalization. This step is crucial as it determines where players are redirected in case reconnect mode does not succeed.

• You can refer to the provided example for guidance.

• Once you have completed these steps, the final task is to change the mode from mode: FALLBACK to mode: RECONNECT in the configuration, then as a player or inside your console run /fs reload for applying all the changes

• With that done, your proxy setup is now complete!

3) Spigot Reconnect Addon

• If you're now here, congratulations! You're near the end of this page.

• First, navigate to the "plugins/" directory within your spigot instance and locate the "FallbackServerAddon" folder (after doing a first startup). Enter this folder and open the config.yml file using a text editor.

• Next, you will need to determine the appropriate mode for your server. The FallbackServerAddon offers two options: in STANDALONE mode, a physical server is employed for reconnection purposes. Alternatively, in ADDON mode, the server acts as a helper to notify the primary plugin once it has fully started.

• Upon opening the config.yml file, you should enter the desired mode under the mode section by specifying "NONE". After making this adjustment, run the command /fsa reload to restart the plugin with the selected mode.

• At this point, your Spigot setup will be successfully configured.

IMPORTANT: Please ensure that you configure this section correctly; failure to do so may result in the reconnect mode not functioning as intended, potentially disrupting player gameplay or causing players to be removed from the game.