Wiki: Installation + Konfiguration, navigering på Home

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-08-30 12:48:24 +02:00
parent fddc74fa53
commit 9d44d24abd
3 changed files with 139 additions and 2 deletions

@@ -6,8 +6,10 @@ Modern, resurssnål dock för Wayfire — transparent Plasma 6-känsla,
byggd i Rust/GTK4 som en enda binär. Körs på **brasse-linux01** i
Wayfire-DE-sessionen.
- **[Användning](Användning)** — flaggor, dagligt bruk, hela configreferensen
- **[Arkitektur](Arkitektur)** — hur appen är byggd (moduler, nyckelbeslut, resursbudget)
- **[Installation](Installation)** — en-raders-install, krav, autostart
- **[Konfiguration](Konfiguration)** — configfilen, settings-GUI:t, per skärm
- **[Användning](Användning)** — dagligt bruk + hela configreferensen
- **[Arkitektur](Arkitektur)** — hur appen är byggd (moduler, nyckelbeslut)
- Planen och milstolparna ligger i repot: [`doc/plan.md`](https://gitea.brasse-pc.eu/brasse/waydock/src/branch/master/doc/plan.md)
| Dockan | Inställningar |

47
Installation.md Normal file

@@ -0,0 +1,47 @@
# Installation
## Snabbast: en rad
```bash
curl -fsSL https://gitea.brasse-pc.eu/brasse/waydock/raw/branch/master/install.sh | sh
```
Det hämtar senaste release-binären (~1,6 MB) till `~/.local/bin/waydock`
och installerar appikon + `.desktop`-fil. Starta sedan med:
```bash
waydock
```
## Krav
| Krav | Varför |
|---|---|
| `gtk4` + `gtk4-layer-shell` | rendering och panel-fönstren (`sudo pacman -S gtk4 gtk4-layer-shell`) |
| wlroots-compositor med `zwlr_foreign_toplevel_manager_v1` | fönsterlistan (Wayfire, Sway, …) |
| Wayfires `ipc` + `ipc-rules`-plugins *(valfritt)* | översiktsknappen, "Flytta till skärm", dodge-autohide och peek |
| Wayfires `alpha`-plugin *(valfritt)* | peek-förhandsvisningen (tona ner andra fönster) |
Pluginsen aktiveras i `wayfire.ini` under `[core] plugins = … ipc ipc-rules alpha …`
— Wayfire laddar om configen live, ingen omstart behövs.
## Bygga själv
```bash
git clone https://gitea.brasse-pc.eu/brasse/waydock.git
cd waydock
cargo build --release # binär: target/release/waydock
```
## Starta med Wayfire-sessionen
Lägg ett autostart-skript (i Wayfire-DE: `autostart/11-dock.sh`):
```bash
#!/usr/bin/env bash
exec ~/.local/bin/waydock
```
## Uppdatera
Kör en-raders-installen igen — den hämtar alltid senaste `latest`-releasen.

88
Konfiguration.md Normal file

@@ -0,0 +1,88 @@
# Konfiguration
## Två sätt — samma fil
waydock konfigureras via **en enda JSON-fil**:
```
~/.config/waydock/config.json
```
Filen **skapas automatiskt med standardvärden** första gången appen
startar. Alla ändringar plockas upp **live** — spara filen och docken
uppdaterar sig direkt, ingen omstart.
Du kan blanda fritt mellan:
1. **Settings-GUI:t** — högerklicka på en tom yta i dockan →
**Inställningar…** (eller kör `waydock --settings`). Varje reglage
skriver direkt till JSON-filen.
2. **Handredigering** — öppna filen i valfri editor. Trasig JSON är
ofarligt: waydock loggar felet och kör vidare på förra värdena utan
att röra din fil.
![Inställningar](settings.png)
## Per skärm
Överst i settings sitter **skärmväljaren** med en klickbar minibild av
dina skärmar. "Alla skärmar" (standard) redigerar det globala; välj en
skärm för att ge just den egna värden — **bara fälten du ändrar** sparas
som avvikelse, resten ärvs från det globala. `*` = skärmen har egna
inställningar; "Återställ skärmen till globalt" tar bort dem.
I JSON-filen hamnar avvikelserna under `"outputs"`, med skärmens
connector-namn som nyckel:
```jsonc
"outputs": {
"DP-1": {
"position": "left", // bara på DP-1
"only_this_output": true, // visa bara DP-1:s fönster
"pins": ["steam", "discord"], // egna pins
"appearance": { "accent": "#5fb878" } // egen accentfärg
}
}
```
## Så här ser filen ut (utdrag med det viktigaste)
```jsonc
{
"position": "bottom", // bottom | top | left | right
"alignment": "center", // center | start | end
"expand": false, // true = täck hela kanten
"margin": 8, // avstånd från kanten (minus tillåtet)
"appearance": {
"background": "#222222", // panelfärg
"opacity": 0.72, // transparens
"accent": "#c9545d", // indikatorer, hover, markeringar
"icon_size": 36,
"corner_radius": 14
},
"pins": ["firefox", "org.kde.konsole", "org.kde.dolphin"],
"behavior": {
"click": "focus_or_minimize",
"group_popup": "click", // click | hover
"list_hover": "peek" // peek | focus | none
}
}
```
`pins` använder `.desktop`-id (filnamnet utan `.desktop`). Hitta rätt id:
```bash
ls /usr/share/applications | grep -i <appnamn>
```
Hela referensen med **alla** nycklar finns på [Användning](Användning).
## Loggar
```bash
waydock --log debug # pratig logg till terminalen
waydock --log-file ~/.cache/waydock.log # eller till fil
```