godot-jam-template by Mikeware

Hi! Are you making a game for a game jam? Wanting to use Godot? Then this template can get a lot of the basics out of the way!

Be sure your jam allows third-party code!

What is a game jam?

New to jamming? Game jams are events where individuals or teams get together for a defined period of time (sometimes 24-48 hours, a weekend, a week, or a month or more) to create a new game, generally. There's generally a specific theme announced at the start of the jam to be the main focus of the event. It's usually an interesting time to experiment with new ideas, learn, and create a small prototype of a game concept.

One of the more common places that hosts game jams, is itch.io. You can find the jam calendar here.

Using this template

We've made it easy, this is a template repository:

Just click the Use this template button from GitHub to start a new repository using this code.

What this template includes

This template includes the following things to get you started:

• Basic Godot project with Compatibility renderer for Web Export
• Export config for Web, Windows, Linux, and Android
• Title screen with three buttons: Play, Credits, Exit
• Credits crawler, just edit credits.txt!
• Basic game scene loader

Things to do:

• Create a new Game.tscn scene for your main game's scene (2D or 3D)
  • Assumes your game's scene will be Game.tscn in the root, update menu.gd otherwise.
• Make sure to update your-name, your-company and change-game-name
• Pick the UI Theme color for your game, delete the rest
  • Make sure to set the Theme on your highest root control node
  • Feel free to change the Default Font used by the UI Theme
• Update the cursor and icon, if your cursor has a different "point"/size adjust the Offset.
• Update the images\background.png image used for the bootsplash and background of menu.

Exporting Notes

• Remember Godot 4.x doesn't allow for C# Web exports yet, stick to GDScript and export to web for highest chances of people playing your game.
  • Alternatively, you can also investigate the 2dog Godot distro for C# web support.
• If you add more exports, be sure to include credits.txt in the Resources tab "Filters to export non-resource files/folders" box.
• For Web, if you enable Thread Support know that will limit browser compatibility and require the SharedArrayBuffer support setting on itch.io, though it may help with longer loading times for complex scenes.

Tips and tricks

Using ImageMagick to make a transparent Windows Icon from an svg:

magick convert -density 256x256 -background transparent source.svg -define icon:auto-resize=256,128,64,48,32,16 -colors 256 icon.ico

License

MIT