ryuslash/ryuk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add section on installing ryuk on Windows

Browse source
This commit is contained in:
Tom Willemse 2020-05-07 18:32:44 -07:00
parent 797e882b85
commit 64929e58ef
1 changed files with 50 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

85
README.org
View file

@ -47,48 +47,63 @@
* Installation * Installation
** X11 ** Linux
To install and use the X11 keyboard, copy the ~xkb/ryuk~ file to where On Linux there's 2 ways you can install the keyboard layout. [[X11]] for the
XKB looks for these files. In my case this is graphical environment and [[TTY]] for the non-graphical environment.
~/usr/share/X11/xkb/symbols~. Once put in the proper place, next to,
for example, ~us~, set your =XkbVariant= to ~ryuk~. For example, I have in
my ~/etc/X11/xorg.conf.d/10-evdev.conf~ file the following:
#+BEGIN_SRC conf *** X11
# ...
Section "InputClass" To install and use the X11 keyboard, copy the ~xkb/ryuk~ file to where
Identifier "evdev keyboard catchall" XKB looks for these files. In my case this is
MatchIsKeyboard "on" ~/usr/share/X11/xkb/symbols~. Once put in the proper place, next to,
MatchDevicePath "/dev/input/event*" for example, ~us~, set your =XkbVariant= to ~ryuk~. For example, I have in
Driver "evdev" my ~/etc/X11/xorg.conf.d/10-evdev.conf~ file the following:
Option "XkbLayout" "ryuk"
EndSection
# ... #+BEGIN_SRC conf
#+END_SRC # ...
Since your distribution may have Xorg configured differently, you Section "InputClass"
may have to specify it in a different file or a different section, Identifier "evdev keyboard catchall"
but please note that only the line starting with ~Option~ was put MatchIsKeyboard "on"
there by me. MatchDevicePath "/dev/input/event*"
Driver "evdev"
Option "XkbLayout" "ryuk"
EndSection
** TTY # ...
#+END_SRC
To install the TTY keyboard layout you should gzip the Since your distribution may have Xorg configured differently, you
~kbd/ryuk.map~ file, which can be achieved by running ~make~ from the may have to specify it in a different file or a different section,
~kbd~ map, and put the resulting file where the kbd utilities can find but please note that only the line starting with ~Option~ was put
them. In my case this is ~/usr/share/kbd/keymaps/i386/colemak/~, and I there by me.
choose the ~colemak~ directory because the ~ryuk~ files are based
directly off the colemak files.
Once put in the proper place you should specify that the TTY should *** TTY
use your keymap by putting the following in your ~/etc/vconsole.conf~:
#+BEGIN_SRC sh To install the TTY keyboard layout you should gzip the
KEYMAP=ryuk ~kbd/ryuk.map~ file, which can be achieved by running ~make~ from the
#+END_SRC ~kbd~ map, and put the resulting file where the kbd utilities can find
them. In my case this is ~/usr/share/kbd/keymaps/i386/colemak/~, and I
choose the ~colemak~ directory because the ~ryuk~ files are based
directly off the colemak files.
This should work at least on systems that use systemd. I don't know Once put in the proper place you should specify that the TTY should
how other init systems set it. use your keymap by putting the following in your ~/etc/vconsole.conf~:
#+BEGIN_SRC sh
KEYMAP=ryuk
#+END_SRC
This should work at least on systems that use systemd. I don't know
how other init systems set it.
** Windows
On Windows you will need to install the [[https://www.microsoft.com/en-us/download/details.aspx?id=22339][Microsoft Keyboard Layout Creator 1.4]]
to be able to compile the keyboard layout. Once installed open the =ryuk.klc=
file in it and go to Project -> Build DLL and Setup Package. Once this has
finished it'll ask you if you want to open the directory it's built the files
in (which should be =%USERPROFILE%\Documents\ryuk=). Go to that directory and
run =setup.exe=. After the installation is finished you'll have to restart
Windows and then you can start using the keyboard layout.