AutoServer

# AutoServer ## Overview AutoServer is a Minecraft plugin designed for the (https://papermc.io/software/velocity). This plugin automatically starts offline backend servers when a player attempts to connect to them. It's perfect for server networks looking to save resources by keeping idle servers offline until needed. ## Features - Automatically starts backend servers when a player attempts to connect. - Automatically stops local servers when no players are online. - Manually start and stop backend servers using commands. - Supports configuration hot reloading. - Customizable messages. ## Getting Started This section will cover how to install and configure a minimal setup of AutoServer. 1. **Downloading AutoServer** Head over to (https://modrinth.com/plugin/autoserver/versions?l=velocity) section to get the latest version of AutoServer. After downloading AutoServer, place the JAR file into the `plugins` directory of your Velocity proxy. 2. **Launching for the first time** Once you have placed AutoServer into the `plugins` directory, we need to restart Velocity to load the plugin. On the first launch AutoServer will generate a configuration file `autoserver/config.toml` located in the `plugins` directory. 3. **Configuring your servers** Start by taking note of your `velocity.toml` file looking for the `` section. How the servers are named needs to match exactly when configuring AutoServer. Open the `autoserver/config.toml` in a text editor and search for the `` section. This section specifies the servers that AutoServer will manage. Create a table for each server you want AutoServer to manage. For example if you have a server named `lobby` you will create a table called ``. Two routes you can head with configuring a server either a remote server or a local server. If you have a remote server you need to configure check out the (#remote-backend) section for more details. For the sake of this section we will handle a local server that we have a script for. This example local server is called `lobby` here is a minimal settings to start the server using a script: ```toml # Path to the directory where the server runs. workingDirectory = "/home/user/minecraft/servers/lobby" # Command to start the "lobby" server. start = "bash start.sh" # Or if you have a Windows Batch Script # start = "start.bat" ``` 4. **Repeat for each server** Now repeat step 3 for each server you want to be managed by AutoServer. There is a lot of example commands in the *Command examples* section of this document. To help you build a command that works for your situation. ## Installation 1. Download the latest version of `autoserver-velocity-1.x.x.jar` from (https://modrinth.com/plugin/autoserver/versions?l=velocity). 2. Place the `AutoServer-velocity-x.x.x.jar` file into your Velocity `plugins` folder. 3. Restart your Velocity Proxy to load the plugin. ## Configuration After the first launch, the plugin will generate a `config.toml` file in the `plugins/autoserver` directory. Modify this file to suit your setup. ### Global | **Key** | **Type** | **Description** | |-------------------|-----------|----------------------------------------------| | `checkForUpdates` | `boolean` | Should AutoServer check for updates on boot? | | `messages` | `table` | Messages that will get sent to players. | | `servers` | `table` | The configuration for each server. | ### Messages | **Key** | **Type** | **Description** | |------------|----------|-----------------------------------------------------------------------------------------------------------| | `prefix` | `string` | Prefix added to all messages displayed to the player. | | `starting` | `string` | Message displayed to the player when they attempt to connect to a server that is currently offline. | | `failed` | `string` | Message displayed to the player if the server fails to start or cannot be connected to. | | `notify` | `string` | Message displayed to the player when the server is ready, indicating that they will be connected shortly. | ### Servers | **Key** | **Type** | **Description** | |---------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `startupDelay` | `int` | Time in seconds to wait before attempting to connect a player after starting the server.