Setup Cross server

Step 1

Set the database type to MySQL and specify the database configuration.

database:
  # Database type: SQLITE, MYSQL
  type: MYSQL
  # MySQL connection settings
  mysql:
    host: localhost
    port: 3306
    database: minecraft
    username: root
    password: password

Step 2

Install redis for testing purpose (fast, 2 min)

1. Go on Redis

2. Register or log-in with Google or something

3. Select a cloud vendor of your region

4. Click on the database named "yourname-free-db"

5. There is a parameter called Public Endpoint where you would find a very-long-hostname:port

6. In the Security section you would find username and password

7. Now you can build your redis-uri like this redis://username:password@very-long-hostname:port

8. Done

Step 3

You need to enable the cross-server setting. Specify the server_id as the name of the server that is connected to Velocity or BungeeCord. Provide the Redis connection details.

  cross_server:
    # Enable cross-server functionality
    enabled: true
    # Unique server ID (must be different for each server)
    server_id: server1
    # Server display name (with color codes)
    server_name: '&#ea435cS&#e85965e&#e66f6er&#e58577v&#e39b80e&#e1b189r'
    # Redis connection settings
    redis:
      host: localhost
      port: 6379
      user: ''
      password: ''
      database: 0
      timeout: 2000

Step 4

After configuring all the data, you need to restart the server.

It is strongly recommended not to reload the plugin using third-party plugins to avoid errors, memory leaks, and other issues.

Step 5

You have successfully enabled the cross-server feature in the plugin and can now join the queue from any server connected to the cross-server system.