Skip to content

Latest commit

 

History

History
135 lines (95 loc) · 3.74 KB

README.md

File metadata and controls

135 lines (95 loc) · 3.74 KB
Raw

📝 Greeter

Godot Badge license reuse

A template to create new Godot Engine project.

Features

  • Clean separation of assets, resources, scenes, scripts and shaders code
  • Continuous integration via GitHub Actions
  • Code formatting enforced by gdformat for gdscript code, and clang-format for shaders, via pre-commit
  • Keep track of licenses and attribution by following the reuse specification
  • Addons management with gd-plug
  • Automatic dependencies bumping with renovate for Godot and addons
  • Command runner with just, with a provided Justfile that handle tools installation, exporting, publishing ...

Usage

Adjust the template to your needs

  • Use this repo as 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:

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

Contributor Covenant

We welcome community contributions to this project.

Please read our Contributor Guide for more information on how to get started.

Releasing

Please read our Release Guide for more information on how we manage our releases.