This repository serves as a starting point for game jam projects using Godot. It contains basic menu functionality and an established file structure to get you started quickly.
- Basic main menu with functionality to start the game or exit.
- Pre-configured file structure for quick development.
- Easily customizable for different game jam themes and styles.
- A global logging system that will print to console and to log files. See globals/logger/logger.gd, for usage, docs etc.
Below is a suggested example file structure (which is currently used for the menus).
- Clone this repository to your local machine.
- Open the project in Godot Engine:
- Make sure you have Godot Engine installed.
- Open
project.godotin Godot to start working on your game.
- The repository includes a basic main menu / set of menu loops.
- You can modify these within the
scenes/ui/menusdirectory. - A main scene and script are already established to start prototyping out of.
- Some basic options like volume sliders and full screen are also preconfigured.
- For code consistency you can enable pre_commit linting / formatting if you are interested.
- See pre_commit
- See gdtoolkit
- In main.gd there is a signal to call the game over screen, which can be modified / moved as needed.
- sig_game_over
Feel free to fork this project and contribute to it. You can create pull requests for improvements, bug fixes, or suggestions.
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch). - Make your changes and commit them (
git commit -am 'Add feature'). - Push to your branch (
git push origin feature-branch). - Create a pull request.
This project is licensed under the MIT License - see the LICENSE file for details