Key Binds API #59

EnnuiL · 2021-12-02T21:49:49Z

A built-from-scratch API that covers Fabric Key Binding API's functionality and more

The PR was planned in two stages: Blue and Pink. The implemented feature set of Blue was:

Key binds now support being dynamically disabled, making them completely invisible to the game's eyes
The Key Binds screen now shows a tooltip on conflicting keys showing the other key binds that use the same key, and adds a (!) indicator to the key text itself for accessibility reasons
The API exposes some methods meant to help with mod intercompatibility

Currently, work is being done on the Pink feature set:

A custom config file at ./config/qsl/key_binds.json allowing for our own key bind extensions (WIP)
Key binds now accepts key chords, expanding the possibilities for modded key binds (WIP)
Key binds will contain key predicates, which essentially points all the use cases where it will be used. This will allow multiple key binds that never overlaps to share the same key

Outdated but relevant information about the stages is available in #61

TheGlitch76 · 2021-12-02T22:02:09Z

Now is the time for any last-minute bikesheds on where to put the keybindings API, since I know people are unhappy with gui

OroArmor · 2021-12-02T22:06:53Z

gui isn't perfect, but its the closest large group in my opinion.

you could make an input or client group, but then we end up with 30 different modules

OroArmor

Looks great! I know you talked about supporting some combination keybinds, not sure if that should be an extra PR or not, but its definitely something to discuss further

library/gui/key_bindings/src/main/java/org/quiltmc/qsl/key/bindings/api/KeyBindingRegistry.java

...gui/key_bindings/src/main/java/org/quiltmc/qsl/key/bindings/impl/KeyBindingRegistryImpl.java

...y_bindings/src/main/java/org/quiltmc/qsl/key/bindings/mixin/client/KeyBindingEntryMixin.java

library/gui/key_bindings/src/main/java/org/quiltmc/qsl/key/bindings/api/KeyBindingRegistry.java

...gui/key_bindings/src/main/java/org/quiltmc/qsl/key/bindings/impl/KeyBindingRegistryImpl.java

OroArmor · 2022-02-11T06:42:01Z

library/gui/key_bindings/src/main/java/org/quiltmc/qsl/key/bindings/api/KeyBindingRegistry.java

+	 *
+	 * <pre>
+	 * {@code
+	 * public static final KeyBinding EXAMPLE_KEY_BIND = KeyBinding.registerKeyBinding(


Suggested change

* public static final KeyBinding EXAMPLE_KEY_BIND = KeyBinding.registerKeyBinding(

* public static final KeyBinding EXAMPLE_KEY_BIND = KeyBindingRegistry.registerKeyBinding(

Oh whoops, I'll fix that

OroArmor · 2022-02-11T06:44:21Z

...y/gui/key_bindings/src/main/java/org/quiltmc/qsl/key/bindings/impl/ConflictTooltipOwner.java

+import net.minecraft.text.Text;
+
+@Environment(EnvType.CLIENT)
+public interface ConflictTooltipOwner {


This could either be exposed as API as it could have some functionality or make it slightly clearer that it's internal with @ApiStatus.Internal

Ah, I was thinking of replacing the interface mixin with the two accessors that I've done for resource pack tooltips; I think it's much cleaner than the current one

...and nevermind, while the accessor does simply a bit of code, ConflictTooltipOwner will still be needed;
I'll mark it as internal

LambdAurora · 2022-02-19T22:20:36Z

library/gui/key_binds/src/main/java/org/quiltmc/qsl/key/binds/api/KeyBindRegistry.java

+	 * @param includeVanilla {@code true} if vanilla entries should be included, else {@code false}
+	 * @return a map containing all modded (and optionally vanilla) key binds
+	 */
+	public static Map<KeyBind, Boolean> getAllKeyBinds(boolean includeVanilla) {


This really should use fastutil's Object2BooleanMap.

I'll probably abandon the Map<KeyBind, Boolean> approach once on the Pink stage, because having some sort of QuiltKeyBinds would probably be better than a map between keybinds and the extra info

Probably would be a good idea to encapsulate the inner map so the api can be a little more resistant to change.

LambdAurora · 2022-03-12T17:43:29Z

A custom config file at ./config/qsl/key_binds.json allowing for our own key bind extensions (WIP)

Now that I'm thinking of it, probably should be ./config/quilt/key_binds.json.

EnnuiL · 2022-03-13T02:44:53Z

A custom config file at ./config/qsl/key_binds.json allowing for our own key bind extensions (WIP)

Now that I'm thinking of it, probably should be ./config/quilt/key_binds.json.

I thought about it (after all, FAPI used ./config/fabric/), however, I don't know; I'd think ./config/quilt/ would instead be used by something like the Quilt Loader, and not QSL

Oh, this is definitely not ready yet, I just needed an easy way to sync progress between computers

It's alive!

If everything goes right, tomorrow we'll have a PR!

Required for translatable texts to work on the tooltips

I'll finish it at my other PC

Viva!

wait, so, tabs are actually okay?

I have a plan to properly fix it, but now, it's icon time

no thoughts, head empty

Also, begin to implement unused_key_binds

mind's currently empty, but i'll find a better way to do things

It's gone!

OroArmor approved these changes Dec 2, 2021

View reviewed changes

TheGlitch76 mentioned this pull request Dec 4, 2021

GUI Library TODO #52

Open

3 tasks

BasiqueEvangelist reviewed Dec 5, 2021

View reviewed changes

LambdAurora added this to the Initial release milestone Dec 6, 2021

EnnuiL mentioned this pull request Dec 11, 2021

Plans on Key Binding API #61

Open

LambdAurora added documentation enhancement New feature or request new: library A pull request which adds a new library. new: module A pull request which adds a new module labels Dec 11, 2021

EnnuiL changed the title ~~Key Bindings API v1~~ Key Bindings API Dec 25, 2021

LambdAurora added the library: gui Related to the GUI library. label Jan 24, 2022

EnnuiL force-pushed the 1.18 branch from 2b96310 to 1520f66 Compare February 2, 2022 20:52

EnnuiL changed the title ~~Key Bindings API~~ Key Binds API Feb 2, 2022

OroArmor requested changes Feb 11, 2022

View reviewed changes

LambdAurora added the t: new api This adds a new API. label Feb 18, 2022

LambdAurora reviewed Feb 19, 2022

View reviewed changes

LambdAurora added s: wip This pull request is being worked on. and removed new: library A pull request which adds a new library. labels May 20, 2022

EnnuiL changed the base branch from 1.18 to 1.19 June 17, 2022 04:46

TheGlitch76 removed the documentation label Aug 28, 2022

EnnuiL removed the enhancement New feature or request label Sep 30, 2022

EnnuiL added 5 commits June 18, 2023 17:49

Begin Key Bindings API

fb28887

Oh, this is definitely not ready yet, I just needed an easy way to sync progress between computers

Begin dynamic key binding system

f3564b5

It's alive!

Further progress on Key Binding API

c727b5a

More API progress

bd1f189

If everything goes right, tomorrow we'll have a PR!

All ready for a draft PR!

310c5f0

EnnuiL added 27 commits June 18, 2023 17:50

Depend on resource loader

3c20a93

Required for translatable texts to work on the tooltips

Use the mappings refactor (I)

0dbac3c

I'll finish it at my other PC

Use the mappings refactor (II)

04b1b4d

Actually fix the Brazilian Portuguese translation

ac51db4

Viva!

Move to QSL event entrypoints

9acea91

Fix conflict tooltips

16ba2a0

Begin Pink's config system and key chords

38c18f1

Apply license; Use sorted maps for chords

2ad3f63

Add chord support for conflict warnings (I)

029225d

Uh, licença

5233854

Fix conflict tooltips

4b366c2

Begin to use FastUtils, add overflow hiding, more!

70f4f34

Pacify Checkstyle

a2f180f

wait, so, tabs are actually okay?

Fix lack of conflicts with the chord map

a6cbfda

Allow for setting default chords

f10008d

Quiltify Key Binds API, tackle down config issues

1009b0f

Push changes done to config

6b19c80

I have a plan to properly fix it, but now, it's icon time

Fix stuff

a48e4d1

no thoughts, head empty

Begin to overhaul toggling

110d0c6

Also, begin to implement unused_key_binds

Recalculating

841bdec

mind's currently empty, but i'll find a better way to do things

Refactor the key bind registry

3b9b425

It's gone!

Begin port to 1.19

0365268

Apply licenses

f25afdc

Fix config system

336531b

Reignite work on Key Binds API

a161416

keyboard mash

0b2e598

Partially port key binds api to 1.20

1286571

EnnuiL force-pushed the 1.18 branch from ffd84e5 to 1286571 Compare June 24, 2023 20:15

EnnuiL changed the base branch from 1.19 to 1.20 June 24, 2023 20:16

Merge branch '1.20' into 1.18

2d78d04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Key Binds API #59

Key Binds API #59

EnnuiL commented Dec 2, 2021 •

edited

Loading

TheGlitch76 commented Dec 2, 2021

OroArmor commented Dec 2, 2021

OroArmor left a comment

OroArmor Feb 11, 2022

EnnuiL Feb 11, 2022

OroArmor Feb 11, 2022

EnnuiL Feb 11, 2022

EnnuiL Feb 11, 2022

LambdAurora Feb 19, 2022

EnnuiL Feb 19, 2022

i509VCB Feb 20, 2022

LambdAurora commented Mar 12, 2022

EnnuiL commented Mar 13, 2022

	* public static final KeyBinding EXAMPLE_KEY_BIND = KeyBinding.registerKeyBinding(
	* public static final KeyBinding EXAMPLE_KEY_BIND = KeyBindingRegistry.registerKeyBinding(

Key Binds API #59

Are you sure you want to change the base?

Key Binds API #59

Conversation

EnnuiL commented Dec 2, 2021 • edited Loading

TheGlitch76 commented Dec 2, 2021

OroArmor commented Dec 2, 2021

OroArmor left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

LambdAurora commented Mar 12, 2022

EnnuiL commented Mar 13, 2022

EnnuiL commented Dec 2, 2021 •

edited

Loading