Merge pull request #160 from rbreaves/documentation

- Updated readme to include Fluent Terminal for Windows

README.md

@@ -10,6 +10,34 @@
 
 Seamless copy and paste with all apps and terminals. Also the only linux remapper that is aware of your cursor/caret status - meaning it avoids shortcut conflicts within an app versus wordwise shortcuts when a text field is in use. (xkeysnail implementation of Kinto has caret checking disabled in master for now.)
 
+## Table of Contents
+
+[What does this do exactly?](#What-does-this-do-exactly)
+
+[What does Kinto require?](#What-does-Kinto-require)
+
+[How to install](#How-to-install)
+
+[Shortcut Creation (Xkeysnail)](#Shortcut-Creation-Xkeysnail)
+
+[Other Notes Related to Install](#Other-Notes-Related-to-Install)
+
+[How to Upgrade/Control Kinto](#How-to-Upgrade-Kinto)
+
+[Troubleshooting](#Troubleshooting)
+
+[Language Support](#Language-Support)
+
+[Related or Useful Resources](#Related-or-Useful-Resources)
+
+[Contributing](#Contributing)
+
+[More information about Kinto](#More-information-about-Kinto)
+
+[License](#License)
+
+[Credits and Contributions](#Credits-and-Contributions)
+
 ## What does this do exactly?
 
 Kinto works for standard Windows, Apple and Chromebook keyboards. The following however describes the dynamic rebinding based on a standard Windows keyboard. (Alt location is Cmd for Apple keyboards)
@@ -20,6 +48,10 @@ Kinto works for standard Windows, Apple and Chromebook keyboards. The following
 
 - Cursor/word-wise shortcut keys have been added to align with macOS keyboard shortcuts.
 
+Does Kinto have to have specific keyamps for individual apps?
+
+I'd say 90+% of the time no, but every OS has their default conventions that sometimes run afoul to macs. For this reason you can easily edit kinto.py or kinto.ahk to support the few shortcut keys Kinto may miss. If you do add additional support please consider forking this project and sharing your new keymaps with the rest of us!
+
 ## What does Kinto require?
 
 - Python (initial install only)
@@ -36,7 +68,7 @@ On most distros you can confirm navigate to your "Language Support" and set "Key
 
 Wayland support is planned, but not ready yet.
 
-## Kinto for Windows 10 Requirements
+### Kinto for Windows 10 Requirements
 
 - WSL Ubuntu edition
 - Powershell - run as Administrator
@@ -191,7 +223,6 @@ systemctl --user disable keyswap
 sudo systemctl disable xkeysnail
 ```
 
-
 ## Learning macOS style hotkeys on Linux
 
 You can use websites like https://www.shortcutfoo.com in Google Chrome while using the terminal style keymap, but Firefox is not compatible due to detecting "cmd" as keycode 224. Chrome detects Win/Super/Cmd as keycode 91 on all OS's.
@@ -315,16 +346,102 @@ sudo systemctl start xkeysnail
 sudo systemctl status xkeysnail
 ```
 
+## Notes about Windows 10
+Sharpkeys was used to create the layout/reg files to swap the Ctrl, Win and Alt keys. Sharpkeys was not required however because the reg keys were extracted. Autohotkey is used to manage keyswaps needed for terminal usage. Autohotkey is also used to add additional mac like keybinds for Sublime text and can be used for other apps as well.
+
+Microsoft is working on a new Powertoy Keyboard Manager that could be used with an easier to use GUI interface, but this approach should be fully sufficient for a mac like experience and autohotkeys appears to be more than capable enough to handle complex rebinding of any or most mac like shortcuts.
+
 ## Language Support
 I'd appreciate any help from people with non-US based keyboards, to help ensure that these keymaps and keyswap methods work in all or most languages.
 
 If you would like to attempt adding additional custom keymaps for other languages then I strongly recommend reading Glen Whitney's post here.
 https://superuser.com/questions/385748/binding-superc-superv-to-copy-and-paste
 
-## Notes about Windows 10
-Sharpkeys was used to create the layout/reg files to swap the Ctrl, Win and Alt keys. Sharpkeys was not required however because the reg keys were extracted. Autohotkey is used to manage keyswaps needed for terminal usage. Autohotkey is also used to add additional mac like keybinds for Sublime text and can be used for other apps as well.
+## Related or Useful Resources
 
-Microsoft is working on a new Powertoy Keyboard Manager that could be used with an easier to use GUI interface, but this approach should be fully sufficient for a mac like experience and autohotkeys appears to be more than capable enough to handle complex rebinding of any or most mac like shortcuts.
+[Xkeysnail](https://github.com/mooz/xkeysnail) by mooz
+
+Yet another keyboard remapping tool for X environment
+
+[fusuma](https://github.com/iberianpig/fusuma) by iberianpig
+
+Multitouch gestures with libinput driver on Linux
+
+[Fluent Terminal - Windows only](https://github.com/felixse/FluentTerminal) by felixse
+
+A Terminal Emulator based on UWP and web technologies.
+
+[PowerToys - Windows only](https://github.com/microsoft/PowerToys) by microsoft
+
+Windows system utilities to maximize productivity
+
+[AutoHotKey - Windows only](https://github.com/AutoHotkey/AutoHotkey) by AutoHotkey
+
+AutoHotkey is a powerful and easy to use scripting language for desktop automation on Windows.
+
+[pykeymacs](https://github.com/zhanghai/pykeymacs) by zhanghai
+
+Emacs style keyboard macros implemented in Python
+
+[Dynamic Wallpapers](https://github.com/adi1090x/dynamic-wallpaper) by adi1090x
+
+Simple bash script to set a Dynamic Wallpaper according to certain conditions.
+
+[macify-linux](https://github.com/Jonchun/macify-linux) by JonChun
+
+Automated setup scripts to transform Linux into macOS. (Uses Kinto for key remaps)
+
+[ibus-typing-booster](https://github.com/mike-fabian/ibus-typing-booster) by mike-fabian
+
+ibus-typing-booster is a completion input method for faster typing
+
+[twemoji color font](https://github.com/eosrei/twemoji-color-font) by eosrei
+
+Twitter Unicode 12 emoji color SVGinOT font for Linux/MacOS/Windows
+
+[iTerm2 Color Schemes](https://github.com/mbadolato/iTerm2-Color-Schemes) by mbadolato
+
+Over 225 terminal color schemes/themes for iTerm/iTerm2. Includes ports to Terminal, Konsole, PuTTY, Xresources, XRDB, Remmina, Termite, XFCE, Tilda, FreeBSD VT, Terminator, Kitty...
+
+[espanso](https://github.com/federico-terzi/espanso) by federico-terzi
+
+Cross-platform Text Expander written in Rust
+
+[GalliumOS](https://github.com/GalliumOS/galliumos-distro) by GalliumOS
+
+Docs, issues, and artwork sources for GalliumOS
+
+[eOS-X](https://github.com/ipproductions/eOS-X) by ipproductions
+
+Dark & Light Theme w/ OSX controls for Elementary OS
+
+[Autorandr](https://github.com/phillipberndt/autorandr) by phillipberndt
+
+Auto-detect the connected display hardware and load the appropriate X11 setup using xrandr
+
+[Barrier](https://github.com/debauchee/barrier) by debauchee
+
+Open-source KVM software
+
+[Synergy Free Binaries](https://github.com/amankhoza/synergy-binaries) by amankhoza
+
+The latest freely available Synergy binaries
+
+[Synergy Official](https://symless.com/) by Symless
+
+Latest Official Synergy
+
+[Karabiner-Elements](https://github.com/pqrs-org/Karabiner-Elements) by pqrs-org
+
+Karabiner-Elements is a powerful utility for keyboard customization on macOS Sierra (10.12) or later. 
+
+[mbpfan](https://github.com/linux-on-mac/mbpfan) by linux-on-mac
+
+A simple daemon to control fan speed on all MacBook/MacBook Pros (probably all Apple computers) for Linux Kernel 3 and newer
+
+[vala-panel](https://github.com/rilian-la-te/vala-panel) by rilian-la-te
+
+Vala rewrite of SimplePanel - GitHub mirror (Global Menu for XFCE)
 
 ## Contributing
 

setup.py

@@ -6,6 +6,44 @@ from prekinto import *
 
 homedir = os.path.expanduser("~")
 
+def windows_setup():
+	keymaps = ["Apple keyboard standard", "Apple keyboard w/ Caps lock as Esc", "Windows keyboard standard", "Windows keyboard w/ Caps lock as Esc","Uninstall"]
+	for index, item in enumerate(keymaps):
+		print("    %i. %s" % (index+1, item.capitalize()))
+	default = 0
+	while not int(default) in range(1,len(keymaps)+1):
+		default = int(input("\nPlease enter your desired keymap (1 - " + str(len(keymaps)) + ") : "))
+	print("")
+	path= cmdline('echo %cd%')[:-1]
+	if default == 1:
+		os.system("regedit " + path + "\\windows\\macbook_winctrl_swap.reg")
+	elif default == 2:
+		os.system("regedit " + path + "\\windows\\macbook_winctrl_capsesc_swap.reg")
+	elif default == 3:
+		os.system("regedit " + path + "\\windows\\standard_ctrlalt_swap.reg")
+	elif default == 4:
+		os.system("regedit " + path + "\\windows\\standard_ctrlalt_capsesc_swap.reg")
+	elif default == 5:
+		os.system("regedit " + path + "\\windows\\remove_keyswap.reg")
+	stvscode = yn_choice(bcolors.CYELLOW2 + "Would you like to use Sublime Text 3 keymaps in VS Code?\n" + bcolors.ENDC)
+	if default > 0 and default < 5:
+		print("Will now install chocolatey and autohotkey with elevated privileges...")
+		print("This install will fail if you are not running with elevated privileges")
+		os.system('powershell -executionpolicy bypass ".\\windows\\autohotkey.ps1"')
+		os.system('refreshenv')
+		print("\nWill now install Ubuntu Terminal Theme as default...")
+		os.system("regedit " + path + "\\windows\\theme_ubuntu.reg")
+		print("Copying autohotkey combinations for Terminals & Editors...")
+		os.system("copy /Y " + path + "\\windows\\kinto.ahk " + path + "\\windows\\kinto-new.ahk")
+		if(stvscode):
+			os.system('perl -pi -e "s/(; )(.*)(; ST2CODE)/$2$3/g" ./windows/kinto-new.ahk')
+		os.system("copy /Y " + path + "\\windows\\kinto-new.ahk \"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\StartUp\\kinto.ahk\"")
+		os.system("del /f .\\windows\\kinto-new.ahk")
+		print("\nPlease log off and back on for changes to take full effect.")
+		print("If using WSL then please remember to right click on title bar -> Properties -> Edit Options -> Use Ctrl+Shift+C/V as Copy/Paste and enable it.")
+	else:
+		os.system("del \"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\StartUp\\kinto.ahk\"")
+
 def cmdline(command):
     process = Popen(
         args=command,
@@ -14,6 +52,19 @@ def cmdline(command):
         shell=True
     )
     return process.communicate()[0]
+
+# check_x11 = cmdline("env | grep -i x11").strip()
+check_x11 = cmdline("(env | grep -i x11 || loginctl show-session \"$XDG_SESSION_ID\" -p Type) | awk -F= '{print $2}'").strip()
+
+if len(check_x11) == 0:
+	if os.name != 'nt':
+		print("You are not using x11, please logout and back in using x11/Xorg")
+		sys.exit()
+	else:
+		print("\nYou are detected as running Windows.")
+		windows_setup()
+		sys.exit()
+
 distro = cmdline("awk -F= '$1==\"NAME\" { print $2 ;}' /etc/os-release").replace('"','').strip().split(" ")[0]
 dename = cmdline("./system-config/dename.sh").replace('"','').strip().split(" ")[0].lower()
 
@@ -178,38 +229,6 @@ def setShortcuts():
 			cmdline('sleep 1 && rm -f ./tempkb.conf;rm -f ./tempmt.conf')
 			# cmdline('dconf update')
 
-def windows_setup():
-	keymaps = ["Apple keyboard standard", "Apple keyboard w/ Caps lock as Esc", "Windows keyboard standard", "Windows keyboard w/ Caps lock as Esc","Uninstall"]
-	for index, item in enumerate(keymaps):
-		print("    %i. %s" % (index+1, item.capitalize()))
-	default = 0
-	while not int(default) in range(1,len(keymaps)+1):
-		default = int(input("\nPlease enter your desired keymap (1 - " + str(len(keymaps)) + ") : "))
-	print("")
-	path= cmdline('echo %cd%')[:-1]
-	if default == 1:
-		os.system("regedit " + path + "\\windows\\macbook_winctrl_swap.reg")
-	elif default == 2:
-		os.system("regedit " + path + "\\windows\\macbook_winctrl_capsesc_swap.reg")
-	elif default == 3:
-		os.system("regedit " + path + "\\windows\\standard_ctrlalt_swap.reg")
-	elif default == 4:
-		os.system("regedit " + path + "\\windows\\standard_ctrlalt_capsesc_swap.reg")
-	elif default == 5:
-		os.system("regedit " + path + "\\windows\\remove_keyswap.reg")
-	if default > 0 and default < 5:
-		print("Will now install chocolatey and autohotkey with elevated privileges...")
-		print("This install will fail if you are not running with elevated privileges")
-		os.system('powershell -executionpolicy bypass ".\\windows\\autohotkey.ps1"')
-		print("\nWill now install Ubuntu Terminal Theme as default...")
-		os.system("regedit " + path + "\\windows\\theme_ubuntu.reg")
-		print("Copying autohotkey combinations for Terminals & Editors...")
-		os.system("copy /Y " + path + "\\windows\\kinto.ahk \"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\StartUp\\kinto.ahk\"")
-		print("\nPlease log off and back on for changes to take full effect.")
-		print("If using WSL then please remember to right click on title bar -> Properties -> Edit Options -> Use Ctrl+Shift+C/V as Copy/Paste and enable it.")
-	else:
-		os.system("del \"C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\StartUp\\kinto.ahk\"")
-
 def Uninstall():
 	print("You selected to Uninstall Kinto.\n")
 	restore = yn_choice("\nYour DE is " + dename + ".\n\nY: Restore hotkeys from backup\nN: Reset OS/DE hotkeys\nWhich option would you prefer?")
@@ -218,7 +237,7 @@ def Uninstall():
 		if dename == "gnome":
 			print("Restoring DE hotkeys...")
 			wmkeys = cmdline('ls | grep -m1 "keybinding"')
-			mutterkeys = cmdline('ls | grep -m1 "mutter"')
+			mutterkeys = cmdline('ls | grep -m1 "mutter_"')
 			if len(wmkeys) > 0:
 				print('dconf load /org/gnome/desktop/wm/keybindings/ < ' + wmkeys)
 				cmdline('dconf load /org/gnome/desktop/wm/keybindings/ < ' + wmkeys)
@@ -270,18 +289,6 @@ def Uninstall():
 		if dename == "kde" or dename == "xfce":
 			print("Please log off and back on for your original DE hotkeys to take effect.")
 
-# check_x11 = cmdline("env | grep -i x11").strip()
-check_x11 = cmdline("(env | grep -i x11 || loginctl show-session \"$XDG_SESSION_ID\" -p Type) | awk -F= '{print $2}'").strip()
-
-if len(check_x11) == 0:
-	if os.name != 'nt':
-		print("You are not using x11, please logout and back in using x11/Xorg")
-		sys.exit()
-	else:
-		print("You are detected as running Windows.")
-		windows_setup()
-		sys.exit()
-
 check_xbind = cmdline("which xbindkeys 2>/dev/null").strip()
 check_xdotool = cmdline("which xdotool 2>/dev/null").strip()
 check_ibus = cmdline("which ibus-setup 2>/dev/null").strip()

windows/autohotkey.ps1

@@ -10,3 +10,6 @@ else{
 if(-not(test-path "C:\Program Files\AutoHotkey\AutoHotkey.exe")){
 	choco install autohotkey.install
 }
+if(-not(test-path "C:\Strawberry\")){
+	choco install strawberryperl
+}

windows/kinto.ahk

@@ -1,9 +1,13 @@
+SetTitleMatchMode, 2
+
 GroupAdd, terminals, ahk_exe ubuntu.exe
 GroupAdd, terminals, ahk_exe ConEmu.exe
 GroupAdd, terminals, ahk_exe ConEmu64.exe
 GroupAdd, terminals, ahk_exe powershell.exe
 GroupAdd, terminals, ahk_exe WindowsTerminal.exe
 GroupAdd, terminals, ahk_exe Hyper.exe
+GroupAdd, terminals, ahk_exe Cmd.exe
+GroupAdd, terminals, Fluent Terminal ahk_class ApplicationFrameWindow
 
 GroupAdd, posix, ahk_exe ubuntu.exe
 GroupAdd, posix, ahk_exe ConEmu.exe
@@ -15,6 +19,11 @@ GroupAdd, ConEmu, ahk_exe ConEmu64.exe
 GroupAdd, ConEmu, ahk_exe WindowsTerminal.exe
 
 GroupAdd, editors, ahk_exe sublime_text.exe
+GroupAdd, editors, ahk_exe VSCodium.exe
+GroupAdd, editors, ahk_exe Code.exe
+
+GroupAdd, vscode, ahk_exe VSCodium.exe
+GroupAdd, vscode, ahk_exe Code.exe
 
 ; Cmd+Space Alternative
 LWin & vk07::return
@@ -34,6 +43,12 @@ RWin & Tab::Send ^{Tab}
 ; Close Apps
 ^q::Send !{F4}
 
+; Full Screenshot
+^+3::Send {PrintScreen}
+
+; Region Screenshot
+^+4::Send #+{S}
+
 ; wordwise support
 $^Left::Send {Home}
 $^+Left::Send +{Home}
@@ -50,7 +65,17 @@ $^+Right::Send +{End}
 !Right::Send ^{Right}
 !+Right::Send ^+{Right}
 
-#IfWinActive ahk_group editors
+; ; Sublime Text Remaps for VS Code                           ; ST2CODE
+; #IfWinActive ahk_group vscode                               ; ST2CODE
+; 	; Remap Ctrl+Shift to behave like macOS Sublimetext ; ST2CODE
+; 	; Will extend cursor to multiple lines              ; ST2CODE
+; 	#+Up::send ^!{Up}                                   ; ST2CODE
+; 	#+Down::send ^!{Down}                               ; ST2CODE
+; 	; Remap Ctrl+Cmd+G to select all matches            ; ST2CODE
+; 	#^g::send ^+{L}                                     ; ST2CODE
+; #If                                                         ; ST2CODE
+
+#IfWinActive ahk_exe sublime_text.exe
 	; Remap Ctrl+Shift to behave like macOS Sublimetext
 	; Will extend cursor to multiple lines
 	#+Up::send {shift up}^!{Up}
@@ -60,6 +85,11 @@ $^+Right::Send +{End}
 	#^g::send !{F3}
 #If
 
+; Not sure why this fix is needed
+#IfWinActive ahk_exe Firefox.exe
+	^v::send ^v
+#If
+
 #IfWinActive ahk_group terminals
 	; Copy
 	^c::Send {LCtrl down}{LShift down}c{LCtrl Up}{LShift Up}

xkeysnail_service.sh

@@ -44,7 +44,7 @@ function uninstall {
 		if [ "$dename" == "gnome" ]; then
 			echo "Restoring DE hotkeys..."
 			wmkeys=$(ls | grep -m1 "keybinding")
-			mutterkeys=$(ls | grep -m1 "mutter")
+			mutterkeys=$(ls | grep -m1 "mutter_")
 			if [[ ${#wmkeys} > 0 ]]; then
 				echo "dconf load /org/gnome/desktop/wm/keybindings/ < $wmkeys"
 				dconf load /org/gnome/desktop/wm/keybindings/ < "$wmkeys"