ED5 Random Loot Plugin Documentation

Overview

The ED5 Random Loot Plugin is a powerful tool for RPG Maker MZ that allows developers to generate random loot for their games. It supports features like loot groups, drop weights, random prefixes, and dynamic loot popups. This plugin is designed to enhance the loot system in your game, making it more engaging and rewarding for players.

Features

• Random Loot Generation: Generate random items, weapons, and armors from a loot pool.
• Loot Groups: Organize loot into groups using <group:groupName> tags for targeted drops.
• Drop Weights: Control the rarity of items using <dropWeight:value> tags.
• Dynamic Loot Popups: Display visually appealing loot popups above the player's character.
• Drop Conditions: Use <drop[stat]:value> tags to restrict loot drops based on party stats.
• Plugin Commands: Easily spawn loot using plugin commands.

Installation

1. Download the plugin file ED5_RandomLoot.js.
2. Place the file in your project's plugins folder.
3. Open RPG Maker MZ and go to the Plugin Manager.
4. Add the plugin and ensure it is enabled.

How to Use

1. Setting Up Loot Items

Plug and play - All items with a price and name are automatically added to the loot pool unless <noDrop> is added

Basic Tags

• Group Tag: Assign the item to one or more groups. <group:test,rare>
  • This item belongs to the test and rare groups.
• Drop Weight: Set the rarity of the item. <dropWeight:5>
  • Higher values make the item more common. Default is 1.
• Drop Range: Specify the quantity range for the item. <drop:1..3>
  • This item will drop between 1 and 3 units.
• No Drop: Exclude the item from the loot pool. <noDrop>

Drop Conditions

Restrict loot drops based on party stats:

• Example: <dropLv:10> <dropAtk:50>
  • The item will only drop if the party's average level is at least 10 and their average ATK is at least 50.

2. Plugin Commands

Use the following plugin commands to spawn loot in your game:

Spawn Random Item

• Command: spawnItem
• Spawns a random item from the loot pool.

Spawn Random Weapon

• Command: spawnWeapon
• Spawns a random weapon from the loot pool.

Spawn Random Armor

• Command: spawnArmor
• Spawns a random armor from the loot pool.

Spawn Random Loot

• Command: spawnAll
• Spawns a random item, weapon, or armor from the loot pool.

Spawn Group Loot

• Command: spawnGroup
• Spawns random loot from a specific group.
  • Argument: groupName (string) - The name of the group to spawn loot from.
  • Example: spawnGroup groupName:test

3. Loot Popups

When loot is spawned, a popup will appear above the player's character showing the item name and icon.

Customizing Popups

The loot popup is designed to be sleek and minimal.

4. Advanced Features

Dynamic Loot Pool

The loot pool is dynamically built from the database ($dataItems, $dataWeapons, $dataArmors) and can include custom items created by other plugins.

Example Usage

Example 1: Basic Random Loot

1. Add the following tags to an item in the database: <group:test> <dropWeight:3> <drop:1..2>
2. Use the plugin command: spawnGroup groupName:test
3. The item will be added to the player's inventory, and a popup will appear.

Example 2: Conditional Loot

1. Add the following tags to a weapon: <group:rare> <dropLv:15> <dropAtk:100>
2. Use the plugin command: spawnGroup groupName:rare
3. The weapon will only drop if the party's average level is at least 15 and their average ATK is at least 100.

Compatibility

This plugin is compatible with:

• ED5_RandomizeItemStats: Adds random prefixes to loot.
• ED5_Reforge: Supports reforged items in the loot pool.
• ED5_EquipmentCreator: Includes dynamically created equipment in the loot pool.

Known Issues

• Database Not Loaded: If the database is not fully loaded, loot generation may fail. Ensure the plugin is used after the game has started.
• Custom Equipment: If using dynamically created items, ensure they are added to the loot pool manually or through integration with other plugins.

Changelog

Version 1.0.0

• Initial release with support for random loot, loot groups, drop weights, and popups.

Compatibility

This plugin is compatible with:

• ED5_RandomizeItemStats: Adds random prefixes to loot.
• ED5_Reforge: Supports reforged items in the loot pool.
• ED5_EquipmentCreator: Includes dynamically created equipment in the loot pool.

Changelog

Version 1.0.0

• Initial release with support for random loot, loot groups, drop weights, and popups.