✦ Aelyx Shell ✦

     

---

✦ Overview ✦

aelyx-shell a quickshell configuration built for clarity, speed, and a smooth, cohesive hyprland experience.

Key goals:

• Minimal, script-centric configuration
• Easy to review and selectively apply
• Composable modules for prompts, completions, and UI widgets

---

✦ Previews ✦

Desktop	Launcher

---

✦ Repository layout ✦

• /dots/ — Primary shell dotfiles (core modules)
• /dots-extra/ — Optional dotfiles, themes, and wallpapers
• /license/ — License and contributing docs
• /previews/ — Example screenshots used in this README
• setup/ — Installer scripts and bootstrap utilities
• bootstrap.sh — High-level dependency installer

---

✦ Installation (automatic recommended) ✦

Follow these steps to install the collection. The automated setup is conservative and will prompt before making destructive changes.

1. Clone the repository:

   git clone https://github.com/xZepyx/aelyx-shell.git ~/.aelyx-shell
   cd ~/.aelyx-shell

2. Inspect configuration and optional modules:

   • Review files in dots/ and dots-extra/ before applying anything to your profile.

3. Run the installer:

   cd setup && bash install.sh

   • The installer will guide you through dependency checks and optional modules.

4. Open a fresh shell session or source your shell profile to apply changes.

Notes:

• Manual installation (symlinking files yourself) is supported and recommended for cautious users.
• Back up your existing dotfiles (e.g. ~/.bashrc, ~/.zshrc, ~/.profile) before running the bootstrap.

---

✦ Configuration & customization ✦

• Primary config: ~/.config/aelyxshell/config.json
• Modular settings: prompt, completion, and widget modules are separated for easy replacement.
• To customize:
  • Edit ~/.config/aelyxshell/config.json or use the provided settings app (if installed).
  • Enable/disable modules by editing the module list in the appropriate config file.

---

✦ Recommended environment ✦

• Shell: QuickShell-compatible environment (see QuickShell docs)
• Compositor: Hyprland is recommended but not required
• Terminal: Kitty or another modern terminal emulator
• Fonts: A patched monospace font with ligatures for best prompt rendering
• Git: recommended for keeping dotfiles updated and synced

---

✦ Troubleshooting ✦

• Missing alias or function:
  • Ensure the module file is loaded in the correct order. Check ~/.config/quickshell/shell.qml.
• Slow startup:
  • Disable unused modules or lazy-load heavy features (e.g., prompt segments that query network/state).
• Conflicting user configs:
  • Inspect existing profile files (~/.bashrc, ~.zshrc, ~/.profile) before applying changes.
• Installer failures:
  • Re-run the installer with verbose output or check setup/ scripts for dependency checks.

---

✦ To-Do ✦

• Redesign config layout and widget system for improved modularity and discoverability
• Add more curated optional modules and theme variants
• Improve installer prompts and backup behavior

---

✦ Contributing ✦

Contributions are welcome. When contributing:

• Open concise issues after confirming the problem isn't caused by local configuration.
• Submit focused PRs with clear descriptions and tests where applicable.
• Follow code structure and naming conventions used in dots/.

See license/CONTRIBUTING.md for full contribution guidelines.

---

✦ Maintainer ✦

• Maintainer: xZepyx (Aditya Yadav)
• Contact: zepyxunderscore@gmail.com
• Side Note: Again I'm low on time and only the bugs I find or someone using the dots finds will be fixed. I might add more widgets if needed. Otherwise the shell is completely usable.

---

✦ Acknowledgments ✦

• QuickShell and its contributors
• Hyprland and its developers/contributors

---

✦ License ✦

© 2025 xZepyx (Aditya Yadav) — Licensed under the MIT License. See license/ for details.

---