Server Hop

ServerHop - Multi-Server Teleporter Plugin

Seamlessly connect your Hytale server network with interactive teleporter blocks!

🌟 Overview

ServerHop is a Hytale server plugin that enables you to create teleporter blocks that transport players between servers in your network. Perfect for lobby servers, hub worlds, or any multi-server setup where you want smooth player navigation.

Simply stand on a block, run a command, and that block becomes a portal to another server!

---

✨ Features

• 🚪 Walk-On Activation - Players see a countdown when they walk onto a portal, showing them which world they're about to move to
• 🎨 Visual Teleporter Blocks - Automatically places portal blocks for clear visual feedback
• ⚙️ Easy Configuration - Simple commands to set up and manage teleporters
• 💾 Persistent Storage - All configurations saved automatically in JSON format
• 🌍 World-Aware - Tracks teleporters across different worlds using unique identifiers
• ⏱️ Smart Cooldown - 1-second cooldown prevents accidental rapid re-triggers
• 🔌 Lightweight - Minimal performance impact using efficient entity systems

---

📦 Installation

1. Download the latest ServerHop-1.0-SNAPSHOT.jar from the files section
2. Place the JAR file in your Hytale server's mods/ folder
3. Restart your server
4. Configure teleporters using the in-game commands below

The plugin will automatically create its configuration directory at mods/ServerHop/

---

🎮 Commands

/setteleporter <host> <port> [displayName]

Creates a teleporter on the block you're standing on.

Examples:

/setteleporter play.example.com 5520
/setteleporter 192.168.1.100 5520 Survival Server
/setteleporter minigames.mynetwork.com 25565 Fun Minigames

Usage:

1. Stand on the block you want to convert into a teleporter
2. Run the command with your destination server details
3. A visual teleporter block will be placed automatically
4. Walk onto the block to test the connection!

---

/removeteleporter

Removes the teleporter from the block you're standing on.

Usage:

1. Stand on any teleporter block
2. Run /removeteleporter
3. The block returns to normal

---

/listteleporters

Lists all configured teleporters on the server.

Example Output:

=== Configured Teleporters ===
Total: 3

1. Survival Server
   Location: 10, 64, 20
   Server: play.example.com:5520

2. Minigames Hub
   Location: 15, 64, 20
   Server: minigames.example.com:5520

3. Creative World
   Location: 20, 64, 20
   Server: 192.168.1.150:5520

---

🏗️ Example Setup: Lobby Server

Create a central hub with teleporters to multiple game servers:

# Create a survival server teleporter
/setteleporter survival.mynetwork.com 5520 Survival Mode

# Create a minigames teleporter
/setteleporter minigames.mynetwork.com 5520 Minigames

# Create a creative server teleporter
/setteleporter creative.mynetwork.com 5520 Creative Building

# List all teleporters to verify
/listteleporters

Now players can walk onto any of these blocks to instantly jump to that server!

---

🔧 How It Works

1. Designate a block as a teleporter using /setteleporter
2. Visual Indicator - Plugin places a portal block at that location
3. Player Activation - When a player walks onto the block, they're transferred
4. Seamless Transfer - Uses Hytale's native PlayerRef.referToServer() API
5. Auto-Save - Configuration persists across server restarts

---

📋 Requirements

• Hytale Server (compatible with QUIC protocol)
• Java 25 or higher
• Multi-Server Network - Requires at least 2 servers to teleport between

---

🛠️ Building from Source

If you want to build the plugin yourself:

git clone <your-repository>
cd ServerHop
mvn clean package

The compiled JAR will be located at target/ServerHop-1.0-SNAPSHOT.jar

---

🐛 Bug Reports & Feature Requests

Found a bug or have an idea for a new feature? Let me know in the comments!

---

📝 Configuration

All teleporter configurations are stored in mods/ServerHop/teleporters.json. You can manually edit this file if needed, but it's recommended to use the in-game commands for proper validation.

Example Configuration:

{
  "teleporters": {
    "world-abc123_10_64_20": {
      "host": "survival.server.com",
      "port": 5520,
      "displayName": "Survival Server"
    }
  }
}

---

📊 Version History

Version 1.0-SNAPSHOT

• Initial release
• Walk-on teleporter activation
• Automatic visual block placement
• JSON-based configuration system
• Block location tracking with world awareness
• Three management commands (set, remove, list)
• 1-second cooldown system
• Server transfer using Hytale's native API

Version 1.1-SNAPSHOT

• settings.json file added
  • You can now configure how long it takes before a player is teleported
  • You can now change which block is placed (leave this blank for no block placement)
  • You can now adjust the language used in the notifications

---

Enjoy building your multi-server network with ServerHop! 🚀

If you like this plugin, let us know in the comments!