A multi-themed XMonad configuration by Aloysius.

I have renamed the default branch, please update your local as follows

$ git checkout master
$ git branch -m master main
$ git fetch
$ git branch --unset-upstream
$ git branch -u origin/main
$ git symbolic-ref refs/remotes/origin/HEAD refs/remotes/origin/main

• Previews
• Themes
• Quick-start
• Features
• Dependencies
• Default applications
• Installation instructions
• Key bindings

Say hello to clickable window decorations!

Heart is currently disabled until I can get copyToAll to work correctly. Dot makes full screen and toggles struts (movie mode!) and cross kills the window.

• Move a the non-critical parts of this README into the wiki
• Sort out the screenshots for the missing themes

This XMonad configuration is my attempt at making it feel more like a desktop environment. This means a lot more mod-cons than you typically find in a tiling WM. You will also need my polybar configuration, available in my nix-overlay, as well as all of the supporting scripts available here.

My personal setup looks like:

• OS: nixOS
• WM: XMonad
• Terminal: kitty
• Launcher: dmenu2
• Editor: doom emacs
• Browser: firefox

See below for how to change these for your preferred options. If the build instructions do not seem to work on your preference of OS then please raise an issue. As the build uses a nix-shell then it should "just work".

Floating desktop

Named scratchpad popup

Lock screen

Please note that the theming mechanisms currently sit across three or so different repositories and it is not yet integrated. There's some manual labour to co-ordinate the themes (across xmonad, those things managed by home-manager and kitty). All themes are available if you use all three of my repos.

The default theme is horizon. Note: all other screenshots are coming to the wiki soon.

Horizon

XMonad-Aloysius includes a means by which you can specify which theme you want through the build script. Please note that specifying the theme automatically produces a build call so you do not need both -b and -t [themename].

To switch all of your xmonad features (dmenu, dzen, containers etc.) to your choice of theme then its as easy as

./build -t [horizon|nord|laserwave|dracula|ephemeral|lovelace|nature]

Please see the following links for the influences behind the themes

• horizon
• Nord
• Laserwave
• Dracula
• Ephemeral
• Lovelace

If you already have this installed and lose your way or don't remember bindings then press Win// to bring up the 'xmonad prompt' and use this handy list of aliased actions. If you use this a lot and would like to request additional actions for this menu then raise an issue.

This list contains all of the features not included in the default XMonad experience. Key sequences are modal with M representing your left super, S- means shift plus the following button and C- is control plus whatever follows it

• Search options
  • g: duckduckgo
  • h: hoogle
  • w: wikipedia

Here are all of the things which this setup needs to work. If you install all of them you should be able to have the intended experience out of the box. If you are content editing the configuration files (which you will have to do eventually) then all of the following should be easily replaceable.

If you notice any missing dependencies please raise an issue so that this table can update.

For the polybar configuration files please see here. It uses home-manager and contains an overlay for nixpkgs with additional software. You also need my custom scripts directory available here.

I have not mentioned here that the preferred login manager here is lightdm in order to get access to dm-tool to enable user switching. If you do not use lightdm then you will need to edit the polybar configuration and change the user switching module into one which suits your preference.

This setup is pretty opinionated. I have some explicit applications named in ./lib/App/Alias.hs which you may wish to change to your own preferences.

If you prefer other apps then edit the variables in this file. At some point you will probably need to be doing this anyway and it helps you to get familiar with the structure of my environment.

In order to compile this you need to have nix-shell and zsh in your $PATH but once you have this it should be pretty automatic

git clone https://gitlab.com/karetsu/xmonad-aloysius
cd xmonad-aloysius
./build -h

This will print the build help documentation. Follow the options presented to build the binary to your needs.

Installing is all well and good but if you log in and don't know how to launch anything there could be trouble. Familiarise yourself with some of these useful bindings. A full list will be available on the wiki.

In all of the below, M is the Windows key (or whatever your Mod4 is) and S is Shift.