Skip to content

Commit ff4f92b

Browse files
committed
readme standardization
1 parent e19f2b6 commit ff4f92b

10 files changed

Lines changed: 44 additions & 23 deletions

File tree

bongocat/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ you type or when audio beats are detected.
88
| Field | Value |
99
| --- | --- |
1010
| ID | `noctalia/bongocat` |
11-
| Version | `1.1.1` |
12-
| Minimum Noctalia | `5.0.0` |
1311
| Entry | Bar widget: `cat` |
1412

1513
## Usage

example/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ shortcut.
99
| Field | Value |
1010
| --- | --- |
1111
| ID | `noctalia/example` |
12-
| Version | `1.0.2` |
13-
| Minimum Noctalia | `5.0.0` |
1412
| Entries | Bar widget: `hello`; service: `ticker`; shortcut: `toggle` |
1513

1614
## Usage

example/plugin.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ include_in_global_search = false
6565
# (panel.render). Demonstrates the interactive controls (toggle/slider/input/
6666
# select inside a scroll) and their value callbacks. Panel size is host-owned
6767
# and declared here, so the surface is sized right on the first open.
68-
# Open it with: noctalia ipc panel-toggle noctalia/example:panel
68+
# Open it with: noctalia msg panel-toggle noctalia/example:panel
6969
[[panel]]
7070
id = "panel"
7171
entry = "panel.luau"

kaomoji/README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@
33
Browse and search kaomoji emoticons `(◍•ᴗ•◍)♡` from the Noctalia launcher and
44
copy them to the clipboard.
55

6+
## Plugin
7+
8+
| Field | Value |
9+
| --- | --- |
10+
| ID | `noctalia/kaomoji` |
11+
| Entry | Launcher provider: `kaomoji` |
12+
| Launcher Prefix | `/kao` |
13+
614
## Usage
715

816
Open the launcher and type `/kao`:
@@ -17,12 +25,13 @@ The category bar follows the launcher's global *Show categories* setting.
1725

1826
## Settings
1927

20-
| Setting | Description |
21-
|---|---|
22-
| **Notify on copy** | Show a notification when a kaomoji is copied. Default on. |
28+
| Setting | Type | Default | Description |
29+
| --- | --- | --- | --- |
30+
| `notify_on_copy` | `bool` | `true` | Shows a notification when a kaomoji is copied. |
2331

2432
## Notes
2533

26-
`database.json` is a curated subset of the upstream kaomoji catalogue. Each entry
27-
records a primary `category` (the labels declared in `plugin.toml`) plus tags for
28-
search, indexed so it decodes quickly inside the launcher.
34+
- `database.json` is a curated subset of the upstream kaomoji catalogue.
35+
- Each entry records a primary `category` that matches the labels declared in
36+
`plugin.toml`, plus tags used for search.
37+
- The database is indexed so it decodes quickly inside the launcher.

mpvpaper/README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,46 @@ Noctalia does not decode video itself. This plugin runs `mpvpaper`, which draws
88
outputs you assign a video to — so the video shows through, with the bar and dock still
99
drawn above it.
1010

11+
## Plugin
12+
13+
| Field | Value |
14+
| --- | --- |
15+
| ID | `noctalia/mpvpaper` |
16+
| Entries | Service: `service`; Panel: `picker`; bar widget: `mpvpaper` |
17+
1118
## Requirements
1219

13-
- `mpvpaper` (which pulls in `mpv`). `mpv` is also used to render the picker thumbnails.
20+
Install `mpvpaper` and `mpv` on `PATH`. `mpvpaper` renders the wallpaper
21+
surface, and `mpv` renders picker thumbnails.
1422

1523
The plugin works on `wlr-layer-shell` compositors (Niri, Hyprland, Sway, Mango).
1624

1725
## Usage
1826

1927
1. Set **Video directory** in the plugin settings (defaults to `~/Videos`).
2028
2. Add the **Video Wallpaper** bar widget, or open the picker with
21-
`noctalia msg panel-toggle noctalia/mpvpaper:picker`.
29+
30+
```sh
31+
noctalia msg panel-toggle noctalia/mpvpaper:picker
32+
```
33+
2234
3. Choose a target output (or **All outputs**), then click a video to apply it.
2335
Use **Stop** to restore Noctalia's own wallpaper on that output.
2436

2537
Assignments persist across restarts. Supported files: `mp4`, `webm`, `mkv`, `mov`, `gif`.
2638

27-
## How it works
39+
## Settings
40+
41+
| Setting | Type | Default | Description |
42+
| --- | --- | --- | --- |
43+
| `video_directory` | `folder` | *(empty)* | Folder scanned for wallpaper videos; defaults to `~/Videos` when empty. |
44+
| `mute` | `bool` | `true` | Starts video wallpapers muted. |
45+
| `hardware_decode` | `bool` | `true` | Uses `mpv` hardware decoding. |
46+
| `auto_pause` | `bool` | `true` | Pauses playback while a fullscreen window covers the wallpaper. |
47+
| `mpv_options` | `string` | *(empty)* | Additional space-separated `mpv` options. |
48+
| `glyph` | `glyph` | `movie` | Bar widget icon. |
49+
50+
## Notes
2851

2952
A headless service supervises one long-lived helper process (`supervisor.sh`) that owns
3053
every `mpvpaper` instance, one per output. The picker panel and bar widget are thin

notes/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ directory you control — yours to sync, edit externally, and grep.
99
| --- | --- |
1010
| ID | `noctalia/notes` |
1111
| Entries | Panel: `panel`; bar widget: `notes`; launcher provider: `launcher` |
12+
| Launcher Prefix | `/nt` |
1213

1314
## Usage
1415

screen_recorder/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ Control Center.
99
| Field | Value |
1010
| --- | --- |
1111
| ID | `noctalia/screen_recorder` |
12-
| Version | `1.1.9` |
13-
| Minimum Noctalia | `5.0.0` |
1412
| Entries | Service: `service`; bar widget: `recorder`; shortcut: `toggle` |
1513

1614
## Requirements

timer/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ progress display.
88
| Field | Value |
99
| --- | --- |
1010
| ID | `noctalia/timer` |
11-
| Version | `1.0.1` |
12-
| Minimum Noctalia | `5.0.0` |
1311
| Entry | Desktop widget: `timer` |
1412

1513
## Usage

translator/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,8 @@ Translate and copies the selected result to the clipboard.
88
| Field | Value |
99
| --- | --- |
1010
| ID | `noctalia/translator` |
11-
| Version | `1.0.5` |
12-
| Minimum Noctalia | `5.0.0` |
1311
| Entry | Launcher provider: `translate` |
14-
| Prefix | `/tr` |
12+
| Launcher Prefix | `/tr` |
1513

1614
## Usage
1715

wallhaven/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ Browse [Wallhaven](https://wallhaven.cc), download a wallpaper into your Noctali
77
| Field | Value |
88
| --- | --- |
99
| ID | `noctalia/wallhaven` |
10-
| Version | `1.0.2` |
11-
| Minimum Noctalia | `5.0.0` |
1210
| Entries | Panel: `browser`; bar widget: `wallhaven` |
1311

1412
## Usage

0 commit comments

Comments
 (0)