Godot Options Menus

For Godot 4.2+

This plugin has options menus that aim to be easy to customize and persist settings in a user's config file.

Example on itch.io
Example is of Maaack's Game Template, which includes additional features.

Videos

All videos

Screenshots

All screenshots

Use Case

Setup options menus and accessibility features in about 15 minutes.

The core components can support a larger project, but the template was originally built to support smaller projects and game jams.

Features

Base

The base/ folder holds the core components of the menus application.

• Options Menus
• Persistent Settings
• Simple Config Interface
• Keyboard/Mouse Support
• Gamepad Support

How it Works

• app_config.tscn is set as the first autoload. It calls app_settings.gd to load all the configuration settings from the config file (if it exists) through config.gd.
• option_control.tscn and its inherited scenes are used for most configurable options in the menus. They work with config.gd to keep settings persistent between runs.

Installation

Godot Asset Library

This package is available as a plugin, meaning it can be added to an existing project.

When editing an existing project:

1. Go to the AssetLib tab.
2. Search for "Maaack's Options Menus".
3. Click on the result to open the plugin details.
4. Click to Download.
5. Check that contents are getting installed to addons/ and there are no conflicts.
6. Click to Install.
7. Reload the project (you may see errors before you do this).
8. Enable the plugin from the Project Settings > Plugins tab.
   If it's enabled for the first time,
   1. A dialogue window will appear asking to copy the example scenes out of addons/.
9. Continue with the Existing Project Instructions

GitHub

1. Download the latest release version from GitHub.
2. Extract the contents of the archive.
3. Move the addons/maaacks_options_menus folder into your project's addons/ folder.
4. Open/Reload the project.
5. Enable the plugin from the Project Settings > Plugins tab.
   If it's enabled for the first time,
   1. A dialogue window will appear asking to copy the example scenes out of addons/.
6. Continue with the Existing Project Instructions

Extras

Users that want additional features can try Maaack's Game Template.

Usage

Changes can be made directly to scenes and scripts outside of addons/.

A copy of the examples/ directory is made outside of addons/ when the plugin is enabled for the first time. However, if this is skipped, it is recommended developers inherit from scenes they want to use, and save the inherited scene outside of addons/. This avoids changes getting lost either from the package updating, or because of a .gitignore.

Existing Project

Existing Project Instructions

Community

Join the Discord server and share your work with others. It's also a space for getting or giving feedback, and asking for help.

Links

Attribution
License
Godot Asset Library - Plugin