Godot Game Template

For Godot 4.7 (4.3+ compatible)

Note

Using the latest version of Godot is recommended.
See Main Menu Setup for use with versions < 4.6.

This template has a main menu, options menus, pause menu, credits, scene loader, extra tools, and an example game scene.

Example on itch.io

Featured Games

Videos

More Videos

Screenshots

More Screenshots

Objective

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. It's meant to cover the needs for a typical game jam, while remaining scalable and extensible enough to support commercial games.

Features

Base

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
• Credits Reader (Markdown File Parser)
• Global State Management (Basic Saving/Loading)
• Global Config Autoload

Extras

The extras/ folder holds components that extend the core application.

• Level Loaders
• Level Progress Manager
• Win / Lose Manager
• Script for Releasing on itch.io with butler

Examples

The examples/ folder contains an example project using inherited scenes from the base/ and extras/.

• Game Scene
• Level Class & 3 Levels
• Tutorial Windows & 3 Tutorial Messages
• Win & Lose Windows
• Master Options Menu
• End Credits
• Main Menu w/ Animations
• Opening w/ Godot Logo
• Game and Level State Management

Minimal

Users that want a minimal set of features can try Maaack's Minimal Game Template or other options from the plugin suite.

Installation

Godot Asset Store & Library

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:

1. Go to the Asset Store tab.
2. Search for "Maaack's Game Template".
3. Click on the result to open the template details.
4. Click to Download.
5. Give the project a new name and destination.
6. Click to Install & Edit.
7. Continue with the Basic Setup

When editing an existing project:

1. Go to the Asset Store tab.
2. Search for "Maaack's Game Template Addon".
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.
   1. If it's enabled for the first time, the setup wizard will start.
   2. Close the window behind it and complete the setup wizard.
9. Continue with the Basic Setup

GitHub

1. Download the latest release version from GitHub.
2. Extract the contents of the archive.
3. Move the addons/maaacks_game_template folder into your project's addons/ folder.
4. Open/Reload the project.
5. Enable the plugin from the Project Settings > Plugins tab.
   1. If it's enabled for the first time, the setup wizard will start.
   2. Close the window behind it and complete the setup wizard.
6. Continue with the Basic Setup

Usage

Basic Setup is done through the Setup Wizard at Project > Tools > Run Maaack's Game Template Setup....

As part of setup, example scenes are copied out of /addons/ into a desired folder (project root by default). These can be edited to fit requirements.

More Documentation

Main Menu Setup
Options Menu Setup
Game Scene Setup
Updating Credits
Blending Music
Adding UI Sound Effects
Loading Scenes
Input Icon Mapping
Joypad Inputs
Game Saving
How Parts Work
Moving Files
Uploading to itch.io
Build and Publish Your Game Using CICD
Automatic Updating
Exhibiting Your Game

---

Featured Games

HeartFix Express	Baking Godium	Rent Seek Kill
Find on Steam	Play on itch.io	Play on itch.io

All Shared Games

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 Store - Template
Godot Asset Store - Addon
Godot Asset Library - Template
Godot Asset Library - Plugin