🛡️ OrbisGuard

Protect Your Community with Shared Intelligence.

OrbisGuard is a modern security solution designed to safeguard your Hytale server from malicious actors, griefers, and risky players. By leveraging a centralized API, OrbisGuard allows servers to share crucial security data which help stop those threats.

Unlike traditional ban plugins that work in isolation, OrbisGuard connects your server to a wider network of community protection.

Key Features:

• Global Risk Analysis: Automatically checks players against the OrbisGuard database when they join.
• Centralized Reporting: Seamlessly report bans, and kicks to help protect other communities.
• No Lag Performance: Built to be fully asynchronous, this ensure your server TPS never drops, even during heavy API usage.
• Server Heartbeat: Integrated heartbeat system to monitor your server's uptime and connectivity with our network.
• Smart Analytics: Logs joins, disconnects, and player retention data to give you better insights into your player base.
• Player Playtime: See how long a certain player has been in your server.

🚀 Getting Started

1. Download the OrbisGuard Mod, and upload it to your mods directory
2. Visit OrbisGuard.io to register for an account and generate a unique API key.
3. Start your server then Stop it.
4. orbisguard.json file will be generated in the root directory
5. Paste your API key in the value field. (You will see a "" for it) Obtained by visiting OrbisGuard.io and adding a new server.
6. Start your server.

🔧 Configuration

OrbisGuard mod is designed to work with minimal configuration. Once you have uploaded the mod, started your server and then stopped it. You will find orbisguard.json file in root directory. There you will insert your unique API key generated from the website.

{
  "api_key": "YOUR API KEY HERE"
}

🤝 Join the Network

We are currently in Beta! Your feedback helps shape the future of Hytale server security.

• Join our Discord
• Visit our website OrbisGuard.io

🔒 Data Collection & External Connections

OrbisGuard relies on a connection to our central API to function. By installing this plugin, you agree to the transmission of specific server and player data to our secure endpoint (https://api.orbisguard.io).

What we collect:

• Server Identity: Your Server Name and OrbisGuard API Key (for authentication).
• Player Information: UUIDs and Usernames of players joining your server.
• Event Data: Ban, Kick, and Disconnect reports (including reasons and timestamps).

Why we collect it: This data is essential to provide risk analysis. By aggregating ban and kick reports, OrbisGuard helps protect your community from risky players who have been flagged by other servers in the network.

Security: All data is transmitted securely over HTTPS. We do not collect personal IP addresses, chat logs, or IP:Port of the Server connected to our network.