How gabrielfrimodig/dotfiles works
Project Type and Purpose
• This is a dotfiles repository containing a fully customized AwesomeWM (a tiling window manager) configuration.
• Its purpose is to define a personalized desktop environment: window behavior (tiling, floating), keybindings, theming, status bar widgets, popups, and startup scripts.
File Structure Analysis
• Top‐level directories:
• .config/awesome: main configuration folder for AwesomeWM
• .config/kitty, .config/picom, .config/rofi: configs for terminal, compositor, launcher
• .zshrc, LICENSE, README.md: shell config and metadata
• Inside .config/awesome:
• rc.lua: entry point that loads all modules
• autostart.sh: startup script (sets wallpaper, launches background services)
• bindings/: keyboard & mouse mappings
• config/: core layout & menu definitions, gap settings, signal hooks
• rules/: application-to-tag/screen placement rules
• signals/: reaction scripts on brightness change, errors, screen corners
• ui/: wibar/bar widgets, popups, notifications, powermenu
README Insights
• Lists dependencies (AwesomeWM core, picom, feh, rofi, maim, playerctl, etc.)
• Describes features: dynamic widgets, popups on volume/brightness, wallpaper on startup
• Highlights multi-screen and tag‐mapping rules for apps (e.g., Spotify→tag8)
a. Main Components
1. Operating System (Fedora Workstation)
2. X Server (Xorg)
3. AwesomeWM Core (git version)
4. AwesomeWM Modules (Lua scripts):
• Autostart
• Bindings
• Config (layout, menus, gaps)
• Rules
• Signals
• Theme
• UI (bar, popups, notifications, powermenu)
5. External Tools/Services invoked:
• feh (wallpaper)
• picom (compositor)
• rofi (launcher)
• maim/xclip (screenshots)
• pactl, acpi, xbacklight (status scripts)
• playerctl, i3lock
• Shell (zsh), Terminal (kitty)
b. Relationships & Interactions
• OS starts X Server → X Server spawns AwesomeWM
• rc.lua loads modules in sequence: autostart → config → bindings → rules → signals → theme → UI
• Autostart.sh uses feh to set wallpaper and may launch picom
• Keybindings trigger Lua callbacks that call external binaries (rofi, maim, pactl, etc.)
• Signals watch system events (brightness change, battery, error) and update widgets/popups
• Rules assign newly created client windows to specific screens/tags
c. Architectural Patterns
• Modular plugin‐style architecture: each concern lives in its own directory
• Event‐driven: “signals” modules react to system/window events
• Layered: core (rc.lua & config) → extensions (bindings, rules, theme) → UI
d. Key Technologies & Libraries
• Lua (scripting language for AwesomeWM)
• AwesomeWM API modules: awful, naughty, ruled, wibox
• External commands called via awful.spawn.with_shell
Elements
• Blue for core & modules
• Green for UI elements
• Orange for external system tools
• Rounded for scripts/modules
• Rectangles for binaries/services