Footstep Sounds (YEP)

From Yanfly.moe Wiki
Jump to navigation Jump to search

Welcome to the wiki! This is where you can find resources from Yanfly.moe, Ækashics.moe,
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.



Download

System

This is a plugin created for RPG Maker MV.

For help on how to install plugins, click here.

For help on how to update plugins, click here.

Got errors with your RPG Maker MV plugin? Click here.

Yanfly Engine Plugins

This plugin is a part of the Yanfly Engine Plugins library.


Introduction

This plugin gives your player and/or events footsteps when they walk onto
tiles. These footsteps made by players and/or events can have different
sounds based on regions, tilesets, and/or terrain tags. If footsteps are
enabled for events, they can have distance based volumes and pitches to
immerse the player further.

This is a collaboration plugin by Chickie and Yanfly to ensure compatibility
with the Yanfly Engine Plugins library.

Instructions

This plugin requires a bit of setup. Adjust the plugin parameters to set up
a default set of footsteps that are to be played when nothing else has been
set. These sound effects will be played when there are no region-specific
sound effects or terrain tag-specific sound effects.

That said, if you go into your project's database and go to the Tilesets tab
you can set footsteps for each tileset. The tiles can play specific footstep
sounds based on their terrain tag ID. Look in the notetags section below for
the notetag setup on how to make a set of tiles play certain footsteps. The
footsteps made here have higher priority than the default sound effects and
if the player or event steps on a tile that has a footstep sound tied to a
terrain tag, that footstep sound will be played instead.

Even higher on the priority level are the region-based footstep sounds. If
the player or an event steps on a tile that has a region-based footstep
sound, then that sound will be played regardless of the terrain tag setting
made for that specific tile. Look in the notetags section below for the
notetag setup on how to make a specific region ID play a footstep sound.

To sum it up, from lowest to highest priority:

  LOWEST  - Default Footstep Sound
            Terrain Tag Footstep Sound
  HIGHEST - Region-Based Footstep Sound

If you wish to give a whole map a certain footsteps sound, use the notetag
to set a region-based footstep sound for region ID 0.

Notetags

NotetagsMV.png

RPG Maker MV's editor is unable to allow for custom traits/properties that a game dev may wish to associate with a database object, event, map, etc. Notetags are used to work around such limitations by allowing the game dev to tag certain traits/properties using specific Notetags declared by the related plugin.

Here is a list of Notetag(s) that you may use.

---

Insert the following notetags to add footsteps to your maps.

Event Notetag:

  <No Footsteps>
  - Insert this into the notebox of any event you wish to not make any
  footsteps when moving.

Tileset Notetags:

  <Terrain Tag x Footstep Sound: filename>
  <Terrain Tag x Footstep Sound: filename, volume>
  <Terrain Tag x Footstep Sound: filename, volume, pitch>
  - Replace 'x' with the terrain tag ID (from 1 to 7). If 0 is used, it will
  be ignored.  When inserting the filename, the filename must be case
  sensitive and must not include the extension. The 'volume' and 'pitch'
  variables must be integar values between 0 and 100 if they are used.

  Examples:

  <Terrain Tag 1 Footstep Sound: Move1>
  <Terrain Tag 2 Footstep Sound: Move2, 80>
  <Terrain Tag 3 Footstep Sound: Move3, 75, 150>

  In the above examples, the tiles marked by terrain tags 1, 2, or 3 will
  play their respective sound effect when stepped on by the player or an
  event that can trigger footsteps.

Map Notetags:

  <Region x Footstep Sound: filename>
  <Region x Footstep Sound: filename, volume>
  <Region x Footstep Sound: filename, volume, pitch>
  - Replace 'x' with the region tag ID (from 1 to 255). If 0 is used, it
  will become the default footstep sound.  When inserting the filename, the
  filename must be case sensitive and must not include the extension. The
  'volume' and 'pitch' variables must be integar values between 0 and 100 if
  they are used.

  Examples:

  <Region 10 Footstep Sound: Move1>
  <Region 20 Footstep Sound: Move2, 80>
  <Region 30 Footstep Sound: Move3, 75, 150>

  In the above examples, the tiles marked by regions 10, 20, or 30 will play
  their respective sound effect when stepped on by the player or an event
  that can trigger footsteps.

Plugin Commands

PluginCommandsMV.png

Plugin Commands are event commands that are used to call upon functions added by a plugin that aren't inherently a part of RPG Maker MV.

Here is a list of Plugin Command(s) that you may use:

If at any time you wish to enable/disable footstep sounds in your game, you
can use some plugin commands to do so.

Plugin Commands:

  EnableFootsteps
  - Turns on footstep sounds.

  DisableFootsteps
  - Turns off footstep sounds.