![[SimplePetsAddon] Residence Addon](https://cdn.metamods.net/images/mods/spets-residence/logo.jpeg)
[SimplePetsAddon] Residence Addon
This extension is designed for the SimplePets plugin and allows server administrators to configure special territory flags for Residence that restrict interactions with pets in specific zones.
Functional Capabilities
The addon introduces several new flags for controlling pet behavior:
Pet Spawning Permission Flag When a player attempts to summon a pet, the system checks the corresponding permission. Spawning is allowed by default.
Pet Entry to Zone Flag Controls whether pets can enter protected territory regions.
Pet Mounting Permission Flag Determines if a player can mount their pet within this zone. Supported by default.
Pet Riding Flag Regulates the ability to use pets as vehicles inside the region.
Compatibility Requirements
Essential requirements for the extension to function:
- Main SimplePets plugin
- Residence modification version 5.0.1.6 or higher
Installation Options
Command Installation (Easiest Method)
Execute the command /pet addon install Residence
in chat. The system will automatically download the extension.
GUI Installation
- Enter the command
/pet addon
- In the bottom menu row, select the "Install Addons" option
- Locate the "Residence" item in the list
- Click on it to install
If the process stalls with "Installing..." status, check the console for errors or use alternative installation methods.
Manual Installation
- Open the SimplePets plugin folder
- Navigate to the "Addons" directory (create it if missing)
- Download the extension file from the official source
- Place the jar file in the Addons folder
- Restart the server to activate the extension
Configuration Settings
# Permission to bypass restrictions
bypass-permission: pet.residence.bypass
checks:
spawning:
flag:
# Flag name for pet spawning
name: 'allow-pet-spawn'
# Default value
default-value: true
# Enable check when spawning a pet
enabled: true
# Message when spawning fails
reason: '&cYour pet cannot be summoned in this area'
mounting:
flag:
name: 'allow-pet-mounting'
default-value: true
enabled: true
# Remove pet or simply cancel the action
remove-pet: true
moving:
flag:
name: 'allow-pet-enter'
default-value: true
enabled: true
remove-pet: true
riding:
flag:
name: 'allow-pet-riding'
default-value: true
enabled: true
remove-pet: true
# Dismount player (ignored when removing pet)
dismount: true