virt/hypr-dynamic-cursors
1
1
Fork 0
mirror of https://github.com/virtcode/hypr-dynamic-cursors synced 2025-09-19 08:03:21 +02:00
Code Issues Projects Releases Packages Wiki Activity

chore: clean up readme

Browse source
This commit is contained in:
Virt 2024-07-23 20:49:30 +02:00
commit 9c8195ccb7
1 changed files with 1 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -39,7 +39,6 @@ This plugin is still very early in its development. There are also multiple thin
- [X] per-shape length and starting angle (if possible) - [X] per-shape length and starting angle (if possible)
- [X] cursor shake to find - [X] cursor shake to find
- [X] overdue refactoring (wait for aquamarine merge) - [X] overdue refactoring (wait for aquamarine merge)
- [ ] ~~inverted cursor?~~ (i think out of scope here, but see the [inverted branch](https://github.com/VirtCode/hypr-dynamic-cursors/tree/inverted))
- [ ] hyprcursor magified shape - [ ] hyprcursor magified shape
If anything here sounds interesting to you, don't hesitate to contribute. If anything here sounds interesting to you, don't hesitate to contribute.
@ -229,7 +228,7 @@ If you have any ideas to improve performance, let me know!
## compatibility ## compatibility
Compatibility with other plugins is not guaranteed. It probably should work with most plugins, unless they also change your cursor's behaviour. It will however work with any cursor theme. Compatibility with other plugins is not guaranteed. It probably should work with most plugins, unless they also change your cursor's behaviour. It will however work with any cursor theme.
Also, this plugin won't work if your hardware cusors rely on `cursor:allow_dumb_copy = true`, which is probably the case if you are on nvidia. You'll probably have to wait until hardware cursors are correctly supported on Hyprland. Also, this plugin won't work if your hardware cusors rely on `cursor:allow_dumb_copy = true`, which is probably the case if you are on nvidia. You'll probably have to wait until hardware cursors are correctly supported on Hyprland, and use software cursors in the meantime.
## development ## development
To work on this plugin, you can clone this repository and use the Makefile to build it. I suggest opening a nested Hyprland session, and loading the plugin there: To work on this plugin, you can clone this repository and use the Makefile to build it. I suggest opening a nested Hyprland session, and loading the plugin there:
@ -242,11 +241,5 @@ If you want to debug hardware cursors, this plugin also has an additional config
Also make sure you disable the plugin on your host session, otherwise your cursor will be rotated twice. Also make sure you disable the plugin on your host session, otherwise your cursor will be rotated twice.
With some distributions of hyprland (notably the hyprland packages on Arch), your system headers are not complete? In this case the build will fail with something like `wayland.hpp: No such file or directory`. In these cases you have to resort back to using `hyprpm`'s headers. To do so, make sure to update hyprpm (`hyprpm update`), and set the following env in your shell before using the makefile:
```sh
export PKG_CONFIG_PATH="$HOME/.local/share/hyprpm/headersRoot/share/pkgconfig"
```
## license ## license
This plugin is licensed under the MIT License. Have a look at the `LICENSE.md` file for more information. This plugin is licensed under the MIT License. Have a look at the `LICENSE.md` file for more information.