2022-11-22 17:53:53 -05:00
#!/bin/bash
# Configures the i3 window manager to make it screen reader accessible
2022-11-23 20:25:29 -05:00
# Written by Storm Dragon, Jeremiah, and contributers.
2022-11-22 17:53:53 -05:00
# Released under the terms of the WTFPL http://www.wtfpl.net
i3Path = " ${ XDG_CONFIG_HOME :- $HOME /.config } /i3 "
# Dialog accessibility
export DIALOGOPTS = '--no-lines --visit-items'
# Check to make sure minimum requirements are installed.
2022-11-22 21:52:20 -05:00
for i in dialog grun sgtk-menu yad ; do
2022-11-22 17:53:53 -05:00
if ! command -v " $i " & > /dev/null ; then
missing += ( " $i " )
fi
done
if [ [ -n " ${ missing } " ] ] ; then
echo "Please install the following packages and run this script again:"
echo " ${ missing [*] } "
exit 1
fi
menulist( ) {
# Args: List of items for menu.
# returns: selected tag
local menuText = " $1 "
shift
local menuList
for i in " ${ @ } " ; do
menuList += ( " $i " " $i " )
done
2022-11-23 00:31:30 -05:00
dialog --title "I38" \
2022-11-22 17:53:53 -05:00
--backtitle "Use the arrow keys to find the option you want, and enter to select it." \
--clear \
--no-tags \
--menu " $menuText " 0 0 0 ${ menuList [@] } --stdout
return $?
}
# rangebox
# $1 text to show
# $2 minimum value
# $3 maximum value
# $4 Default value
rangebox( ) {
2022-11-23 00:31:30 -05:00
dialog --title "I38" \
2022-11-22 17:53:53 -05:00
--backtitle "Use the arrow keys to select a number, then press enter." \
--rangebox " $1 " -1 -1 $2 $3 $4 --stdout
}
yesno( ) {
# Returns: Yes 0 or No 1
# Args: Question to user.
2022-11-23 00:31:30 -05:00
dialog --clear --title "I38" --yesno " $* " -1 -1 --stdout && return 0
2022-11-22 17:53:53 -05:00
}
2022-11-22 21:11:29 -05:00
help( ) {
echo " ${ 0 ##*/ } "
echo "Released under the terms of the WTFPL License: http://www.wtfpl.net"
echo -e "This is a Stormux project: https://stormux.org\n"
echo -e "Usage:\n"
echo "With no arguments, create the i3 configuration."
for i in " ${ !command[@] } " ; do
echo " - ${ i / : / <parameter> } : ${ command [ ${ i } ] } "
done | sort
exit 0
}
2022-11-22 17:53:53 -05:00
write_xinitrc( )
{
if [ [ -f " $HOME /.xinitrc " ] ] ; then
continue = " $( yesno " This will overwrite your existing $HOME /.xinitrc file. Do you want to continue? " ) "
if [ " $continue " = "no" ] ; then
exit 0
fi
fi
cat << 'EOF' > ~/.xinitrc
#!/bin/sh
#
# ~/.xinitrc
#
# Executed by startx (run your window manager from here)
dbus-launch
[ [ -f ~/.Xresources ] ] && xrdb -merge -I$HOME ~/.Xresources
if [ -d /etc/X11/xinit/xinitrc.d ] ; then
for f in /etc/X11/xinit/xinitrc.d/*; do
[ -x " $f " ] && . " $f "
done
unset f
fi
[ -f /etc/xprofile ] && . /etc/xprofile
[ -f ~/.xprofile ] && . ~/.xprofile
export DBUS_SESSION_BUS_PID
export DBUS_SESSION_BUS_ADDRESS
exec i3
EOF
if [ [ -f " $HOME /.xprofile " ] ] ; then
continue = " $( yesno " Would you like to add accessibility variables to your $HOME /.xprofile? Without these, accessibility will be limited or may not work at all. Do you want to continue? " ) "
if [ " $continue " = "no" ] ; then
exit 0
fi
fi
cat << 'EOF' > ~/.xprofile
# Accessibility variables
export ACCESSIBILITY_ENABLED = 1
export GTK_MODULES = gail:atk-bridge
export GNOME_ACCESSIBILITY = 1
export QT_ACCESSIBILITY = 1
export QT_LINUX_ACCESSIBILITY_ALWAYS_ON = 1
EOF
}
2022-11-23 17:41:13 -05:00
update_scripts( ) {
cp -rv scripts/ " ${ i3Path } / " | dialog --backtitle "I38" --progressbox "Updating scripts..." -1 -1
exit 0
}
2022-11-22 17:53:53 -05:00
2022-11-22 21:11:29 -05:00
# Array of command line arguments
declare -A command = (
[ h] = "This help screen."
2022-11-23 17:41:13 -05:00
[ u] = "Copy over the latest version of scripts."
2022-11-22 21:17:35 -05:00
[ x] = "Generate ~/.xinitrc and ~/.xprofile."
2022-11-22 21:11:29 -05:00
)
# Convert the keys of the associative array to a format usable by getopts
args = " ${ !command[*] } "
args = " ${ args //[[ : space : ]]/ } "
while getopts " ${ args } " i ; do
case " $i " in
h) help; ;
2022-11-23 17:41:13 -05:00
u) update_scripts; ;
2022-11-22 21:17:35 -05:00
x) write_xinitrc
2022-11-22 21:11:29 -05:00
esac
done
2022-11-23 01:19:31 -05:00
# Configuration questions
escapeKey = " $( menulist "Ratpoison mode key:" Control+t Control+z -Control+Escape Alt+Escape Control+Space Super_L Super_R) "
2022-11-23 16:00:25 -05:00
escapeKey = " ${ escapeKey //Alt/Mod1 } "
2022-11-23 20:05:57 -05:00
# Web browser
2022-11-23 17:14:36 -05:00
unset programList
for i in brave chromium epiphany firefox google-chrome-stable midori seamonkey ; do
if command -v ${ i /#-/ } & > /dev/null ; then
if [ -n " $programList " ] ; then
programList = " $programList $i "
else
programList = " $i "
fi
fi
done
if [ " $programList " != " ${ programList // / } " ] ; then
webBrowser = " $( menulist "Web browser:" $programList ) "
else
webBrowser = " ${ programList /#-/ } "
fi
2022-11-23 21:38:35 -05:00
webBrowser = " $( command -v $webBrowser ) "
2022-11-23 20:05:57 -05:00
# Text editor
unset programList
for i in geany gedit kate kwrite l3afpad leafpad libreoffice mousepad pluma ; do
if hash ${ i /#-/ } & > /dev/null ; then
if [ -n " $programList " ] ; then
programList = " $programList $i "
else
programList = " $i "
fi
fi
done
if [ " $programList " != " ${ programList // / } " ] ; then
textEditor = " $( menulist "Text editor:" $programList ) "
else
textEditor = " ${ programList /#-/ } "
fi
textEditor = " $( command -v $textEditor ) "
# File browser
# Configure file browser
unset programList
for i in caja nemo nautilus pcmanfm pcmanfm-qt thunar ; do
if hash ${ i /#-/ } & > /dev/null ; then
if [ -n " $programList " ] ; then
programList = " $programList $i "
else
programList = " $i "
fi
fi
done
if [ " $programList " != " ${ programList // / } " ] ; then
fileBrowser = " $( menulist "File browser:" $programList ) "
else
fileBrowser = " ${ programList /#-/ } "
fi
fileBrowser = " $( command -v $fileBrowser ) "
# Auto start with dex
2022-11-23 00:31:30 -05:00
dex = 1
if command -v dex & > /dev/null ; then
export dex = $( yesno "Would you like to autostart applications with dex?" )
fi
2022-11-23 17:53:07 -05:00
if [ [ $dex -eq 0 ] ] ; then
dex -t " ${ XDG_CONFIG_HOME :- ${ HOME } /.config } /autostart " -c $( command -v orca)
fi
2022-11-23 01:19:31 -05:00
brlapi = 1
2022-11-23 20:27:41 -05:00
brlapi = $( yesno "Do you want to use a braille display with Orca?" )
2022-11-23 16:15:25 -05:00
sounds = 1
sounds = $( yesno "Do you want window event sounds?" )
2022-11-23 00:31:30 -05:00
2022-11-22 21:52:20 -05:00
if [ [ -d " ${ i3Path } " ] ] ; then
yesno " This will replace your existing configuration at ${ i3Path } . Do you want to continue? " || exit 0
2022-11-22 17:53:53 -05:00
fi
2022-11-22 21:52:20 -05:00
# Create the i3 configuration directory.
mkdir -p " ${ i3Path } "
# Move scripts into place
2022-11-23 16:18:26 -05:00
cp -rv scripts/ " ${ i3Path } / " | dialog --backtitle "I38" --progressbox "Moving scripts into place and writing config..." -1 -1
2022-11-22 21:52:20 -05:00
cat << EOF > ${ i3Path } /config
# Generated by I38 (${0##*/}) https://github.com/stormdragon2976/I38
# $(date '+%A, %B %d, %Y at %I:%M%p')
# i3 config file (v4)
#
# Please see https://i3wm.org/docs/userguide.html for a complete reference!
#
# This config file uses keycodes (bindsym) and was written for the QWERTY
# layout.
#
# To get a config file with the same key positions, but for your current
# layout, use the i3-config-wizard
#
2022-11-23 17:41:13 -05:00
workspace_layout tabbed
2022-11-22 21:52:20 -05:00
# Font for window titles. Will also be used by the bar unless a different font
# is used in the bar {} block below.
font pango:monospace 8
# Run dialog
bindsym Mod1+F2 exec grun
# Clipboard manager
bindsym Mod1+Control+c exec clipster -s
# gtk bar
bindsym Mod1+Control+Delete exec --no-startup-id sgtk-bar
# Use pactl to adjust volume in PulseAudio.
2022-11-23 20:05:57 -05:00
bindsym Mod1+XF86AudioRaiseVolume exec --no-startup-id pactl set-sink-volume @DEFAULT_SINK@ +10%
bindsym Mod1+XF86AudioLowerVolume exec --no-startup-id pactl set-sink-volume @DEFAULT_SINK@ -10%
2022-11-22 21:52:20 -05:00
2022-11-23 22:09:24 -05:00
# Music player controls
# Requires playerctl.
bindsym XF86AudioRaiseVolume exec --no-startup-id ${ i3Path } /scripts/music_controler.sh incvol
bindsym XF86AudioLowerVolume exec --no-startup-id ${ i3Path } /scripts/music_controler.sh decvol
bindsym XF86AudioPrev exec --no-startup-id ${ i3Path } /scripts/music_controler.sh prev
bindsym XF86AudioMute exec --no-startup-id ${ i3Path } /scripts/music_controler.sh pause
bindsym XF86AudioPlay exec --no-startup-id ${ i3Path } /scripts/music_controler.sh play
bindsym XF86AudioStop exec --no-startup-id ${ i3Path } /scripts/music_controler.sh Stop
bindsym XF86AudioNext exec --no-startup-id ${ i3Path } /scripts/music_controler.sh Next
2022-11-22 21:52:20 -05:00
# start a terminal
bindsym Mod1+Return exec i3-sensible-terminal
# kill focused window
bindsym Mod1+F4 kill
# Applications menu
bindsym Mod1+F1 exec --no-startup-id sgtk-menu -f
# Desktop icons
bindsym Mod1+Control+d exec --no-startup-id yad --icons --compact --no-buttons --title= "Desktop" --close-on-unfocus --read-dir= ${ HOME } /Desktop
# change focus
# alt+tab and shift tab
bindsym Mod1+Shift+Tab focus left
bindsym Mod1+Tab focus right
# enter fullscreen mode for the focused container
bindsym Mod1+BackSpace fullscreen toggle
# focus the parent container
bindsym Mod1+a focus parent
# focus the child container
#bindsym Mod1+d focus child
# move the currently focused window to the scratchpad
bindsym Mod1+Shift+minus move scratchpad
# Show the next scratchpad window or hide the focused scratchpad window.
# If there are multiple scratchpad windows, this command cycles through them.
bindsym Mod1+minus scratchpad show
# Define names for default workspaces for which we configure key bindings later on.
# We use variables to avoid repeating the names in multiple places.
set \$ ws1 "1"
set \$ ws2 "2"
set \$ ws3 "3"
set \$ ws4 "4"
set \$ ws5 "5"
set \$ ws6 "6"
set \$ ws7 "7"
set \$ ws8 "8"
set \$ ws9 "9"
set \$ ws10 "10"
# switch to workspace
2022-11-24 00:54:16 -05:00
bindsym Control+F1 workspace number \$ ws1, exec spd-say -P important -Cw "workspace 1"
bindsym Control+F2 workspace number \$ ws2, exec spd-say -P important -Cw "workspace 2"
bindsym Control+F3 workspace number \$ ws3, exec spd-say -P important -Cw "workspace 3"
bindsym Control+F4 workspace number \$ ws4, exec spd-say -P important -Cw "workspace 4"
bindsym Control+F5 workspace number \$ ws5, exec spd-say -P important -Cw "workspace 5"
bindsym Control+F6 workspace number \$ ws6, exec spd-say -P important -Cw "workspace 6"
bindsym Control+F7 workspace number \$ ws7, exec spd-say -P important -Cw "workspace 7"
bindsym Control+F8 workspace number \$ ws8, exec spd-say -P important -Cw "workspace 8"
bindsym Control+F9 workspace number \$ ws9, exec spd-say -P important -Cw "workspace 9"
bindsym Control+F10 workspace number \$ ws10, exec spd-say -P important -Cw "workspace 10"
2022-11-22 21:52:20 -05:00
# move focused container to workspace
2022-11-24 00:54:16 -05:00
bindsym Control+Shift+F1 move container to workspace number \$ ws1, exec spd-say -P important -Cw "moved to workspace 1"
bindsym Control+Shift+F2 move container to workspace number \$ ws2, exec spd-say -P important -Cw "moved to workspace 2"
bindsym Control+Shift+F3 move container to workspace number \$ ws3, exec spd-say -P important -Cw "moved to workspace 3"
bindsym Control+Shift+F4 move container to workspace number \$ ws4, exec spd-say -P important -Cw "moved to workspace 4"
bindsym Control+Shift+F5 move container to workspace number \$ ws5, exec spd-say -P important -Cw "moved to workspace 5"
bindsym Control+Shift+F6 move container to workspace number \$ ws6, exec spd-say -P important -Cw "moved to workspace 6"
bindsym Control+Shift+F7 move container to workspace number \$ ws7, exec spd-say -P important -Cw "moved to workspace 7"
bindsym Control+Shift+F8 move container to workspace number \$ ws8, exec spd-say -P important -Cw "moved to workspace 8"
bindsym Control+Shift+F9 move container to workspace number \$ ws9, exec spd-say -P important -Cw "moved to workspace 9"
bindsym Control+Shift+F10 move container to workspace number \$ ws10, exec spd-say -P important -Cw "moved to workspace 10"
2022-11-22 21:52:20 -05:00
2022-11-23 01:19:31 -05:00
bindsym $escapeKey mode "ratpoison"
mode "ratpoison" {
2022-11-23 20:05:57 -05:00
# Text editor bound to e
bindsym e exec $textEditor , mode "default"
# File browser bound to f
bindsym f exec $fileBrowser , mode "default"
2022-11-23 17:14:36 -05:00
# Web browser bound to w
bindsym w exec $webBrowser , mode "default"
2022-11-23 20:18:58 -05:00
$( if command -v mumble & > /dev/null ; then
2022-11-23 20:05:57 -05:00
echo 'bindsym m exec $(command -v mumble), mode "default"'
fi )
2022-11-23 20:18:58 -05:00
$( if command -v pidgin & > /dev/null ; then
2022-11-23 20:05:57 -05:00
echo 'bindsym p exec $(command -v pidgin), mode "default"'
fi )
2022-11-23 22:50:53 -05:00
$( if command -v transfersh & > /dev/null ; then
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 )
2022-11-23 21:38:35 -05:00
# Restart orca
bindsym Shift+o exec $( command -v orca) --replace, mode "default"
2022-11-22 21:52:20 -05:00
# reload the configuration file
2022-11-23 18:40:13 -05:00
bindsym Control+semicolon exec bash -c 'i3-msg -t run_command reload && spd-say -P important -Cw "I38 Configuration reloaded."' , mode "default"
2022-11-22 21:52:20 -05:00
# restart i3 inplace (preserves your layout/session, can be used to upgrade i3)
2022-11-23 18:50:38 -05:00
bindsym Control+Shift+semicolon exec bash -c 'i3-msg -t run_command restart && spd-say -P important -Cw "I3 restarted."' , mode "default"
2022-11-22 21:52:20 -05:00
# exit i3 (logs you out of your X session)
2022-11-23 01:19:31 -05:00
bindsym Control+q exec "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.' && exit i3
2022-11-23 16:05:26 -05:00
bindsym Escape mode "default"
2022-11-23 01:19:31 -05:00
}
2022-11-22 21:52:20 -05:00
2022-11-23 16:15:25 -05:00
# Auto start section
$( if [ [ $sounds -eq 0 ] ] ; then
2022-11-23 18:30:56 -05:00
echo " exec_always --no-startup-id ${ i3Path } /scripts/sound.py "
2022-11-23 20:27:41 -05:00
if [ [ $brlapi -eq 0 ] ] ; then
echo 'xbrlapi --quiet'
fi
2022-11-23 16:15:25 -05:00
fi
if [ [ $dex -eq 0 ] ] ; then
2022-11-23 00:31:30 -05:00
echo '# Start XDG autostart .desktop files using dex. See also'
echo '# https://wiki.archlinux.org/index.php/XDG_Autostart'
echo 'exec --no-startup-id dex --autostart --environment i3'
else
echo '# Startup applications'
echo 'exec clipster -d'
echo 'exec /usr/lib/notification-daemon-1.0/notification-daemon'
echo 'exec orca'
fi )
2022-11-22 21:52:20 -05:00
EOF