Found and fixed a bug in non ratpoison mode. It was creating a shit ton of conflicting keybinds.

README.md

@@ -6,6 +6,7 @@ Accessibility setup script for the i3 window manager.
 Released under the terms of the WTFPL License: http://www.wtfpl.net
 This is a Stormux project: https://stormux.org
 
+
 ## Why the name?
 
 An uppercase I looks like a 1, 3 from i3, and 8 because the song [We Are 138](https://www.youtube.com/watch?v=-n2Mkdw4q44) rocks!
@@ -17,7 +18,6 @@ An uppercase I looks like a 1, 3 from i3, and 8 because the song [We Are 138](ht
 - acpi: [optional] for battery status. It will still work even without this package, but uses it if it is installed.
 - dex: [optional] Alternative method for auto starting applications.
 - clipster: clipboard manager
-- grun: Run application dialog
 - jq: for getting the current workspace
 - libnotify: For sending notifications
 - notification-daemon: To handle notifications
@@ -33,6 +33,7 @@ An uppercase I looks like a 1, 3 from i3, and 8 because the song [We Are 138](ht
 
 I38 will try to detect your browser, file manager, and web browser and present you with a list of options to bind to their launch keys. It will also create bindings for pidgin and mumble if they are installed. To use the bindings, press your ratpoison mode key which is set when you run the i38.sh script. next, press the binding for the application you want, w for web browser, e for text editor, f for file manager, m for mumble, etc. To learn all the bindings, find and read the mode ratpoison section of ~/.config/i3/config.
 
+
 ## Usage:
 
 - With no arguments, create the i3 configuration.
@@ -40,3 +41,17 @@ I38 will try to detect your browser, file manager, and web browser and present y
 - -u: Copy over the latest version of scripts.
 - -x: Generate ~/.xinitrc and ~/.xprofile.
 - -X: Generate ~/.xprofile only.
+
+
+## Ratpoison Mode
+
+I38 is an adaptation of the old Strychnine project which was based on the Ratpoison window manager. Ratpoison is a screen like window manager, and the important concept from that, which applies to I38, is adding keyboard shortcuts without conflicting application shortcuts. This is done with an "escape key".
+
+When creating I38, I really wanted to port that functionality over, because it is very powerful and allows for lots and lots of shortcuts while minimizing collisions between shortcuts. So, for example, if you have chosen brave as your web browser, and selected alt+escape as your ratpoison mode key, you can quickly launch brave by pressing alt+escape followed by the letter w.
+
+
+## I38 Help
+
+To get help for I38, you can press the top level keybinding alt+shift+F1. It is also available by pressing the ratpoison mode key followed by question mark. A limitation of yad, which is used to display the help text means that the cursor starts at the bottom of the text. Please press control+home to jump to the top. You can navigate with the arrow keys, and use control+f to find text within the document.
+
+The help text is a modified version of the configuration file itself that is intended to be easier to read. I have tried to add in comments that should also serve to make things more clear.

i38.sh

@@ -155,7 +155,7 @@ while getopts "${args}" i ; do
 done
 
 # Configuration questions
-export i3Mode=$(yesno "Would you like to use ratpoison mode? This behaves more like strychnine, with an escape key followed by keybindings.")
+export i3Mode=$(yesno "Would you like to use ratpoison mode? This behaves more like strychnine, with an escape key followed by keybindings. (Recommended)")
 # Prevent setting ratpoison mode key to the same as default mode key
 while [[ "$escapeKey" == "$mod" ]]; do
     if [[ $i3Mode -eq 0 ]]; then
@@ -191,7 +191,7 @@ fi
 webBrowser="$(command -v $webBrowser)"
 # Text editor
 unset programList
-for i in geany gedit kate kwrite l3afpad leafpad libreoffice mousepad pluma ; do
+for i in emacs geany gedit kate kwrite l3afpad leafpad libreoffice mousepad pluma ; do
 if hash ${i/#-/} &> /dev/null ; then
 if [ -n "$programList" ]; then
 programList="$programList $i"
@@ -273,6 +273,9 @@ focus_follows_mouse no
 # is used in the bar {} block below.
 font pango:monospace 8
 
+# I38 help
+bindsym \$mod+Shift+F1 exec ${i3Path}/scripts/i38-help.sh
+
 # Run dialog
 bindsym \$mod+F2 exec ${i3Path}/scripts/run_dialog.sh
 
@@ -371,6 +374,8 @@ if [[ -n "${escapeKey}" ]]; then
     cat << EOF >> ${i3Path}/config
 bindsym $escapeKey mode "ratpoison"
 mode "ratpoison" {
+# I38 help bound to ?
+bindsym Shift+slash exec ${i3Path}/scripts/i38-help.sh, mode "default"
 # Terminal emulator bound to c
 bindsym c exec i3-sensible-terminal, mode "default"
 # Text editor bound to e
@@ -379,17 +384,23 @@ bindsym e exec $textEditor, mode "default"
 bindsym f exec $fileBrowser, mode "default"
 # Web browser bound to w
 bindsym w exec $webBrowser, mode "default"
+# Kill window bound to k
+bindsym k kill, mode "default"
 $(if command -v mumble &> /dev/null ; then
+    echo "# Mumble bound to m"
     echo "bindsym m exec $(command -v mumble), mode \"default\""
 fi)
 $(if command -v ocrdesktop &> /dev/null ; then
+    echo "# OCR desktop bound to print screen alternative \$mod+r"
     echo "bindsym Print exec $(command -v ocrdesktop) -b, mode \"default\""
     echo "bindsym \$mod+r exec $(command -v ocrdesktop) -b, mode \"default\""
 fi)
 $(if command -v pidgin &> /dev/null ; then
+    echo "# p bound to pidgin"
     echo "bindsym p exec $(command -v pidgin), mode \"default\""
 fi)
 $(if command -v transfersh &> /dev/null ; then
+    echo "# t bound to share file with transfer.sh"
     echo 'bindsym t exec bash -c '"'"'fileName="$(yad --title "I38 Upload File" --file)" && url="$(transfersh "${fileName}" | tee >(yad --title "I38 - Uploading ${fileName##*/} ..." --progress --pulsate --auto-close))" && echo "${url#*saved at: }" | tee >(yad --title "I38 - Upload URL" --show-cursor --show-uri --button yad-close --sticky --text-info) >(xclip -selection clipboard)'"', mode \"default\""
 fi)
 
@@ -422,67 +433,15 @@ bindsym Control+Shift+semicolon exec bash -c '$i3msg -t run_command restart && s
 bindsym Shift+exclam exec ${i3Path}/scripts/run_dialog.sh, mode "default"
 # exit i3 (logs you out of your X session)
 bindsym Control+q exec bash -c 'yad --image "dialog-question" --title "I38" --button=yes:0 --button=no:1 --text "You pressed the exit shortcut. Do you really want to exit i3? This will end your X session." && $i3msg -t run_command exit'
+# Exit ratpoison mode without any action escape or Control+g
 bindsym Escape mode "default"
+bindsym Control+g mode "default"
 }
 
 
 EOF
 fi
 
-# For those who do not want ratpoison mode.
-if [[ -z "${escapeKey}" ]]; then
-    cat << EOF >> ${i3Path}/config
-# Text editor bound to $mod+e
-bindsym \$mod+e exec $textEditor
-# File browser bound to $mod+f
-bindsym \$mod+f exec $fileBrowser
-# Web browser bound to $mod+w
-bindsym \$mod+w exec $webBrowser
-
-$(if command -v mumble &> /dev/null ; then
-    echo "bindsym \$mod+m exec $(command -v mumble)"
-fi)
-$(if command -v ocrdesktop &> /dev/null ; then
-    echo "bindsym Print exec $(command -v ocrdesktop)' -b"
-fi)
-$(if command -v pidgin &> /dev/null ; then
-    echo "bindsym \$mod+p exec $(command -v pidgin)"
-fi)
-$(if command -v transfersh &> /dev/null ; then
-    echo 'bindsym \$mod+t exec bash -c '"'"'fileName="$(yad --title "I38 Upload File" --file)" && url="$(transfersh "${fileName}" | tee >(yad --title "I38 - Uploading ${fileName##*/} ..." --progress --pulsate --auto-close))" && echo "${url#*saved at: }" | tee >(yad --title "I38 - Upload URL" --show-cursor --show-uri --button yad-close --sticky --text-info) >(xclip -selection clipboard)'"'"
-fi)
-#Keyboard based volume controls using pulseaudio
-bindsym \$mod+Shift+0 exec --no-startup-id pactl set-sink-volume @DEFAULT_SINK@ +${volumeJump}% & play -qnG synth 0.03 sin 440
-bindsym \$mod+Shift+9 exec --no-startup-id pactl set-sink-volume @DEFAULT_SINK@ -${volumeJump}% & play -qnG synth 0.03 sin 440
-# Music player controls
-# Requires playerctl.
-bindsym \$mod+Shift+equal exec --no-startup-id ${i3Path}/scripts/music_controler.sh incvol $volumeJump
-bindsym \$mod+Shift+minus exec --no-startup-id ${i3Path}/scripts/music_controler.sh decvol $volumeJump
-bindsym \$mod+Shift+z exec --no-startup-id play -qV0 "| sox -np synth 0.03 sin 2000 pad 0 .02" "| sox -np synth 0.03 sin 2000" norm 1.0 vol 0.4 & ${i3Path}/scripts/music_controler.sh prev
-bindsym \$mod+Shift+c exec --no-startup-id play -qV0 "| sox -np synth 0.03 sin 2000 pad 0 .02" "| sox -np synth 0.03 sin 2000" norm 1.0 vol 0.4 & ${i3Path}/scripts/music_controler.sh pause
-bindsym \$mod+Shift+x exec --no-startup-id play -qV0 "| sox -np synth 0.03 sin 2000 pad 0 .02" "| sox -np synth 0.03 sin 2000" norm 1.0 vol 0.4 & ${i3Path}/scripts/music_controler.sh play
-bindsym \$mod+Shift+v exec --no-startup-id play -qV0 "| sox -np synth 0.03 sin 2000 pad 0 .02" "| sox -np synth 0.03 sin 2000" norm 1.0 vol 0.4 & ${i3Path}/scripts/music_controler.sh stop
-bindsym \$mod+Shift+b exec --no-startup-id play -qV0 "| sox -np synth 0.03 sin 2000 pad 0 .02" "| sox -np synth 0.03 sin 2000" norm 1.0 vol 0.4 & ${i3Path}/scripts/music_controler.sh next
-bindsym \$mod+Shift+u exec --no-startup-id play -qV0 "| sox -np synth 0.03 sin 2000 pad 0 .02" "| sox -np synth 0.03 sin 2000" norm 1.0 vol 0.4 & ${i3Path}/scripts/music_controler.sh info
-#Check battery status
-bindsym \$mod+b exec --no-startup-id ${i3Path}/scripts/battery_status.sh
-#Check controller battery status
-bindsym \$mod+g exec ${i3Path}/scripts/game_controler.sh -s
-# Get a list of windows in the current workspace
-bindsym \$mod+apostrophe exec --no-startup-id ${i3Path}/scripts/window_list.sh
-# Restart orca
-bindsym \$mod+Shift+o exec $(command -v orca) --replace
-# reload the configuration file
-bindsym \$mod+Control+semicolon exec bash -c '$i3msg -t run_command reload && spd-say -P important -Cw "I38 Configuration reloaded."'
-# restart i3 inplace (preserves your layout/session, can be used to upgrade i3)
-bindsym \$mod+Control+Shift+semicolon exec bash -c '$i3msg -t run_command restart && spd-say -P important -Cw "I3 restarted."'
-# exit i3 (logs you out of your X session)
-bindsym \$mod+Control+q exec bash -c 'yad --image "dialog-question" --title "I38" --button=yes:0 --button=no:1 --text "You pressed the exit shortcut. Do you really want to exit i3? This will end your X session." && $i3msg -t run_command exit'
-
-
-
-EOF
-fi
 
 cat << EOF >> ${i3Path}/config
 # Auto start section

scripts/i38-help.sh

@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+
+
+configPath="$(readlink -f $0)"
+configPath="${configPath%/*/*}"
+
+if [[ -f "${configPath}/config" ]]; then
+    mod="$(grep 'set $mod ' "${configPath}/config" | cut -d ' ' -f3)"
+    mod="${mod//Mod1/Alt}"
+    mod="${mod//Mod4/Super}"
+    mapfile helpText < <(sed -e '/set \($mod\|mod\)/d' \
+        -e '/set $ws/d' \
+        -e 's/bindsym/Key:/g' \
+        -e 's/Mod1/Alt/g' \
+        -e 's/, mode "default"//g' \
+        -e 's/--no-startup-id //g' \
+        -e 's/$ws\([0-9]\)/\1/g' \
+        -e 's/play \(.*\)& //g' \
+        -e "s/\$mod/$mod/g" "${configPath}/config")
+else
+    exit 1
+fi
+for i in "${!helpText[@]}" ; do
+    helpText[$i]="${helpText[$i]//${configPath}\/scripts\//}"
+    helpText[$i]="${helpText[$i]/.sh/}"
+    helpText[$i]="${helpText[$i]/, exec announce*/$'\n'}"
+    helpText[$i]="${helpText[$i]/, exec spd-say*/$'\n'}"
+done
+helpText+=("End of text. Please press Control+Home to jump to the beginning of this document.")
+echo "${helpText[@]}" | yad --text-info --show-cursor --title "I38 help" --button "Close:0" --listen
+
+exit 0

scripts/run_dialog.sh

@@ -21,7 +21,7 @@ fi
 if [[ -z "$txt" ]]; then
     exit 0
 fi
-if [[ "$txt" =~ ^ftp://|http://|https://|www.* ]]; then
+if [[ "$txt" =~ ^ftp://|^http://|^https://|^www.* ]]; then
     xdg-open $txt
     write_history
     exit 0