Skip to content

Commit

Permalink
updated book and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
casperstorm committed May 9, 2024
1 parent 253bf87 commit 34155a3
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
Added:

- Ability to overwrite nickname colors by providing a hex string (see [buffer configuration](https://halloy.squidowl.org/configuration/buffer.html#buffernicknamecolor-section)).
- Ability to overwrite server & internal message colors by providing a hex string (see [buffer configuration](https://halloy.squidowl.org/configuration/buffer.html#bufferserver_messages-section)).

# 2024.7 (2024-05-05)

Expand Down
16 changes: 12 additions & 4 deletions book/src/configuration/buffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,10 @@ enabled = true | false
position = "left" | "right"
```

| Key | Description | Default |
| ---------- | ------------------------------------------------ | ---------- |
| `enabled` | Control if nicklist should be shown or not | `true` |
| `position` | Nicklist position. Can be `"left"` or `"right"`. | `"right"` |
| Key | Description | Default |
| ---------- | ------------------------------------------------ | --------- |
| `enabled` | Control if nicklist should be shown or not | `true` |
| `position` | Nicklist position. Can be `"left"` or `"right"`. | `"right"` |

### `[buffer.channel.nicklist.color]` Section

Expand Down Expand Up @@ -102,48 +102,56 @@ max_lines = <integer>
enabled = true | false
smart = <integer>
username_format = "full" | "short"
hex = "<string>"
```

```toml
[buffer.server_messages.part]
enabled = true | false
smart = <integer>
username_format = "full" | "short"
hex = "<string>"
```

```toml
[buffer.server_messages.quit]
enabled = true | false
smart = <integer>
username_format = "full" | "short"
hex = "<string>"
```

```toml
[buffer.server_messages.topic]
enabled = true | false
hex = "<string>"
```

| Key | Description | Default |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `enabled` | Control if the server message should appear in buffers or not | `true` |
| `smart` | Only show server message if the user has sent a message in the given time interval (seconds) prior to the server message. | `not set` |
| `username_format` | Adjust how the username should look. Can be `"full"` (shows the longest username available (nickname, username and hostname) or `"short"` (only shows nickname). | `"full"` |
| `hex` | Overwrite the default color. Optional. | `not set` |

## `[buffer.internal_messages]` Section

```toml
[buffer.internal_messages.success]
enabled = true | false
smart = <integer>
hex = "<string>"
```

```toml
[buffer.internal_messages.error]
enabled = true | false
smart = <integer>
hex = "<string>"
```

| Key | Description | Default |
| --------- | -------------------------------------------------------------------------------- | --------- |
| `enabled` | Control if the internal message should appear in buffers or not | `true` |
| `smart` | Only show internal message if received within the given time duration (seconds). | `not set` |
| `hex` | Overwrite the default color. Optional. | `not set` |

0 comments on commit 34155a3

Please sign in to comment.