Skip to content

Conversation

@jacobfranco
Copy link
Contributor

Pull Request

Description

Adds a "Custom Keybindings" section to KEYBINDINGS.en.md, showing users how to bind the built-in gamelauncher.sh script via userprefs.conf.

This provides a helpful example for customizing HyDE keybindings and increases discoverability for the included game launcher.

Also includes localized versions of the section in:

  • Spanish (KEYBINDINGS.es.md)
  • German (KEYBINDINGS.de.md)
  • Chinese (KEYBINDINGS.zh.md)
  • Arabic (KEYBINDINGS.ar.md)
  • Dutch (KEYBINDINGS.nl.md)
  • French (KEYBINDINGS.fr.md)

No code or functional changes.

Type of change

  • Documentation update (non-breaking change; modified files are limited to the documentations)

Checklist

  • I have read the CONTRIBUTING document.
  • My commit message follows the commit guidelines.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Additional context

This change was based on #453 (comment) and expands the documentation to support new users getting started with customization.

@kRHYME7 kRHYME7 changed the base branch from master to dev April 28, 2025 09:27

> [!TIP]
> <kbd>Super</kbd> + <kbd>/</kbd> zeigt die Tastenkombinationen.
> [!TIP] > <kbd>Super</kbd> + <kbd>/</kbd> zeigt die Tastenkombinationen.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do you changed it to a single line, this doesn't render correct if it's a single line

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahhh I think my linter automatically did that, it didn't affect the English or Chinese doc afaik.


## <a id="custom-keybindings"></a><img src="https://readme-typing-svg.herokuapp.com?font=Lexend+Giga&size=23&pause=1000&color=CCA9DD&width=435&lines=Custom%20Keybindings" width="450"/>

You can define your own keybindings by editing your preferences file at:
Copy link
Collaborator

@prime-run prime-run May 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe a link to related section in hyprland docs website ?

For example, to create a keybinding that launches the **HyDE Game Launcher**, add the following line:

```ini
bind = $mainMod, SPACE, exec, $HOME/.local/lib/hyde/gamelauncher.sh
Copy link
Collaborator

@prime-run prime-run May 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could be helpful to mention groupings and our default $MainMod + / integration.


> [!TIP]
> <kbd>Super</kbd> + <kbd>/</kbd> zeigt die Tastenkombinationen.
> [!TIP] > <kbd>Super</kbd> + <kbd>/</kbd> zeigt die Tastenkombinationen.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahhh I think my linter automatically did that

if you remove white space after > [!TIP] your linter should be fine!

@dieBakterie
Copy link
Collaborator

German translation is correct.

@kRHYME7
Copy link
Contributor

kRHYME7 commented May 15, 2025

Let me know if this is ready.

@jacobfranco
Copy link
Contributor Author

@kRHYME7 Sorry for just getting back to this, was on vacation. I think it should be good to go, I fixed the formatting issue mentioned above.

@kRHYME7
Copy link
Contributor

kRHYME7 commented May 19, 2025

Thank you! @jacobfranco

BTW how about this #518 (comment)

@jacobfranco
Copy link
Contributor Author

@kRHYME7 I saw that comment but I don't understand what they mean. I can definitely add something about it, but I'm not sure what to write or how it relates to my original addition. If you or @prime-run could clarify then I'll go for it!

@kRHYME7
Copy link
Contributor

kRHYME7 commented May 23, 2025

Merging

@kRHYME7 kRHYME7 merged commit 0844927 into HyDE-Project:dev May 23, 2025
kRHYME7 added a commit that referenced this pull request May 30, 2025
This is an automated PR to promote changes from `dev` to `master`.
Please review and test before merging.


See [TESTING.md](./TESTING.md) for complete testing instructions.


According to our release policy, this PR is expected to be merged on:
**Friday**
Testers are encouraged to test the changes before merging.
Please note that this schedule may be adjusted based on the needs of the
project.

---
* chore Merge branch 'master' into dev (2db2112) by Khing
* fix: improve mediaplayer.py `max_length` behavior in case of extremely
long artist and track (#701) (bb1ed13) by Ilya Bogdanov
* feat: add keybinding for rofi animation select menu (#698) (0464c8d)
by Rubin Bhandari
* feat: add keybinding for rofi animation select menu (d534f61) by Ilya
Bogdanov
* feat: use `duf` as alias for `df` (#693) (f9fd4b6) by Rubin Bhandari
* chore Merge branch 'dev' into feature-duf (7aef008) by Rubin Bhandari
* chore Add Optimized Animation Config and Enhanced IBM Hyprlock Theme
(#681) (7e1ba15) by Rubin Bhandari
* chore Merge branch 'dev' into master (bf58a9b) by Rubin Bhandari
* feat: use `duf` as alias for `df` (2373b81) by Ilya Bogdanov
* doc: remove copied line (#688) (adb788d) by ProfShiba
* fix: change config names in `uninstall.sh` note to actual values
(#684) (81eacca) by Ilya Bogdanov
* chore Adding enhanced IBM hyprlock with transparency, and blur support
(0e2953c) by xaicat
* chore LimeFrenzy - An optimized animation config with smooth and
fluent transitions (8f92b21) by xaicat
* fix: explicitly mention playerctl (#679) (4f0b15d) by Rubin Bhandari
* fix: systemupdate (a99a15a) by kRHYME7
* fix: systemupdate (a584569) by kRHYME7
* fix: update hypridle config syntax (#676) (ba6c273) by Rubin Bhandari
* fix: Fix #677/graphic-loading for non-interactive shell (#678)
(d8eb7f9) by Rubin Bhandari
* chore Update Configs/.user.zsh (ffa2db0) by Rubin Bhandari
* chore Merge branch 'master' into dev (d538f66) by Khing
* fix: Fix #677 graphic-loading for non-interactive shell (8ed764d) by
comrumino
* feat: Add dropdown terminal (#673) (29e0b0e) by Rubin Bhandari
* doc: add dropdown terminal keybind (2d72567) by ProfShiba
* chore Update keybindings.conf (6d17828) by Khing
* chore Merge branch 'dev' into dropdown (d23f742) by Khing
* chore Merge branch 'master' into dev (d71b42b) by Khing
* chore Update Configs/.config/hypr/keybindings.conf (1e91a5f) by Rubin
Bhandari
* chore Merge branch 'dev' into dropdown (2f398db) by Rubin Bhandari
* fix: Some QOL (cdb73c1) by kRHYME7
* chore Shaders (#656) (813e13b) by Khing
* feat: dropdown terminal (14e7b4c) by ProfShiba
* fix: includes the XDG cache directory in the discord wallbash script
(#671) (2a5e8a5) by Keegan Wright
* chore config: update .zshrc and .zshenv to reference .user.zsh instead
of .hyde.zshrc (#668) (b0e6d71) by dagiikg9134
* fix: Missing scrollbars on Discord Clients (#666) (ebdd8a9) by
Xyloflake
* chore Merge branch 'master' into dev (acf8ec0) by Khing
* docs: add custom keybinding example for gamelauncher.sh (#518)
(0844927) by jacob
---

Please review the changes carefully before merging.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants