For Godot 4.4 (4.2+ compatible)
This template has a main menu, options menus, pause menu, credits, scene loader, extra tools, and an example game scene.
Setup menus and accessibility features in about 15 minutes.
The template can be the start of a new project, or plug into an existing one. It is game agnostic (2D or 3D) and can work with multiple target resolutions, up to 4k and down to 640x360.
The base/ folder holds the core components of the menus application.
- Main Menu
- Options Menus
- Pause Menu
- Credits
- Loading Screen
- Opening Scene
- Persistent Settings
- Simple Config Interface
- Extensible Overlay Menus
- Keyboard/Mouse Support
- Gamepad Support
- UI Sound Controller
- Background Music Controller
The extras/ folder holds components that extend the core application.
- Win & Lose Menus
- Level Loaders
- Level Progress Manager
- Logging Scripts
- Script for Releasing on itch.io with butler
The examples/ folder contains an example project using inherited scenes from the base/ and extras/.
- Example Game Scene
- Base Level Class
- Example Levels
- End Credits
- Additional Inherited Scenes:
- Game Options Menu w/ Reset button
- Master Options Menu w/ Game Options tab
- Main Menu w/ Animations
- Opening w/ Godot Logo
- Level Loading Screen
- Loading Screen w/ Shader Pre-caching
Users that want a minimal set of features can try Maaack's Menus Template or other options from the plugin suite.
This package is available as both a template and a plugin, meaning it can be used to start a new project, or added to an existing project.
When starting a new project:
- Go to the
Asset Library Projectstab. - Search for "Maaack's Game Template".
- Click on the result to open the template details.
- Click to Download.
- Give the project a new name and destination.
- Click to Install & Edit.
- Continue with the New Project Instructions
When editing an existing project:
- Go to the
AssetLibtab. - Search for "Maaack's Game Template Plugin".
- Click on the result to open the plugin details.
- Click to Download.
- Check that contents are getting installed to
addons/and there are no conflicts. - Click to Install.
- Reload the project (you may see errors before you do this).
- Enable the plugin from the Project Settings > Plugins tab.
If it's enabled for the first time,- A dialogue window will appear asking to copy the example scenes out of
addons/. - Another dialogue window will ask to update the project's main scene.
- A dialogue window will appear asking to copy the example scenes out of
- Continue with the Existing Project Instructions
- Download the latest release version from GitHub.
- Extract the contents of the archive.
- Move the
addons/maaacks_game_templatefolder into your project'saddons/folder. - Open/Reload the project.
- Enable the plugin from the Project Settings > Plugins tab.
If it's enabled for the first time,- A dialogue window will appear asking to copy the example scenes out of
addons/. - Another dialogue window will ask to update the project's main scene.
- A dialogue window will appear asking to copy the example scenes out of
- Continue with the Existing Project Instructions
These instructions assume starting with the entire contents of the project folder. This will be the case when cloning the repo, or starting from the template version in the Godot Asset Library.
These instructions assume starting with just the contents of addons/. This will be the case when installing the plugin version in the Godot Asset Library.
Main Menu Setup
Game Scene Setup
Input Icon Mapping
Joypad Inputs
How Parts Work
| Rent Seek Kill | A Darkness Like Gravity | Nanny Bot Overload |
|---|---|---|
 |
 |
 |
| Play on itch.io | Play on itch.io | Play on itch.io |
Join the Discord server and share your work with others. It's also a space for getting or giving feedback, and asking for help.
Attribution
License
Godot Asset Library - Template
Godot Asset Library - Plugin
