Mandatory

Plugin Requirements for Optimal Functionality

Introduction

To ensure the seamless operation of our plugin on your server, certain plugins must be installed. These plugins are critical for the proper functioning of features such as the "Suspend" menu and the integration with PvP settings. Below, you will find detailed descriptions and the necessity of each required plugin.

Required Plugins

LuckPerms

Overview: LuckPerms is an advanced rank, permissions management plugin that provides extensive API integration capabilities.

Usage: The "Suspend" menu function of our plugin is entirely dependent on the API integration provided by LuckPerms. This makes it indispensable for the plugin's operation. Without LuckPerms, the "Suspend" feature cannot function correctly.

Installation:

  1. Download the LuckPerms plugin from the official source.

  2. Place the downloaded file into your server's plugins directory.

  3. Restart your server to enable LuckPerms.

WorldGuard

Overview: WorldGuard is a powerful tool that provides comprehensive region management and protection capabilities.

Usage: We have utilized WorldGuard to implement several critical functionalities for our plugin:

  • Combat Pet Restrictions: Combat Pets cannot be used or activated in regions where PvP is disabled.

  • Custom Flags: We introduced a custom flag to further control Combat Pet usage in specified regions.

Custom Flags:

  1. gcombatpets-use Allow

    • Allows the use of a pet in the region, regardless of PvP settings. However, this is generally unnecessary.

  2. gcombatpets-use Deny

    • Denies the use of a pet in the region, irrespective of the PvP status. This flag ensures that pets cannot be used in specified regions.

Commands: To set the custom flag for a region, use the following command:

/rg flag <region> combatpets-use deny or allow

Installation:

  1. Download the WorldGuard plugin from the official source.

  2. Place the downloaded file into your server's plugins directory.

  3. Restart your server to enable WorldGuard.

Conclusion

The integration of LuckPerms and WorldGuard is essential for the optimal functionality of our plugin. Ensure that these plugins are correctly installed and configured on your server to utilize all features effectively. For further assistance, refer to the documentation of LuckPerms and WorldGuard or contact our support team.

Last updated