Hi

README.md

@@ -0,0 +1,68 @@
+# hyprEasymotion
+Plugin to enable 'easymotion' navigation. Inspired by Xmonad easymotion (which is in turn inspired by vim-easymotion)
+
+# Configuration
+Easymotion is basically a single dispatcher that brings up window labels and then allows you to execute a user-defined command when one of those labels is typed.
+
+`bind=SUPER,z,action:hyprctl dispatch focuswindow address:{}`
+
+This bind will bring up easymotion with SUPER-z. Once you select a window the window
+will focus. If you want to change the command, the selected window's address is substituted where "{}" occurs. 
+
+
+You can configure the appearance of the labels. Defaults are as follows:
+
+```
+plugin {
+  easymotion {
+    #font size of the text
+    textsize=15
+
+    #color of the text, takes standard hyprland color format
+    textcolor=rgba(ffffffff)
+
+    #background color of the label box. alpha is respected
+    bgcolor=rgba(000000ff)
+
+    #font to use for the label. This is passed directly to the pango font description
+    textfont=Sans
+    
+    #padding around the text (inside the label box) size in pixels, adjusted for
+    #monitor scaling. This is the same format as hyprland's gaps_in/gaps_out
+    textpadding=0
+
+    #size of the border around the label box
+    bordersize=0
+
+    #color of the border. takes the same format as hyprland's border (so it can be a gradient)
+    bordercolor=rgba(ffffffff)
+
+    #rounded corners? Same as hyprland's 'decoration:rounding' config
+    rounding=0
+
+    #which keys to use for labeling windows
+    motionkeys=abcdefghijklmnopqrstuvwxyz1234567890
+  }
+}
+```
+
+Every one of these variables is also settable via the dispatcher, so you can create multiple dispatchers that look different based on function.
+
+`bind=SUPER,z,bgcolor=rgba(ff0000ff);bordersize=5;action:hyprctl dispatch closewindow address:{}`
+
+### IMPORTANT 
+The easymotion arguments are separated by a semicolon, not a comma. (gap/padding format uses commas :/)
+
+# Installing
+
+## Hyprpm, Hyprland's official plugin manager (recommended)
+1. Run `hyprpm add https://github.com/zakk4223/hyprland-easymotion` and wait for hyprpm to build the plugin.
+2. Run `hyprpm enable hyprEasymotion`
+
+
+# TODO
+- [ ] Blur? 
+- [ ] Allow multi-letter labels? 
+- [ ] Fixed/static label box sizing 
+- [ ] Location of label in window (edges etc)
+- [ ] Auto label placement that tries to avoid being occluded