First Install

This guide will walk you through the first-time installation and activation of the CatzUtils plugin. Following these steps carefully will ensure the plugin and its dependencies are set up correctly.

Step #1 - Optional Dependencies

CatzUtils is designed to integrate with several popular plugins to enhance its reward capabilities. These are soft dependencies, meaning CatzUtils will work without them, but certain reward types will be unavailable.

Install these plugins if you plan to use the following features:

  • Vault: Required to give money as a reward.

  • (Optional) ItemsAdder, Oraxen or Nexo: Required if you want to give custom items from these plugins as rewards.

Step #2 - Plugin Installation

  • Stop your server completely.

  • Place the CatzUtils.jar file into your server's /plugins/ folder.

  • If you decided to use any of the optional dependencies from Step #1, place their JAR files into the /plugins/ folder as well.

  • Start your server. This will generate all the necessary configuration files inside the /plugins/CatzUtils/ directory. The plugin will disable itself at this stage because the license key is missing. This is normal.

Step #2 - Get License and Activate

  • Join our official Discord server to receive your license key.

  • Open a ticket and provide proof of purchase (e.g., your BuiltByBit profile link).

  • You will receive a license key via DM from our License Bot.

  • Stop your server again.

  • Open the newly generated /plugins/CatzUtils/config.yml file.

  • Place the license key you received into the license: "" field.

  • Start the server. If the key is valid, the plugin will now enable successfully, and you will see a confirmation message in the console.

Step #4 - What's Next?

Congratulations! CatzUtils is now installed and fully functional.

  • Your first step should be to review the config.yml file to enable or disable the reward modules you want to use (pvp, mob-kills, fishing, block-breaking).

  • After that, you are ready to dive into the rewards.yml file to start creating your custom rewards!

Last updated