Skip to content

Maaack/Godot-Menus-Template

Repository files navigation

Godot Menus Template

For Godot 4.6 (4.3+ compatible)

Note

Using the latest version of Godot is recommended.
If getting stuck on a gray screen, see Main Menu Setup.

This template has a main menu, options menus, credits, and a scene loader.

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

Featured Games

Videos

Quick Intro Video
More Videos

Screenshots

Main Menu
Key Rebinding
Audio Controls
Video Controls
Pause Menu
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.

Maaack's Minimal Game Template is recommended for first time users, especially those new to Godot.

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

Examples

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

  • End Credits
  • Main Menu w/ Animations
  • Opening w/ Godot Logo
  • Loading Screen w/ Shader Pre-caching

Extras or Components

Users that want additional features can try Maaack's Game Template or other options from the plugin suite.

Installation

Godot Asset 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.

Package Icon

When starting a new project:

  1. Go to the Asset Library Projects tab.
  2. Search for "Maaack's Menus 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 AssetLib tab.
  2. Search for "Maaack's Menus Template Plugin".
  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_menus_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 Menus 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
How Parts Work
Moving Files
Automatic Updating


Featured Games

Baking Godium Spud Customs Rent Seek Kill
Baking Godium Spud Customs Rent-Seek-Kill
Play on itch.io Find on Steam 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 Library - Template
Godot Asset Library - Plugin

About

Godot template with a main menu, options menus, credits, and a scene loader.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

 
 
 

Contributors