Sideview Battle UI VisuStella MZ

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

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


UpdatePlugins.png

Click here to learn how to update plugins.


Troubleshooting.jpg

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



SideviewBattleUi Preview1.png

SideviewBattleUi Ani.gif

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.


VisuStella MZ

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


Support VisuStella

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


Introduction

SideviewBattleUi Preview1.png

This plugin changes the RPG Maker MZ Battle UI for Sideview Battle Systems into something more minimalistic. The menus are placed towards the player's party to let the player focus their attention to the center of the screen instead of to the lower ledges of the screen. The input command windows show up near the inputting actor to give the player a clear understanding of who is performing what action.

  • NOTE* To use this battle layout, you will need the updated version of

VisuStella's Battle Core. Go into its Plugin Parameters and change the Battle Layout Settings > Battle Layout Style > plugin parameter to this value: "Sideview Battle UI" or "sideview_ui".

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

  • This plugin changes the UI for the RPG Maker MZ Sideview Battle System.
  • Status windows appear on the side of the screen for each actor in battle.
  • The appearance is more compact for both the status windows and input command windows.
  • More of the battlefield can be seen with this kind of layout.
  • Lots of customization options to adjust the status windows.

Requirements

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

Required Plugin List

This plugin requires the above listed plugins to be installed inside your game's Plugin Manager list in order to work. You cannot start your game with this plugin enabled without the listed plugins.


Tier 3

This plugin is a Tier 3 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.


Major Changes

This plugin adds some new hard-coded features to RPG Maker MZ's functions. The following is a list of them.

---

Sideview Only

SideviewBattleUi Ani.gif

This plugin only works for the sideview battle system. If this layout is selected in the Battle Core, the battle system will automatically shift to sideview regardless of the settings.

  • NOTE* To use this battle layout, you will need the updated version of

VisuStella's Battle Core. Go into its Plugin Parameters and change the Battle Layout Settings > Battle Layout Style > plugin parameter to this value: "Sideview Battle UI" or "sideview_ui".

---

Window Properties

SideviewBattleUi Param2.png

With how the battle layout works, many of the command windows used in the battle system will have preset and hardcoded properties to them in order to maintain a specific aesthetic. These include columns, padding, and scaling types to name a few.

Therefore, any plugins that may alter these effects may not have any effect at all provided that this plugin is in a higher tier than those modifying it. This is an intended change to maintain the aesthetic and is not a bug.

---

Extra Features

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

---

SideviewBattleUi Preview1.png

Aggro Control System VisuStella MZ

Battle System - BTB VisuStella MZ

Boost Action VisuStella MZ

Break Shields VisuStella MZ

State Tooltips VisuStella MZ

There are features provided in this plugin for the above plugins. Their UI elements can be shown with this plugin's status windows.

---

Plugin Parameters

Battler Offset Settings

SideviewBattleUi Ani.gif

SideviewBattleUi Param1.png

Settings for battler sprite offsets when using the Sideview Battle UI. Since there's more room on the screen, placing them lower will help adjust for the player's visual comfort.

---

Settings

 Perform Offset?:
 - Offsets the battler sprite positions when using Sideview Battle UI.
 Offset X:
 - How much to offset the sprite positions by?
 - Negative goes left. Positive goes right.
 Offset Y:
 - How much to offset the sprite positions by?
 - Negative goes up. Positive goes down.

---

General Window Settings

SideviewBattleUi Preview1.png

SideviewBattleUi Param2.png

Settings for general windows when using the Sideview Battle UI. These settings are made for the windows that aren't the status windows but are affected by this plugin.

---

Global

 UI Scale:
 - What is the scaling rate for battle windows?
 - Use a number between 0 and 1 for the best results.

---

Help Window

 Fade BG Style?:
 - Fade the Help Window background with this UI?

---

Actor Command Window

 Max Rows:
 - What is the maximum number of rows for the actor command window with
   this UI?

---

Party Command Window

 Max Rows:
 - What is the maximum number of rows for the party command window with
   this UI?

---

Item Window

 Max Rows:
 - What is the maximum number of rows for the item window with this UI?
 Width:
 - What is the width item window with this UI?
 - This is the width BEFORE scaling.
 Offset X:
 - How much to offset the window X position by?
 - Negative goes left. Positive goes right.
 Offset Y:
 - How much to offset the window Y position by?
 - Negative goes up. Positive goes down.

---

Skill Window

 Max Rows:
 - What is the maximum number of rows for the skill window with this UI?
 Width:
 - What is the width skill window with this UI?
 - This is the width BEFORE scaling.
 Offset X:
 - How much to offset the window X position by?
 - Negative goes left. Positive goes right.
 Offset Y:
 - How much to offset the window Y position by?
 - Negative goes up. Positive goes down.

---

Status Window Settings

SideviewBattleUi Ani.gif

SideviewBattleUi Param3.png

Settings for the status window when using the Sideview Battle UI. Each of these plugin parameters allow you to adjust many of the various elements found inside of this window.

---

Dimensions

 Width Base:
 - How width is each actor's status window?
 - This is the width AFTER scaling.
 Height Base:
 - How tall do you want the status window to be?
 - 'auto' for automatic calculations.
 - This is the height BEFORE scaling.
   Height Buffer:
   - How much space do you want there to be vertically from window
     to window?
   - This is the height BEFORE scaling.
 Move Distance:
 - How far will the status window move when the actor is selected
   or active?
   Move Speed:
   - How many pixels with the status window move per frame?

---

Standard UI > Name

 Show?:
 - Show this UI element?
 Offset X:
 - How much to offset the UI X position by?
 - Negative goes left. Positive goes right.
 Offset Y:
 - How much to offset the UI Y position by?
 - Negative goes up. Positive goes down.

---

Standard UI > States

 Show?:
 - Show this UI element?
 Ignore Scale?:
 - Ignore scaling to show icons at their real size?
 Offset X:
 - How much to offset the UI X position by?
 - Negative goes left. Positive goes right.
 Offset Y:
 - How much to offset the UI Y position by?
 - Negative goes up. Positive goes down.

---

Standard UI > TPB/ATB Gauge

 Show?:
 - Show this UI element?
 Offset X:
 - How much to offset the UI X position by?
 - Negative goes left. Positive goes right.
 Offset Y:
 - How much to offset the UI Y position by?
 - Negative goes up. Positive goes down.

---

Standard UI > HP Gauge

 Show?:
 - Show this UI element?
 Offset X:
 - How much to offset the UI X position by?
 - Negative goes left. Positive goes right.
 Offset Y:
 - How much to offset the UI Y position by?
 - Negative goes up. Positive goes down.

---

Standard UI > MP Gauge

 Show?:
 - Show this UI element?
 Offset X:
 - How much to offset the UI X position by?
 - Negative goes left. Positive goes right.
 Offset Y:
 - How much to offset the UI Y position by?
 - Negative goes up. Positive goes down.

---

Standard UI > TP Gauge

 Show?:
 - Show this UI element?
 Offset X:
 - How much to offset the UI X position by?
 - Negative goes left. Positive goes right.
 Offset Y:
 - How much to offset the UI Y position by?
 - Negative goes up. Positive goes down.

---

Compatibility UI > Aggro Gauge

 Show?:
 - Show this UI element?
 - Requires VisuMZ_2_AggroControlSystem!
 Offset X:
 - How much to offset the UI X position by?
 - Negative goes left. Positive goes right.
 Offset Y:
 - How much to offset the UI Y position by?
 - Negative goes up. Positive goes down.

---

Compatibility UI > Boost Points

 Show?:
 - Show this UI element?
 - Requires VisuMZ_3_BoostAction!
 Offset X:
 - How much to offset the UI X position by?
 - Negative goes left. Positive goes right.
 Offset Y:
 - How much to offset the UI Y position by?
 - Negative goes up. Positive goes down.

---

Compatibility UI > Brave Points

 Show?:
 - Show this UI element?
 - Requires VisuMZ_2_BattleSystemBTB!
 Offset X:
 - How much to offset the UI X position by?
 - Negative goes left. Positive goes right.
 Offset Y:
 - How much to offset the UI Y position by?
 - Negative goes up. Positive goes down.

---

Compatibility UI > Break Shield

 Show?:
 - Show this UI element?
 - Requires VisuMZ_4_BreakShields!
 Ignore Scale?:
 - Ignore scaling to show icons at their real size?
 Offset X:
 - How much to offset the UI X position by?
 - Negative goes left. Positive goes right.
 Offset Y:
 - How much to offset the UI Y position by?
 - Negative goes up. Positive goes down.

---

Compatibility UI > State Tooltips

 Show?:
 - Show this UI element?
 - Requires VisuMZ_3_StateTooltips!

---

JS

 JS: Custom UI:
 - JavaScript used to add custom elements to each status window.

---


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.03: July 30, 2021

  • Bug Fixes!
    • Plugin Parameters for adjusting row quantity should now work properly. Fix made by Olivia.


Version 1.02: June 18, 2021

  • Optimization Update!
    • Plugin should run more optimized.


Version 1.01: April 23, 2021

  • Bug Fixes!
    • Item window during battle should now align properly. Fix made by Olivia.


Version 1.00 Official Release Date: May 12, 2021

  • Finished Plugin!

End of File