MF_SimpleVisual — Reference

Declarative UI layout for RPG Maker MZ: re-arrange windows of built-in scenes, add pictures, text, gauges, buttons, lists and particles, build custom scenes, map HUD and battle layouts — all from data/SimpleVisual.json, with a visual editor (MF_SimpleVisualEditor, F10 in test play).

New here?Install, first layout, first custom scene File formatRoot, themes, scenes, windows, values and expressions ElementsAll element types and their properties Actions & scenesActions, conditions, custom scenes, HUD, battle, presets Script API & versionsStable API, deprecation, versioning policy

Overview

PluginVersionRole
MF_Core1.1.0+Required base library (units, expressions, conditions, data files, saves)
MF_SimpleVisual0.8.0Runtime: reads the file and applies it. Needed in the released game
MF_SimpleVisualEditor0.7.0Visual editor, test play only. Does nothing in a deployed game

The layout file is optional: without it (or with enabled off) the game keeps the standard look. A broken file is reported in the console and ignored.

WhatWhere
Windows of built-in scenes: position, size, anchor, opacity, skin, fontFile format › Windows
Rows of standard lists, command items of standard menusFile format › Rows and commands
Backgrounds and title spritesFile format › Sprites
Pictures, text, gauges, buttons, shapes, lists, particlesElements
Custom scenes, main menu itemsCustom scenes, Main menu
Map HUD, battle screenHUD, Battle
Themes, player options, presetsThemes, Player settings, Presets

Installation

  1. Copy MF_Core.js, MF_SimpleVisual.js and (for development) MF_SimpleVisualEditor.js to js/plugins/.
  2. Order in the Plugin Manager: MF_Core → MF_SimpleVisual → MF_SimpleVisualEditor. Place SimpleVisual below plugins that change windows.
  3. Start test play, open any scene, press F10. Saving creates data/SimpleVisual.json (backup SimpleVisual.bak.json).

Parameters

ParameterDefaultDescription
enabledtrueOff — safe mode, everything standard
optThemetrueOptions: the player chooses the UI theme
themeListemptyComma separated themes offered to the player; empty — all
optWindowOpacitytrueOptions: window background opacity
optFontSizefalseOptions: font size of windows
optHudPositionfalseOptions: anchor of HUD elements
skipScenesemptyScene classes left completely standard (Scene_Shop, Scene_Equip)
autoCompattrueScenes rebuilt by known plugins are left alone unless force: true — see Compatibility

Plugin commands

CommandArgumentsEffect
OpenCustomSceneidOpens scenes.<id> with "custom": true
SetLayoutPresetpresetActivates a preset (empty — none). Stored in the save file
ShowHud / HideHudidOne HUD element or (empty) the whole HUD. Stored in the save file

Pitfalls