@helyx/module-afk

AFK lets members set server-specific away statuses and provides bounded notices when another human member mentions somebody who is away.

Availability and deployment

AFK is Live and supported by Hosted Helyx and Helyx Self-Hosted. It depends only on Helyx runtime services and Discord capabilities available in both deployment modes.

What it does

A member can store one optional 300-character away message, choose manual or next-message clearing, and optionally set an expiry between five minutes and 30 days. Structural Discord mentions can produce one cooldown-protected notice. AFK does not inspect source-message content, change nicknames, or expose away messages in the dashboard.

Commands and interactions

| Path | Default access | Purpose | | ------------- | -------------- | --------------------------------------------------------- | | /afk set | Everyone | Create or replace the member's status and clearing rule. | | /afk clear | Everyone | Manually clear the member's active status. | | /afk status | Everyone | Privately inspect the caller's or another member's state. |

Dashboard configuration

AFK has no server settings or manager-visible member list. The dashboard provides enablement, command permissions, and optional Logging event configuration only.

Discord requirements

Helyx needs View Channel and Send Messages where AFK commands and notices are used. AFK does not require Administrator, Manage Nicknames, Manage Roles, Message Content, or the Server Members privileged intent.

Data, privacy and retention

AFK retains the server ID, member ID, optional away message, clear rule, expiry, lifecycle state, generation fence, and timestamps. Cleared and expired records remain for seven days for safe task and duplicate handling. Privacy access and erasure cover these records even while AFK is disabled; source messages and mention history are not stored.

Operations and failure behavior

The server supports at most 10,000 active statuses. Expiry uses the durable scheduler, message-based clearing uses the bounded guild-message event, and mention notices fail closed when the shared cooldown is unavailable. Storage, scheduling, or validation failure does not leave a partially updated status. Disabling AFK blocks commands and events immediately while retaining records for normal lifecycle handling.

Documentation and support

See the AFK guide, commands, permissions, and FAQ.