Repository files navigation

🤖 Godot Engine 4.0 template to better get started for gamejams with your game!

This template project comes with game settings out of the box:

• Audio volume (Master, Sound, Music)
• Game Language (English only by default)

Either use the default Godot bootsplash or define your own logo bootsplashes!

This project comes with basic menu navigation that allows you to navigate between ingame, settings and quitting the game.

Automatically saves the state of the game on exit. Starting a new game overrides the existing save game. Any game object that needs to be saved has to be part of the "Persist" group.

Comes with pre-defined translations that can be extended.

TheIngameScene supports a pause menu to temporarily pause the game.

This templates comes with automatic deployment to itch.io for MacOS, Windows, Linux and HTML5 (Web). Delete.github/workflows/godot-ci.yml in case you are not interested in deploying to itch.io!

1. generate new API key in your itch.io settings and setup yourBUTLER_API_KEY secret -learn more
2. create a new game on itch.io
3. setupITCHIO_GAME andITCHIO_USERNAME secrets in Github and assign them to your itch.io username and game name

See working example here

1. ClickUse this template in Github (learn more about Template Repositories)
2. Open the project in Godot Engine 4
3. Customize it to your needs (see🧱 Customization)
4. Open theIngameScene and start building your game!

Not all gamejams allow project templates! Please make sure to carefully read the gamejam rules before using this project, otherwise you mightrisk being disqualified!

Down below is a list of some compatible gamejam formats that permit using this repository as a template:

• GoGodotJam
• Ludum Dare
• GMTK Game Jam
• Brackeys Gamejam
• Global Game Jam
• GameDevLondon Summer Jam
• Godot Wild Jam

This project is built to be as generic as possible and it can be fully adjusted to your needs.

Search for the filetheme.tres and open it. TheGodot theme editor should appear. Feel free to customise the UI to your needs. AnyControl node will use this theme by default:

This toolkit is not limited to either 2D or 3D. It has been kept vague on purpose so feel free to build 2D or 3D scenes with it!

Within Godot Engine, head toscenes/boot to access boot splash scenes. You can create your custom bootsplash by either modifyingGodotBootsplashScene or creating a new node of typeControl. AddBootsplashScene as a child and configure its properties as follows:

• Fade Duration - the amount of time in milliseconds to fade in/out the bootsplash.
• Stay Duration - the amount of time in milliseconds the bootsplash should stay.
• Node - the node/scene that should be displayed during the bootsplash.
• Next Scene - the next scene that should be loaded after the bootsplash has finished.
• Interruptable - wether the bootsplash is interruptable or not.

You will find a translation file ini18n/translation.csv. Feel free to extend it to your needs. Godot will automatically pickup the translations if you use them inside your control nodes likeButton orLabel. In case you need to manually translate something in a script, call thetr() function.

In case you want to add a new language, add a new column to thetranslation.csv file.

The game settings are managed inUserSettings.gd. You can change the defaults by updatingUSER_SETTING_DEFAULTS. You can also add additional properties to extend them.

TheGameSettings node and theGameSettings.gd script connects to theUserSettings by setting it/loading from it.

By default, save games are enabled. You can toggle support for save games insideSaveGame.gd by changing theENABLED property.

The save game saves any node inside theIngameScene that is part of thePersist group (learn more about groups in Godot). The save game system will save existing nodes but also nodes that were dynamically added to the scene at runtime!

Currently, the game will only save the scene when exiting the game via the pause menu.

Feel free to raise a pull request or suggest any changes or improvements you would like to see!

🐱‍💻PLEASE NOTE: this project is a template and any contribution should only introduce/extend features that are template related. If something can be its own addon (e.g. movement controller or specific 2D/3D stuff) it probably should be its own (separate) addon.