Skip to content
MCCitiesNetworkPublic

About

🐱 Minecraft plugin to manage pets and display useful information via holograms, action bar or chat messages.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Pet Master

A Paper plugin that shows who owns a pet when you right-click it, and lets owners give pets away or set them free.

Requires Paper 26.3 or newer.

Commands

Command Permission Default What it does
/petm or /petm help none everyone Lists the commands you can use
/petm info none everyone Shows the plugin's version and author
/petm setowner <player> petmaster.command.setowner everyone Right-click one of your pets next to give it to an online player
/petm free petmaster.command.free everyone Right-click one of your pets next to release it to the wild
/petm reload petmaster.command.reload op Reloads config.yml and messages.yml

/petmaster works as an alias. Players are only offered, and can only run, the subcommands they have permission for.

Permission Default What it allows
petmaster.command.setowner.others op Give away other players' pets, including to yourself
petmaster.command.free.others op Free other players' pets
petmaster.admin op Reload, plus both .others permissions
petmaster.* op Everything

Seeing pet owners

Right-clicking a tamed pet shows its owner in the action bar, in chat, or both, depending on config.yml. petmaster.showowner.* turns this on for all pets, and petmaster.showowner.dog, .cat, .horse, .llama and .parrot let you turn individual pets off. Every player has these by default.

Configuration

plugins/PetMaster/config.yml holds the settings and messages.yml holds every message, in MiniMessage format. PetMaster never rewrites either file. On every start it writes the shipped versions to defaults/, so after an upgrade you can compare them with yours. Messages you leave out of messages.yml use the shipped wording, and the console warns about any new setting your config.yml is missing.

Upgrading from 1.x

2.0.0 is a hard fork, and each of these changes needs action on an existing server:

  • Permissions: petmaster.setowner and petmaster.free are now petmaster.command.setowner and petmaster.command.free. petmaster.admin still exists and now grants petmaster.command.reload plus the two .others permissions above. petmaster.setcolor is gone.
  • Config: keys are now kebab-case (actionBarMessage is action-bar-message, and so on). The easiest path is to delete config.yml and let it regenerate. The holograms, Vault prices, update checker, leash, riding and damage protection, collar colours and the per-pet display… settings are gone. languageFileName is gone: edit messages.yml instead.
  • Messages: lang.yml is replaced by messages.yml, with new keys. Translations into other languages are no longer shipped.
  • Commands: /petm enable, /petm disable and /petm setcolor are gone.
  • For other plugins: the ownership event is now com.minecraftcitiesnetwork.petmaster.ownership.PetOwnershipChangeEvent, with oldOwner(), newOwner() and pet(). newOwner() returns null when the pet was freed. It fires after the change and cannot be cancelled.

Building

Needs JDK 25.

./gradlew build       # compiles, runs Checkstyle and the unit tests, writes build/libs/petmaster-<version>.jar
./gradlew runServer   # starts a local Paper 26.3 server with the plugin installed

Live-server tests

Needs Node.js. These start a real Paper 26.3 server and drive it with bot players.

./gradlew plugwrightTest

The specs are in src/test/e2e/tests/. When one fails, the server log is at src/test/e2e/generated/local/run/logs/latest.log.

Credits

Maintained by Technofied for MinecraftCitiesNetwork. A hard fork of PetMaster, originally created by DarkPyves (PyvesB/PetMaster) and later maintained by leothawne and Nobookie.

License

GNU General Public License v3.0

About

🐱 Minecraft plugin to manage pets and display useful information via holograms, action bar or chat messages.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages