Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

[notifications]

Customize and enable notifications.

Example

[notifications] direct_message = { sound = "peck", show_toast = true } [notifications.highlight] sound = "dong" exclude = ["NickServ", "#halloy"]

Following notifications are available:

NameDescriptionContent
connectedTriggered when a server is connectedN/A
direct_messageTriggered when a direct message is receivedMessage text
disconnectedTriggered when a server disconnectsN/A
file_transfer_requestTriggered when a file transfer request is receivedFile name
highlightTriggered when you were highlighted in a bufferMessage text
monitored_onlineTriggered when a user you're monitoring is onlineN/A
monitored_offlineTriggered when a user you're monitoring is offlineN/A
reconnectedTriggered when a server reconnectsN/A

sound

Notification sound. Supports both built-in sounds, and external sound files (mp3, ogg, flac or wav placed inside the sounds folder within the configuration directory).

# Type: string # Values: "dong", "peck", "ring", "squeak", "whistle", "bonk", "sing" or external sound. # Default: not set [notifications.<notification>] sound = "dong"

show_toast

Notification should trigger a OS toast.

# Type: boolean # Values: true, false # Default: false [notifications.<notification>] show_toast = true

show_content

Notification should show the content of the trigger (as described in the table above).

# Type: boolean # Values: true, false # Default: false [notifications.<notification>] show_content = true

delay

Delay in milliseconds before triggering the next notification.

# Type: integer # Values: any positive integer # Default: 500 [notifications.<notification>] delay = 250

exclude

Exclude notifications for nicks (and/or channels in highlight's case).

Only available for direct_message, highlight and file_transfer_request notifications.

You can also exclude all nicks/channels by using a wildcard: ["*"] or ["all"].

# Type: array of strings # Values: array of strings # Default: [] [notifications.<direct_message|file_transfer_request>] exclude = ["HalloyUser1"] [notifications.highlight] exclude = ["HalloyUser1", "#halloy"]

include

Include notifications for nicks (and/or channels in highlight's case).

Only available for direct_message, highlight and file_transfer_request notifications.

The include rule takes priority over exclude, so you can use both together. For example, you can exclude all nicks with ["*"] for direct_message and then only include a few specific nicks to receive direct_message notifications from.

# Type: array of strings # Values: array of strings # Default: [] [notifications.<direct_message|file_transfer_request>] include = ["HalloyUser1"] [notifications.highlight] include = ["HalloyUser1", "#halloy"]