An open API service indexing awesome lists of open source software.

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

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.