retrovim 0.0.3

package/README.md

@@ -0,0 +1,336 @@
+ <img width="1366" height="768" alt="screenshot" src="https://github.com/user-attachments/assets/72895442-cdaa-445c-aefe-6c487d89ba13" />
+
+<div align="center">
+
+terax-terminal preconfigured with neovim IDE + yazi builtin plugins + zsh builtin plugins + kanata keyboard layout
+
+---
+
+**[<kbd> <br> Install <br> </kbd>][Install]** 
+**[<kbd> <br> Zsh Keymaps <br> </kbd>][Zsh Keymaps]** 
+**[<kbd> <br> Keyboard-Layout <br> </kbd>][Keyboard-Layout]** 
+
+[Install]: #installation
+[Zsh Keymaps]: #zsh-keymaps
+[Keyboard-Layout]: #if-touchcursor-keyboard-layout-started
+
+</div>
+
+---
+
+<details open><summary>Table of Contents</summary>
+
+1. Neovim keymaps
+   - [Neovim text object that starts with a/i](#neovim-text-object-that-starts-with-ai)
+   - [Neovim text-object/motions/operators that starts with g](#neovim-text-objectmotionsoperators-that-starts-with-g)
+2. Terminal
+   - [zsh keymaps](#zsh-keymaps)
+3. [If Touchcursor Keyboard Layout Started](#if-touchcursor-keyboard-layout-started)
+4. Installation
+   - [Install](#installation)
+5. [Related projects](#related-projects)
+
+</details>
+
+---
+
+## Neovim text object that starts with `a`/`i`
+
+<details open><summary></summary>
+
+|         text-object keymap         | repeat action key | finds and autojumps? | text-object name | description                                                                               | inner / outer                                                                 |
+| :--------------------------------: | :---------------: | :------------------: | :--------------- | :---------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------- |
+|             `ia`, `aa`             |        `.`        |         yes          | \_argument       | whole argument/parameter of a function                                                    | outer includes comma                                                          |
+|             `ib`, `ab`             |        `.`        |         yes          | \_braces         | find the nearest inside of `()` `[]` `{}`                                                 | outer includes braces                                                         |
+|             `iB`, `aB`             |        `.`        |         yes          | \_brackets       | find the nearest inside of `{}` `:help iB`                                                | outer includes brackets                                                       |
+|             `id`, `ad`             |        `.`        |         yes          | diagnostic       | find errors, warnings, info or hints (only works inside neovim and requires LSP)          | outer same as inner                                                           |
+|             `ie`, `ae`             |        `.`        |                      | line             | from start to end of line without beginning whitespaces (line wise)                       | outer includes begining whitespaces                                           |
+|             `if`, `af`             |        `.`        |         yes          | \_function_call  | like `function args` but only when a function is called                                   | outer includes the function called                                            |
+|             `ih`, `ah`             |        `.`        |         yes          | \_html_attribute | attribute in html/xml like `href="foobar.com"`                                            | inner is only the value inside the quotes trailing comma and space            |
+|             `ii`, `ai`             |        `.`        |                      | indent_noblanks  | surrounding lines with same or higher indentation delimited by blanklines                 | outer includes line above                                                     |
+|             `iI`, `aI`             |        `.`        |                      | indent           | surrounding lines with same or higher indentation                                         | outer includes line above and below                                           |
+|             `ik`, `ak`             |        `.`        |         yes          | \_key            | key of key-value pair, or left side of a assignment                                       | outer includes spaces                                                         |
+|             `il`, `al`             |        `.`        |         yes          | +last            | go to last mini.ai text-object (which start with `_`)                                     | requires `i`/`a` example `vilk`                                               |
+|             `im`, `am`             |        `.`        |         yes          | \_number         | numbers, similar to `<C-a>`                                                               | inner: only pure digits, outer: number including minus sign and decimal point |
+|             `in`, `an`             |        `.`        |         yes          | +next            | go to Next mini.ai text-object (which start with `_`)                                     | requires `i`/`a` example `viNk`                                               |
+|             `io`, `ao`             |        `.`        |         yes          | \_whitespaces    | whitespace beetween characters                                                            | outer includes surroundings                                                   |
+|             `ip`, `ap`             |        `.`        |                      | paragraph        | blanklines can also be treat as paragraphs when focused on a blankline                    | outer includes below lines                                                    |
+|             `iq`, `aq`             |        `.`        |         yes          | \_quotes         | inside of `` ` ` `` or `' '` or `" "`                                                     | outer includes openning and closing quotes                                    |
+|             `is`, `as`             |        `.`        |                      | sentence         | sentence delimited by dots of blanklines `:help sentence`                                 | outer includes spaces                                                         |
+|             `it`, `at`             |        `.`        |         yes          | \_tag            | inside of a html/jsx tag                                                                  | outer includes openning and closing tags                                      |
+|             `iu`, `au`             |        `.`        |                      | \_subword        | like `iw`, but treating `-`, `_`, and `.` as word delimiters _and_ only part of camelCase | outer includes trailing `_`,`-`, or space                                     |
+|             `iv`, `av`             |        `.`        |         yes          | \_value          | value of key-value pair, or right side of a assignment                                    | outer includes trailing commas or semicolons or spaces                        |
+|             `iw`, `aw`             |        `.`        |                      | word             | from cursor to end of word (delimited by punctuation or space)                            | outer includes whitespace ending                                              |
+|             `iW`, `aW`             |        `.`        |                      | WORD             | from cursor to end of WORD (includes punctuation)                                         | outer includes whitespace ending                                              |
+|             `ix`, `ax`             |        `.`        |         yes          | \_Hex            | hexadecimal number or color                                                               | outer includes hash `#`                                                       |
+|             `i?`, `a?`             |        `.`        |         yes          | \_user_prompt    | will ask you for enter the delimiters of a text object (useful for dot repeteability)     | outer includes surroundings                                                   |
+|       `i(`, `i)`, `a(`, `a)`       |        `.`        |         yes          | `(` or `)`       | inside `()`                                                                               | outer includes surroundings                                                   |
+|       `i[`, `i]`, `a[`, `a]`       |        `.`        |         yes          | `[` or `]`       | inside `[]`                                                                               | outer includes surroundings                                                   |
+|       `i{`, `i}`, `a{`, `a}`       |        `.`        |         yes          | `{` or `}`       | inside `{}`                                                                               | outer includes surroundings                                                   |
+|       `i<`, `i>`, `a<`, `a>`       |        `.`        |         yes          | `<` or `>`       | inside `<>`                                                                               | outer includes surroundings                                                   |
+|         `` i` ``, `` a` ``         |        `.`        |         yes          | apostrophe       | inside `` ` ` ``                                                                          | outer includes surroundings                                                   |
+| `i<punctuation>`, `a<punctuation>` |        `.`        |         yes          | `<punctuation>`  | inside `<punctuation><punctuation>`                                                       | outer includes surroundings                                                   |
+
+</details>
+
+## Neovim text-object/motions/operators that starts with `g`
+
+<details open><summary></summary>
+
+|      keymap       |    mode     | repeat action key |    repeat jump key     | text-object description                                                   | `n`ormal mode = `n` = operator           | `o`perating-pending mode = `o` = text-object | `v`isual mode = `v` = `x` = motion      | examples in normal mode                                                             |
+| :---------------: | :---------: | :---------------: | :--------------------: | :------------------------------------------------------------------------ | :--------------------------------------- | :------------------------------------------- | :-------------------------------------- | :---------------------------------------------------------------------------------- |
+|    `[c` / `]c`    | `n`,`o`,`x` |        `.`        |                        | previous/next comment                                                     | finds and jumps                          | jumps                                        | uses selection                          | `v]c` selects from cursor position until next comment                               |
+|    `[d` / `]d`    | `n`,`o`,`x` |        `.`        |                        | previous/next diagnostic                                                  | finds and jumps                          | jumps                                        | uses selection                          | `v]d` selects from cursor position until next diagnostic                            |
+|    `[h` / `]h`    | `n`,`o`,`x` |        `.`        |                        | previous/next git hunk                                                    | finds and jumps                          | jumps                                        | uses selection                          | `v]h` selects from cursor position until next git hunk                              |
+|    `[i` / `]i`    | `n`,`o`,`x` |        `.`        |                        | previous/next indent                                                      | finds and jumps                          | jumps                                        | uses selection                          | `v]i` selects from cursor position until next indent                                |
+|     `g[`/`g]`     | `n`,`o`,`x` |        `.`        |                        | +prev/+next textobj (only textobj with `_` prefix)                        | followed by text-object                  | finds and jumps                              | uses selection                          | `g]q` next end of quotation                                                         |
+|   `g\` / `g\|`    | `n`,`o`,`x` |        `.`        |       `\` / `\|`       | +end/+start of textobj (any inner/outer textobj)                          | followed by text-object                  | finds and jumps                              | uses selection (`\` / `\|` to reselect) | `dg\iq` delete until inner end of quotation (`.` to repeat)                         |
+|    `qq ... q`     |   `n`,`x`   |        `.`        |   `\` or `@q` + `@@`   | repeats ... macro                                                         | followed by text-object                  |                                              | selects from cursor position            | `qqviqq` selects quotation (`\` to repeat)                                          |
+|    `qw ... q`     |   `n`,`x`   |        `.`        |  `\|` or `@w` + `@@`   | repeats ... macro                                                         | followed by text-object                  |                                              | selects from cursor position            | `qwdiqq` delete inner quotation (`\| ` to repeat)                                   |
+|     `g;`/`g,`     |     `n`     |                   |                        | go backward/forward in `:changes`                                         | jumps                                    |                                              |                                         | `g;` go to last change                                                              |
+|       `g.`        | `n`,`o`,`x` |                   |                        | jump to last change                                                       | jumps                                    | won't jump                                   | uses selection                          | `vg.` selects from cursor position until last change                                |
+|       `ga`        |   `n`,`x`   |                   |                        | +align                                                                    | followed by textobject/motion            |                                              | uses selected region                    | `gaip=` or `vipga=` aligns a paragraph by `=`                                       |
+|       `gb`        |   `n`,`x`   |        `.`        |                        | +blackhole register                                                       | followed by textobject/motion            |                                              | deletes selection                       | `gbip` or `vipgb` deletes a paragraph without copying                               |
+|       `gB`        |   `n`,`x`   |        `.`        |                        | blackhole linewise                                                        | text-object not required                 |                                              | deletes line                            | `gB.` deletes two lines without saving it in the register                           |
+|       `gc`        | `n`,`o`,`x` |        `.`        |                        | +comment (`vgc` in normal mode will select a block comment)               | followed by textobject/motion            | won't jump                                   | uses selection                          | `gcip` or `vipgc` comments a paragraph                                              |
+|       `gC`        | `n`,`o`,`x` |        `.`        |                        | block comment (supports selection `vgC` or just `gC`)                     | select text-object under cursor          | won't jump                                   | reselects                               | `vgC` selects current block of comment                                              |
+|       `gd`        |     `n`     |                   |                        | go to definition                                                          | jumps                                    |                                              |                                         | `gd` go to definition of word under cursor                                          |
+|       `gD`        |     `x`     |                   |                        | git diff/hunk (vscode selects from cursor position to end of diff)        |                                          | won't jump                                   | reselects                               | `vgD` selects modified code                                                         |
+|     `ge`/`gE`     | `n`,`o`,`x` |                   |                        | previous end of word/WORD (`WORD` omits punctuation)                      | jumps                                    | uses cursor position                         | uses selection                          | `vge` selects from cursor position until previous end of word                       |
+|       `gf`        |   `n`,`x`   |                   |                        | go to file under cursor                                                   | jumps                                    |                                              | uses selection                          | `gf` open in a tab the path under cursor                                            |
+|     `gg`/`G`      | `n`,`o`,`x` |        `.`        |                        | first/last line                                                           | jumps                                    | uses cursor position                         | uses selection                          | `vgg` selects until first line                                                      |
+|       `gi`        |   `n`,`x`   |                   |                        | last position of cursor in insert mode                                    | finds and jumps                          |                                              | uses selection                          | `vgi` selects until last insertion                                                  |
+|     `gj`/`gk`     | `n`,`o`,`x` |        `.`        |                        | go down/up when wrapped                                                   | jumps                                    | uses cursor position                         | uses selection                          | `vgj` selects one line down                                                         |
+|       `gJ`        |   `n`,`x`   |        `.`        |                        | join below lines                                                          | joins                                    |                                              | uses selection                          | `vgJ` joins selected lines into one line                                            |
+|       `gm`        |   `n`,`x`   |                   |                        | +multiply (duplicate text) operator                                       |                                          | won't jump                                   | uses selection                          | `gmap` or `vapgm` duplicates paragraph without replacing clipboard                  |
+|       `gM`        |   `n`,`x`   |                   |                        | go to middle line                                                         | jumps                                    |                                              | uses selection                          | `vgM` selects until middle of the line                                              |
+|     `gp`/`gn`     | `n`,`o`,`x` |        `.`        |                        | prev/next find                                                            | text-object not required                 | finds and jumps                              | uses selection                          | `cgn???` replaces last search with `???` forwardly                                  |
+|       `go`        |     `x`     |                   |                        | jsx/tsx comment (only inside neovim)                                      |                                          |                                              | uses selection                          | `vipgt` comments out a paragraph with `{/* */}`                                     |
+|       `gq`        |   `n`,`x`   |        `.`        |                        | +format selection/comments 80chars (LSP overrides it)                     | requires a textobject                    |                                              | applies to selection                    | `gqip` or `vipgq` formats a paragraph                                               |
+|       `gr`        |   `n`,`x`   |        `.`        |                        | +replace (with register) operator                                         | followed by text-object/motion           |                                              | applies to selection                    | `griw` or `viwgr` replaces word with register (yanked text)                         |
+|       `gs`        |   `n`,`x`   |        `.`        |                        | +sort Operator                                                            | followed by text-object/motion           |                                              | uses selection                          | `gsip` or `vipgs` sorts a paragraph                                                 |
+|       `gS`        |   `n`,`x`   |        `.`        |                        | split/join arguments                                                      | toggles inside `{}`,`[]`,`()`            |                                              | followed by operator                    | `vipgS` joins selected lines in one line                                            |
+|     `gu`/`gU`     |   `n`,`x`   |        `.`        |                        | +to lowercase/uppercase                                                   | requires a text-object                   |                                              | applies to selection                    | `gUiw` (neovim and cvim only) or `viwgU` uppercase a word                           |
+|       `gv`        |   `n`,`x`   |                   |                        | last selected                                                             | finds and jumps                          |                                              | reselects                               | `vgv` selects last selection                                                        |
+|       `gw`        |   `n`,`x`   |        `.`        |                        | split/join comments/lines 80chars (keeps cursor position)                 | requires a text-object                   |                                              | applies to selection                    | `gwip` or `vipgw` split/join a paragraph limited by 80 characters                   |
+|       `gx`        |   `n`,`x`   |        `.`        |                        | +exchange (text) Operator                                                 | followed by text-object/motion           |                                              | uses selection                          | `gxiw` or `viwgx` exchanges word with another `gxiw` or `viwgx` or `.`              |
+|     `gy`/`gY`     |     `n`     |        `.`        |                        | redo register (dot to paste forward/bacward)                              | paste                                    |                                              |                                         | `gy.....` paste deleted lines by history                                            |
+|     `g-`/`g+`     |   `n`,`x`   |        `.`        |                        | decrement/increment number                                                | selects number under cursor              |                                              | uses selected number                    | `g+..` or `3g+` increments by 3                                                     |
+| `g<Up>`/`g<Down>` |   `n`,`x`   |                   |                        | numbers ascending/descending                                              | selects number under cursor              |                                              | uses selected number                    | `g<Up>` increases selected numbers ascendingly                                      |
+|        `=`        |   `n`,`x`   |        `.`        |                        | +autoindent                                                               | followed by text-object                  |                                              | uses selection                          | `==` autoindents line                                                               |
+|      `<`/`>`      |   `n`,`x`   |        `.`        |                        | +indent left/right                                                        | followed by text-object                  |                                              | uses selection                          | `<<` indents to left a line                                                         |
+|      `0`/`$`      | `n`,`o`,`x` |        `.`        |                        | start/end of line                                                         | jumps                                    |                                              | uses selection                          | `d$j.` deletes two end-of-lines                                                     |
+|        `^`        | `n`,`o`,`x` |        `.`        |                        | start of line (non-blankline)                                             | jumps                                    |                                              | uses selection                          | `d^` deletes until start of line (after whitespace)                                 |
+|        `%`        | `n`,`o`,`x` |                   |                        | matching character: '()', '{}', '[]'                                      | finds and jumps                          |                                              | finds and jumps                         | `d%` deletes until bracket                                                          |
+|      `(`/`)`      | `n`,`o`,`x` |        `.`        |                        | prev/next sentence                                                        | jumps                                    |                                              | uses selection                          | `d(.` deletes until start of sentence (two times)                                   |
+|      `{`/`}`      | `n`,`o`,`x` |        `.`        |                        | prev/next empty line (before a paragraph)                                 | jumps                                    |                                              | uses selection                          | `d{.` deletes until next empty line (two times)                                     |
+|     `[[`/`]]`     | `n`,`o`,`x` |        `.`        |                        | prev/next section                                                         | jumps                                    |                                              | uses selection                          | `d[[` deletes until start of section                                                |
+|      `b`/`w`      | `n`,`o`,`x` |        `.`        |                        | prev/next word                                                            | jumps                                    |                                              | uses selection                          | `db` deletes until start of word                                                    |
+|      `B`/`W`      | `n`,`o`,`x` |        `.`        |                        | prev/next WORD                                                            | jumps                                    |                                              | uses selection                          | `dW.` deletes 2 WORDS                                                               |
+|      `e`/`E`      | `n`,`o`,`x` |        `.`        |                        | end of word/WORD                                                          | jumps                                    |                                              | uses selection                          | `de` deletes until end of word                                                      |
+|        `/`        | `n`,`o`,`x` |        `.`        |                        | search with labels like [flash.nvim](https://github.com/folke/flash.nvim) | jumps                                    | finds and jumps                              | uses selection                          | `d/` then `search` then `label` to delete `c/` to change `v/` to select `/` to jump |
+|      `f`/`F`      | `n`,`o`,`x` |        `.`        | `;`forward `,`backward | move to next/prev char (`f` forward, `F` backward for vscode-neovim)      | jumps                                    |                                              | uses selection                          | `df,` deletes until a next `,`                                                      |
+|      `t`/`T`      | `n`,`o`,`x` |        `.`        | `;`forward `,`backward | move before next/prev char (`t` forward, `T` backward for vscode-neovim)  | jumps                                    |                                              | uses selection                          | `dt,` deletes before next `,`                                                       |
+|        `s`        |   `n`,`x`   |        `.`        |                        | +surround (followed by a=add, d=delete, r=replace)                        | followed by textobject/motion (only add) |                                              | uses selection (only add)               | `saiw"` or `viwsa"` adds `"` to word, `sd"` deletes `"`, `sr"'` replaces `"`        |
+|        `U`        |   `n`,`x`   |                   |          `U`           | whichkey repeater (inside neovim repeats `:<command>` like macros)        |                                          |                                              |                                         | `<s-space>gjUUU` repeats next-git-change (`:normal A,jkj` end of line comma)        |
+|        `Y`        |   `n`,`x`   |                   |                        | yank until end of line                                                    |                                          |                                              | uses selection                          | `v^Y` yanks line                                                                    |
+| `<space><space>p` |   `n`,`x`   |        `.`        |                        | Paste after (secondary clipboard)                                         |                                          |                                              | uses selection                          | `viw<space><space>p` replaces word with a second clipboard                          |
+| `<space><space>P` |   `n`,`x`   |        `.`        |                        | Paste before (secondary clipboard)                                        |                                          |                                              | uses selection                          | `viw<space><space>P` replaces word with a second clipboard                          |
+| `<space><space>y` |   `n`,`x`   |                   |                        | yank (secondary clipboard)                                                |                                          |                                              | uses selection                          | `viw<space><space>y` yanks word using the second clipboard                          |
+| `<space><space>Y` |   `n`,`x`   |                   |                        | yank until end of line (secondary clipboard)                              |                                          |                                              | uses selection                          | `v<space><space>Y` yanks until end of line using the second clipboard               |
+
+</details>
+
+---
+
+## zsh keymaps
+
+<details open><summary></summary>
+
+|       keymap        | description                                                |
+| :-----------------: | :--------------------------------------------------------- |
+|       `<tab>`       | show (dash/path) options or complete path                  |
+|    `<tab><tab>`     | enter completion menu                                      |
+|    `<esc><esc>`     | tmux-copy-mode-like / normal-mode (inside neovim terminal) |
+|   `shift+escape`    | tmux-copy-mode-like / normal-mode (inside neovim terminal) |
+|    `nvim<enter>`    | open retronvim's neovim IDE (`<space>` to open whichkey)   |
+|     `y<enter>`      | open yazi (changes directory on exit)                      |
+| `alt+o` or `<esc>o` | open yazi (even while writing commands)                    |
+| `alt+h` or `<esc>`  | enter vim-mode                                             |
+|       `alt+l`       | complete inline/ghost suggestion and enter vim-mode        |
+|       `alt+j`       | prev shell history and enter vim-mode                      |
+|       `alt+k`       | next shell history and enter vim-mode                      |
+|        `Up`         | prev shell history                                         |
+|       `Down`        | next shell history                                         |
+|      `ctrl+r`       | search history with fzf                                    |
+|      `ctrl+l`       | clear screen                                               |
+|    `ctrl+alt+l`     | clear screen (inside neovim terminal or vscode terminal)   |
+|      `ctrl+d`       | exit signal                                                |
+|      `ctrl+c`       | cancel signal                                              |
+
+</details>
+
+---
+
+## If Touchcursor Keyboard Layout Started
+
+<details open><summary></summary>
+
+**layer qwerty**
+
+```
+@grl 1    2    3    4    5    6    7    8    9    0    -    =    @bsp
+tab  q    w    @e   r    t    y    u    i    o    p    [    ]    ret
+@cap a    @s   @d   f    g    @h   @j   @k   @l   @;   '    \
+lsft ret  z    x    c    v    b    n    m    ,    .    /    rsft
+lctl lmet @alt           @spc           @sft rmet rctl
+```
+
+**layer touchcursor** (press and hold space to enter the layer)
+
+```
+_    f1   f2   f3   f4   f5   f6   f7   f8   f9   f10  f11  f12  _
+_    @M↑  del  @m↑  @clr @m🡠  _    _    _    _    _    _    _    _
+_    @M↓  @bsp @m↓  spc  @m🡪  @🡠   @↓   @↑   @🡪   @yaz _    _
+_    _    _    _    caps @¿   @ñ   pgup home end  pgdn _    _
+_    _    _              _              _    _    _
+```
+
+| key  | description                                                                               |          example / keymap          |
+| :--: | :---------------------------------------------------------------------------------------- | :--------------------------------: |
+| @grl | tap: backtick/grave, hold and press `1` = qwerty layer, hold and press `2` = dvorak layer |         `` `+2 = dvorak ``         |
+| @cap | tap for escape, hold for LeftCtrl                                                         |          `cap+l = ctrl+l`          |
+| @sft | tap for backspace, hold for LeftShift                                                     |         `RAlt+l = shift+l`         |
+| @alt | tap for middle click, hold for LeftAlt                                                    |         `LAlt+l = LAlt+l`          |
+| @spc | tap for space, hold for touchcursor layer, release for qwerty layer                       | `space+jj = DownArrow + DownArrow` |
+|  @;  | tap for semicolon, hold for ctrl                                                          | `;+click = OpenInNewTab (chrome)`  |
+| @clr | clear screen on any shell                                                                 |             `space+r`              |
+|  @¿  | unicode ¿                                                                                 |             `space+v`              |
+|  @ñ  | unicode ñ                                                                                 |             `space+b`              |
+| @m🡠  | mouse scrolling left                                                                      |             `space+t`              |
+| @m🡪  | mouse scrolling right                                                                     |             `space+g`              |
+| @m↑  | mouse scrolling up                                                                        |             `space+e`              |
+| @m↓  | mouse scrolling down                                                                      |             `space+d`              |
+| @M↑  | mouse fast scrolling up                                                                   |             `space+q`              |
+| @M↓  | mouse fast scrolling down                                                                 |             `space+a`              |
+| spc  | space key                                                                                 |             `space+f`              |
+| bspc | backspace key                                                                             |             `space+s`              |
+| home | home key                                                                                  |             `space+m`              |
+| end  | end key                                                                                   |             `space+,`              |
+| pgup | pageup key                                                                                |             `space+n`              |
+| pgdn | pagedown key                                                                              |             `space+.`              |
+|  @🡠  | left arrow key                                                                            |             `space+h`              |
+|  @↓  | down arrow key                                                                            |             `space+j`              |
+|  @↑  | up arrow key                                                                              |             `space+k`              |
+|  @🡪  | right arrow key                                                                           |             `space+l`              |
+| caps | toggles capslock                                                                          |             `space+c`              |
+
+</details>
+
+---
+
+## Installation
+
+<details open><summary></summary>
+
+**Install RetroVim on any terminal or shell**
+
+- Powershell (windows):
+
+  ```bash
+  irm pixi.sh/install.ps1 | iex
+  pixi g install retrovim -c retronvim -c conda-forge
+  ```
+
+- SSH/Bash/Zsh (linux/macos):
+
+  ```bash
+  sh <(curl https://pkgx.sh) pixi g install retrovim -c retronvim -c conda-forge --with pixi
+  ```
+
+- npm + any package manager:
+
+  ```bash
+  # brew   install bat eza fzf git kanata lazygit mise neovim ripgrep starship yazi zsh zsh-patina
+  # pixi g install bat eza fzf git kanata lazygit mise nvim   ripgrep starship yazi zsh zsh-patina -c retronvim -c conda-forge
+
+  npm install -g retronvim
+  ```
+
+- pip + any package manager:
+
+  ```bash
+  # brew   install bat eza fzf git kanata lazygit mise neovim ripgrep starship yazi zsh zsh-patina
+  # pixi g install bat eza fzf git kanata lazygit mise nvim   ripgrep starship yazi zsh zsh-patina -c retronvim -c conda-forge
+
+  pip install retronvim
+  ```
+
+**Plugins**
+
+- RetroVim.conda is shipped with
+  - [`bat`](https://github.com/sharkdp/bat)
+  - [`eza`](https://github.com/eza-community/eza)
+  - [`firacode_nerd_font`](https://github.com/ryanoasis/nerd-fonts)
+  - [`fd`](https://github.com/sharkdp/fd)
+  - [`fzf`](https://github.com/junegunn/fzf)
+  - [`git`](https://github.com/git-for-windows/git)
+  - [`kanata`](https://github.com/jtroo/kanata)
+  - [`lazygit`](https://github.com/jesseduffield/lazygit)
+  - [`mise`](https://github.com/jdx/mise)
+  - [`neovim`](https://neovim.io)
+  - [`pixi`](https://github.com/prefix-dev/pixi)
+  - [`ripgrep`](https://github.com/BurntSushi/ripgrep)
+  - [`starship`](https://github.com/starship/starship)
+  - [`terax`](https://github.com/crynta/terax-ai)
+  - [`yazi`](https://github.com/sxyazi/yazi)
+  - [`zerobrew`](https://github.com/lucasgelfond/zerobrew)
+  - [`zsh`](https://github.com/zsh-users/zsh)
+  - [`zsh-patina`](https://github.com/michel-kraemer/zsh-patina)
+  - [`7zip`](https://github.com/ip7z/7zip)
+
+- RetroVim/nvim comes with an installer for
+  - [`mini.nvim`](https://github.com/echasnovski/mini.nvim) (shipped as git-submodule)
+  - [`copilot`](https://github.com/github/copilot-language-server-release) (shipped with sidekick.nvim)
+  - [`flash.nvim`](https://github.com/folke/flash.nvim)
+  - [`neotype`](https://github.com/rodolfo-arg/neotype)
+  - [`nvim-lspconfig`](https://github.com/neovim/nvim-lspconfig)
+  - [`sidekick.nvim`](https://github.com/folke/sidekick.nvim) (free copilot nes + agents integration like gemini-cli)
+  - [`supermaven`](https://github.com/supermaven-inc/supermaven-nvim) (free copilot)
+
+- RetroVim/nvim searches for vscode extensions's snippets in `~/.*/extensions/*/snippets/*code-snippets`
+  (alphabetically first `~/.antigravity` otherwise `~/.cursor` otherwise `~/.vscode` otherwise `~/.windsurf`)
+  and automatically adds them to `mini.completion`
+
+  - if you see: `No contains a valid JSON object` then to fix it use biome linter usually it is extras commas or comments
+  - if you see: `File is absent or not readable` then delete the file to make `mini.snippet` work
+
+- `Touchcursor Keyboard Layout` on `MacOs` requires `zb install karabiner`
+
+- `terax` on `archlinux` requires `pacman -S webkit2gtk-4.1`
+
+- `terax` on `debian` requires `apt install webkit2gtk-4.1-dev`
+
+- `terax` on `linux` requires `chsh --shell /bin/zsh` (sets zsh as default shell)
+
+- `terax` requires the setting `Font family: FiraCode Nerd Font` for icons support (`pixi exec --channel retronvim -- firacode-nerdfont-installer` to install firacode font)
+
+</details>
+
+## Related projects
+
+<details open><summary></summary>
+
+- [yeferyv/RetroNvim](https://github.com/yeferyv/retronvim)
+  vscode extension with minimal whichkey, lazyvim, terax, yazi, zsh and kanata setup
+
+- [yeferyv/dotfiles](https://github.com/yeferyv/dotfiles)
+  retronvim + [hyprland](https://hypr.land) setup
+
+- [binvim](https://github.com/bgunnarsson/binvim/)
+  neovim IDE written in rust (with copilot, agents, text-objects, whichkey ...)
+
+- [terax](https://github.com/crynta/terax-ai)
+  agentic terminal + neovim-like IDE
+
+</details>

package/kanata/touchcursor.kbd

@@ -0,0 +1,164 @@
+;; vim:ft=lisp
+
+;; Comments are prefixed by double-semicolon. A single semicolon is parsed as the
+;; keyboard key. Comments are ignored for the configuration file.
+;;
+;; This configuration language is Lisp-like. If you're unfamiliar with Lisp,
+;; don't be alarmed. The maintainer jtroo is also unfamiliar with Lisp. You
+;; don't need to know Lisp in-depth to be able to configure kanata.
+;;
+;; If you follow along with the examples, you should be fine. Kanata should
+;; also hopefully have helpful error messages in case something goes wrong.
+;; If you need help, you are welcome to ask.
+
+;; testing: map `a` as `A`
+;; (defcfg process-unmapped-keys yes) (defsrc) (deflayer mylayer) (defoverrides (a) (lsft a))
+;; (defcfg process-unmapped-keys yes) (defsrc) (deflayermap (mylayer) a (multi lsft a))
+
+(defcfg
+  linux-x11-repeat-delay-rate 300,50
+)
+
+;; Only one defsrc is allowed.
+;;
+;; defsrc defines the keys that will be intercepted by kanata. The order of the
+;; keys matches with deflayer declarations and all deflayer declarations must
+;; have the same number of keys as defsrc. Any keys not listed in defsrc will
+;; be passed straight to the operating system.
+(defsrc
+  grv  1    2    3    4    5    6    7    8    9    0    -    =    bspc
+  tab  q    w    e    r    t    y    u    i    o    p    [    ]    ret
+  caps a    s    d    f    g    h    j    k    l    ;    '    \
+  lsft <    z    x    c    v    b    n    m    ,    .    /    rsft
+  lctl lmet lalt           spc            ralt comp rctl
+)
+
+;; The first layer defined is the layer that will be active by default when
+;; kanata starts up. This layer is the standard QWERTY layout except for the
+;; backtick/grave key (@grl) which is an alias for a tap-hold key.
+;;
+;; There are currently a maximum of 25 layers allowed.
+(deflayer qwerty
+  @grl 1    2    3    4    5    6    7    8    9    0    -    =    @bsp
+  tab  q    w    @e   r    t    y    u    i    o    p    [    ]    ret
+  @cap a    @s   @d   f    g    @h   @j   @k   @l   @;   '    \
+  lsft ret  z    x    c    v    b    n    m    ,    .    /    rsft
+  lctl lmet @alt           @spc           @sft rmet rctl
+)
+
+;; The dvorak layer remaps the keys to the dvorak layout. In addition there is
+;; another tap-hold key: @cap. This key retains caps lock functionality when
+;; quickly tapped but is read as left-control when held.
+(deflayer dvorak
+  @grl 1    2    3    4    5    6    7    8    9    0    [    ]    bspc
+  tab  '    ,    .    p    y    f    g    c    r    l    /    =    ret
+  @cap a    o    e    u    i    d    h    t    n    s    -    \
+  lsft ret  ;    q    j    k    x    b    m    w    v    z    rsft
+  lctl lmet lalt           spc            ralt rmet rctl
+)
+
+;; (deflayermap (altspace)
+;;   spc  (multi (release-key lalt) lsft spc)
+;; )
+
+(deflayer touchcursor
+  _    f1   f2   f3   f4   f5   f6   f7   f8   f9   f10  f11  f12  _
+  _    @M↑  del  @m↑  @clr @m🡠  _    _    _    _    _    _    _    _
+  _    @M↓  @bsp @m↓  spc  @m🡪  @🡠   @↓   @↑   @🡪   @yaz _    _
+  _    _    _    _    caps @¿   @ñ   pgup home end  pgdn _    _
+  _    _    _              _              _    _    _
+)
+
+;; defalias is used to declare a shortcut for a more complicated action to keep
+;; the deflayer declarations clean and aligned. The alignment in deflayers is not
+;; necessary, but is strongly recommended for ease of understanding visually.
+;;
+;; Aliases are referred to by `@<alias_name>`.
+(defalias
+  ;; tap: backtick (grave), hold: toggle layer-switching layer while held
+  grl (tap-hold 200 200 grv (layer-toggle layers))
+
+  ;; layer-switch changes the base layer.
+  dvk (layer-switch dvorak)
+  qwr (layer-switch qwerty)
+
+  ;; tap for esc, hold for lctl
+  cap (tap-hold 200 200 esc lctl)
+
+  ;; tap for backspace, hold for lshift
+  sft (tap-hold 200 200 bspc rsft)
+
+  ;; tap for middle click, hold for lalt
+  alt (tap-hold 200 200 mmid lalt)
+
+  ;; tap for semicolon, hold for ctrl
+  ; (tap-hold 200 200 ; lctl)
+
+  ;; tap for middle click, hold for altspace layout
+  ;; alt (tap-hold 200 200 mmid (multi lalt (layer-while-held altspace)))
+
+  ;; tap for space, hold for oneshot in touchcursor layout
+  spc (tap-hold 200 200 spc (one-shot 500 (layer-while-held touchcursor)))
+
+  ;; fast keyboard repeat rate emulation
+  ;; (multi f24) fixes fast typing `vh`, `vj`, `vk` and `vl` not entering visual mode on neovim
+  e   (tap-hold 200 200 e     (macro-repeat e     20))
+  d   (tap-hold 200 200 d     (macro-repeat d     20))
+  s   (tap-hold 200 200 s     (macro-repeat s     20))
+  h   (tap-hold 200 200 h     (macro-repeat h     20))
+  j   (tap-hold 200 200 j     (macro-repeat j     20))
+  k   (tap-hold 200 200 k     (macro-repeat k     20))
+  l   (tap-hold 200 200 l     (macro-repeat l     20))
+  🡠   (tap-hold 200 200 left  (macro-repeat left  20))
+  ↓   (tap-hold 200 200 down  (macro-repeat down  20))
+  ↑   (tap-hold 200 200 up    (macro-repeat up    20))
+  🡪   (tap-hold 200 200 right (macro-repeat right 20))
+  bsp (tap-hold 200 200 bspc  (macro-repeat bspc  20))
+
+  ;; open yazi_cd on any shell
+  yaz (macro S-` / . p i x i / b i n / y a z i spc S-4 S-(p w d) spc - - c w d - f i l e spc S-4 S-(h o m e) / . y a z i ; spc c d spc S-' S-4 S-9 c a t spc S-4 S-( h o m e) / . y a z i S-0 S-' ret)
+
+  ;; clear screen on any shell
+  clr (macro c l e a r ret)
+
+  ;; unicode outputs
+  ¿   (unicode ¿)
+
+  ;; unicode outputs
+  ñ   (unicode ñ)
+
+  ;; mouse scrolling <intervale> <distance>
+  m↑ (mwheel-up 50 40)
+  m↓ (mwheel-down 50 40)
+
+  ;; mouse scrolling <intervale> <distance>
+  m🡠 (mwheel-left 50 40)
+  m🡪 (mwheel-right 50 40)
+
+  ;; mouse scrolling <intervale> <distance>
+  M↑ (mwheel-up 25 60)
+  M↓ (mwheel-down 25 60)
+)
+
+;; The `lrld` action stands for "live reload". This will re-parse everything
+;; except for linux-dev, meaning you cannot live reload and switch keyboard
+;; devices.
+;;
+;; The keys 1 and 2 switch the base layer to qwerty and dvorak respectively.
+;;
+;; Apart from the layer switching and live reload, all other keys are the
+;; underscore _ which means "transparent". Transparent means the base layer
+;; behaviour is used when pressing that key.
+(deflayer layers
+  _    @qwr @dvk lrld _    _    _    _    _    _    _    _    _    _
+  _    _    _    _    _    _    _    _    _    _    _    _    _    _
+  _    _    _    _    _    _    _    _    _    _    _    _    _
+  _    _    _    _    _    _    _    _    _    _    _    _    _
+  _    _    _              _              _    _    _
+)
+
+;; RetroNvim uses alt+space to open whichkey but Windows uses alt+space to open minimize/maximize menu
+(defoverrides
+  (lalt spc) (lsft spc)
+  (rsft spc) (ralt spc)
+)