# Configuration

### Keybindings

```tmux
# Default keybindings (customize as needed)
set -g @grimoire-key "f"              # Summon the main shpell, or banish any active one
set -g @ephemeral-grimoire-key "F"    # Summon an ephemeral shpell
set -g @grimoire-kill-key "C"         # Banish the current shpell and erase its tmux window
```

### Appearance

```tmux
# Title
set -g @grimoire-title ' grimoire '   # Plain text title
set -g @grimoire-title ' 󱥭 '          # Nerd Font icon (if available)

# Color
set -g @grimoire-color '#c6b7ee'      # Border and title color (hex)

# Size
set -g @grimoire-width '80%'          # Width as percentage
set -g @grimoire-height '30%'         # Height as percentage

# Position
set -g @grimoire-position 'bottom-center'  # See position options below
```

### Clipboard

OSC52 clipboard support is enabled by default. Copied text inside shpells is routed to your system clipboard through the terminal, even over SSH.

```tmux
# Disable if it causes issues with your terminal
set -g @grimoire-osc52 'off'
```

---
## Position Options

Available positions for shpells:

```
┌─────────────┬──────────────┬─────────────┐
│  top-left   │  top-center  │  top-right  │
├─────────────┼──────────────┼─────────────┤
│    left     │    center    │    right    │
├─────────────┼──────────────┼─────────────┤
│ bottom-left │bottom-center │bottom-right │
└─────────────┴──────────────┴─────────────┘
```
---
## Custom Shpell Configuration

Override global settings for individual shpells using the pattern `@shpell-<name>-<option>`.
- Use names without spaces: use hyphens or underscores
```tmux
# Example: Customize a shpell named "dev"
bind-key -T prefix q run-shell "custom_shpell standard dev"

set -g @shpell-dev-color '#c2b3e9'
set -g @shpell-dev-position 'top-right'
set -g @shpell-dev-width '100%'
set -g @shpell-dev-height '50%'
```

```tmux
# Example: Customize an ephemeral shpell named "gitlog"
bind-key -T prefix G run-shell "custom_shpell ephemeral gitlog \"git log --oneline --graph --decorate --all\""

set -g @shpell-gitlog-color '#e3716e'
set -g @shpell-gitlog-position 'right'
set -g @shpell-gitlog-width '50%'
set -g @shpell-gitlog-height '100%'
```

### Available Custom Shpell Options

```tmux
set -g @shpell-<name>-color     # Border/title color
set -g @shpell-<name>-position  # Position (see diagram above)
set -g @shpell-<name>-width     # Width (percentage or cells)
set -g @shpell-<name>-height    # Height (percentage or cells)
```
> [!NOTE]  
> Any option not specified for a shpell will fall back to the global `@grimoire-*` value.

---
### Custom Shpells Path

```tmux
# Directory for custom shpell scripts
set -g @grimoire-path '$HOME/.config/grimoire'  # default location
```

Scripts placed in this directory can be referenced by relative path in custom shpell bindings.
WIP: Add information/examples