Skip to content

Commit

Permalink
Update README and ATTRIBUTION for addon changes
Browse files Browse the repository at this point in the history
  • Loading branch information
hatmix committed Jan 26, 2025
1 parent e9c368d commit 5595946
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 13 deletions.
13 changes: 4 additions & 9 deletions ATTRIBUTION.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,10 @@ Author: [Daenvil](https://github.com/daenvil)
Source: [https://github.com/daenvil/MarkdownLabel](https://github.com/daenvil/MarkdownLabel)
License: [MIT](https://github.com/daenvil/MarkdownLabel/tree/main?tab=MIT-1-ov-file#readme)

### Godot Resource Groups
Author: [Jan Thomä "derkork"]()
Source: [https://github.com/derkork/godot-resource-groups](https://github.com/derkork/godot-resource-groups)
License: [MIT](https://github.com/derkork/godot-resource-groups?tab=MIT-1-ov-file#readme)

### Godot Input Event Icons
Author: [hatmix](https://github.com/hatmix)
Source: [https://github.com/hatmix/godot-input-event-icons](https://github.com/hatmix/godot-input-event-icons)
License: [MIT](https://github.com/hatmix/godot-input-event-icons?tab=MIT-1-ov-file)
### G.U.I.D.E Godot Unified Input Detection Engine
Author: [Godotneers](https://github.com/godotneers)
Source: [https://github.com/godotneers/G.U.I.D.E](https://github.com/godotneers/G.U.I.D.E)
License: [MIT](https://github.com/godotneers/G.U.I.D.E?tab=MIT-1-ov-file#readme)

### ThemeGen
Author: [Inspiaaa](https://github.com/Inspiaaa)
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Godot 4 Jam Template

Quick start template for game jams built on [hatmix/godot-4-ci](https://github.com/hatmix/godot-4-ci). See the plain template in action at [https://hatmix.itch.io/godot-4-jam-template](https://hatmix.itch.io/godot-4-jam-template) (try password `gwj70`).
Quick start template for game jams built on [hatmix/godot-4-ci](https://github.com/hatmix/godot-4-ci). See the plain template in action at [https://hatmix.itch.io/godot-4-jam-template](https://hatmix.itch.io/godot-4-jam-template) (password `hatmix`).

Features:
* Github template repository vs. addon
* Web, Windows, Linux and macOS exports for maximum jam
* Premade basic UI for main menu, pause menu, credits, and settings
* Visualization of controls with built-in remapping
* 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)
Expand Down Expand Up @@ -63,10 +63,10 @@ Each UI layout is contained in its own directory under `res://ui`. The `assets`

## Settings and Controls

Actions not starting with "ui_" or "editor_" will be listed in the controls (remapping) UI. If there are no actions defined, a default set of ui_ actions will be shown. The default set is just for testing and changes to those actions will not persist.

Settings are saved automatically in `user://settings.cfg` and control mappings in `user://controls.tres`. Saving and loading are handled by `res://autoloads/settings.gd`.

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

## Tests

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

0 comments on commit 5595946

Please sign in to comment.