Skip to content

Installation

Jump to bottom
Wiki Generator edited this page Mar 18, 2026 · 1 revision

Installation

This guide will walk you through the installation process for OverWatch-ML.

Requirements

  • Minecraft Server: Paper 1.21+ (Paper recommended, Spigot supported)
  • Java Version: Java 21+
  • Dependencies: ProtocolLib (required)

Installation Steps

1. Install ProtocolLib

OverWatch-ML requires ProtocolLib to function. Download and install it first:

  1. Download ProtocolLib from SpigotMC
  2. Place the JAR file in your server's plugins folder
  3. Restart your server

2. Install OverWatch-ML

  1. Download the latest release from SpigotMC or Modrinth
  2. Place the JAR file in your server's plugins folder
  3. Restart your server

3. Initial Configuration

On first startup, OverWatch-ML will create its configuration file at plugins/OverWatch-ML/config.yml.

The default configuration is optimized for most servers, but you may want to:

  • Adjust the decoy ore settings
  • Configure Discord webhooks
  • Set up punishment levels

4. Verify Installation

Run the following command to verify the plugin is installed correctly:

/owml help

You should see a list of available commands.

Building from Source

If you want to build the plugin from source:

git clone https://github.com/denfry/OverWatchML.git
cd OverWatchML
mvn clean package

The compiled JAR will be in the target/ directory.

Upgrading

When upgrading to a new version:

  1. Stop your server
  2. Backup your current config and data files
  3. Replace the JAR file
  4. Start your server
  5. Review any new configuration options in the updated config.yml
  6. Run /owml reload to apply changes

Supported Server Software

  • Paper (Recommended) - Full support including Paper-specific APIs
  • Folia - Supported with folia-supported: true in plugin.yml
  • Spigot - Basic support, some features may be limited

Troubleshooting

Plugin not loading

  • Ensure ProtocolLib is installed first
  • Verify you have Java 21+
  • Check server console for error messages

Commands not working

  • Make sure you have the required permissions
  • Check that command-hiding is disabled or you have owml.use permission

Performance issues

  • Reduce detection sensitivity in config
  • Disable unused features
  • Increase analysis intervals

Clone this wiki locally