template_readme.md

🌟 You make games, the template handles the boring stuff.

Get started

1. 💻 Create a new repo using this template
2. Clone the new repository locally
3. Open the project in Godot (GDScript)
4. Done

Read the wiki to learn more.

Used by

Logo	Title	Play it!	Source
	YouAreUto (2019)	Android, iOS	GitHub
	Defending Todot (2020)	HTML5	GitHub
	Karooto No Gase (2021)	Android, Itch.io	N/A
	demo-godot-game-template (2021)	Android	GitHub

Get in contact if you want to be featured here!

Changelog

• changelog.md

Features

• Continuos Integration:
  • Automatic desktop build (linux, windows, osx, HTML5)
  • Automatic HTML5 deploy to Github pages
  • Automatic HTML5 deploy to itch.io
  • Automatic Android builds
• Scenes loading with graphic transitions (fade-in/out)
  • Send parameters to the new scene
  • Input prevention during scene changes
  • You can still play individual scenes for quick development
  • Singlethread & Multithread
• Game pause handling
• .gitignore
• Follows official GDScript guidelines (tested with gdlint)
• Compatible with other Godot addons

How to

Change scene

Game.change_scene("res://scenes/gameplay/gameplay.tscn")

Change scene and show progress bar

Game.change_scene("res://scenes/gameplay/gameplay.tscn", {
  "show_progress_bar": true
})

Change scene and pass parameters

# 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)

# gameplay.gd

func pre_start(params):
   print(params.level) # 4
   print(params.skin) # 'dark'
   # setup your scene here

To learn more about all the features, read the wiki.

Center a Node2D into the viewport

$Sprite.position = Game.size / 2

Contributors

Many features were implemented only thanks to the help of:

• Andrea-Miele
• Fahien
• Andrea1141
• vini-guerrero

Also many tools were already available in the open source community, see the Thanks section.

Contributing

Development of new versions is made on the dev branch.

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 (#godot-game-template channel).

Before adding new features please open an issue to discuss it with other contributors.

Thanks

• For support & inspiration:
  • All the contributors
  • Crystal Bit community
  • GameLoop.it
  • Godot Engine Italia
  • Godot Engine
• For their work on free and open source software:
  • aBARICHELLO
  • croconut
  • josephbmanley
  • GDQuest
  • Scony
  • myood