Template

mirror of https://github.com/Maaack/Godot-Menus-Template.git synced 2025-03-14 20:01:21 +00:00

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

game-development godot godot-addon godot-plugin godot-template godot4 template-project

Marek dd748bcb0b Merge pull request #41 from Maaack/updates-from-game-template Updates from game template		2025-03-13 17:34:07 -07:00
.github	Adds sponsorship link.	2024-10-24 21:05:53 -07:00
addons/maaacks_menus_template	Removes one more game template specific screenshot.	2025-03-13 17:30:32 -07:00
assets/godot_engine_logo	Copies examples into project root.	2025-03-03 20:30:51 -08:00
resources/themes	Recopies themes from examples into project root.	2025-03-13 17:25:29 -07:00
scenes	Adds UIDs to copied example files.	2025-03-05 13:29:48 -08:00
scripts	Fixes some code comments.	2024-10-25 12:40:41 -07:00
.gitattributes	Updates gitattributes for template version.	2025-03-05 13:31:21 -08:00
.gitignore	first commit	2024-04-24 12:33:57 -07:00
ATTRIBUTION.md	Fixes attribution.	2025-01-02 11:23:11 -08:00
default_bus_layout.tres	Re-adds default_bus_layout for music audio streams.	2024-04-25 17:12:04 -07:00
icon.png	first commit	2024-04-24 12:33:57 -07:00
icon.png.import	first commit	2024-04-24 12:33:57 -07:00
LICENSE.txt	Updates Credits scene.	2024-04-25 18:11:47 -07:00
override.cfg	Updates root override.cfg.	2025-03-05 13:23:51 -08:00
project.godot	Updates project file to Godot 4.4.	2025-02-07 14:27:41 -08:00
README.md	Updates root README.	2025-03-13 14:18:05 -07:00

README.md

Godot Menus Template

For Godot 4.4 (4.2+ compatible)

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

Screenshots

More Screenshots

Use Case

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.

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
Additional Inherited Scenes:
- 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.

When starting a new project:

Go to the Asset Library Projects tab.
Search for "Maaack's Menus 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 AssetLib tab.
Search for "Maaack's Menus 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,
1. A dialogue window will appear asking to copy the example scenes out of addons/.
2. Another dialogue window will ask to update the project's main scene.
Continue with the Existing Project Instructions

GitHub

Download the latest release version from GitHub.
Extract the contents of the archive.
Move the addons/maaacks_menus_template folder into your project's addons/ folder.
Open/Reload the project.
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/.
2. Another dialogue window will ask to update the project's main scene.
Continue with the Existing Project Instructions

Usage

New Project

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.

New Project Instructions

Existing Project

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.

Existing Project Instructions