https://github.com/lucasmcclean/godot-game-template
Project template for any Godot 4.0+ project. It comes with several robust core systems and thorough documentation. Currently under development.
https://github.com/lucasmcclean/godot-game-template
game-template gdscript godot-4 godot-game-engine godot4-2 godotengine platformer save-system state-machine
Last synced: 8 months ago
JSON representation
Project template for any Godot 4.0+ project. It comes with several robust core systems and thorough documentation. Currently under development.
- Host: GitHub
- URL: https://github.com/lucasmcclean/godot-game-template
- Owner: lucasmcclean
- License: mit
- Created: 2023-12-11T15:34:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-23T21:44:53.000Z (over 1 year ago)
- Last Synced: 2025-02-09T23:33:40.631Z (over 1 year ago)
- Topics: game-template, gdscript, godot-4, godot-game-engine, godot4-2, godotengine, platformer, save-system, state-machine
- Language: GDScript
- Homepage:
- Size: 363 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Godot Game Template
***In Progress***
[](https://discord.gg/98SXCFJJ5k)
## Summary
Includes:
- Player
> Basic movement state machine with idle, moving, jumping, and falling states
> already setup.
- State Machine
> Basic finite state machine for managing anything with single active states.
> (e.g. player, enemy, crops, etc.)
- Save & Load System
> Uses encrypted binary serialization to provide security, a smaller save file,
> and a custom save structure. This system is highly customizable for more
> complex projects. Also contains methods for saving and loading user
> preferences (controls, volume, etc.).
- User Preferences
> Save and load system specifically for user preferences. Completely modular for
> custom game settings.
- Scene Manager
> A simple scene manager to provide additional utilites such as a loading screen
> and simple pause and resume functions to abstract and simplify basic processes.
- Basic Menus
> Simple main menu, loading screen, and settings menu. They are purely functional
> and will require sprucing up. They have built in scene changes and buttons for
> necessary interaction. The settings menu interfaces with necessary systems
> and can update and save user preferences.
- Simple Audio System
> This system includes some basic convenience functions and a prebuilt bus layout
> integrated with the settings system.
This template provides all of the necessary systems to get started with a new game
right away. Unlike some other options on GitHub though, these systems are
designed to be extremely customizable and modular. Most, if not all, of them
can be easily modified or completely removed.
## Getting Started
There are two options to get started:
#### 1. GitHub Template:
1. Create a new repository using this [template](https://github.com/new?template_name=godot_game_template&template_owner=LucksDev)
2. Clone the repository on your device
3. Open the project in [Godot](https://godotengine.org/download/)
#### 2. Local Project:
1. Go to the latest release (not yet active)
2. Download the source code zip
3. Unzip the project
4. Open the project in [Godot](https://godotengine.org/download/)
## Setting Up
Now that you have the project on your device you will need to do a few things before you can
get going.
- Set the projects Default Bus Layout to "res://common/audio/default_bus_layout.tres"
> This settings can be found via the Project tab > Project settings... > General > Audio >
> Buses > Default Bus Layout
- Set the Main Scene to "res://scenes/main/main.tscn"
> This settings can be found via the Project tab > Project settings... > General > Application >
> Run > Main Scene
## Further Information
For specific details about each of the systems you can reference the [docs](_docs) or you can use
Godot's in-editor class reference ([learn more](_docs/systems.md#ineditor-documentation)).
For notes on coding style you can reference the [style guide](_docs/best_practices.md#style-guide)
and for notes on the project structure you can reference the
[file structure](_docs/best_practices.md#file-structure) documentation.
**Autoload Roles**:
- Scene Manager
> [Scene Manager Documentation](_docs/systems.md#scene-manager)
- The scene manager is used for handling scene changes and transitions. It comes with several
methods for handling loading screens, additive loads, etc.
- Audio Manager
> [Audio Manager Documentation](_docs/systems.md#audio-manager)
- The audio manager serves the role of abstracting low-level interactions with Godot's `AudioServer`
while simultaneously ensuring consistent transitions for volume and effects.
- Events
> [Events Documentation](_docs/systems.md#events)
- The events singleton provides a single point for global signal handling.
- Save & Load
> [Save & Load Documentation](_docs/systems.md#save--load-game)
- This class is used for saving and loading the game with encrypted binary serialization. This means
that this class is likely the most flexible but also one of the most complex of all of the autoloads.
If you feel lost, NightQuestGames has a wonderful
[resource](https://www.nightquestgames.com/godot-4-save-and-load-games-how-to-build-a-robust-system/)
that covers all of the intricacies of the process thoroughly.
## Resources, Credit, & Licensing
This project is free to use, modify, or redistribute (see [LICENSE](LICENSE)). Credit is not required
but it is appreciated. If you would like to credit me feel free to link my
[GitHub account](https://github.com/LucksDev).
Godot Download: [Download](godotengine.org/download)
- Godot License: [License](godotengine.org/license)
Thank you to...
- [NightQuestGames](https://www.nightquestgames.com/ "NightQuestGames' blog")
- [GDQuest](https://www.gdquest.com/ "GDQuest's website")
- Godot's amazing [community](https://www.bing.com/ck/a?!&&p=f5a756818708d6cfJmltdHM9MTcwMzIwMzIwMCZpZ3VpZD0xMzMyNDg1ZS04NGJkLTY0MTktMmYxZi01YmNlODVjYTY1MzcmaW5zaWQ9NTE5Ng&ptn=3&ver=2&hsh=3&fclid=1332485e-84bd-6419-2f1f-5bce85ca6537&psq=official+godot+discord&u=a1aHR0cHM6Ly9kaXNjb3JkLmNvbS9pbnZpdGUvekg3TlVneg&ntb=1 "Godot's official Discord server")
## Discord Community
If you're interested in joining a Discord community – to give feedback or help on development of this project
or to learn from and share with other devs – check out [Developer Nexus | Godot](https://discord.gg/98SXCFJJ5k).
If you appreciate the project, give it a star!