@helyx/module-levels
v1.0.10
Published
Optional participation levels and rewards.
Downloads
1,386
Readme
Levels
Levels is an optional participation module. It awards a configurable amount of XP for eligible server messages without receiving raw message content or attachments, and without storing message content, attachments or message IDs. Managers may optionally select bounded message types classified transiently by the core Discord adapter.
Progression
The module uses one fixed formula:
XP required for level L = 100 × L²
level = floor(square root(total XP ÷ 100))XP is buffered by a core-owned write-behind service and committed in bounded, idempotent database batches. A normal flush occurs after about 30 seconds. Rank reads include pending XP; leaderboards first establish a flushed durable server snapshot. A simple single-process or self-hosted bot uses a bounded memory buffer and may lose only its uncommitted buffer after an abrupt process crash. Coordinated hosted operation requires the persistent shared supervisor-owned Redis accumulator and never exposes Redis credentials to module code or shard workers.
Eligibility and privacy
Server managers may use all channels or choose only eligible channels, select eligible message types and exclude roles. Threads inherit their parent channel's eligibility. Bots, webhooks, Discord system messages and direct messages never earn XP.
The durable member row stores only the Discord server and user IDs, total XP, award count and progression timestamps. It does not store message content, attachments, message IDs, usernames, avatars, channel names or role names. Current member names are resolved from Discord only for an authorised command or dashboard view. Disabling or removing the module retains progression; permanent deletion is an explicit, exact-server operation.
Commands
/rank [member]shows current server progression without pinging the member./leaderboardshows current human members and skips retained departed or bot records./levels statusshows the active server configuration./levels manageopens the authorised XP-adjustment workflow.
Manual changes flush the target member, preview the exact before and after values, require confirmation, apply atomically and create an Admin audit record. One adjustment is limited to 1,000,000 XP.
Discord permissions
Levels declares View Channel, Send Messages, Embed Links and Manage Roles. Manage Roles is needed only for configured reward roles, which must remain below Helyx's highest editable role. A role or announcement failure never rolls back saved XP.
Release state
Version 1.0.0 is unpublished and in Testing. Publication, catalogue inclusion and Live hosted or self-host distribution require explicit owner approval and retained real-Discord evidence.
