Quick Custom Menu plugin guide (for RPG Maker MV and MZ)

Guide.md

Quick Menu Customization Guide

Visual Customization

• To customize the Quick Menu visually, you can edit the .json files located in the data\PKD_QuickMenu folder.

• Ensure that all images are placed in the img\pQuickMenu folder.

• For edit quick menu open button position, edit file NUI_OpenMenuScreenButton.json in data\PKD_QuickMenu folder.

---

Script Calls

I. Building Menu

• Create a new Quick Menu

  PQMenu.New(ID); // Create new Quick Menu with ID

• Remove a Quick Menu

  PQMenu.Remove(ID); // Remove Quick Menu by ID

Note: Before adding or removing options, you need to create a menu with PQMenu.New(ID);.

• Add a new option to Quick Menu

  PQMenu(ID).AddOption(OPTION_ID); // Add new option to Quick Menu

Note: The option should be created in Plugin Parameters: Menu Options. Example:

PQMenu('myMenu').AddOption('Item'); // Add 'Item' option to Quick Menu with ID 'myMenu'

• Remove an option from Quick Menu

  PQMenu(ID).RemoveOption(OPTION_ID); // Remove option from Quick Menu

• Add a new option to Quick Menu at specific index

  PQMenu(ID).AddOptionAt(OPTION_ID, INDEX); // Add new option to Quick Menu at INDEX

  INDEX starts from 0

• Remove option from Quick Menu at specific index

  PQMenu(ID).RemoveOptionAt(INDEX); // Remove option from Quick Menu at INDEX

II. Changing Visual Appearance

• Change background image

  PQMenu(ID).ChangeSceneBackground(NAME); // Change background image

• Change menu background image

  PQMenu(ID).ChangeMenuBackground(NAME); // Change menu background image

• Change menu sector highlight image

  PQMenu(ID).ChangeMenuHighlight(NAME); // Change menu sector highlight image

III. Extra Options for Menu

• Disable exit from Menu by ESC

  PQMenu(ID).DisableEscape(); // Disable exit from Menu by ESC

IV. Opening, Closing, Disabling, Enabling

• Open Quick Menu by ID

  POpenQuickMenu(ID); // Open Quick Menu by ID

  Examples:

  POpenQuickMenu('myMenu'); // Open Quick Menu with ID 'myMenu'
  POpenQuickMenu(); // Open Default Quick Menu

• Close current Quick Menu

  PCloseQuickMenu(); // Close current Quick Menu

• Disable Quick Menu

  PDisableQuickMenu(); // Disable Quick Menu

  After disabling, you can't open Quick Menu by POpenQuickMenu(ID).

• Enable Quick Menu

  PEnableQuickMenu(); // Enable Quick Menu

V. Extra

Commands after PQMenu(ID) can be chained.

Example:

PQMenu('myMenu').AddOption('Item').AddOption('Skill').ChangeSceneBackground('bg1');

---