[SimplePetsAddon] RedProtect Addon

*What is this addon?*

This is a SimplePets Addon that allows server owners/admins to utilize custom RedProtect flags that will allow for pets to have some restrictions in certain regions.

*Plugin/Resource Links:*

* (REQUIRED) *(REQUIRED)* * %%MD1%% *(REQUIRED)* `(At least v7.7.2)`

*What Features does it have?*

* New flag `"pet-spawning"` - This is used when the player tries to spawn a pet

(Default is set to allow) * New flag `"pet-moving"` - This is used a pet tries to walk into the region

(Default is set to allow) * New flag `"pet-mounting"` - This is used the player tries to mount the pet

(Default is set to allow) * New flag `"pet-riding"` - This is used when the player tries to ride the pet in the region

(Default is set to allow)

*How to install:*

The addon can be installed a few different ways it can be done via the install command, via the GUI installer, or manually

*Install via Command:* (Easiest)

* Simply type the *`/pet addon install RedProtect`* command It will also attempt to load and enable it

*Install via GUI Installer:*

* Run the *`/pet addon`* command * Click the *`Install Addons`* item that is in the bottom row of the GUI * Locate the *`RedProtect`* item in the GUI * Once found simply click it

*NOTE:* If it gets stuck saying "Installing..." then check your console for any errors, If there are none then try one of the other methods.

*Install Manually:*

* Open the SimplePets plugin folder * Open the *`Addons`* folder (If the folder is not there then simply create one) * Download the addon from one of the download locations * Drop the addons jar file into the *`Addons`* folder * Restart your server (This is to actually get the addon loaded into the plugin)

*Default Config:*

```yaml

If enabled this will allow the pets to be used outside of regions (aka if there is no region in the world/location)

allow-outside-regions: true

pet-spawning:

The default value the flag should be (Will be ignored if 'admin-only' is enabled)

default: true

Admins are only able to modify this flag (default value is ignored)

admin-only: false

pet-moving:

The default value the flag should be (Will be ignored if 'admin-only' is enabled)

default: true

Admins are only able to modify this flag (default value is ignored)

admin-only: false

pet-riding:

The default value the flag should be (Will be ignored if 'admin-only' is enabled)

default: true

Admins are only able to modify this flag (default value is ignored)

admin-only: false

pet-mounting:

The default value the flag should be (Will be ignored if 'admin-only' is enabled)

default: true

Admins are only able to modify this flag (default value is ignored)

admin-only: false

What should the bypass permission be set to?

bypass-permission: pet.redprotect.bypass

checks: spawning:

Should the addon check when a pet is spawned?

enabled: true

This message is only visible when you hover over the 'pet failed to spawn' message

You can make this blank or 'null' if you want no message

reason: '&cYour pet is not able to be spawned in this area'

mounting:

Should the addon check when the player mounts the pet?

enabled: true

Should the pet be removed or should it just be canceled?

remove-pet: true

moving:

Should the addon check when a pet moves?

enabled: true

Should the pet be removed or should it just be canceled?

remove-pet: true

riding:

Should the addon check when the pets owner is riding it?

enabled: true

Should the pet be removed or should it just be canceled?

remove-pet: true

Should the player be dismounted (if remove-pet is set to true this is ignored)?

dismount: true ```