Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mechanicalflower/godot-template
:memo: Godot template with code formatting, license tracking & CI/CD
https://github.com/mechanicalflower/godot-template
gdscript github-action godot godot-template godot3 godot4 pre-commit reuse template
Last synced: 2 months ago
JSON representation
:memo: Godot template with code formatting, license tracking & CI/CD
- Host: GitHub
- URL: https://github.com/mechanicalflower/godot-template
- Owner: MechanicalFlower
- License: mit
- Created: 2022-09-07T19:09:16.000Z (over 2 years ago)
- Default Branch: 4.x
- Last Pushed: 2024-12-01T14:15:51.000Z (2 months ago)
- Last Synced: 2024-12-01T15:25:04.158Z (2 months ago)
- Topics: gdscript, github-action, godot, godot-template, godot3, godot4, pre-commit, reuse, template
- Language: GDScript
- Homepage:
- Size: 12.2 MB
- Stars: 28
- Watchers: 3
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 📝 Greeter
A template to create new [Godot Engine](https://godotengine.org/) project.
## Features
- Clean separation of assets, resources, scenes, scripts and shaders code
- Continuous integration via [GitHub Actions](https://help.github.com/en/actions/)
- Code formatting enforced by [gdformat](https://github.com/Scony/godot-gdscript-toolkit) for gdscript code, and [clang-format](https://clang.llvm.org/docs/ClangFormat.html) for shaders, via [pre-commit](https://github.com/pre-commit/pre-commit)
- Keep track of licenses and attribution by following the [reuse specification](https://reuse.software/spec/)
- Addons management with [gd-plug](https://github.com/imjp94/gd-plug)
- Automatic dependencies bumping with [renovate](https://docs.renovatebot.com/) for Godot and addons
- Command runner with [just](https://just.systems/man/en/), with a provided `Justfile` that handle tools installation, exporting, publishing ...
## Usage
### Adjust the template to your needs
- Use this repo [as a template](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template).
- Replace all occurrences of "Greeter" with the name of your project
- Replace files with your own
- Happy coding!
Eventually, you can remove any unused files, such as irrelevant github workflows for your project.
Feel free to replace the License with one suited for your project.
## Installation
### From a release
Released binaries are available on Itch.io and
on the Github repository, in the release section.
Download the zip archive, accordingly to your OS, and unzip it.
- **Windows**: Double click on `Greeter.exe`.
- **MacOS**: Double click on `Greeter.app`.
- **Linux**: In a terminal, run `./Greeter.x86_64`.
### From source
> [!IMPORTANT]
> For this installation, you need to have
> the Godot Editor installed.
Clone the source locally:
```
git clone https://github.com/MechanicalFlower/godot-template.git
```
You need to install addons first:
```
godot --headless --script plug.gd install
```
And simply run the game as any Godot project:
```
godot
```
## Development
The project use:
- [`just`](https://just.systems/man/en/) as command runner,
- [`pre-commit`](https://pre-commit.com/) to run formatters, this requires [Python 3](https://docs.python.org/3/).
> [!IMPORTANT]
> Actually, `just` recipes only support Linux.
To check all available recipes, run:
```
just
```
To run formatters:
```
just fmt
```
To install, and run the game:
```
just install-addons
just godot
```
> [!TIP]
> In `just` recipes, the Godot Editor is installed
> automatically. This ensure that you
> use the right version of the engine.
## Contributing
We welcome community contributions to this project.
Please read our [Contributor Guide](CONTRIBUTING.md) for more information on how to get started.
## Releasing
Please read our [Release Guide](RELEASING.md) for more information on how we manage our releases.