Files
apex/INSTALL.md
s0wlz (Matthias Puchstein) cbfa26afb7 feat: add SwayNC notification center template
- Created Jinja2 template for SwayNC CSS.
- Mapped system DNA to notification states (Critical, Normal, MPRIS).
- Updated documentation and repository map.
2025-12-31 01:23:53 +01:00

364 lines
6.6 KiB
Markdown

# Apex Theme System: Installation Guide
This guide explains how to install the **Apex Neon** (Dark) and **Apex Aeon** (Light) themes.
All generated theme files can be found in the `dist/` directory after running `uv run build.py`.
---
## 1. Neovim (`nvim`)
**Files:**
- `dist/nvim/colors/apex-neon.lua`
- `dist/nvim/colors/apex-aeon.lua`
**Manual Installation:**
1. Copy the files to your Neovim colors directory:
```bash
mkdir -p ~/.config/nvim/colors
cp dist/nvim/colors/*.lua ~/.config/nvim/colors/
```
2. Enable the theme in your `init.lua`:
```lua
vim.cmd.colorscheme "apex-neon"
-- or
vim.cmd.colorscheme "apex-aeon"
```
---
## 2. Zsh
**Files:**
- `dist/zsh/apex-neon.zsh-theme`
- `dist/zsh/apex-aeon.zsh-theme`
**Installation:**
1. Source the desired theme file in your `.zshrc`.
2. Ideally, place the file in a standard location like `~/.zsh/themes/`.
```bash
# In ~/.zshrc
source /path/to/apex-neon.zsh-theme
```
---
## 3. Kitty Terminal
**Files:**
- `dist/kitty/apex-neon.conf`
- `dist/kitty/apex-aeon.conf`
**Installation:**
1. Copy the files to your Kitty config directory:
```bash
cp dist/kitty/*.conf ~/.config/kitty/
```
2. Include one of them in your `~/.config/kitty/kitty.conf`:
```conf
include apex-neon.conf
# include apex-aeon.conf
```
---
## 4. Alacritty
**Files:**
- `dist/alacritty/apex-neon.toml`
- `dist/alacritty/apex-aeon.toml`
**Installation:**
1. Copy the files to your Alacritty config directory:
```bash
mkdir -p ~/.config/alacritty/themes
cp dist/alacritty/*.toml ~/.config/alacritty/themes/
```
2. Import the theme in your `~/.config/alacritty/alacritty.toml`:
```toml
[general]
import = ["~/.config/alacritty/themes/apex-neon.toml"]
```
---
## 5. Zed Editor
**Files:**
- `dist/zed/apex.json` (Aggregated: contains **both** Neon and Aeon)
**Installation:**
1. Open Zed.
2. Go to **Extensions** (Ctrl+Shift+X).
3. If developing locally, you can open this file as a Dev Extension.
4. Once loaded, switch themes via the theme picker (Ctrl+K Ctrl+T) and select "Apex Neon" or "Apex Aeon".
---
## 6. Gemini CLI
**Files:**
- `dist/gemini/apex-neon.json`
- `dist/gemini/apex-aeon.json`
**Installation:**
1. Edit your Gemini settings file (usually `~/.config/gemini/settings.json` or via `gemini settings`).
2. Point the `theme` property to the absolute path of the generated file:
```json
{
"ui": {
"theme": "/absolute/path/to/dist/gemini/apex-neon.json"
}
}
```
---
## 7. GTK4 / Libadwaita
**Files:**
- `dist/gtk4/gtk.css` (Aggregated: Responsive to System Dark/Light mode)
**Installation:**
1. This file maps Apex colors to Libadwaita named colors (`@window_bg_color`, etc.).
2. Copy or symlink it to your GTK4 config directory:
```bash
# For standard GTK4 apps
mkdir -p ~/.config/gtk-4.0
ln -s $(pwd)/dist/gtk4/gtk.css ~/.config/gtk-4.0/gtk.css
```
3. To apply changes immediately, you may need to restart your applications or log out/in.
---
## 8. Hyprland
**Files:**
- `dist/hyprland/apex-neon-colors.conf`
- `dist/hyprland/apex-aeon-colors.conf`
**Installation:**
1. Copy the files to your Hyprland config directory:
```bash
cp dist/hyprland/*.conf ~/.config/hypr/
```
2. Source the desired theme in your `hyprland.conf`:
```conf
source = ~/.config/hypr/apex-neon-colors.conf
# source = ~/.config/hypr/apex-aeon-colors.conf
```
---
## 9. Fuzzel
**Files:**
- `dist/fuzzel/apex-neon-fuzzel.ini`
- `dist/fuzzel/apex-aeon-fuzzel.ini`
**Installation:**
1. Copy the desired file to your Fuzzel config location:
```bash
cp dist/fuzzel/apex-neon-fuzzel.ini ~/.config/fuzzel/fuzzel.ini
```
2. Alternatively, use the `--config` flag when launching Fuzzel.
---
## 10. Waybar
**Files:**
- `dist/waybar/apex-neon-colors.css`
- `dist/waybar/apex-aeon-colors.css`
**Installation:**
1. Copy the desired file to your Waybar config directory:
```bash
cp dist/waybar/apex-neon-colors.css ~/.config/waybar/colors.css
```
2. Import it in your main `style.css`:
```css
@import "colors.css";
```
3. Use the variables in your CSS (e.g., `background-color: @background;`, `color: @foreground;`, `border-color: @accent;`).
---
## 11. Zathura
**Files:**
- `dist/zathura/apex-neon-zathurarc`
- `dist/zathura/apex-aeon-zathurarc`
**Installation:**
1. Copy the desired file to your Zathura config directory:
```bash
mkdir -p ~/.config/zathura
cp dist/zathura/apex-neon-zathurarc ~/.config/zathura/zathurarc
```
2. Or include it in your existing config:
```conf
include apex-neon-zathurarc
```
---
## 12. Btop
**Files:**
- `dist/btop/apex-neon.theme`
- `dist/btop/apex-aeon.theme`
**Installation:**
1. Copy the desired file to your Btop themes directory (usually `~/.config/btop/themes/`):
```bash
mkdir -p ~/.config/btop/themes
cp dist/btop/*.theme ~/.config/btop/themes/
```
2. Select the theme within Btop settings (ESC -> Options -> Color theme).
---
## 13. SwayNC
**Files:**
- `dist/swaync/apex-neon-style.css`
- `dist/swaync/apex-aeon-style.css`
**Installation:**
1. Copy the desired file to your SwayNC config directory:
```bash
mkdir -p ~/.config/swaync
cp dist/swaync/apex-neon-style.css ~/.config/swaync/style.css
```
2. Reload SwayNC:
```bash
swaync-client -rs
```