https://github.com/greenpixels/godot-template-4-3
A template for godot projects
https://github.com/greenpixels/godot-template-4-3
game-dev godot open-source
Last synced: about 1 year ago
JSON representation
A template for godot projects
- Host: GitHub
- URL: https://github.com/greenpixels/godot-template-4-3
- Owner: greenpixels
- Created: 2025-02-15T16:38:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-15T16:40:04.000Z (over 1 year ago)
- Last Synced: 2025-02-15T17:29:25.696Z (over 1 year ago)
- Topics: game-dev, godot, open-source
- Language: GDScript
- Homepage:
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ๐ฎ Godot 4.3 Template โ Opinionated Project Structure & Utilities
This is an **opinionated Godot 4.3 template** that provides a structured folder setup and commonly used utilities to speed up development. It includes helpful tools like a **BBCodeHelper, Tooltip UI component, WeightedList class, TweenHelper**, and moreโthings I frequently use in every project.
---
## ๐ Folder Structure
This template enforces an organized folder structure for better scalability and maintainability:
```
/project_root/
โโโ object_scenes/ # Scenes that represent game instances (player, enemies, pickups)
โโโ localization/ # CSV files for language translations
โโโ resources/ # Resource files like upgrades, abilities, ...
โโโ utils/ # Global scripts and utilities (tween_helper, weighted_list, ... )
โโโ ui/ # UI elements and reusable components
โโโ addons/ # Third-party or custom plugins/addons
```
Each folder contains specific guidelines to maintain consistency (see subfolder **README.md** files).
---
## โก Features & Utilities
### ๐ **BBCodeHelper**
A utility for handling BBCode-rich text, including dynamic replacements and formatting helpers.
### ๐ฌ **Tooltip UI Component**
A flexible tooltip system for displaying contextual information on hover or interaction.
### ๐ฒ **WeightedList**
A helper class for handling **random weighted selection** from an array. Useful for loot tables, enemy spawning, and probability-based systems.
### ๐ญ **TweenHelper**
A convenience wrapper for **Godot's Tween system**, making smooth transitions, animations, and UI effects easier to manage.
---
## ๐ Getting Started
1. Clone this repository:
```bash
git clone https://github.com/your-username/godot-4.3-template.git
```
2. Open the project in **Godot 4.3**.
3. Modify the folder structure and utilities to fit your needs.
4. Enjoy an organized and efficient development experience! ๐
---
## ๐ ๏ธ Contributing
Feel free to suggest improvements, add new utilities, or refine the existing template via pull requests.