Difference between revisions of "Bestiary VisuStella MZ"

From Yanfly.moe Wiki
Jump to navigation Jump to search
(Changelog)
Line 1: Line 1:
 
{{MzPlugin
 
{{MzPlugin
<!-- |preview = <youtube>link</youtube> -->
+
<!-- |preview = <youtube>https://youtu.be/VGzXdawZ16M</youtube> -->
 
|preview = [[File:VisuMZ.118.jpg|600px]]
 
|preview = [[File:VisuMZ.118.jpg|600px]]
 
|link1 = <html><iframe frameborder="0" src="https://itch.io/embed/1953110" width="552" height="167"><a href="https://visustellamz.itch.io/bestiary">Bestiary plugin for RPG Maker MZ by VisuStellaMZ</a></iframe></html>
 
|link1 = <html><iframe frameborder="0" src="https://itch.io/embed/1953110" width="552" height="167"><a href="https://visustellamz.itch.io/bestiary">Bestiary plugin for RPG Maker MZ by VisuStellaMZ</a></iframe></html>

Revision as of 14:13, 20 March 2023

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.


VisuMZ.118.jpg


Download

System

This is a plugin created for RPG Maker MZ.

InstallPluginsMz.png

UpdatePlugins.png

Troubleshooting.jpg

Click here for help on how to install plugins and an explanation on the Tier Hierarchy System.

Click here to learn how to update plugins.

Click here for how to troubleshoot plugins if you get an error.


Masterarbeit Writer


Bestiary Preview1.png

Bestiary Preview2.png

Bestiary Preview3.png

Bestiary Preview4.png

Bestiary Preview5.png

Bestiary Preview6.png

Bestiary Preview7.png


VisuStella MZ

This plugin is a part of the VisuStella MZ Plugin Library.

Click here if you want to help support VisuStella on Patreon.

Introduction

VisuMZ.118.jpg

This plugin adds a new scene accessible through (but not limited to) the Main Menu, the Bestiary. The Bestiary is a monster book/encyclopedia that will update as the player plays the game. When an enemy is defeated, the player can view that enemy through the Bestiary to see the enemy's stats, elemental resistances and weaknesses, skills, rewards, and more.

Features include all (but not limited to) the following:

  • Access the Bestiary through the Main Menu or through Plugin Commands.
  • Enemies will automatically populate the Bestiary as they are seen in battle and defeated.
  • The player can access the full information of an enemy after defeating it.
  • Full information found in the bestiary includes the basic stats, elemental weaknesses and resistances, skills, rewards (EXP, Gold, Drops, etc.), and any added Lore.
  • If the VisuStella MZ Elements and Status Menu Core is added, Traits are also added to the Bestiary.
  • The VisuStella MZ Enemy Levels plugin gives functionality to view enemy stats at different levels.
  • The VisuStella MZ Extra Enemy Drops will show any and all additional drops including conditional drops.
  • The VisuStella MZ Class Change Core and Skill Learn System will show any AP, CP, JP, and SP rewards, too.
  • Selected skills found in the Bestiary will have a help window appear that will also list what the skill does.
  • The game dev can add in custom lore to an enemy's entry through notetags.

Requirements

This plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker.


Tier 2

This plugin is a Tier 2 plugin. Place it under other plugins of lower tier value on your Plugin Manager list (ie: 0, 1, 2, 3, 4, 5).

This is to ensure that your plugins will have the best compatibility with the rest of the VisuStella MZ Plugin library.


Extra Features

There are some extra features found if other VisuStella MZ plugins are found present in the Plugin Manager list.

---

Elements and Status Menu Core VisuStella MZ

Bestiary Preview6.png

When this plugin is used together with VisuStella MZ's Elements and Status Menu Core plugin, the "Traits" data page becomes available. It lets the player adjust the trait properties for the enemy being viewed so that the player can view the changes when different traits are applied.

---

Enemy Levels VisuStella MZ

Bestiary Preview2.png

When used together in the same project as VisuStella MZ's Enemy Levels plugin, new commands will appear under the "Basic" parameters window, allowing the player to adjust the level of the currently viewed enemy in order to see their parameters across different levels.

---

Extra Enemy Drops VisuStella MZ

Bestiary Preview5.png

When used together in the same project as VisuStella MZ's Extra Enemy Drops plugin, extended drops will be listed as well as conditional drops (although the conditional drops will not display how they are acquired).

---

VisuStella MZ Compatibility

While this plugin is compatible with the majority of the VisuStella MZ plugin library, it is not compatible with specific plugins or specific features. This section will highlight the main plugins/features that will not be compatible with this plugin or put focus on how the make certain features compatible.

---

Core Engine VisuStella MZ

Bestiary Preview2.png

When used together in the same project as VisuStella MZ's Core Engine, this plugin will display the Extended Parameters dictated by the Core Engine. The icons assigned by the Core Engine will also be utilized, too.

---

Battle Core VisuStella MZ

Bestiary Preview4.png

When used together in the same project as VisuStella MZ's Battle Core, the notetags <Display Icon: x> and <Display Text: string> will be used on top of displayed enemy skills to portray their displayed appearances.

---

Elements and Status Menu Core VisuStella MZ

Bestiary Preview3.png

When used together in the same project as VisuStella MZ's Elements and Status Menu Core, any excluded elements found in that plugin's Plugin Parameters will also be used here to exclude certain elements, too.

---

Class Change System VisuStella MZ

Bestiary Preview5.png

When used together in the same project as VisuStella MZ's Class Change System plugin, the CP and JP gains from enemies can be displayed under the "Rewards" page as long as the rewards are intended to be shown in the victory reward gains.

---

Skill Learn System VisuStella MZ

Bestiary Preview5.png

When used together in the same project as VisuStella MZ's Skill Learn System plugin, the AP and SP gains from enemies can be displayed under the"Rewards" page as long as the rewards are intended to be shown in the victory reward gains.

---

Notetags

RPG Maker MZ'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.

The following are notetags that have been added through this plugin. These notetags will not work with your game if this plugin is OFF or not present.

---

Bestiary-Related Notetags

---

Bestiary Preview1.png

<Bestiary Category: x>
<Bestiary Categories: x, x, x>

- Used for: Enemy Notetags
- Displays this enemy in the Bestiary category(ies) 'x'.
- Replace 'x' with the ID Key of the category or categories found in the
  Plugin Parameters.
- If this notetag is not used, use the default category determined by the
  Plugin Parameters.

---

<Hide in Bestiary>

- Used for: Enemy Notetags
- Prevents this enemy from being listed in the Bestiary.

---

Bestiary Preview2.png

<Bestiary Custom Picture: filename>

- Used for: Enemy Notetags
- Makes this enemy display a custom picture in the Bestiary instead of the
  battler graphic used in-game.
- Replace 'filename' with the name of the image file to pick from the game
  project's /img/pictures/ folder.
  - Filenames are case sensitive.
  - Leave out the filename extension from the notetag.

---

Bestiary Preview3.png

<Bestiary Battleback 1: filename>
<Bestiary Battleback 2: filename>

- Used for: Enemy Notetags
- Makes this enemy display a custom battleback background in the Bestiary
  instead of the default graphic determined by the Plugin Parameters.
- Replace 'filename' with the name of the image file to pick from the game
  project's /img/battlebacks1/ and /img/battlebacks2/ folders.
  - Filenames are case sensitive.
  - Leave out the filename extension from the notetag.
- If these notetags are not used, use the default settings found in the
  Plugin Parameters instead.

---

Bestiary Preview7.png

<Bestiary Lore>
 text
 text
 text
</Bestiary Lore>

- Used for: Enemy Notetags
- Inserts the written 'text' as the enemy's lore in the Bestiary.
- Replace 'text' with whatever you want as the enemy's lore.
- If this notetag is not used, then the text displayed will be the default
  settings found in the Plugin Parameters.

---

Bestiary Preview4.png

<Hide Skill in Bestiary>

- Used for: Skill Notetags
- Prevents this skill from being listed in the Bestiary.

---

Plugin Commands

PluginCommandsMZ.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 MZ.

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

---

The following are Plugin Commands that come with this plugin. They can be accessed through the Plugin Command event command.

Bestiary Plugin Commands

Bestiary Preview2.png

---

Bestiary Command0.png

Bestiary: Reveal Enemies
- Reveals bestiary information for target enemies without needing to defeat them.
- Must not be forcefully hidden.

  Enemy ID(s):
  - Reveals Bestiary information for target enemies.
  - Must not be forcefully hidden.

---

Debug Plugin Commands

---

Bestiary Preview1.png

Bestiary Command1.png

Debug: Full Bestiary?
- For playtest only! Allows you to fully view Bestiary.
- Resets when the game client is closed.

  Reveal?:
  - Fully reveals Bestiary for playtesting.
  - Resets when the game client is closed.

---

Scene Plugin Commands

---

Bestiary Preview1.png

Bestiary Command2.png

Scene: Open Bestiary
- Opens the Bestiary scene.
- Cannot be used in battle.

---

System Plugin Commands

---

Bestiary Preview8.png

Bestiary Command3.png

System: Enable Bestiary in Menu?
- Enables/disables Bestiary menu inside the main menu.

  Enable/Disable?:
  - Enables/disables Bestiary menu inside the main menu.

---

Bestiary Preview8.png

Bestiary Command4.png

System: Show Bestiary in Menu?
- Shows/hides Bestiary menu inside the main menu.

  Show/Hide?:
  - Shows/hides Bestiary menu inside the main menu.

---

Plugin Parameters

Enemy Categories List Settings

Bestiary Preview1.png

Bestiary Param1.png

List of categories that are used for the bestiary.

By default, categories are hidden away until one enemy in that category has been seen (not necessarily defeated). Once seen, the category is visible for the player to browser through. This is to prevent spoilers based on the category name (in case the game developer decides to name categories based on regions for example).

The "Default Category", however, will always be visible to the player regardless of whether or not an enemy has been seen inside of it. Therefore, it's best to use the "Default Category" as a category for commonly seen enemies in the game.

---

Category

 ID Key:
 - This category's identification key.
 - Categories require unique keys for the plugin to differentiate them.
 - Used with <Bestiary Category: x> notetag.
 Title:
 - This category's title.
 - You may use text codes.

---

Plugin Parameters

 Default Category:
 - Default enemy category when no notetag is used.

---

Main Menu Settings

Bestiary Param2.png

Set up the main menu defaults.

---

Main Menu Settings

 Command Name:
 - Name of the 'Bestiary' option in the Main Menu.
 Show in Main Menu?:
 - Add the 'Bestiary' option to the Main Menu by default?
 Enable in Main Menu?:
 - Enable the 'Bestiary' option to the Main Menu by default?

---

Background Settings

Bestiary Preview2.png

Bestiary Param3.png

Background settings for Scene_Bestiary.

---

Background Settings

 Snapshop Opacity:
 - Snapshot opacity for the scene.
 Background 1:
 - Filename used for the bottom background image.
 - Leave empty if you don't wish to use one.
 Background 2:
 - Filename used for the upper background image.
 - Leave empty if you don't wish to use one.

---

Vocabulary Settings

Bestiary Preview4.png

Bestiary Param4.png

These settings let you adjust the text displayed for this plugin.

---

Button Assist Window

 Collapse:
 - Text used to collapse a category.
 - Requires VisuMZ_0_CoreEngine!
 Expand:
 - Text used to expand a category.
 - Requires VisuMZ_0_CoreEngine!
 Scroll Fast:
 - Text used to scroll enemy lore quickly.
 - Requires VisuMZ_0_CoreEngine!
 Scroll Slow:
 - Text used to scroll enemy lore slowly.
 - Requires VisuMZ_0_CoreEngine!
 Switch Enemy:
 - Text used to switch an enemy.
 - Requires VisuMZ_0_CoreEngine!
 View:
 - Text used to view an enemy.
 - Requires VisuMZ_0_CoreEngine!

---

Main Windows > List Window

 Category (Closed):
 Category (Opened):
 - Text format used for closed/open categories.
 - %1 - Category Name, %2 - Percent Complete
   Decimal Places:
   - Decimal places for completion percentages.
 Mask Character:
 - Text character used to mask unknown enemy names.

---

Main Windows > Name Window

 Category Text:
 - Text used when selecting an enemy.

---

Main Windows > Sub Window

 Completion Rate:
 - Text used to announce completion rate.
 - %1 - Percentage, %2 - Defeated, %3 - Total
   Decimal Places:
   - Decimal places for completion percentage.
 Defeated:
 - Text used to announce defeated monsters.
 - %1 - Defeated Number
 Encountered:
 - Text used to announce encountered monsters.
 - %1 - Encountered Number

---

Data Windows > Category Window

 Basic Text:
 Elements Text:
 Skills Text:
 Rewards Text:
 Traits Text:
 Lore Text:
 - Text used for this command.
   Icon:
   - Icon used for this command.

---

Data Windows > Basic Window

 Level Up To Max:
 Level Up By One:
 Level Down By One:
 Level Down To Min:
 - Text used for leveling.
 - Text codes allowed.
 - Requires VisuMZ_3_EnemyLevels!
 - %1 - Level Name

---

Data Windows > Elements Window

 Weak to Element:
 Neutral to Element:
 Resistant to Element:
 Immune to Element:
 Absorbs Element:
 - Text used with this elemental affinity.
 - Text codes allowed.

---

Data Windows > Rewards Window

 Drop Rate 100%:
 Drop Rate >= 50%:
 Drop Rate >= 20%:
 Drop Rate >= 10%:
 Drop Rate < 10%:
 Conditional Rate:
 - Text used for this kind of drop rate.
 - Text codes allowed.

---

Data Windows > Traits Window

 Category (Closed):
 Category (Opened):
 - Text format used for closed/open categories.
 - Text codes allowed.
 - %1 - Category Name
 Help Description:
 - Help description used for trait categories.
 - Text codes allowed.
 Null Help:
 - Help description used for no traits.
 - Text codes allowed.

---

Data Windows > Lore Window

 Default Lore:
 - Text when no lore is found.
 - Text codes allowed.

---

Window Settings

Bestiary Preview6.png

Bestiary Param5.png

These settings let you adjust the windows displayed for this plugin.

---

Help Window

 Background Type:
 - Select background type for this window.
 Scale Window:
 - Scale the help window to fit with the enemy preview window?
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Main Windows > Image Window

 Background Type:
 - Select background type for this window.
 Blur Strength:
 - What is the blur strength used for unknown enemies?
 Default Battleback 1:
 Default Battleback 2:
 - Default battleback 1 image used for enemies without
   <Bestiary Battleback 1: filename> and <Bestiary Battleback 2: filename>
   notetags.
 Padding:
 - What is the padding value used for this window?
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Main Windows > List Window

 Background Type:
 - Select background type for this window.
 Delay MS:
 - How many milliseconds (MS) to delay the preview update?
 - This is to prevent lag spikes.
 Mask Unknown Enemies:
 - Apply a character mask to unknown enemies?
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Main Windows > Name Window

 Background Type:
 - Select background type for this window.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Main Windows > Sub Window

 Background Type:
 - Select background type for this window.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Data Windows

 JS: X, Y, W, H:
 - Code used to determine the dimensions for all data windows.

---

Data Windows > Category Window

 Background Type:
 - Select background type for this window.
 Category Order:
 - What order do you want the commands to appear in?
 Style:
 - How do you wish to draw commands for this window?
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Data Windows > Basic Window

 Background Type:
 - Select background type for this window.
 Show Level Change:
 - Show level change commands?
 - Requires VisuMZ_3_EnemyLevels!

---

Data Windows > Elements Window

 Background Type:
 - Select background type for this window.

---

Data Windows > Skills Window

 Background Type:
 - Select background type for this window.

---

Data Windows > Rewards Window

 Background Type:
 - Select background type for this window.
 Rewards Order:
 - What order do you want the rewards to appear in?
 Reward EXP Icon:
 - Icon used for EXP reward.
 Reward Gold Icon:
 - Icon used for Gold reward.

---

Data Windows > Traits Window

 Background Type:
 - Select background type for this window.
 Show All Traits:
 - Show all traits? Including unused ones?
 - Requires VisuMZ_1_ElementStatusCore!

---

Data Windows > Lore Window

 Auto Word Wrap?:
 - Automatically enable word wrap?
 - Requires VisuMZ_1_MessageCore!
 Background Type:
 - Select background type for this window.
 Font Size:
 - Font size used for Lore Window.
 Scrolling > Slow:
   Scroll Speed:
   - What speed will Up/Down scroll the window at?
   - Lower is slower. Higher is faster.
   Sound Frequency:
   - How frequent will Up/Down scrolling make sounds?
   - Lower is quicker. Higher is later.
 Scrolling > Fast:
   Scroll Speed:
   - What speed will Up/Down scroll the window at?
   - Lower is slower. Higher is faster.
   Sound Frequency:
   - How frequent will Up/Down scrolling make sounds?
   - Lower is quicker. Higher is later.

---


Terms of Use

1. These plugins may be used in free or commercial games provided that they have been acquired through legitimate means at VisuStella.com and/or any other official approved VisuStella sources. Exceptions and special circumstances that may prohibit usage will be listed on VisuStella.com.

2. All of the listed coders found in the Credits section of this plugin must be given credit in your games or credited as a collective under the name: "VisuStella".

3. You may edit the source code to suit your needs, so long as you do not claim the source code belongs to you. VisuStella also does not take responsibility for the plugin if any changes have been made to the plugin's code, nor does VisuStella take responsibility for user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow custom JavaScript code.

4. You may NOT redistribute these plugins nor take code from this plugin to use as your own. These plugins and their code are only to be downloaded from VisuStella.com and other official/approved VisuStella sources. A list of official/approved sources can also be found on VisuStella.com.

5. VisuStella is not responsible for problems found in your game due to unintended usage, incompatibility problems with plugins outside of the VisuStella MZ library, plugin versions that aren't up to date, nor responsible for the proper working of compatibility patches made by any third parties. VisuStella is not responsible for errors caused by any user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow JavaScript code.

6. If a compatibility patch needs to be made through a third party that is unaffiliated with VisuStella that involves using code from the VisuStella MZ library, contact must be made with a member from VisuStella and have it approved. The patch would be placed on VisuStella.com as a free download to the public. Such patches cannot be sold for monetary gain, including commissions, crowdfunding, and/or donations.

7. If this VisuStella MZ plugin is a paid product, all project team members must purchase their own individual copies of the paid product if they are to use it. Usage includes working on related game mechanics, managing related code, and/or using related Plugin Commands and features. Redistribution of the plugin and/or its code to other members of the team is NOT allowed unless they own the plugin itself as that conflicts with Article 4.

8. Any extensions and/or addendums made to this plugin's Terms of Use can be found on VisuStella.com and must be followed.

Terms of Use: Japanese


『VisuStella MZ』利用規約

1. これらのプラグインは、VisuStella.comおよび/または公式に承認されたVisuStellaのソースから合法的な手段で入手したものである限り、フリーゲームや商用ゲームに使用することができます。例外的に使用が禁止される場合については、VisuStella.comの記載をご確認ください。

2. 本プラグインの「クレジット」部分に記載されているすべてのコーダーの名前は、ゲーム内にクレジット表記を行うか、もしくは「VisuStella」という名前の下にまとめて表記する必要があります。

3. ソースコードを自分のものだと主張しない限りは、必要に応じて編集することが可能です。ただしプラグインのコードに変更が加えられた場合、VisuStellaはそのプラグインに対して一切の責任を負いません。高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードについても、VisuStellaは一切の責任を負いません。

4. これらのプラグインやプラグイン内のコードを、「自分のもの」として再配布したり使用したりすることはできません。これらのプラグインとそのコードは、VisuStella.comおよび、その他の公式/承認済みVisuStellaソースからのみダウンロードすることができます。公式/承認済みのソースのリストは、VisuStella.comでご確認いただけます。

5. VisuStellaは、意図しない使用方法による問題、VisuStella MZライブラリ以外のプラグインとの非互換性の問題、プラグインのバージョンが最新でないことによる問題、第三者による互換性パッチが適切に動作していないことなどが原因でゲーム内で発生した問題については、一切の責任を負いません。VisuStellaは、高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードに起因するエラーについても、一切の責任を負いません。

6. VisuStella MZライブラリのコードを使用した互換性パッチをVisuStellaとは関係のない第三者を通じて作成する必要がある場合は、まずVisuStellaのメンバーと連絡を取り、承認を得る必要があります。パッチはVisuStella.comに公開され、誰でも無料でダウンロードすることができるようになります。このようなパッチを、制作発注やクラウドファンディングの対象にしたり、寄付などの金銭的な利益を得るために販売することはできません。

7. このVisuStella MZプラグインが商用製品である場合、プロジェクトチームのすべてのメンバーは、それを使用するため、それぞれ製品を購入しなければなりません。使用方法には、関連するゲームメカニクスの作業、関連するコードの管理、および/または関連するプラグインコマンドや機能の使用、が含まれます。プラグインそのものやそのコードをチームの他のメンバーに再配布することは第4項に抵触するため、そのメンバーがプラグインそのものを所有していない限りは許可されません。

8. このプラグインの利用規約の追加項目や補足については、VisuStella.comに掲載されていますので、それを参照し従ってください。

Credits

If you are using this plugin, credit the following people in your game:

Team VisuStella

Changelog

Version 1.01: March 16, 2023

  • Bug Fixes!
    • Fixed a bug that allowed players to scroll to unrevealed enemies. Fix made by Irina.


Version 1.00 Official Release Date: April 3, 2023

  • Finished Plugin!

End of File