Plugin Instructions

A downloadable asset pack

Posted February 16, 2025 by Cardigan

1. Introduction

Here you’ll find step-by-step guides on how to customize your menu screens using the Instant GUI Customize Plugin. This document will not feature details or explanations and it’s instead suggested as a reference or quick guide for those who already understand how the Plugin works. It is recommended you check the Walkthrough here for any doubts you may have as to how everything works.

2. Importing the Plugin

Download the .zip and .rpy files available on the itch.io page
Extract asset_template.zip file into a folder
Open the project’s “game” folder
Copy the contents of the asset_template folder and the provided .rpy files into the project's “game” folder
Override any files if asked

3. Exporting images for use with focus_mask

Create a new image of the size of the project’s screen
Create your own menu designs
Isolate an element (background, overlay, button, etc.)
Export said element as an image file the size of your canvas
Replace the respective image in the project’s gui folder
Repeat for each element in a given screen

4. Main Menu button file names

Action	Idle file name	Hover file name
Start	mm_start_idle.png	mm_start_hover.png
Load	mm_load_idle.png	mm_load_hover.png
Options	mm_pref_idle.png	mm_pref_hover.png
About	mm_about_idle.png	mm_about_hover.png
Help	mm_help_idle.png	mm_help_hover.png
Quit	mm_quit_idle.png	mm_quit_hover.png

5. Quick Menu button file names

Action	Idle file name	Hover file name
Back	qm_back_idle.png	qm_back_hover.png
History	qm_history_idle.png	qm_history_hover.png
Skip (w/ selected)	qm_skip_idle.png qm_skip_selected_idle.png	qm_skip_hover.png qm_skip_selected_hover.png
Auto (w/ selected)	qm_auto_idle.png qm_auto_selected_idle.png	qm_auto_hover.png qm_auto_selected_hover.png
Save	qm_save_idle.png	qm_save_hover.png
Options	qm_pref_idle.png	qm_pref_hover.png

6. Game Menu button file names

Action	Idle file name	Selected Idle file name	Hover file name
Options	gm_pref_idle.png	gm_pref_selected_idle.png	gm_pref_hover.png
Save	gm_save_idle.png	gm_save_selected_idle.png	gm_save_hover.png
Load	gm_load_idle.png	gm_load_selected_idle.png	gm_load_hover.png
History	gm_history_idle.png	gm_history_selected_idle.png	gm_history_hover.png
About	gm_about_idle.png	gm_about_selected_idle.png	gm_about_hover.png
Help	gm_help_idle.png	gm_help_selected_idle.png	gm_help_hover.png
Exit	gm_exit_idle.png	gm_exit_selected_idle.png	gm_exit_hover.png

7. Game Menu overlay file names

Screen / Tab	Overlay file name
Options	overlay_pref.png
Save	overlay_save.png
Load	overlay_load.png
History	overlay_history.png
About	overlay_about.png
Help	overlay_help.png