Installation Guide

Complete installation instructions for MinerTrack Anti-XRay on supported server platforms.

📋 Requirements

Supported Platforms

📥 Installation Steps

1. Download the Latest Release

Tip: Download the version matching your server's Minecraft version. Dev builds (-dev suffix) are for testing only.

2. Install the Plugin

# 1. Stop your server
./stop.sh  # or use your server management panel

# 2. Place the JAR in plugins folder
cp MinerTrack-<version>.jar /path/to/server/plugins/

# 3. Start the server
./start.sh

Folder structure after installation:

/your-server/
├── plugins/
│   └── MinerTrack-<version>.jar
├── ...

3. First Startup — Configuration Generation

On first startup, MinerTrack generates default configuration files:

/plugins/MinerTrack/
├── config.yml              # Global settings
├── language.yml            # Messages & formatting
└── Configuration/          # World-specific profiles
    ├── overworld.yml       # Overworld (minecraft:overworld)
    ├── nether.yml          # Nether (minecraft:the_nether)
    └── end.yml             # End (minecraft:the_end)

Important: The plugin creates world configs using Minecraft namespace IDs (minecraft:overworld, etc.), not folder names. This works regardless of your world folder naming (world, world_nether, world_the_end, or custom names).

4. Verify Installation

Run these commands in-game or console:

5. Restart After Configuration Changes

After editing any .yml file:

/mtrack reload
# OR restart server for major changes

🔧 Platform-Specific Notes

Paper / Purpur

• No additional setup required
• Uses Paper's async chunk loading for performance
• Compatible with Paper's anti-xray (can run alongside, but not needed)

Folia (Regionized Paper)

• Fully compatible with regionized scheduling
• Detection runs on region threads — no global lock contention
• Recommended for large servers (100+ players)

Custom World Names

If your worlds use non-standard folder names (e.g., survival, survival_nether):

1. MinerTrack auto-detects dimensions by namespace ID, not folder name
2. No config changes needed — overworld.yml applies to any minecraft:overworld dimension
3. For custom dimensions (datapacks/mods), create Configuration/<namespace>_<dimension>.yml

🐳 Docker / Container Deployments

# Example: Paper + MinerTrack
FROM papermc/paper:1.21

# Copy plugin to plugins directory
COPY MinerTrack-*.jar /plugins/

# Config persistence (optional)
VOLUME ["/plugins/MinerTrack"]

Docker Compose:

services:
  minecraft:
    image: papermc/paper:1.21
    volumes:
      - ./plugins:/plugins
      - ./world:/world
      - ./minertrack-config:/plugins/MinerTrack
    environment:
      - MEMORY=4G
    ports:
      - "25565:25565"

✅ Post-Installation Checklist

• Plugin loads without errors in console
• /mtrack help shows all commands
• config.yml, language.yml, Configuration/*.yml generated
• Discord webhook tested (if configured)
• Staff permissions granted (minertrack.notify, minertrack.verbose, minertrack.check)
• disable_bypass_permission: true set if you want to monitor ops/staff
• Monitor logs for 24–48 hours before taking action on alerts

🔄 Updating MinerTrack

1. Backup your /plugins/MinerTrack/ folder
2. Download new version
3. Replace JAR file
4. Run /mtrack reload or restart server
5. Check console for config migration messages (config version bumps are rare)

Config Version: MinerTrack uses _config-version in configs. Major version changes may require manual migration — check GitHub Releases for migration notes.

🗑️ Uninstallation

# 1. Stop server
# 2. Remove plugin
rm /path/to/server/plugins/MinerTrack-*.jar
# 3. (Optional) Remove config & logs
rm -rf /path/to/server/plugins/MinerTrack/
# 4. Start server

🆘 Installation Issues?

Still stuck? → Troubleshooting | Discord Support | GitHub Issues