feat: documentation, license and hyprpm

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2024 Virt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,63 @@
+# hypr-dynamic-cursors
+This plugin makes your more realistic by simulating how it would behave if it was an actual object being dragged across your screen. This means that it will change orientation based on in which direction you are moving.
+
+This plugin changes the cursor rendering, so it will work with all of your cursor themes.
+
+Why should you use this? Right, why did I implement this again?
+
+## showcase
+Currently, the cursor is being simulated as a stick being dragged across a surface. In action, this looks like this.
+
+
+## state
+This plugin is still very early in its development. **Currently, only the `-git` version of hyprland is supported**. There are also multiple things which may or may not be implemented in the future:
+
+- [X] Software Cursor rendering
+- [X] Hardware Cursor rendering (as good as possible)
+- [X] Stick simulation
+- [ ] Per-shape length and starting angle (at least with serverside cursors)
+- [ ] Pendulum simulation
+- [ ] Air Drag simulation
+
+If anything here sounds interesting to you, don't hesitate to contribute.
+
+Also note that this plugin was created more or less as a joke. I do not guarantee any updates or bugfixes, but will still try to somewhat maintain it.
+
+## installation
+Installation is supported via `hyprpm`. Supported hyprland versions are `v0.42.0` (yet unreleased) and upwards. The main branch generally tries to target `-git`.
+
+```sh
+hyprpm add https://github.com/virtcode/hypr-dynamic-cursors
+hyprpm enable dynamic-cursors
+```
+
+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.
+
+## configuration
+This plugin can be configured in its dedicated configuration section (`plugin:dynamic-cursors`). The default values are shown below.
+```ini
+plugin:dynamic-cursors {
+
+    # enables the plugin
+    enabled = true
+
+    # length in px of the simulated stick used to rotate the cursor
+    # it is recommended to set this to your actual cursor size
+    # longer sticks feel more "drifty"
+    length = 20
+
+}
+```
+
+## performance
+Depending on your hyprland configuration, this plugin can have a different performance impact. It mainly depends on whether you are using software or hardware cursors:
+
+**Software Cursors**: No (additional) performance impact. <br>
+Rotating the cursor can be done in the same draw call that is used to draw the cursor anyways, so there is no additional performance impact. Note however that software cursors in of themselves are not really efficient.
+
+**Hardware Cursors**: Medium performance impact. <br>
+To rotate the cursor smoothly, the cursor shape needs to be changed quite often. This is not exactly compatible with how hardware cursors are intended to work. With this plugin, the overhead of changing the cursor shape can be noticed more often, making it less efficient. It is still more efficient than using software cursor though.
+
+
+## license
+This plugin is licensed under the MIT License. Have a look at the `LICENSE.md` file for more information.

hyprpm.toml

@@ -0,0 +1,7 @@
+[dynamic-cursors]
+description = "make your cursors more realistic"
+authors = ["Virt"]
+output = "out/dynamic-cursors.so"
+build = [
+    "make all",
+]

src/main.cpp

@@ -92,7 +92,7 @@ APICALL EXPORT PLUGIN_DESCRIPTION_INFO PLUGIN_INIT(HANDLE handle) {
 
     HyprlandAPI::reloadConfig();
 
-    return {"dynamic-cursors", "The most stupid cursor plugin.", "Virt", "1.1"};
+    return {"dynamic-cursors", "make your cursor more realistic", "Virt", "0.1"};
 }
 
 APICALL EXPORT void PLUGIN_EXIT() {