# Config.yml Guide

## config.yml

<table><thead><tr><th width="315.41649735940405">Setting (Directive)</th><th>Options</th><th>Description</th></tr></thead><tbody><tr><td>checkForUpdates</td><td>true/false</td><td>Checks for a newer version of Miniature Pets when logged into your server.</td></tr><tr><td>disablePlugin</td><td>true/false</td><td>Disables the plugin entirely, without the need to uninstall it.</td></tr><tr><td>useWorldGuard</td><td>true/false</td><td>Hook into WorldGuard for region support and additional pet spawning options.</td></tr><tr><td>usePackets</td><td>true/false</td><td>Use packets for some menus to get a nicer display.</td></tr><tr><td>useHats</td><td>true/false</td><td>Allow users with the hat permission to wear pets as hats.</td></tr><tr><td>useDisguises</td><td>true/false</td><td>Allow users with the disguise permission to disguise as a pet.</td></tr><tr><td>useRide</td><td>true/false</td><td>Allow users with the ride permission to ride their pets.</td></tr><tr><td>useInteractGUI</td><td>true/false</td><td>Show pet options when right clicking your pet.</td></tr><tr><td>debug</td><td>true/false</td><td>Shows extra debug output in console.</td></tr><tr><td>combatTag</td><td>true/false</td><td>Use combat tag integration.</td></tr><tr><td>petPunch</td><td>true/false</td><td>Allow pets to be punched.</td></tr><tr><td>useHopperGUI</td><td>true/false</td><td>Use a hopper GUI for the interact menu, instead of a chest.</td></tr><tr><td>handlePlayerData</td><td>true/false</td><td>Save data pertaining to a player's pets.</td></tr><tr><td>PetExtraRemoval</td><td>true/false</td><td>Removes leftover armor stands after a server crash.</td></tr><tr><td>runGUIAsync</td><td>true/false</td><td>Use multithreading to improve GUI efficiency.</td></tr><tr><td>perPetName</td><td>true/false</td><td>Allow and save names per pet a player has, rather than using one name per player.</td></tr><tr><td>hideDisguisedPlayers</td><td>true/false</td><td>Show/hide players disguised as a pet.</td></tr><tr><td>respawnOnFallingToVoid</td><td>true/false</td><td>Respawn pet after falling to void.</td></tr><tr><td>animationRefreshRate</td><td>Integer</td><td>Controls how often pet animations update (lower is faster).</td></tr><tr><td>standardizedPermissions</td><td>true/false</td><td>Standardize permissions to be based on the file name, instead of configurable per pet.</td></tr><tr><td>dismountOnWater</td><td>true/false</td><td>If you should be dismounted when riding a pet into water.</td></tr><tr><td>bypassSpawnProtections</td><td>true/false</td><td>Bypasses most external spawning plugins. May help if pets don't spawn due to a plugin conflict.</td></tr><tr><td>minimumPetTeleportRange</td><td>Integer</td><td>Controls how far a pet has to be before teleported to the owner.</td></tr><tr><td>petTeleportCheckSeconds</td><td>Integer</td><td>Controls how often a pet's distance from its owner should be checked.</td></tr><tr><td>disallowDisguiseTeleport</td><td>true/false</td><td>Disallow teleportation when disguised.</td></tr><tr><td>respawnPetOnWorldMove</td><td>true/false</td><td>Should pets reappear after you change world?</td></tr><tr><td>downloadDefaultPetsIfNone</td><td>true/false</td><td>If true, downloads the default pet pack if your pets folder is empty.</td></tr><tr><td>disallowedPetNameWords</td><td><p>List of words introduced by a dash.</p><p><img src="broken-reference" alt=""></p></td><td>Words that should not be allowed in pet names.</td></tr><tr><td>respawnPetOnJoin</td><td>true/false</td><td>Respawn last spawned pet on server join.</td></tr><tr><td>petLoadingMessage</td><td>true/false</td><td>Sends a message on server startup for every pet successfully loaded.</td></tr><tr><td>despawnOnGamemodeChangeTo</td><td>List of Gamemodes introduced by a dash.<br><img src="broken-reference" alt=""></td><td>Despawns pet when gamemode is changed to one of the specified ones.</td></tr><tr><td>petDistance</td><td>Integer</td><td>Distance of pet from player at any given moment.</td></tr><tr><td>SaveWithUUID</td><td>true/false</td><td>Use UUID saving (probably not good for offline servers).</td></tr><tr><td>PetSpawnDistance</td><td>Integer</td><td>How far away should pets spawn, when selected?</td></tr><tr><td>PetNameLimit</td><td>Integer</td><td>Controls maximum characters in a pet's name.</td></tr></tbody></table>
