godot-project-template

A
Project Template
for

What is godot-project-template?

This is a collection of essential resources for Godot projects.

Tech Stack

• Game Engine: Godot 4.4-beta4
• Programming Language: GDScript
• Testing Framework: GdUnit4
• Git Hooks: Lefthook
• IDE: Cursor (VSCode Alternative)
• VSC: GitHub

Main Features

Directories

• assets
• scenes
• scripts
• tests

VSCode

• Settings
• Recommended Extensions

GDScript

• Typed GDScript
• Warnings for Typed GDScript

Code Formatting

• gdlint
• gdformat

Code Spell Checker

• VSCode Extensions
• Dictionaries

Tests

• GdUnit4 Sample Tests
• GitHub Workflow
• Shell Script

Export

• Web Export Presets
• Custom HTML Template
• Twitter Card

Git

• Custom .gitignore
• Custom .gitattributes

Git Hooks

• Lefthook
• pre-commit
  • Prevent Main Push
  • GDScript Format
  • Spell Check
• pre-push
  • Check Merge Conflicts
  • GDScript lint
  • GDScript test

Pull Request

• Pull Request Template
• Branch Ruleset
• Status Checks

GitHub Workflows

• Auto Tag on version changed
• CI
  • Lint and format
  • Unit test
• Deploy Web

Security

• Code Security
• Security Policy

GitHub Repository

• Repository Settings
• release.yml
• About
  • Description
  • Website
  • Topics

Docs

• README.md
  • Show Badges
• LICENSE
• SECURITY.md

You're Welcome To

• Give Feedback in Discussions
• Suggest improvements in Issues
• Report Bugs in Issues

Thank You for Supporting This Project

If you like this project, please give it a thumbs up and follow.

This is an MIT-licensed open-source project, and its ongoing development is made possible entirely by fantastic volunteers. If you'd like to support their efforts, please consider:

• Becoming a backer on Open Collective.

Funds donated via Open Collective will be used to cover expenses related to the development of this project, such as hosting costs. If sufficient donations are received, funds may also be used to support further enhancements and features for the Godot project template. Your support can make a significant difference in improving our project!