An opinionated template for Godot projects. Currently, this branch is set up for 3.5.stable.
Following the structure provided by this template can speed up development, especially for jams or prototypes. It's probably not enough for larger projects, but can serve as a good starting point.
This template also supplies a CircleCI configuration, preconfigured with the Dockerfile also in this repo, for easy CI builds that also publish to itch.io.
Change all instances of godot-template to your-game-name in:
export_presets.cfgtools/build-and-deploy.sh
Packed scenes for gameplay objects that need to be manually placed or (usually) instantiated in scripts.
Godot editor addon scripts.
Like controllers, but autoloaded and marked as singletons in the project menu of the editor.
This is where builds of your game go. In CI, we create subfolders for win, osx, linux, and html5.
Scripts that contain const variables in constant format. Usually autoloaded.
Custom Resource definitions and instances.
Packed scenes and scripts for game objects that implement no behavior or very minimal, non-player-interactive behavior.
Like addons, but generally not for the editor. Generic scripts or scenes for things like data structures and cameras.
Non packed scene Godot editor files. Themes, fonts, materials, and the like go here. This template provides a simple UI theme from Kenney assets.
Packed scenes that represent complete collections for some stage of gameplay or testing (like Scenes in Unity).
Contains subfolders for most kinds of gdscripts.
These scripts implement a shared interface, such as for tracking health and taking damage. Usually paired with a packed scene in the root Behaviors folder.
These scripts implement the basis for large collections of functionality and state. Usually paired with a packed scene in the root Actors folder.
These scripts are for those one-off bits of functionality like tracking state for game win/over, providing services like tracking all enemies, etc.
Yupp.
Images for all your in-game and UI needs.
Scripts for creating builds, doing other CI things, or mutating/generating assets.
Scripts that control UI, usually heavily tied into the Store. Also generally placed on the root of a tree of Control nodes. If you need to instantiate your UI, the packed scene also goes here.
Scripts and packed scenes for instantiated pieces of your UI, like dynamic, selectable items such as buildings, units, etc.
To build:
docker build .circleci/images/godot/ -t greysonr/godot_butler:<version number>
To push:
docker push greysonr/godot_butler:<tag name>