Item Menu Categories (YEP)

From Yanfly.moe Wiki
Jump to navigation Jump to search


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.

Download

Required Plugins

The following plugins are required in order to use this plugin.

Place the following plugins above this plugin located in the Plugin Manager.

Yanfly Engine Plugins

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


Introduction

This plugin requires YEP_ItemCore. Make sure this plugin is located under
YEP_ItemCore in the plugin list.

In RPG Maker MV, there exists only four categories seen in the item menu:
Items, Weapons, Armors, and Key Items. Adding extra categories wouldn't be
possible without plugins. This plugin, through the help of Item Core, will
allow you to add in many more categories in addition to many premade ones
that are automatically added based on weapon types, armor types, equipment
types, item usage, and more!

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

Instructions

To change the item categories that appear in the item menu, go to the plugin
parameters and alter the list. Separate each category with a comma (,). Each
category must be spelled correctly using the following formats:

-----------------------   --------------------------------------------------
Plugin Parameter Syntax   Description
-----------------------   --------------------------------------------------
Items                     Lists only Regular Item types
AllItems                  All items in the items database with Key Items

RegularItems              Lists only Regular Item types
KeyItems                  Lists only Key Item types
HiddenItemA               Lists only Hidden Item A types
HiddenItemB               Lists only Hidden Item B types
Consumable                Lists only consumable items
Nonconsumable             Lists only nonconsumeable items
AlwaysUsable              Lists only always usable items
BattleUsable              Lists only battle usable items
FieldUsable               Lists only field usable items
NeverUsable               Lists only never usable items

Weapons                   Lists all weapons
WType:x                   Lists weapons of type x (replace x with ID)

Armors                    Lists all armors
AType:x                   Lists armors of armor type x (replace x with ID)

EType:x                   Lists items of equip type x (replace x with ID)

Category:x                Lists items of category x (replace x with text)

An example of a list that would display something like:
  Items
  Key Items
  Dagger
  Sword
  Bodygear
  Accessory
  Herbs

Would look like this for the plugin parameters:

  Items, KeyItems, WType:1, WType2, AType1, AType2, Category:Herbs

The categories go in the order they're listed so plan them out accordingly.

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.

To add custom categories to items, use the following notetag:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Item, Weapon, and Armor Notetags:

  <Menu Category: x>
  <Menu Category: x, x, x>
  - Replace 'x' with the category name you wish to give the item. Insert
  multiples of this tag to insert more categories. These categories will be
  used in combination with the Category:x plugin parameter syntax keyword.

  For Example:

    <Menu Category: Herbs>

  Would require this syntax keyword in the plugin parameters:

    Category:Herbs

  If you use the version of the notetag with multiple categories, it would
  work something like this:

    <Menu Category: Herbs, Potions, Elixirs>

  Plugin Parameter:

    Category:Herbs, Category:Potions, Category:Elixirs

  **Note** The notetag does not apply for any of the pre-made categories.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Changelog

Version 1.01:
- Updated for RPG Maker MV version 1.5.0.

Version 1.00:
- Finished Plugin!