🐾 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)
🩺 Pet State Validation
- 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 validatePets for manual validation from the console or event commands.
- Updated File: js/plugins/ED5_Pets.js
  (validatePet, validateAllPets)
🎨 Menu Icon Animation Fix
- 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
🗺️ Map Pet Animation Behavior
- Summoned pet event animations now correctly respect their template event’s walk/step animation flags, rather than forcing them on.
- Game_PetEvent now reads walkAnime / stepAnime from template event pages, restoring the intended behavior of original pet templates.
- Updated File: js/plugins/ED5_Pets.js
  (Game_PetEvent initialize/refresh/hasStepAnime/hasWalkAnime)
🔒 Other Improvements & Safety Hardening
- 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/plugins folder
Enable it in the Plugin Manager
Create a map with the ID set in the PetMapId parameter (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 Pets

Place 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 bank
ED5_Pets summonPet x - 🐶 Summon pet
ED5_Pets recallPet - 👋 Recall pet
ED5_Pets gainExp x y - 🧪 Add EXP
ED5_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 needed
recallPet – 👋 No parameters needed
changeLoyalty – 💖 Just the amount
changeHunger – 🍗 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.

Discover Plugins & Games

ED5 Pets Plugin