🚀 Production-ready template for Godot Engine development
⭐ Star this repo if it helps you!
Production-ready Godot template that eliminates setup time and maintenance overhead:
- ⚡ Zero Configuration - Start coding immediately
- 🛡️ Enterprise Ready - CI/CD, testing, deployment
- 🌍 Global Ready - EN/JP i18n built-in
- 🌐 Multi-Platform - Web, desktop, mobile ready
- 🚀 Auto-Deploy - GitHub Pages with PWA
- 🧪 Testing First - GdUnit4 integration
This template eliminates repetitive setup tasks and ongoing maintenance overhead:
📊 Calculation Basis: 40h/week developer, 4 commits/day, daily deployment
| Feature | This Template | New Project | Time Saved |
|---|---|---|---|
| 🚀 Initial Setup | ✅ Ready | +15min | |
| 📁 Project Structure | ✅ Optimized | -45min |
| Feature | This Template | New Project | Time Saved |
|---|---|---|---|
| 🧪 Testing | ✅ GdUnit4 ready | -2hrs | |
| 🔄 CI/CD | ✅ GitHub Actions ready | -3hrs | |
| 🌐 Multi-language | ✅ EN/JP ready | -1.5hrs | |
| 📦 Web Export | ✅ PWA ready | -1hr | |
| 🚀 Deployment | ✅ Auto-deploy ready | -2.5hrs | |
| ✏️ Code Quality | ✅ Auto-format ready | -1.5hrs | |
| 🪝 Git Hooks | ✅ Automated | -2hrs |
🎯 Total weekly savings: ~13.5 hours
| Aspect | This Template | New Project |
|---|---|---|
| 📝 Code Standards | ✅ Flexible | |
| 🎯 Main Branch | ✅ Direct commits |
💡 Pro Tip: Enforced standards actually save time by maintaining consistent code quality!
- Click Use this template
- Clone your new repository
- Open
project.godotin Godot Engine - Start coding! 🎉
🎯 Pro Tip: Enable the GdUnit4 plugin in Project Settings for full testing capabilities!
📋 Complete Feature Breakdown
- 📁 Project Structure - Clean, scalable folder organization
- 🎨 Asset Management - Custom fonts with proper import setup
- 🌐 Multi-Language - English/Japanese with real-time switching
- 📝 Typed GDScript - Static typing for better code quality
- 🎯 Sample Implementation - Complete example scene with real-time features
- 💾 Settings Management - Type-safe configuration with error handling
- 🖥️ Editor Integration - VSCode/Cursor optimized configuration
- 🧪 Testing Framework - GdUnit4 with automated test execution
- 🐛 Advanced Debugging - Comprehensive logging with timestamps
- 🎯 Spell Checking - Multi-dictionary system with custom terminology
- ✏️ Code Quality - Auto-formatting and linting
- 🪝 Git Hooks - Pre-commit and pre-push automation
- 🤖 GitHub Actions - Automated CI/CD with multiple workflows
- 🏷️ Version Management - Automatic version tagging and releases
- 🛡️ Security & Quality - Branch protection and conflict detection
- 🚫 Main Branch Protection - Prevents direct commits to main branch
- 🔍 Conflict Prevention - Automatic merge conflict detection
- 🧹 Report Cleanup - Automated test report management
- 📊 Quality Gates - Automated testing and code quality checks
- 🔍 Code Scanning - Security and quality analysis
- 🛡️ PR Validation - Automated pull request checks
- 🔒 Security Settings - GitHub security configurations
- 📦 Web Export - Optimized web export preset with PWA support
- 🚀 GitHub Pages Auto-Deploy - Automatic web deployment
- 🐦 Custom HTML - Optimized web export with PWA support
- 🗂️ Export Presets - Pre-configured export settings
- 📱 Progressive Web App - Full PWA support with offline capabilities
- 📊 Social Media - Twitter cards and meta tags
| Tool | Version | Installation |
|---|---|---|
| Godot Engine | 4.4.1+ | Download |
| GdUnit4 | Latest | Godot AssetLib |
| Node.js | 18+ | Download |
| godot-gdscript-toolkit | Latest | Install |
-
Enable GdUnit4 Plugin
Project Settings → Plugins → GdUnit4 → Enable -
Install Dependencies
npm install
-
Configure Editor (Optional)
- Install VSCode/Cursor extensions
- Enable auto-format on save
-
Customize Project
- Update project name in
project.godot - Configure GitHub Pages: Settings → Pages → Source:
gh-pages
- Update project name in
# Testing
npm run test:win # Windows testing
npm run test:mac # macOS testing
# Code Quality
npm run format # Format all GDScript files
npm run lint # Run linting checks
npm run spell # Spell check with custom dictionaries- 📝 Typed GDScript - Use static typing for all functions
- 🎨 Auto-format - Enable format on save in your editor
- ✅ Spell Check - Custom dictionaries for game terminology
- 🧪 Unit Tests - Write tests for critical game logic
- 🌐 Translations - Add new languages to
locale/directory
The template includes a complete example scene demonstrating:
- Real-time language switching with UI buttons
- Type-safe settings management with error handling
- Comprehensive logging with timestamp tracking
- Asset management with custom fonts
- Testing examples with GdUnit4
| Issue | Solution | Priority |
|---|---|---|
| 🧪 Tests not running | Enable GdUnit4 plugin in Project Settings | 🔴 High |
| 💻 Formatting not working | Install godot-gdscript-toolkit | 🔴 High |
| 📦 npm commands fail | Install Node.js 18+ | 🔴 High |
| 🪝 Git hooks not working | Run npm install to install Lefthook |
🟡 Medium |
| 🌐 Web export fails | Check GitHub Pages branch is set to gh-pages |
🟡 Medium |
| 🌍 Translations not showing | Ensure .po files are in locale/ directory |
🟡 Medium |
| Question | Answer |
|---|---|
| Godot 4.3 compatible? | ✅ Yes, optimized for 4.4.1 but works with 4.3+ |
| All tools required? | ❌ Only Godot Engine and Node.js required |
| Customize project name? | ✅ Edit project.godot and update references |
| Add new languages? | ✅ Add .po files to locale/ directory |
| Commercial use? | ✅ Yes, MIT licensed for any use |
| Deploy to other platforms? | ✅ Configure export presets in Godot |
| Channel | Purpose | Response Time |
|---|---|---|
| 🐛 Bug Reports | GitHub Issues | < 48h |
| ✨ Feature Requests | GitHub Discussions | < 48h |
| 💬 General Questions | GitHub Discussions | < 48h |
MIT License - see LICENSE for details.
- ⭐ Star the repository - Helps with visibility
- 🐛 Report bugs - Help improve stability
- ✨ Suggest features - Shape future development
- 📖 Improve docs - Help other developers
- 🔧 Submit PRs - Direct code contributions
Support continued development:
- Open Collective - Monthly support
- Buy me a coffee ☕ - One-time support
- Godot Engine - The amazing game engine
- GdUnit4 - Testing framework
- Lefthook - Git hooks automation
Made with ❤️ for the Godot community
