Documentation
Quick InfoVersion: Alpha R4
Made for RPG Maker MZ 1.9.0
PositioningPositioning for most elements can either be absolute (you provide an exact pixel amount for that positional value) or percentage based. Percentages will be based on the UI area height for height and y, or width for width and x.
There are also some special positional types for certain elements. The X positional element can be set to Right Edge, which will cause it to appear as far to the right edge of the screen as possible without overflow
The Y positional element can be set to Bottom Edge, which will cause it to appear as far to the bottom edge of the screen as possible without overflow
For the Height element, you can also create windows that will fit a certain amount of text lines in them. This can make it hard to calculate absolute values for aspects of the window you may want to be based on this height. By default, these values will be used for a window of the following lines tall:
1 line = 68px
2 lines = 112px
3 lines = 156px
If you do not observe these values, some other plugin has changed how this is calculated. You will need to ask that plugin author what values to expect.
It is also common to need to know the Y value most windows start at if the touch UI buttons need room to display. This value is 60 by default.
A custom formula for positioning can also be used. If a custom formula exists, other position settings will be ignored.
Custom formulas are JavaScript code you can write, which will be executed in the context of Scene_Menu. Your custom formula should return a Rectangle object. If it does not return a Rectangle object, your game will crash. A sample custom formula which would re-create the default gold window positioning would be:
const ww = this.mainCommandWidth();
const wh = this.calcWindowHeight(1, true);
const wx = this.isRightInputMode() ? Graphics.boxWidth - ww : 0;
const wy = this.mainAreaBottom() - wh;
return new Rectangle(wx, wy, ww, wh);
https://www.caspergaming.com/documentation/mz/Scene_Menu.html
Actor Window Display TypeThis parameter allows you to choose how your actor window has its info displayed. There are 3 hard-coded layouts and 1 customizable layout:
Horizontal
The original layout, fits well with a window with 1 column. Ignores most custom settings for the actor window.
Square
A layout that fits well with a window that has 2 cols, 2 rows. Ignores most custom settings for the actor window.
Vertical
A layout that fits well with a window that only has 1 row. Ignores most custom settings for the actor window.
Custom
This layout uses the additional Actor Window Display parameters to display various pieces of info in certain locations. It requires a lot of additional setup, but should allow you to almost completely control every piece of data drawn in the window for each actor.
Hiding WindowsYou should proceed with caution when hiding certain windows. Hiding the gold window is most likely not going to have any consequences. Hiding the actor window will break any menu commands that require actor selection. Hiding the command window will not allow the player to select any commands. The option to hide these windows is provided in the rare case you may need them, for example if you are using a plugin that replaces those windows' functionality with its own custom windows. Unless you know what you are doing, please do not hide the actor or command windows.
Gold Window SettingsThe gold window is shown in more places than just the menu. The settings for the gold window available in this plugin only affect the gold window when it appears in the menu scene, it will not affect the gold window anywhere else.
Integrations[CGMZ] Scene Backgrounds
Use this plugin to customize the background image in the menu. It focusing on background images means it can offer a lot more options than other [CGMZ] plugins can, including scrolling backgrounds.
[CGMZ] Controls Window
Show the player keyboard or gamepad controls in the scene, based on the player's last input. The controls window is completely customizable to fit in to any scene.
CompatibilitySometimes, other plugins may add their own windows to the menu. This plugin will not allow you to customize those third-party windows. It is the other plugin's responsibility to allow you to customize its windows.
If using [CGMZ] Menu Command Window, the Command Window Alignment setting may use the Menu Command Window's setting for that depending on Plugin Manager order.
Plugin CommandsThis plugin does not contain any plugin commands.
Saved GamesThis plugin is fully compatible with saved games. This means you can:
✓ Add this plugin to a saved game and it will work as expected.
✓ Change any plugin params and changes will be reflected in saved games.
✓ Remove the plugin with no issue to save data.
Filename
The filename for this plugin MUST remain CGMZ_MenuCustomizer.js. This is what it comes as when downloaded. The filename is used to load parameters and execute plugin commands. If you change it, things will begin behaving incorrectly and your game will probably crash. Please do not rename the js file.
Known Issues
This plugin currently has no known issues that need to be fixed. If you believe you have encountered a bug, please report it to Casper Gaming.
Compatibility
This plugin currently has no known compatibility issues with other RMMZ plugins. If you believe you have encountered a conflict, please report it to Casper Gaming.
Version HistoryVersion AlphaR2
- Added custom layout type, various options for customizing actor window
- Added window options for padding, background opacity, windowskin, and tone
- Added options to add info to gold window
- Added window background options (window/dim/transparent)
- Added new height option for smaller lines
- Added [CGMZ] Scene Backgrounds integration
- Added [CGMZ] Controls Window integration
- Added animated walk sprite option for actors
- Added animated battle sprite option for actors
- Added [CGMZ] Window Settings integration
- Added [CGMZ] Window Backgrounds integration