Installation

Requirements

Requirement	Value
Java	17+
Paper / Spigot	1.13+
Velocity	3.1+
Waterfall	1.18+

Steps

1. Download the correct jar for your platform from Modrinth:

   • CommandGuard-*-spigot.jar — for Paper/Spigot backend
   • CommandGuard-*-velocity.jar — for Velocity proxy
   • CommandGuard-*-waterfall.jar — for Waterfall proxy

2. Place the jar into the plugins/ folder of your server

3. Start the server — config files are generated automatically:

   plugins/CommandGuard/config.yml           ← backend
   plugins/CommandGuard/velocity-config.yml  ← velocity proxy
   plugins/CommandGuard/bungee-config.yml    ← waterfall proxy
   plugins/CommandGuard/lang/en_EN.yml
   plugins/CommandGuard/lang/ru_RU.yml

4. Edit the config to your needs

5. Reload without a restart:

   /cg reload      ← backend (Paper/Spigot)
   /cgv reload     ← proxy (Velocity/Waterfall)

Network Setup

If you run a network (proxy + backends), install CommandGuard on both the proxy and each backend, then enable is_network: true on both sides. See Cross-Server Setup.

tip

You do not need to restart the server after editing the config. Use /cg reload or /cgv reload.

info

ProtocolLib is only needed if you want tab-complete packet-level filtering for clients on 1.12 or older.