Getting Started Configuration Commands Troubleshooting

Getting Started

Complete step-by-step guide to install Velocity Nexus

📦 Installation Step-by-Step

Step 1: Download Both Plugins

You need TWO separate JAR files:

  • velocitynexus-velocity.jar - For your Velocity proxy
  • velocitynexus-spigot.jar - For ALL your Spigot/Paper servers
Download Both Files

Step 2: Install Proxy Plugin

  1. Locate your Velocity server folder
  2. Navigate to the plugins/ directory
  3. Copy velocitynexus-velocity.jar into this folder
Folder Structure 
Velocity/
├── plugins/
│   └── velocitynexus-velocity.jar  ← Place here
├── velocity.toml
└── ...

Step 3: Install Backend Plugin (IMPORTANT!)

Must Install on ALL Backend Servers!

The backend plugin is required on EVERY Spigot/Paper server. Forgetting even one server will cause errors!

  1. Go to EACH Spigot/Paper server folder
  2. Navigate to the plugins/ directory
  3. Copy velocitynexus-spigot.jar into this folder
  4. Repeat for ALL backend servers (hub, survival, minigames, etc.)
Folder Structure 
Hub-Server/
├── plugins/
│   └── velocitynexus-spigot.jar  ← Place here
├── spigot.yml
└── ...

Survival-Server/
├── plugins/
│   └── velocitynexus-spigot.jar  ← Place here too!
├── spigot.yml
└── ...

Step 4: First Restart

  1. Restart your Velocity proxy server
  2. Restart ALL Spigot/Paper servers
  3. Wait for all servers to fully start up

Step 5: Verify Installation

Check that both plugins loaded correctly:

Velocity Console 
plugins
# Should see: VelocityNexus v1.0.0
Spigot/Paper Console 
plugins
# Should see: VelocityNexusBackend v1.0.0

⚙️ First Configuration

Locate the Config File

After first startup, a config file is created at:

Path 
Velocity/plugins/velocitynexus/config.toml

Understanding Server Names

Critical: Server Names MUST Match!

Server names in config.toml MUST EXACTLY MATCH the names in your Velocity velocity.toml file (case-sensitive!).

First, check your Velocity config to see your server names:

velocity.toml 
[servers]
hub = "127.0.0.1:25566"
survival = "127.0.0.1:25567"
minigames = "127.0.0.1:25568"

Then use those exact names in your Velocity Nexus config:

config.toml 
[menu]
title = "✦ SERVER SELECTOR ✦"
rows = 3

[servers.hub]  # Must match velocity.toml exactly!
display-name = "🏠 HUB"
description = [
    "",
    "  ▸ Main Network Hub",
    "  Your journey starts here",
    "  👥 Players: %players%",
    ""
]
icon = "NETHER_STAR"
slot = 13
enabled = true

[servers.survival]  # Must match velocity.toml exactly!
display-name = "⛏️ SURVIVAL"
description = [
    "",
    "  ▸ Vanilla Experience",
    "  Build, explore, survive",
    "  👥 Players: %players%",
    ""
]
icon = "GRASS_BLOCK"
slot = 11
enabled = true

Test the Configuration

  1. Save your config.toml file
  2. Run /velocitynexus reload in Velocity console (or restart)
  3. Join your network and type /server
  4. The GUI should open with your configured servers!

🎉 Installation Complete!

Ready to customize your server selector?

Configuration Guide Commands & Permissions