Doors/readme.md
2024-01-03 18:39:50 -05:00

4.2 KiB

Doors are sturdier than windows

This is my personal desktop environment that is:

  1. Reliable
  2. Fast
  3. Made from readily available components
  4. Simple (see above)
  5. Decent looking

I try to use the terminal as much as possible for performance and also so it's the same experience whether you're at the computer or connected via ssh.

If it's not here then you probably don't need it.

Some Features

Shell/Base

  • Yay - Package manager with AUR support (Arch only)
  • rsync - For my 'push' alias
  • sl - For when you're too fast
  • btop - Top++
  • neovim - Edit text blazingly fast (even over ssh)
  • byobu - Comfy multiplexer
  • Oh My Zsh - Community enhancements for zsh. Easier than DIY
  • nnn - Lightning fast file manager
  • lf - File manager like ranger but faster
  • mosh - MObile SHell, like ssh but better with a bad connection

GUI

Business:

  • awesome - Dynamic window manager based on DWM
  • alacritty - Fast terminal with GPU acceleration written in Rust
  • maim - Screenshot tool, with a script for ease of use

Eye Candy:

  • pywal - Set whole system color scheme from wallpaper colors
  • nitrogen - Wallpaper setter that allows stretching across multiple screens
  • picom - Vsync, shadows, transparency, etc
  • redshift - Shifts screen to red at night to be easier on the eyes
  • unclutter - Hides the cursor after inactivity

Install

The install script clones this repo, installs a few dependencies, then copies my configs to $HOME/.config/ creating a backup for any config files that already exist. NOTE: Only ONE backup per file is saved to prevent piling up backups. It's only meant to catch small oversights and is very verbose. In other words, if you run the installer twice IT WILL OVERWRITE THE BACKUP!

The install script is only for Arch right now but I plan to include any distro that has these programs in their repos. Or at least the popular ones

Quick shell (start here):

Note: back up your home directory or create a new user (unless you don't care) or you aren't allowed to complain about anything that may be overwritten

  1. curl https://doors.doordesk.net/setup | bash
  2. Log out and log back in

GUI

  • For now the setup just installs everything in one shot so you get the GUI whether you need it or not, to use it just run startx or start awesome from your display manager if you have one.

  • The mod keys are Super, Menu, and Meta

  • Once in awesome press Mod + F1 for a quick reference of all keybinds

Post Install

Neovim

  • Run :PackerSync on first run, :Mason to install language servers, :TSUpdate after installing language servers to update treesitter. Do this again periodically to keep everything fresh

Colors

Some manual setup is required for theming if you want eye candy. My scripts should handle everything else

  • Install pywalfox for firefox, then open it and click the "Fetch Pywal colors" button. You shouldn't have to touch it ever again
  • Point telegram to wal-telegram's generated theme. It should handle itself from here

Known issues (aka things to fix and excuses why they aren't):

  • Installer can hang at "retrieving packages" - I think this is a pacman/mirror issue. Just wait or kill and restart it if you're impatient. The setup should pick up where it left off
  • lsp-zero (nvim plugin) changed some things and needs to be reconfigured

Future:

  • More granular installer (shell, gui, make some gui apps optional like messengers)
  • Support more distros
  • Add color to setup cause why not?