Godot Game Template

Forked from Nezvers template

Template made for Godot Wild Jam

Features

• Modular and clean code base.
• Quick to setup (Plugin format - enabling plugin adds all singletons).
• Easy to expand Save/Load system. (Comes with Resource saving as default but there's an option to switch to JSON). Comes with a custom ResourceAsyncLoader class (used in scene changing. Has fallbacks to regular loading for platforms that don't support async loading).
• Localization system
• Sound effects manager system - (manages SFX sample playing to not trigger multiple same samples together)
• Controls rebinding system.
• Resolution changing system.
• Audio volume system.
• Easy to change scene transition (comes with a fade to black).
• Menus can navigate without a mouse. Convenient singleton HtmlFocus, that asks the player to click on it if you have an HTML5 game to gain game window focus (automatically free itself if not html5).
• Comes with a custom style (saved - planned to turn into a theme).
• HUD singleton (ready to be used in your way).
• Music singleton for persistent music after restarting or changing scenes
• CI/CD pipeline to build and deploy to itch.io. Courtesy of Lucas

How to use

• Enable GameTemplate plugin in Project Settings. It will set up all necessary autoloads automatically;
• Edit SettingsControls.gd (inside Autoload directory) Actions array of input map names. They are the ones used in button remapping.
• To change scenes trigger signal: Game.emit_signal('change_scene', scene_file_location_string)
• All wav files in addons/Assets/Sounds folder are loaded to SfxManager singleton and may be triggered with: SfxManager.play("file_name_without_extension")
• To enable/disable HUD your levels set: Hud.visible = true
• To enable/disable pause menu levels set: PauseMenu.can_show = true
• Check convenient signals in Game singleton (New Game, Continue, Resume, Restart, ChangeScene, Exit)
• Localization is possible by adding languages and strings to this CSV file

Singletone roles:

• Game - convenient game signals, scene changing, scene restarting, game exit.
• ScreenFade - scene transitioning layer. As a template, it's just Fade-to-Black ColorRect but it's easy to add fading shader to it. PauseMenu - This is a menu that appears while in-game and pauses the game, allowing to (Resume, Options, Main Menu, Exit).
• Options - GUI for changing resolution (Fullscreen, Borderless, scaling), Audio faders (Master, Music, SFX) and Controls section for Action bindings.
• Settings - delegates order of other Settings singletons _ready.
• SettingsSaveLoad - Manages save/load settings. Easily expandable for other parameters and comes with 2x versions Resource and JSON saving.
• SettingsResolutions - handles the resolution changes.
• SettingsControls - handles the information for controls.
• SettingsLanguage - handles information for languages.
• MenuEvent - handles events between options menu GUI.
• Hud - reserved for game-specific overlay (HP, Points, etc.).
• Music - Persistent AudioStreamPlayer for music.
• HTMLfocus - if the game is HTML5 it will overlay a button on the screen, requesting the player to click on it and allowing the game to become in focus.

CI CD

• CI/CD pipeline runs on the main branch and builds an export for each platform (Windows, Mac, Linux and HTML5) and then deploys it to an already-made itch.io page. You need to edit the game page so the HTML version is playable online. These secrets are needed for the CICD pipeline to work correctly:

  Name	Description
  ITCH_GAME	Name of the premade project in the itch.io site
  ITCH_USER	Useername who uploads the game
  BUTLER_CREDENTIALS	Butler credentials to upload in a workflow
  SILENTWOLF_API_KEY	Api Key to access the Silent Wolf Platform
  SILENTWOLF_GAME_ID	Game id for Silent Wolf platform