MV Plugin: Orange Hud

From all the plugins that I made for RPG Maker MV, one of my favorites is the Orange Hud. It’s a powerful plugin capable of creating basically any kind of HUD for your game. It works a little different from other plugins because you need to add at least one add-on for it to do anything. Instead of explaining about every single param of every add-on, let me explain how to create different kinds of HUDs instead.

Setting Up.

For any HUD that you want to create, you’ll need to include the main plugin on your game, as it is required for the add-ons to work.

Displaying a simple variable on screen.

When all you want is to display a simple variable on the screen, OrangeHudLine.js is the add-on you need. Add it to your game at any position after OrangeHud itself.

The most important parameter of this add-on is the VariableId. That’s where you say what variable you want to display. Set it to whatever variable you want, save your project and playtest. You’ll notice that the value of that variable will be displayed on the top right corner of the screen.

OrangeHud Line 1

Configuring the HUD Window.

By default, the HUD window is invisible, only the contents are shown. To change that, you need to change the value of the HudOpacity param, on the main OrangeHud plugin. You can use any value between 0 and 255, where 0 means completely transparent and 255 means completely opaque. Please note that if your window skin has transparency, this transparency will be kept even if the opacity of the hud is set to 255 (and increasing it further won’t make any difference).

Probably not what you expected to see.
Probably not what you expected to see.

You’ll notice that the window is now visible across the entire screen. That’s because the plugin uses the whole screen when no size is defined. You can configure the size and position of the window by changing the params HudWidth, HudHeight, HudX and HudY on the main plugin.  You can also change the WindowMargin and WindowPadding params to move the contents inside the window. The difference between the margin and the padding is that the first also affects the background.

Small Window

Showing Multiple Variables:

If you want to use an add-on more than once, you can simply duplicate the add-on file and include the copy. The plugin is smart enough to understand that and not run the same code twice, but show both variables on the screen anyway. Make sure to change the X and/or Y parameters of the second line, so that both variables aren’t displayed on the same position.

Multiple Lines

Changing the Pattern and drawing icons:

The pattern is a parameter of the OrangeHudLine add-on. It defines how the value will be displayed on the screen. The default value is “%1”, because this symbol followed by the number 1 will be replaced by the value of the variable. You can write anything you want on it and even display icons. If you don’t want to use any variable, you can simply remove the %1 symbol.

You can use the \i[n] command to display an icon on the same way that you would do when using the “show text” command on an event:

Sample Patterns:

\i[1] %1 / 100
\v[2]\n\v[3]

Pattern Commands

Please note: Before version 1.9 of OrangeHud, even if you use the \v[n] command to display variables, the plugin will only refresh the hud when the value of the variable defined in the VariableId param changes.

Different Scenes:

The main OrangeHud plugin has a few parameters to configure where the hud should be visible. The possible values are: On the map, On the title screen, On the menu and On Battles. By default it will be visible only on maps, but you can easily change that by modifying the params visible on the following screenshot from false to true.

Scenes

The ShowUnderTintLayer param will let you configure if the HUD should be displayed over or under effects like fade in / fade out and the weather.

A Few More Things:

There’s a few more parameters you can configure on the OrangeHudLine add-on:

VariableX and VariableY:

You can set the number of a variable to those params so that the plugin will pick the X and Y position from those variables instead of the X and Y params.

FontFace, FontSize, FontColor and FontItalic:

You can change those parameters to configure the font used on the line. Leave empty to load the default values configured on the main plugin.

ScriptPattern:

You can use this param to configure a dynamic pattern using a script. I’ll talk more about it in another post in the future.

Other Add-Ons:

There are still many other add-ons available for the OrangeHud plugin. I’ll explain how to use them on different posts over time, but here’s a list of them: