Help: webpush | Mongoose

Showing help on 'webpush'

Notifications
Mongoose can alert you in the game, through browser Web Push, or through
ntfy. It also keeps missed output for catch-up when you reconnect.
Start with @notify status. These settings control notification alerts;
ordinary speech, pages and channel output have their own normal delivery.

Quick setup
Browser/phone: enable Web Push in the official Mongoose client and allow
notifications in your browser or device. Register on each device you use.
@notify on webpush permits delivery to existing browser subscriptions;
it does not register a device or grant browser permission.
ntfy: @player-options +notify_me or @player-options +offline_page creates
a subscription topic and shows you its URL. Subscribe to that topic in
the ntfy app or at ntfy.sh. Keep your personal topic URL private.
Either ntfy option enables the ntfy delivery adapter for eligible alerts.

Commands for your preferences
@notify status Show master switch, kinds and mute count.
@notify on Enable notifications.
@notify off Disable all notification kinds; clear
queued alerts and saved alert summaries.
@notify off <kind> Disable one kind.
@notify on <kind> Enable one kind again.
@notify off webpush Stop browser push delivery.
@notify on webpush Resume browser push delivery.
@notify mute <player> Suppress alerts attributed to this sender.
@notify unmute <player> Allow their alerts again.
@notify channel <name> on Opt into offline alerts for that channel.
@notify channel <name> off Remove that channel's offline opt-in.
@notify why Preview the first registered kind.
@notify why <kind> Explain what would happen right now.
@notify why <kind> full Show all delivery checks.
@notify why <kind> from <player>
Explain using that sender's mute/gag state.
@notify why from <player> Use the first registered kind.
@player-options Show your current player options.
@player-options -notify_me Disable this ntfy/idle-speech option.
@player-options -offline_page Disable this ntfy/offline-speech option.
Disable BOTH options to make the ntfy adapter unavailable.
Use lower-case "from" in the explanation command. With a sender, do not
append "full": the current parser treats it as part of the player's name.
@notify why is a preview; it does not send a test alert. It cannot prove
browser permission, successful phone delivery or that a source produced
an alert. @notify status does not list muted names or channel opt-ins.
Bare @notify and @notifications show notification status for everyone.
Use @ntfy for optional ntfy setup; see help notify-me.

Notification kinds
page Pages sent to you.
direct_say Speech directed to you, subject to the player options below.
direct_notify Legacy explicit alerts from the optional @ntfy feature.
channel Messages on channels you opted into.
room Missed output while disconnected, including nearby
speech and other output kept for catch-up.
event Calendar event reminders.
news News feed subscription updates.
fedi Federated social activity.
bluesky Bluesky activity.
ntfy_topic Private notices about ntfy subscription changes.
ntfy_topic notices are saved privately for login, rather than pushed.
Use these exact kind names with @notify on/off; @notify status shows
the current list. Example: @notify off room, then @notify on room.

How delivery works
While connected and active, ordinary speech, pages and channel messages
arrive normally. Eligible alert kinds can also appear in the game.
After more than 30 minutes without input, eligible alerts may also go
to a remote device. An @away message does not replace this idle check.
Offline, the router prefers Web Push, then ntfy if enabled and available.
It chooses one remote method, rather than sending through both.
If no remote method is available, or delivery fails, eligible alerts are
saved for your next login. Saved alerts expire according to their kind.
The login alert summary queue keeps at most 50 items, dropping the oldest.
Channel alerts require both the channel opt-in and @notify on channel.
To opt in, you must already be listening to the named channel.
Channel alerts are produced only while you are disconnected.
Directed speech uses +notify_me when connected and idle, and
+offline_page when disconnected, before the router checks preferences.
Turning on direct_say alone does not enable those source options.

Missed room output
The official client's Web Push connection can carry missed output as
room updates while you are disconnected. Speech prompts an earlier
update; background output is batched quietly. The current push window
is one hour since disconnect or your last offline command.
Up to 500 captured lines are kept for catch-up. On login, a
"While you were away" block replays missed lines, followed by any
saved alert summaries. Oldest lines can be lost when the limit is reached.
@notify off room stops these alert deliveries; it does not disable
capture or login replay. @notify off clears queued alerts and saved
alert summaries, but the separate missed-line backlog remains.
Room updates have no individual sender attribution, so muting a player
does not filter their text out of this catch-up stream.

Privacy and troubleshooting
Remote alerts normally show generic text instead of message contents.
The official client can still receive catch-up text in room
updates. These are delivery settings, not a way to erase room history.
There is currently no @notify command for choosing full message text.
The "Stop these" action on a Web Push notification leads to a
confirmation page which stops Web Push for your account.
Resume it with @notify on webpush. Other delivery methods remain eligible.
@notify off webpush may therefore leave ntfy or login summaries active.
There is no @notify off ntfy command: turn off BOTH ntfy player options.
Notifications default to on for registered kinds, but source subscriptions
and device setup still determine whether anything is generated or delivered.
Muted senders, your gag list and page refusal rules can block attributed
alerts. Guests do not receive alerts through this notification router.
If @notify why page says "already_told" while you are connected and
active, the page's normal delivery is sufficient; it is not a push error.
SMS, phone-number and email alert destinations have no player setup
commands in this notification system yet.
help notification-sources lists the calendar, Bluesky, fedi and news controls.

Other notification commands
help notify-me explains the optional Notify Me feature and its @ntfy command.
help @add-notify explains consensual notices when another player gets mail.
Mail forwarding and list subscriptions are separate from @notify:
see help mail-forwarding and help @subscribe.
@away [message] and @back set or clear your visible away status.
@clear-notifies is a staff command, not a personal notification setting.
See also: help notification-sources, help notify-me, help @add-notify, help mail.