{"id":22274215,"url":"https://github.com/mechanicalflower/godot-template","last_synced_at":"2025-07-28T15:30:50.767Z","repository":{"id":66992334,"uuid":"533904703","full_name":"MechanicalFlower/godot-template","owner":"MechanicalFlower","description":":memo: Godot template with code formatting, license tracking \u0026 CI/CD","archived":false,"fork":false,"pushed_at":"2025-07-28T03:24:25.000Z","size":12762,"stargazers_count":45,"open_issues_count":5,"forks_count":6,"subscribers_count":2,"default_branch":"4.x","last_synced_at":"2025-07-28T05:26:05.537Z","etag":null,"topics":["gdscript","github-action","godot","godot-template","godot3","godot4","pre-commit","reuse","template"],"latest_commit_sha":null,"homepage":"","language":"GDScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MechanicalFlower.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-09-07T19:09:16.000Z","updated_at":"2025-07-17T13:02:32.000Z","dependencies_parsed_at":"2023-10-24T18:29:49.095Z","dependency_job_id":"7bddf3f9-3372-412b-ac69-b8b1fc929a6a","html_url":"https://github.com/MechanicalFlower/godot-template","commit_stats":null,"previous_names":[],"tags_count":1,"template":true,"template_full_name":null,"purl":"pkg:github/MechanicalFlower/godot-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MechanicalFlower%2Fgodot-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MechanicalFlower%2Fgodot-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MechanicalFlower%2Fgodot-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MechanicalFlower%2Fgodot-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MechanicalFlower","download_url":"https://codeload.github.com/MechanicalFlower/godot-template/tar.gz/refs/heads/4.x","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MechanicalFlower%2Fgodot-template/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267539022,"owners_count":24103933,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-28T02:00:09.689Z","response_time":68,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gdscript","github-action","godot","godot-template","godot3","godot4","pre-commit","reuse","template"],"created_at":"2024-12-03T13:18:47.247Z","updated_at":"2025-07-28T15:30:50.496Z","avatar_url":"https://github.com/MechanicalFlower.png","language":"GDScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003cdiv align=\"center\"\u003e\n\n# 📝 Greeter\n\n![Godot Badge](https://img.shields.io/badge/godot-4.2-blue?logo=Godot-Engine\u0026logoColor=white)\n![license](https://img.shields.io/badge/license-MIT-green?logo=open-source-initiative\u0026logoColor=white)\n![reuse](./.reuse/REUSE-compliant.svg)\n\nA template to create new [Godot Engine](https://godotengine.org/) project.\n\n\u003c/div\u003e\n\n## Features\n\n- Clean separation of assets, resources, scenes, scripts and shaders code\n- Continuous integration via [GitHub Actions](https://help.github.com/en/actions/)\n- 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)\n- Keep track of licenses and attribution by following the [reuse specification](https://reuse.software/spec/)\n- Addons management with [gd-plug](https://github.com/imjp94/gd-plug)\n- Automatic dependencies bumping with [renovate](https://docs.renovatebot.com/) for Godot and addons\n- Command runner with [just](https://just.systems/man/en/), with a provided `Justfile` that handle tools installation, exporting, publishing ...\n\u003c!-- - Integrated test suite --\u003e\n\n## Usage\n\n### Adjust the template to your needs\n\n- Use this repo [as a template](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template).\n- Replace all occurrences of \"Greeter\" with the name of your project\n- Replace files with your own\n- Happy coding!\n\nEventually, you can remove any unused files, such as irrelevant github workflows for your project.\nFeel free to replace the License with one suited for your project.\n\n## Installation\n\n### From a release\n\nReleased binaries are available on Itch.io and\non the Github repository, in the release section.\n\nDownload the zip archive, accordingly to your OS, and unzip it.\n\n- **Windows**: Double click on `Greeter.exe`.\n- **MacOS**: Double click on `Greeter.app`.\n- **Linux**: In a terminal, run `./Greeter.x86_64`.\n\n\u003c!--\n### From Snap\n\nWith the [Snap command line](https://manpages.ubuntu.com/manpages/focal/en/man8/snap.8.html), run:\n```\nsnap install godot-template\n```\n\nTo run the game:\n```\ngodot-template.greeter\n```\n--\u003e\n\n\u003c!--\n### From an AppImage\n\nThe AppImage is available on the Github\n repository, in the release section.\n\nMore details on how to run an AppImage, on the\n [official documentation](https://docs.appimage.org/introduction/quickstart.html#how-to-run-an-appimage).\n--\u003e\n\n### From source\n\n\u003e [!IMPORTANT]\n\u003e For this installation, you need to have\n\u003e the Godot Editor installed.\n\nClone the source locally:\n```\ngit clone https://github.com/MechanicalFlower/godot-template.git\n```\n\nYou need to install addons first:\n```\ngodot --headless --script plug.gd install\n```\n\nAnd simply run the game as any Godot project:\n```\ngodot\n```\n\n## Development\n\nThe project use:\n- [`just`](https://just.systems/man/en/) as command runner,\n- [`pre-commit`](https://pre-commit.com/) to run formatters, this requires [Python 3](https://docs.python.org/3/).\n\n\u003e [!IMPORTANT]\n\u003e Actually, `just` recipes only support Linux.\n\nTo check all available recipes, run:\n```\njust\n```\n\nTo run formatters:\n```\njust fmt\n```\n\nTo install, and run the game:\n```\njust install-addons\njust godot\n```\n\n\u003e [!TIP]\n\u003e In `just` recipes, the Godot Editor is installed\n\u003e automatically. This ensure that you\n\u003e use the right version of the engine.\n\n## Contributing\n\n![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)\n\nWe welcome community contributions to this project.\n\nPlease read our [Contributor Guide](CONTRIBUTING.md) for more information on how to get started.\n\n## Releasing\n\nPlease read our [Release Guide](RELEASING.md) for more information on how we manage our releases.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmechanicalflower%2Fgodot-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmechanicalflower%2Fgodot-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmechanicalflower%2Fgodot-template/lists"}