Jump to content
Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Add-ons/Toolbox/Notifications

From Shroud of the Avatar Wiki - SotA

Toolbox can collect game notices in a window, show them briefly on a HUD, write them to chat, and play optional sounds. Each source has its own enable, delivery, and sound settings.[1]

Notice sources

Toolbox 1.7.0 supports the following source names for /toolbox notify <name>:

Name Notice
motd A changed guild message of the day
mail New mail
expiring Mail approaching expiration
ransoms New ransom activity
rewards Newly available rewards
applications Guild applications
durability Equipped items crossing repair or broken thresholds
friends Friends coming online
guild Guild members coming online
events Calls to Arms and selected world events from the game's calendar

The Notifications window opens after login, after /lua reload, or when a newly detected notice is ready. Notices already marked as seen are not repeatedly delivered. Disabled count-based sources continue tracking quietly, so enabling one does not normally produce a backlog of old events.[2]

World events

On clients with Lua API 35, the events source reads the game's calendar and announces a Call to Arms or official event fifteen minutes before it starts. It also reports a qualifying event already underway at login and includes featured community events. Each calendar occurrence is announced once.[3]

/toolbox events reports what is happening now, the next calendar item, and whether the Cabalist Stronghold is open. The game's /calendar remains the complete calendar and reminder interface. On an older client, Toolbox reports that this feature requires API 35.

Toolbox 1.8.0 enhancement: clients with Lua API 38 receive calendar changes immediately. On API 35–37 clients, Toolbox continues polling, so an update may take up to about thirty seconds to appear. This enhancement is included in the current catalog package.[4]

Party notices and alerts

Toolbox 1.10.0 can report party joins and departures, scene changes, returns, and offline or online changes on Lua API 55 clients. Party health and named-debuff alerts are configured under Settings → Party and can use HUD notifications and sounds.[1]

Choosing delivery

For each source, choose Window, HUD, or Chat, with sound on or off. Examples:

  • /toolbox notify mail via hud
  • /toolbox notify friends via chat
  • /toolbox notify durability sound on
  • /toolbox notify guild off

Leaving out the source name when changing delivery or sound applies the setting to every source. /toolbox notify lists the current states, while /toolbox notify show displays everything currently available. /toolbox motd shows the guild message directly.

Notifications window

The window combines newly detected notices. Compact mode hides its title bar until the pointer is over it while retaining ordinary window resizing and opacity controls. Use the settings checkbox or /toolbox notify compact on|off.

Notification HUD

The HUD retains the latest twenty entries, newest first. Fresh items appear brighter and older entries dim; hovering reveals the full text. It appears when a notice arrives and normally hides after ten seconds, pausing while the pointer is over it.

Change the delay with /toolbox notify hud hide <seconds>; a value of zero leaves it visible. Move it with its grip, HUD layout settings, or /toolbox notify hud move <x> <y>. /toolbox notify hud clear clears the HUD history but does not manufacture a new notice from already-seen game state. Version 1.9.0 adds a Background shade slider for the HUD; it starts at 60 percent, and zero removes the panel while leaving the text solid.[1]

Sounds

The default notification is a rising chime. In version 1.7.0, new and expiring mail use a doorbell by default. Each source can instead use Chime, Ping, Tap, Doorbell, Bell, or Low notes. Multiple notices arriving in one check play each distinct selected sound once rather than repeating the same sound for every line.

The global alert volume and per-sound share are configured on the Sounds page. A per-sound value of zero silences only that sound. Custom notification files and general volume controls are described under Toolbox configuration and backups.

Startup behavior

Some game counts can briefly read as zero while a character loads. The implementation allows a settling interval after startup or character change before accepting decreasing counts, reducing false state changes during login.[2] Friends and guild-member online notices are live events rather than a reconstructable history, so they begin with the running add-on session.

Troubleshooting

If a notice does not appear, use /toolbox notify to confirm that its source is enabled, has the expected delivery route, and is not muted. Use /toolbox notify show to test the window with current data and the Sounds page to test audio. Remember that Toolbox deliberately does not repeat already-seen notices.

References

  1. ↑ 1.0 1.1 1.2 Toolbox 1.10.0 in-addon documentation, approved package reviewed November 1, 2026.
  2. ↑ 2.0 2.1 Toolbox source at revision 216b5ffd, notification implementation and tests reviewed October 13, 2026.
  3. ↑ Toolbox 1.7.0 release notes, published October 13, 2026.
  4. ↑ Toolbox 1.8.0 release notes, published October 14, 2026.

See also

Page verification: Unverified · This page could use a check