ED5 Mounts Plugin Documentation and Setup Guide

Plugin Overview

The ED5 Mounts Plugin allows you to create custom rideable mounts for your RPG Maker MZ game. Players can interact with events to ride them as mounts, with support for flight, custom offsets, animations, and visual equipment integration.

Features

• Custom Mounts: Turn any event into a rideable mount.
• Flight Mode: Allow mounts to ignore movement restrictions.
• Player Position Offsets: Adjust the player's position on the mount.
• Visual Equipment Integration: Equipment sprites are displayed correctly while mounted.
• Motion Animation: Add swaying or bouncing motion to the player while mounted.
• Z-Index Control: Proper layering of mounts, players, and equipment based on direction.
• Simple Mount/Dismount System: Easy interaction to mount and dismount.

How to Use

1. Setting Up a Mount

To make an event a mount, follow these steps:

1. Add <Vehicle> to the event's Note field:
   • This marks the event as a mount.
2. Add optional tags in the event's Comment field:
   • <speed: X>: Set the mount's movement speed (default: 4).
   • <xOffset: X>: Adjust the player's horizontal position on the mount (default: 0).
   • <yOffset: X>: Adjust the player's vertical position on the mount (default: 0).
   • <fly: 1>: Enable flight mode, allowing the mount to ignore movement restrictions.
   • <playerMotion: X>: Enable (1) or disable (0) motion animation for the player (default: 0).
   • <motion: X>: Set the height of the player's swaying motion (default: 4).
3. Example Setup:
   • Note Field: <Vehicle>
   • Comment Field: <speed: 5> <xOffset: 10> <yOffset: -5> <fly: 1> <playerMotion: 1> <motion: 6>

2. Z-Index Control

Control how the player and visual equipment are layered relative to the mount using these tags in the Comment field:

• <playerLayerR: X>: Z-index when facing Right.
• <playerLayerU: X>: Z-index when facing Up.
• <playerLayerL: X>: Z-index when facing Left.
• <playerLayerD: X>: Z-index when facing Down.

Behavior:

• 1: Player is drawn below the mount.
• 0: Player is drawn above the mount (default).

Example:

<playerLayerR: 1>

<playerLayerU: 0>

<playerLayerL: 1>

<playerLayerD: 0>

3. Mount Interaction

• To Mount: Interact with the event (press the action button).
• To Dismount: Press the OK button (default: Z or Enter).

Advanced Features

1. Motion Animation

• Enable motion animation with <playerMotion: 1>.
• Adjust the height of the motion with <motion: X> (e.g., <motion: 8> for higher swaying).

2. Flight Mode

• Add <fly: 1> to allow the mount to ignore terrain restrictions (e.g., walk over water or cliffs).

Example Use Case

Flying Dragon Mount

• Note Field: <Vehicle>
• Comment Field: <speed: 6> <xOffset: 0> <yOffset: -20> <fly: 1> <playerMotion: 1> <motion: 8> <playerLayerR: 1> <playerLayerU: 1> <playerLayerL: 1> <playerLayerD: 1>

This setup creates a flying dragon mount with:

• Speed of 6.
• Player positioned slightly above the dragon.
• Motion animation enabled with a height of 8.
• Player always drawn on top of the dragon.

Plugin Commands

This plugin does not require plugin commands. All functionality is controlled through event Notes and Comments.

Compatibility

• Visual Equipment Plugin: Fully compatible. Equipment sprites are displayed correctly while mounted.
• Alpha ABS
• Other Plugins: Ensure no other plugins overwrite player movement or sprite behavior.

Troubleshooting

1. Player Not Visible While Mounted:
   • Ensure the <Vehicle> tag is in the event's Note field.
   • Check that the event has a valid character sprite.
2. Motion Animation Not Working:
   • Add <playerMotion: 1> to the event's Comment field.
   • Ensure <motion: X> is set to a positive value.
3. Z-Index Issues:
   • Use <playerLayerX: X> tags to control layering for each direction.

Changelog

Version 1.3

• Added <playerMotion: X> to enable/disable motion animation.
• Added <motion: X> to control the height of the player's swaying motion.
• Improved z-index handling for mounts, players, and visual equipment.
• Fixed bugs related to player visibility and sprite layering.

Support

For questions or support, comment.