![Package Icon](/addons/maaacks_menus_template/media/menus-icon-black-transparent-256x256.png) # Godot Menus Template ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/Maaack/Godot-Menus-Template) ![GitHub Release Date](https://img.shields.io/github/release-date/Maaack/Godot-Menus-Template) [![Discord members](https://img.shields.io/discord/772191827570720798.svg?label=&logo=discord&logoColor=ffffff)](https://discord.gg/AyZrJh5AMp) This template has a main menu, options menus, pause menu, credits, and scene loader. For *Godot 4.7* (4.4+ compatible) [Example on itch.io](https://maaack.itch.io/godot-game-template) of *[Maaack's Game Template](https://github.com/Maaack/Godot-Game-Template)*, which includes additional features. ## 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. ### Minimal Users that want a minimal set of features can try *[Maaack's Minimal Game Template](https://github.com/Maaack/Godot-Minimal-Game-Template)* or other options from the [plugin suite](/addons/maaacks_menus_template/docs/PluginSuite.md). ## Installation *Maaack's Menus Template* is available in both the *Godot Asset Library* and the *Godot Asset Store*. It 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. ### New Project While in the *Godot Project Manager*: 1. Go to the **Asset Store** 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](/addons/maaacks_menus_template/docs/BasicSetup.md). ### Existing Project While editing a project in *Godot*: 1. Go to the **Asset Store** tab. 2. Search for "Maaack's Menus 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 if there are any conflicts. Conflicts that are safe to ignore: - `addons/plugin_updater/` - `addons/clean_copy_examples/` - `addons/maaacks_scene_loader/` - `addons/maaacks_music_controller/` - `addons/maaacks_ui_sound_controller/` 6. Click to **Install**. 7. Reload the project (you may see errors before you do this). 8. Enable the plugin(s) from the **Project > Project Settings > Plugins** tab. 1. Optionally, enable the following: - *Plugin Updater* - *Maaack's Scene Loader* - *Maaack's Music Controller* - *Maaack's UI Sound Controller* 2. Enable *Maaack's Menus Template*. 3. If it's enabled for the first time, the setup wizard will start. Close the window behind it and complete the setup wizard. 9. Continue with the [Basic Setup](/addons/maaacks_menus_template/docs/BasicSetup.md). ## Usage [Basic Setup](/addons/maaacks_menus_template/docs/BasicSetup.md) 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 [Feature List](/addons/maaacks_menus_template/docs/FeatureList.md) [Main Menu Setup](/addons/maaacks_menus_template/docs/MainMenuSetup.md) [Options Menu Setup](/addons/maaacks_menus_template/docs/OptionsMenuSetup.md) [Game Scene Setup](/addons/maaacks_menus_template/docs/GameSceneSetup.md) [Updating Credits](/addons/maaacks_menus_template/docs/UpdatingCredits.md) [Blending Music](/addons/maaacks_music_controller/docs/BlendingMusic.md) [Adding UI Sound Effects](/addons/maaacks_ui_sound_controller/docs/AddingUISFX.md) [Loading Scenes](/addons/maaacks_scene_loader/docs/LoadingScenes.md) [Input Icon Mapping](/addons/maaacks_menus_template/docs/InputIconMapping.md) [Joypad Inputs](/addons/maaacks_menus_template/docs/JoypadInputs.md) [How Parts Work](/addons/maaacks_menus_template/docs/HowPartsWork.md) [Moving Files](/addons/maaacks_menus_template/docs/MovingFiles.md) [Automatic Updating](/addons/maaacks_menus_template/docs/AutomaticUpdating.md) ## Media ### Videos [![Quick Intro Video](https://img.youtube.com/vi/U9CB3vKINVw/hqdefault.jpg)](https://youtu.be/U9CB3vKINVw) [More Videos](/addons/maaacks_menus_template/docs/Videos.md) ### Screenshots ![Main Menu](/addons/maaacks_menus_template/media/screenshot-6-main-menu-5.png) ![Key Rebinding](/addons/maaacks_menus_template/media/screenshot-6-input-list-8.png) ![Audio Controls](/addons/maaacks_menus_template/media/screenshot-6-audio-options-2.png) [More Screenshots](/addons/maaacks_menus_template/docs/Screenshots.md) ## Featured Games | HeartFix Express | Baking Godium | Rent Seek Kill | | :-------:| :-------: | :-------: | | ![HeartFix Express](/addons/maaacks_menus_template/media/thumbnail-game-heartfix-express.png) | ![Baking Godium](/addons/maaacks_menus_template/media/thumbnail-game-baking-godium.png) | ![Rent-Seek-Kill](/addons/maaacks_menus_template/media/thumbnail-game-rent-seek-kill.png) | | [Find on Steam](https://store.steampowered.com/app/3983290/HeartFix_Express_Demo/) | [Play on itch.io](https://maaack.itch.io/baking-godium) | [Play on itch.io](https://xandruher.itch.io/rent-seek-kill) | [All Shared Games](/addons/maaacks_menus_template/docs/GamesMade.md) ## Community Join the [Discord server](https://discord.gg/AyZrJh5AMp) and share your work with others. It's also a space for getting or giving feedback, and asking for help. ## Links [Attribution](/addons/maaacks_menus_template/ATTRIBUTION.md) [License](/addons/maaacks_menus_template/LICENSE.txt) [Godot Asset Store - Template](https://store.godotengine.org/asset/maaack/maaacks-menus-template/) [Godot Asset Store - Addon](https://store.godotengine.org/asset/maaack/maaacks-menus-template-addon/) [Godot Asset Library - Template](https://godotengine.org/asset-library/asset/3790) [Godot Asset Library - Plugin](https://godotengine.org/asset-library/asset/2899)