MechanicalFlower Godot Template
A comprehensive Godot project template by MechanicalFlower, designed for clean code separation, continuous integration, and streamlined development workflows. It includes features like code formatting, license tracking, and addon management.
https://github.com/MechanicalFlower/godot-templateMechanicalFlower Godot Template: A Robust Starting Point
This Godot Engine project template offers a solid foundation for new projects, emphasizing best practices and efficient workflows. Developed by MechanicalFlower, it aims to accelerate development by providing pre-configured tools and structures.
Key Features
- Clean Architecture: Enforces a clear separation of assets, resources, scenes, scripts, and shaders for maintainability.
- Continuous Integration: Integrates seamlessly with GitHub Actions for automated building and testing.
-
Code Formatting: Utilizes
gdformat
for GDScript andclang-format
for shaders, ensuring consistent code style through pre-commit hooks. - License Management: Simplifies license tracking and attribution following the reuse specification.
-
Addons Management: Employs
gd-plug
for easy installation and management of project addons. -
Automated Dependencies: Uses
renovate
to keep Godot and addon dependencies up-to-date. -
Command Runner: Includes
just
for running common development tasks like installation, exporting, and publishing.
Getting Started
To use this template, simply create a new repository from it and customize it to your project's needs. The template encourages replacing placeholder names like "Greeter" with your project's specific name. The provided Justfile
automates many development tasks, including installing the correct Godot Engine version.