McGuardian

TECHNICAL GUIDE MINECRAFT JAVA

Install McGuardian on your Minecraft server.

Choose the right artifact for your server and connect it to the McGuardian dashboard to review activity and coordinate your team's moderation decisions.

Platforms Bukkit, Fabric, Quilt, Forge, and NeoForge Proxies Velocity and BungeeCord Network Outbound HTTPS and WSS connections over port 443

01 / SETUP

Connect with Bukkit (Paper/Spigot)

  1. 01

    Register your server with McGuardian

    Sign in to your account, open Servers, and add the server with a unique ID, such as survival-1. Create a credential for that server and select only the permissions you plan to use.

  2. 02

    Install the plugin file

    Stop Paper or Spigot, place the McGuardian .jar file in the plugins/ folder, then start the server again. The current download is a release candidate compatible with Paper 1.21.x and Java 21.

    Descargas

    McGuardian v2.0.0-rc.1

    Candidata

    Selecciona la plataforma y la versión de tu servidor.

    Java 25+Un único JAR Bukkit cubre esta versión.
  3. 03

    Save the configuration and credential

    In the McGuardian setup wizard, copy the generated configuration to plugins/McGuardian/config.yml. Check that server-id matches the registered server and that server-credential contains that server's key. The full key is shown only once, so store it as a secret.

    api-url: "https://api.mcguardian.win/api/sanctions/analyze"
    server-credential: "cgs_…"
    server-id: "survival-1"

    Use the values shown in your setup wizard. Do not reuse a credential across servers.

  4. 04

    Restart and confirm the connection

    Restart Paper or Spigot to load the changes. Run /mcguardian status in the console or in-game with permission, then check under Servers that the connection is online.

02 / PLUGIN PERMISSIONS

Enable only the features you need

The credential limits what each server can send or receive:

  • analysis:writeSend messages for moderation analysis.
  • sanctions:receiveReceive sanctions approved by your team in the dashboard.
  • presence:writeUpdate player sessions and profiles.
  • reports:writeReceive reports submitted from the server.
  • replays:writeSend compatible activity and replay data.

For a network with a lobby, survival, or other modes, register each server separately and create a different credential for each one.

03 / CONTROL AND PRIVACY

Review sanctions and data before enabling everything

AI helps review chat; your staff decides which sanctions to apply. If sanction enforcement is enabled, approved actions are sent to the plugin. Check enforcement.commands in config.yml to make sure the commands match your sanctions plugin.

Chat context can send recent messages to the AI provider. Disable it by setting enabled: false in the context section. Profiles can also send a player's IP address; to disable this, set send-ip: false in profiles. Let your community know what data the server records.

04 / UPDATING

Update the plugin

The plugin does not update automatically. When a new version is available, download it here, stop Paper, back up plugins/McGuardian/config.yml, replace the old JAR, and start the server again. Check the release notes for configuration changes and confirm the connection with /mcguardian status. The dashboard will show the connected version.

The current download is marked as a release candidate (RC); check the version label before installing it in production.

05 / PLATFORMS AND VERSIONS

Download the file for your server

Choose a platform and version in the selector. The matching JAR and its SHA-256 checksum will appear below.

Spigot and Paper

Minecraft 1.16.5 or later · Java 16+. Use the Bukkit JAR in plugins/ and configure plugins/McGuardian/config.yml.

Fabric

1.20.1 · Java 17; 1.21.1–1.21.11 · Java 21; 26.1.2 · Java 25. The selector chooses the right JAR for each version; place it in mods/.

Quilt

1.20.1 · Java 17 and 1.21.1 · Java 21. Use the matching Fabric JAR and add QFAPI/QSL; do not install Fabric API separately.

Forge

Minecraft 1.20.1 · Java 17. Place the Forge JAR in mods/.

NeoForge

Minecraft 1.21.1 · Java 21. Place the NeoForge JAR in mods/.

Proxies

Velocity 3/4 and BungeeCord · Java 17+. Choose the proxy JAR and place it in its plugins/ folder.

Fabric, Quilt, Forge, and NeoForge create their configuration at config/mcguardian/mcguardian.properties. Bukkit uses plugins/McGuardian/config.yml.

Fabric, Quilt, Forge, and NeoForge adapters provide chat moderation. Reports, presence, sanctions, and replays are handled by the Bukkit adapter.

Go to downloads for all platforms ↓

06 / TROUBLESHOOTING

Quick checks

  • Paper or Spigot is running, and the plugin appears as loaded in the console.
  • The ID and credential belong to the same registered server.
  • The credential still has the permissions required by each enabled feature.
  • Your host allows outbound HTTPS/WSS connections over port 443; no inbound ports need to be opened.

Check /mcguardian status and the console messages to see the plugin status.

07 / QUESTIONS

Frequently asked questions

Do I need to open a port on my server?

No. The plugin starts secure outbound HTTPS and WSS connections over port 443.

Does AI apply sanctions automatically?

Your staff makes the decision: they review and approve it. The plugin executes the approved action if the feature is enabled and configured.

Can I connect multiple servers?

Yes. Register each server in the dashboard and configure a unique ID and credential for it.

Does the plugin update automatically?

No. Download the new version from this page, replace the JAR, and restart Paper. Keep a copy of your configuration and check the release notes.

Can I use McGuardian without Paper?

Yes. Artifacts are available for Spigot, Fabric, Quilt, Forge, NeoForge, Velocity, and BungeeCord. Supported versions and requirements are listed in the platforms section and download selector.