Skip to content

Instantly share code, notes, and snippets.

@KageDesu

KageDesu/alternarive_equipment_menu_guide.md

Last active October 13, 2025 14:15
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save KageDesu/13bfa559ab86e3ab0fe253ecfbc58aa9 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save KageDesu/13bfa559ab86e3ab0fe253ecfbc58aa9 to your computer and use it in GitHub Desktop.
Download ZIP
Alterantive Equipment Menu RPGMZ Plugin Guide
Raw
alternarive_equipment_menu_guide.md

PKD Alternative Equipment Menu - User Guide

AlterEquipMenu

Table of Contents

  1. Overview
  2. Installation
  3. Basic Configuration
  4. Equipment Slot Configuration
  5. Visual Customization
  6. Actor Notetags
  7. Equipment Notetags
  8. Advanced Features
  9. Script Calls
  10. Compatibility
  11. Troubleshooting

Overview

The PKD Alternative Equipment Menu plugin transforms RPG Maker MZ's default equipment menu into a highly customizable and visually appealing interface. This plugin provides:

  • Visual Equipment Slots: Display equipment slots overlaid on character silhouettes
  • Custom Parameter Display: Show additional parameters with custom icons and positioning
  • Flexible Window Layout: Customize window positions and sizes
  • Rich Visual Elements: Add character portraits, backgrounds, and visual effects
  • Sound Customization: Custom sound effects for different equipment slots
  • Advanced Configuration: Fine-tune every aspect of the equipment interface
Comparision bak

Installation

  1. Download the Plugin: Place PKD_AlterEquipMenu.js in your js/plugins folder
  2. Add Resources: Extract the img/pAlterEquipMenu folder to your project's img directory
  3. Enable Plugin: Activate the plugin in the Plugin Manager
  4. Configure Settings: Open the plugin parameters to customize your equipment menu

Basic Configuration

Window Layout Options

The plugin offers two main layout modes:

Standard Layout

Uses RPG Maker's default window positioning with enhanced visuals.

Custom Layout (PRO Feature)

Enable "Is Use Custom Positions?" to unlock advanced window positioning:

  • Slots Window: Contains equipment slots and character silhouette
  • Status Window: Shows character parameters and statistics
  • Items Window: Displays available equipment items
  • Commands Window: Equipment menu commands
  • Help Window: Item descriptions and information
Custom window layout configuration

Window Skins (PRO Feature)

Customize the appearance of each window with different windowskins:

  • Slots Window skin
  • Status Window skin
  • Items Window skin
  • Commands Window skin

Equipment Slot Configuration

Slot Positions

Configure the X,Y coordinates for each equipment slot type. The plugin supports up to 10 different equipment types with customizable positions.

Default Slot Layout:

  • Weapon (Type 1): Position 20, 200
  • Shield (Type 2): Position 210, 200
  • Helmet (Type 3): Position 110, 52
  • Armor (Type 4): Position 110, 120
  • Accessory (Type 5): Position 210, 52
Equipment slot positioning diagram

Slot Appearance

  • Slot Size: Adjust the size of equipment slots (default: 48px)
  • Disabled Icon: Choose an icon for sealed/unavailable slots (default: icon 21)

Visual Customization

Character Images

Character Portrait (<pEquipImg:NAME>)

  • Purpose: Background image for the status window
  • Recommended Size: 248x400px
  • Location: img/pictures/ folder
  • Example: <pEquipImg:Actor1_2>

Character Silhouette (<pEquipBodyImg:NAME>)

  • Purpose: Background for equipment slots
  • Recommended Size: 280x440px
  • Location: img/pictures/ folder
  • Example: <pEquipBodyImg:WarriorSilhouette>
silhouette examples

Scene Background

Set a custom background image for the entire equipment scene:

  • Location: img/pAlterEquipMenu/ folder
  • Configuration: Equipment Scene Background Image parameter

Actor Name Display

  • Actor Name Position: Customize character name placement
  • Name Background: Add a background image behind the character name

Actor Notetags

Equipment Image Notetags

<pEquipImg:ImageName>       - Character portrait for equipment scene
<pEquipBodyImg:ImageName>   - Character silhouette for slot background

Slot Visibility Control

<pEquipSlotHide:N,N,...>    - Hide specific equipment slots

Examples:

  • <pEquipSlotHide:1> - Hide weapon slot
  • <pEquipSlotHide:1,4> - Hide weapon and armor slots
hidden slots

Custom Slot Positioning

<pEquipSlotPos:N,X,Y>       - Set custom position for slot N

Examples:

  • <pEquipSlotPos:1,20,40> - Move weapon slot to position 20,40
  • Multiple notes allowed for different slots
slot_pos

Equipment Notetags

Slot Background Customization

<pEquipSlotBack:ImageName>  - Custom slot background when equipped

Requirements:

  • Image location: img/pAlterEquipMenu/ folder
  • Recommended size: 48x48px
  • Applied when the item is equipped
Different slot backgroundss

Equipment Requirements

Set level and parameter requirements for equipment items. If requirements are not met, the item cannot be equipped.

Level Requirements

<requiredLevel:N>           - Minimum level required to equip item

Example:

  • <requiredLevel:15> - Requires character level 15 or higher

Parameter Requirements

<requiredMhp:N>             - Minimum Max HP required
<requiredMmp:N>             - Minimum Max MP required
<requiredAtk:N>             - Minimum Attack required
<requiredDef:N>             - Minimum Defense required
<requiredMat:N>             - Minimum Magic Attack required
<requiredMdf:N>             - Minimum Magic Defense required
<requiredAgi:N>             - Minimum Agility required
<requiredLuk:N>             - Minimum Luck required

Examples:

  • <requiredAtk:50> - Requires 50 or higher Attack stat
  • <requiredDef:30> - Requires 30 or higher Defense stat
  • <requiredMat:25> - Requires 25 or higher Magic Attack stat

Combining Requirements

You can combine multiple requirements on the same item:

Example Equipment Notetags:

<requiredLevel:20>
<requiredAtk:75>
<requiredDef:60>

This creates a high-level equipment that requires level 20, 75 Attack, and 60 Defense.

Note: Requirements are checked against the character's base parameters (without equipment bonuses). If any requirement is not met, the equipment cannot be equipped and will be grayed out or hidden in the equipment list.

Advanced Features

Custom Parameters Display

Extra Parameters

Add custom parameters with icons and positioning:

  • Parameter Selection: Choose from MHP, MMP, HIT, EVA, CRI, etc.
  • Icon Images: Custom parameter icons from img/pAlterEquipMenu/
  • Positioning: Precise X,Y coordinate control
  • Font Customization: Adjustable font size for parameter values
  • Icon Spacing: Control distance between icon and text
Custom parameters with icons displayed Custom parameters with icons displayed 2

Default Parameters Configuration

Customize the display of standard RPG Maker parameters (ATK, DEF, MAT, MDF, AGI, LUK):

Global Settings:

  • Padding, start positions, spacing between parameters
  • Font size for parameter values

Individual Parameter Control:

  • Icon and value positions for each parameter
  • Width settings for value display
  • Visibility toggles
  • Arrow width for stat changes
Default parameters configuration interface

Equipment Slot Enhancements

Slot Placeholders

Display custom icons in empty equipment slots:

  • Configuration: Equipment Type ID + Icon Index
  • Purpose: Visual indication of available slot types
placeholders

Custom Slot Sounds

Assign unique sound effects to different equipment types:

  • Configuration: Equipment Type ID + Sound Effect file
  • Location: audio/se/ folder
  • Trigger: Plays when equipping items to specific slots

Visual Effects

Actor Image Foreground

Add a darkening overlay effect:

  • Toggle: Enable/disable foreground dimming
  • Opacity: Adjustable transparency (default: 130)
  • Color: Customizable overlay color (default: black)

Parameter Change Arrows

Control arrow display for stat changes:

  • Always Show: Display arrows even when stats don't change
  • Conditional: Only show arrows for actual stat changes

Script Calls

Dynamic Image Assignment

SetCustomBodyImageForActor(actorId, imageName);

Example:

SetCustomBodyImageForActor(1, "WarriorBody");

Parameters:

  • actorId: The ID of the actor
  • imageName: Name of the image file (without extension)
  • Location: img/pictures/ folder

Compatibility

VisuMZ Items & Equips Core

When using with VisuMZ_1_ItemsEquipsCore:

  1. Configure VisuMZ Plugin: Adjust window positions to prevent overlapping
  2. Alternative: Disable VisuMZ extra windows and status menu features
  3. Testing: Verify both plugins work correctly together

RPG Maker Versions

  • Supported: RPG Maker MZ (primary), RPG Maker MV
  • Compatibility: Designed primarily for MZ with MV support

Troubleshooting

Common Issues

Window Overlapping

  • Custom Positions: Enable custom positioning and adjust coordinates
  • Window Sizes: Modify window dimensions in parameters
  • VisuMZ Conflicts: Configure VisuMZ plugin settings

Credits and Resources

Resource Customization

All images in img/pAlterEquipMenu/ can be edited for your project needs. Follow the recommended dimensions for best results.

End of Guide

For additional support and updates, visit the official plugin page at https://kdworkshop.net/plugins/equipment-menu

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment