plugin
ED5 Pets Plugin
$4.99
πΎ ED5_Pets Plugin Documentation
π Overview
The ED5_Pets plugin adds a complete pet system to RPG Maker MZ, including:
- π₯ Egg hatching mechanics
- π― Pet capturing with balls
- π¦ Pet inventory and bank system
- π Hunger system
- π Loyalty system
- π£ Pet summoning and despawning
- π± Evolution system
- π Stat growth and leveling
- Changelog
Core Plugin Updates β ED5_Pets.js
π§ Event Queue System- Implemented a serialized pet event queue to prevent overlapping or reserved common events when multiple pets trigger actions simultaneously.
- Added deduplication logic to stop the same pet + event combination from being queued multiple times.
- Introduced polling-based completion detection so the next queued pet event only executes when the map and common-event system are idle.
- Updated File:
js/plugins/ED5_Pets.js
(Game_Pets.prototype.queuePetCommonEvent, processPendingEvents)
- Added
validatePet()to auto-repair common corruptions (missing IDs, bad fields, or broken triggers) and clamp data to safe ranges. - Added
validateAllPets()to run full-suite validation across both inventory and bank, removing corrupted or invalid entries. - Automatic validation now runs after loading save data, fixing broken pet states automatically.
- New plugin command:
ED5_Pets validatePetsfor manual validation from the console or event commands. - Updated File:
js/plugins/ED5_Pets.js
(validatePet, validateAllPets)
- Fixed pet icons and portraits so they now animate correctly while menu scenes are open.
- Hooked into
Scene_MenuBase.update()to refresh pet icons efficiently without unnecessary redraws. - Updated File:
js/plugins/ED5_Pets.js
- Summoned pet event animations now correctly respect their template eventβs walk/step animation flags, rather than forcing them on.
Game_PetEventnow readswalkAnime/stepAnimefrom template event pages, restoring the intended behavior of original pet templates.- Updated File:
js/plugins/ED5_Pets.js
(Game_PetEvent initialize/refresh/hasStepAnime/hasWalkAnime)
- Improved event add/remove safety on maps.
- Safer summon/recall logic and post-load validation routines.
- Enhanced defensive checks and update loops across the plugin to prevent state corruption.
βοΈ Installation
- Place the plugin file in your
js/pluginsfolder - Enable it in the Plugin Manager
- Create a map with the ID set in the
PetMapIdparameter (default is 1)
π§° Basic Setup
πΎ 1. Pet Template Map
Create pet templates on a map (ID = 1 by default). Each event = one pet type.
πΏ 2. Creating Pets
There are two ways to add pets:
A. Wild PetsPlace events and add these tags:
<pet: 1>
<petsMHP: 50>
<petsATK: 10>
<Loyalty: 30>
<hunger: 80>
<hungerRate: 0.5>
<ballWeakness: 75>
<petLv: 5>
B. Eggs
Create an item and add:
<egg: 1>
<hatch: 500>
<petsMHP: 40>
<petsATK: 8>
<Loyalty: 50>
<hunger: 100>
β½ 3. Pet Balls
Tag pet balls in the database with:
<petBall: 75>
<ballRange: 2>
<ballSprite: SuperBall>
<successAni: 51>
<failedAni: 52>
π Player Inventory
Defaults to 6 pets. Can be expanded via:
- π
<petInventory: x>in actor notebox - π‘οΈ
<expandPetInventory: x>in equipment
π Evolution System
Tag evolving pets or eggs with:
<evolveLv: 15,30>
<evolveEID: 2,3>
<evolveMHP: 10,20>
<evolveRaiseATK: 5,10>
π» Plugin Commands
ED5_Pets openBank- π¦ Open pet bankED5_Pets summonPet x- πΆ Summon petED5_Pets recallPet- π Recall petED5_Pets gainExp x y- π§ͺ Add EXPED5_Pets changeLoyalty x y- π Change loyalty
π Script Calls
$gameSystem.pets().addPet(petData)- β Add a pet$gameSystem.pets().summonPet(petId)- πΎ Summon pet$gameSystem.pets().recallPet()- π« Recall pet$gameSystem.pets().gainExp(pet, amount)- π Gain EXP
π Hunger System
- Hunger decreases over time (default 1 per min)
- 0 hunger = -10 loyalty
- π Pet is recalled if hunger = 0
π Loyalty System
- Ranges 0β100
- Decreases with hunger
- Affects future pet behavior
π¦ Bank System
- Stores up to 1000 pets
- Access via plugin command or custom menu
π£ Summoning Mechanics
- One pet out at a time
- Appears as an event
- Use event pages for interaction
π οΈ Tips & Troubleshooting
π§© Common Issues
- Pets not appearing? Check template map ID and pet event IDs
- Capture not working? Verify
<petBall>tag and range - Glitches? Check sprite sizes, animation IDs, and plugin conflicts
β¨ ED5_Pets Lite Version Features
πΆ Single Pet Only
- 1οΈβ£ Players can only have one pet at a time
- π« Must release current pet before getting a new one
βοΈ Core Systems Retained
- π₯ Egg hatching
- β½ Pet capturing
- π Hunger system
- π Loyalty system
- π± Evolution system
- π£ Summoning and recalling
ποΈ Removed Features
- π¦ No pet bank system
- π No pet inventory (only one pet)
- π No pet swapping or rearranging
- π§Ύ Simplified UI
π§ͺ Simplified Commands
Only the most essential commands are retained with simplified usage:
summonPetβ π No parameters neededrecallPetβ π No parameters neededchangeLoyaltyβ π Just the amountchangeHungerβ π Just the amount
β Usage Differences
π¦ No Bank System
- π« Players canβt store pets
- π Must release pet to get another
π Simplified Tags
- β Use the same tags for pets/eggs as the full version
- π§Ό No need for inventory size tags
πΌοΈ Basic UI
- π No pet menu scene
- πΉοΈ All interactions via plugin commands
β Why Use the Lite Version?
This version maintains all core pet functionality while being much simpler to implement and manage. Perfect for developers who want pets without the extra management systems.
Purchase
$4.99
Reviews
Comments
Sign in to comment