Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
hatmix committed Jan 26, 2025
1 parent 986b265 commit 3b41b65
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -4,9 +4,9 @@ Quick start template for game jams built on [hatmix/godot-4-ci](https://github.c

Features:
* Github template repository vs. addon
* Web, Windows, Linux and macOS exports for maximum jam
* Web, Windows, Linux and macOS exports configured for maximum jam
* Premade basic UI for main menu, pause menu, credits, and settings
* G.U.I.D.E for input with remapping
* [G.U.I.D.E](https://godotneers.github.io/G.U.I.D.E/) for input with remapping
* Settings persisted across sesssions (where `user://` filesystem is writable)
* Keyboard and controller support for all template UI, touchscreen via [Godot's emulate mouse from touch setting](https://docs.godotengine.org/en/stable/classes/class_projectsettings.html#class-projectsettings-property-input-devices-pointing-emulate-mouse-from-touch)
* ATTRIBUTION.md for in-game credits (inspired by [Maaack](https://github.com/Maaack/Godot-Game-Template/blob/main/ATTRIBUTION.md)'s approach)
@@ -57,6 +57,7 @@ Each UI layout is contained in its own directory under `res://ui`. The `assets`
├───controls
├───credits
├───game
├───how_to_play
├───main_menu
├───notifications
├───pause_menu
@@ -69,11 +70,11 @@ Settings are saved automatically in `user://settings.cfg` and control mappings i

See [G.U.I.D.E documentation](https://godotneers.github.io/G.U.I.D.E/) for how to add new actions, etc.

The remapping icons are generated by G.U.I.D.E in a RichTextLabel. The buttons used for remapping use the theme generated by `res://ui/controls/remap_input_button_theme.gd`.
The input icons are generated by G.U.I.D.E in a RichTextLabel. The buttons used for remapping use the theme generated by `res://ui/controls/remap_input_button_theme.gd`.

## Tests

GUT testing has been removed. I hope to have [gdUnit4](https://github.com/MikeSchulze/gdUnit4) tests working with CI soon.
GUT addon has been removed. I hope to have [gdUnit4](https://github.com/MikeSchulze/gdUnit4) tests working with CI soon.

## CI/CD

0 comments on commit 3b41b65

Please sign in to comment.