Comedot

Component-based framework and project template for Godot

The goal is to be an all-in-one toolkit for 2D games (platformers, shoot-em-ups, RPGs, turn-based strategy or puzzle) where you build scenes by adding components to entities and tweaking their parameters in the UI. "Entities" and "Components" are like regular Godot Nodes but for gameplay, so you can combine this framework with any other addons or architecture or fetish.

• Comes with a library of components for the common stuff needed in most games: Different types of player movement, combat, collectibles, interactions, upgrades etc.
• UI controls like a stats HUD and dynamic buttons for special skills, inventory etc.
• Template scenes for Logo → Main Menu → Options, Input Remapping, Pause Overlay
• Save/Load player preferences via a config file with just Settings.anyName = 69
• A neutron star spoonful of helper functions & debugging tools.
• Commented & documented code.
• Free-to-use 3rd-party assets for quick prototyping.

Warning

This is still mostly a private personal project; it's what I'm using to make future GotYs while learning Godot as I go. The API eschews certain conventions like ugly underscores and may change frequently: No backwards compatibility is guaranteed!

Examples

⭐️ The composition architecture lets you do cool shit like putting a GunComponent and MouseRotationComponent on any object and It Just Works: (imgur)

TreesWithGuns.mp4

⭐️ Implement dynamic gameplay and easily change abilities/buffs at runtime; just add/remove components in simple event handlers, like this example of swapping between platformer physics and flying/overhead movement: (imgur)

HotSwapping.mp4

⬆️ These scenes are included in /Templates/Examples/

📈 There's even kawaii charts for monitoring variables in real-time!

How To Use

Important

Requires Godot 4.5 ~Embrace the Future ✨

1. Clone this repository; This is a Godot template so you must make a local copy of this entire project for each of your games.
   • Or you can cherry-pick files from Comedot to use in other templates.
2. Drag-&-drop nodes from the /Entities/ and /Components/ folders into your scene tree.
   • /Templates/ contains scenes and Entities with preset Components as a quick starting point for various gameplay.
   • /Scripts/ contains code for non-Entity nodes.
   • /UI/ contains customizable UI elements for health, ammo, actions, upgrades etc.

Note

🧩 A "component" is any Godot node that:

• Reacts to events (like player input or collisions).
• Moves or modifies its parent node or other components.
• Contains data for other components to use (like character health and other stats).

🪆 An "entity" is a node whose children are components (it may also have non-component children).

🎳 Whenever your game needs an "actor" like the player character or a monster, or an object with "behaviors" that could be reused for other objects, like interactive items or collectible powerups:

• Use the included custom dock plugin (the Comedock :) or perform these steps manually:

1. Create a new Entity node: a Node2D/Sprite2D/CharacterBody2D etc. with the Entity.gd script attached.
2. Add Component child nodes to the entity. A component is also any Node/Area2D etc. with a script that extends Component
3. Modify component parameters in the Inspector sidebar.
4. Save that entity+components subtree as a standalone scene file, to organize it separately from the main "world scene" and quickly create copies of it anywhere.

Tip

📜 Read HowTo.md to see how to do basic tasks or fix common issues.
See Conventions.md for the style guide and design rules this project tries to follow.

---

Comedot ©? MMXXV ShinryakuTako@GitHub • Syntaks.io@Discord • Syntaks@Mastodon

💕 THANKS:

• Tilesets: https://kenney.nl/assets/1-bit-pack
• Font: Jayvee Enaguas (HarvettFox96) https://www.dafont.com/pixel-operator.font