Xpose - Minecraft Server Exposer

Xpose is a powerful Minecraft plugin that allows you to expose your local Minecraft server to the internet using a custom domain. It uses ngrok for tunneling and integrates with the Xpose service to provide you with a beautiful, memorable domain for your server.

Features

  • Custom Domain: Get a custom subdomain like myserver.quizyy.fun for your Minecraft server
  • Multiple Domain Options: Choose between quizyy.fun or mysmp.fun domains
  • Automatic Updates: Your custom domain automatically updates when your ngrok tunnel changes
  • Multiple Regions: Choose from various ngrok regions for optimal performance
  • Simple Configuration: Easy-to-use configuration file
  • Permission-Based Commands: Secure command access with permissions

Requirements

  • Java 8 or higher
  • Minecraft server 1.16 or higher
  • ngrok authentication token
  • Xpose authentication token

Installation

  1. Download the latest release of Xpose from the releases page
  2. Place the JAR file in your server's plugins folder
  3. Start or restart your server
  4. Configure the plugin using the generated config.yml file

Configuration

The configuration file (config.yml) is located in the plugins/Xpose folder. Here's how to configure it:

# Ngrok configuration
ngrok:
  auth_token: "your-ngrok-token"  # Get this from https://dashboard.ngrok.com/get-started/your-authtoken
  region: "US"  # Available regions: US, EU, AP, AU, SA, JP, IN
  server_port: 25565  # Your Minecraft server port

# Xpose configuration
xpose:
  auth_token: "your-xpose-auth-token"  # Get this from https://xpose.quizyy.fun
  subdomain: "your-subdomain"  # The subdomain you want to use
  domain: "mysmp.fun"  # or quizyy.fun

Getting Your Tokens

Ngrok Token

  1. Sign up at ngrok.com
  2. Get your auth token from dashboard.ngrok.com

Xpose Token

  1. Visit xpose.quizyy.fun
  2. Log in to your account
  3. Get your authentication token

Commands

  • /xpose status - Check the current status of your tunnel
  • /xpose reload - Reload the plugin configuration
  • /xpose help - Display help information

Permissions

  • xpose.admin - Allows access to all Xpose commands

How It Works

  1. Xpose creates an ngrok tunnel to your Minecraft server
  2. When the tunnel is established, Xpose sends the public URL to the Xpose API
  3. The Xpose service creates a custom subdomain for your server
  4. Players can now connect to your server using your custom domain

Troubleshooting

  • Plugin won't start: Make sure both your ngrok and Xpose tokens are correctly set in the config.yml file
  • Tunnel not working: Check your ngrok token and make sure your server port is correct
  • Custom domain not working: Verify your Xpose token and subdomain settings

Support

For support, please visit xpose.quizyy.fun or join our Discord server.

License

This plugin is licensed under the MIT License. See the LICENSE file for details.