Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crystal-bit/godot-game-template
Generic template for Godot games
https://github.com/crystal-bit/godot-game-template
game-template godot godot4 godotengine
Last synced: 26 days ago
JSON representation
Generic template for Godot games
- Host: GitHub
- URL: https://github.com/crystal-bit/godot-game-template
- Owner: crystal-bit
- License: mit
- Created: 2020-09-05T19:02:02.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-22T16:12:35.000Z (3 months ago)
- Last Synced: 2024-09-30T18:23:11.030Z (about 1 month ago)
- Topics: game-template, godot, godot4, godotengine
- Language: GDScript
- Homepage:
- Size: 34.7 MB
- Stars: 629
- Watchers: 16
- Forks: 48
- Open Issues: 11
-
Metadata Files:
- Readme: readme.md
- License: license.txt
Awesome Lists containing this project
- awesome-godot - Crystal Bit Godot Game Template - Opinionated game template. It includes continuous integration, scene loading with graphic transitions and game pause handling. (Templates / 3D)
- awesome-godot-3 - Crystal Bit Godot Game Template - Opinionated game template. It includes continuous integration, scene loading with graphic transitions and game pause handling. (Templates / 3D)
- awesome-godot-3 - Crystal Bit Godot Game Template - Opinionated game template. It includes continuous integration, scene loading with graphic transitions and game pause handling. (Templates / 3D)
README
> 🌟 You make games, the template handles the boring stuff.
**Godot Game Template** is a generic starter project for Godot games.
Its main focus is to provide a solid base to build upon.
# Get started
You have 2 options:
## 1. Get started with Github Templates:
1. [Create a new repo using this template](https://github.com/crystal-bit/godot-game-template/generate)
2. Clone the new repository locally
3. Open the project in [Godot](https://godotengine.org/download/) (GDScript)
## 2. Get started with a local project:
1. Go to https://github.com/crystal-bit/godot-game-template/releases
2. Download _Source code (zip)_
3. Unzip the project
4. Open the project in [Godot Engine](https://godotengine.org/download/) (GDScript) and create your game!
## Used by
| Logo | Godot | Title | Link |
| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----- | ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|  | 3.x | **YouAreUto** (2019) | [Android](https://play.google.com/store/apps/details?id=com.youare.uto), [iOS](https://apps.apple.com/app/brain-game-teaser-youareuto/id1590561597#?platform=iphone), [GitHub](https://github.com/YouAreUto/YouAreUto) |
|  | 3.x | **Defending Todot** (2020) | [HTML5](https://crystal-bit.github.io/defending-todot/), [GitHub](https://github.com/crystal-bit/defending-todot) |
|  | 3.x | **Karooto No Gase** (2021) | [Android](https://play.google.com/store/apps/details?id=org.calalinta.karootonogase), [Itch.io](https://calalinta.itch.io/) |
|  | 3.x | **demo-godot-game-template** (2021) | [Android](https://play.google.com/store/apps/details?id=org.crystalbit.godottemplate), [GitHub](https://github.com/crystal-bit/demo-godot-game-template) |
_Get in contact if you want to be featured here!_
# How to...
## Change scene
```gd
Game.change_scene("res://scenes/gameplay/gameplay.tscn")
```
## Change scene and show progress bar
```gd
Game.change_scene("res://scenes/gameplay/gameplay.tscn", {
"show_progress_bar": true
})
```
## Change scene and pass parameters
```gd
# you can pass whatever value you like: int, float, dictionary, ...
var params = {
"level": 4,
"skin": 'dark'
}
Game.change_scene("res://scenes/gameplay/gameplay.tscn", params)
```
```gd
# gameplay.gd
func pre_start(params):
print(params.level) # 4
print(params.skin) # 'dark'
# setup your scene here
```
## \_ready() vs pre_start() vs start()
They are called in this order:
| method | description |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `_ready()` | gets called when the graphic transition covers the screen |
| `pre_start(params)` | gets called immediately after \_ready, it receives params passed via Game.change_scene(scene_path, params) |
| `start` | it's called as soon as the graphic transition finishes. It's a good place to activate gameplay logic, enemy AI, timers, ... |
## Restart the current scene
```gd
Game.restart_scene() # old params will be reused
```
## Restart the current scene and override params
```gd
var new_params = {
"level": 5,
}
Game.restart_scene_with_params(new_params)
```
## Center a Node2D into the viewport
```gd
$Sprite.position = Game.size / 2
# Game.size it's just a shortcut to get_viewport().get_visible_rect().size
```
# Conventions and project structure
- `assets/`
- Contains textures, sprites, sounds, music, fonts, ...
- `builds/`
- output directory for game builds (ignored by .gitignore and .gdignore)
- `scenes/`
- Contains Godot scenes (both entities, reusable scenes and "game screen" scenes)
- Scene folders can contain `.gd` scripts or resources used by the scene
Mostly inspired by the official [Godot Engine guidelines][l1]:
- **snake_case** for files and folders (eg: game.gd, game.tscn)
- **PascalCase** for node names (eg: Game, Player)
[l1]: https://docs.godotengine.org/en/stable/getting_started/workflow/project_setup/project_organization.html#style-guide
### Lower Case file names
This convention avoids having filesystem issues on different platforms. Stick with it
and it will save you time. Read more
[here](https://docs.godotengine.org/en/stable/getting_started/workflow/project_setup/project_organization.html#case-sensitivity):
> Windows and recent macOS versions use case-insensitive filesystems by default,
> whereas Linux distributions use a case-sensitive filesystem by default. This
> can cause issues after exporting a project, since Godot's PCK virtual
> filesystem is case-sensitive. To avoid this, it's recommended to stick to
> snake_case naming for all files in the project (and lowercase characters in
> general).
See also [this PR](https://github.com/godotengine/godot/pull/82957/files) that adds `is_case_sensitive()`.
# Export utilities
## `release.sh`
From your project root:
```sh
./release.sh MyGameName # this assumes that you have a "godot" binary/alias in your $PATH
```
Look inside the ./builds/ directory:
```sh
builds
└── MyGameName
├── html5
│  ├── build.log # an export log + build datetime and git hash
│  ├── index.html
│  ├── ...
├── linux
│  ├── MyGameName.x86_64
│  └── build.log
├── osx
│  ├── MyGameName.dmg
│  └── build.log
└── windows
├── MyGameName.exe
└── build.log
```
## Github Actions
If you are using Github you can take advantage of:
1. automatic exports for every commit push (see [push-export.yml][ci-push-export])
2. manual exports via Github CI (see [dispatch-export.yml][ci-dispatch] )
[ci-push-export]: ./.github/workflows/push-export.yml
[ci-dispatch]: ./.github/workflows/push-export.yml
You can read more on [Wiki - Continuos Integration][wiki_ci]
[wiki_ci]: https://github.com/crystal-bit/godot-game-template/wiki/1.-Continuous-integration-(via-GitHub-Actions)
# Contributing
If you want to help the project, create games and feel free to get in touch and report any issue.
You can also join [the Discord server](https://discord.gg/SA6S2Db) (`#godot-game-template` channel).
Before adding new features please open an issue to discuss it with other contributors.
## Contributors
Many features were implemented only thanks to the help of:
- [Andrea-Miele](https://github.com/Andrea-Miele)
- [Fahien](https://github.com/Fahien)
- [Andrea1141](https://github.com/Andrea1141)
- [vini-guerrero](https://github.com/vini-guerrero)
- [idbrii](https://github.com/idbrii)
- [jrassa](https://github.com/jrassa)
Also many tools were already available in the open source community, see the [Thanks](#thanks) section.
# Thanks
- For support & inspiration:
- All the [contributors](https://github.com/crystal-bit/godot-game-template/graphs/contributors)
- Crystal Bit community
- GameLoop.it
- Godot Engine Italia
- Godot Engine
- For their work on free and open source software:
- [aBARICHELLO](https://github.com/aBARICHELLO/godot-ci)
- [croconut](https://github.com/croconut/godot-multi-builder)
- [josephbmanley](https://github.com/josephbmanley)
- [GDQuest](https://github.com/GDquest)
- [Scony](https://github.com/Scony)
- [myood](https://github.com/myood)