Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/custom-bot/modules/community/activity-streak.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Reward users for being active every day, week, or month with an activity score t
- In automatic mode, the bot tracks user activity based on messages sent. When a user sends a message during a new period, their streak is incremented. If they miss an entire period, their streak resets to zero.
- In staff-managed mode, staff members use [`/streak add`](#commands) to manually add streak points to users.
- Users can view their current and longest streak using [`/streak view`](#commands).
- If streak restoration is enabled, users who lost their streak can use [`/streak restore`](#commands) to recover it once.
- If streak restoration is enabled, users who lost their streak can use [`/streak restore`](#commands) to recover it once. You can optionally set a time limit (in days) after which a lost streak can no longer be restored. Restoring keeps the higher of the current and previous streak, so a member who already started a new streak never loses progress.
- When a user reaches a streak count that matches a configured role reward, the role is automatically assigned.

## Commands {#commands}
Expand All @@ -43,7 +43,7 @@ Reward users for being active every day, week, or month with an activity score t
| `/streak add user:<User>` | Manually add a streak point to a user. Only available in staff-managed mode. Requires a configured staff role. |
| `/streak remove user:<User>` | Subtract one from a user's streak count. Useful for correcting mistakes without fully resetting. Only available in staff-managed mode. Requires a configured staff role. |
| `/streak reset user:<User>` | Fully reset a user's streak, clearing both the current streak and any saved backup, and removing all streak-related roles. Only available in staff-managed mode. Requires a configured staff role. |
| `/streak restore [user:<User>]` | Restore a previously lost streak. Only available if streak restoration is enabled. Can only be used once per streak loss. |
| `/streak restore [user:<User>]` | Restore a previously lost streak. Only available if streak restoration is enabled. Can only be used once per streak loss, and only within the configured restore time limit (if one is set). |
| `/streak leaderboard` | Show the top 20 active streaks on the server. Available in both staff-managed and automatic modes. |
| `/streak hide` | Toggle whether your streak is displayed in your nickname. Only available when nickname display is enabled and the "Allow users to hide streak from nickname?" option is turned on. |

Expand All @@ -65,6 +65,7 @@ In this configuration file, you can configure the module. Open it in your [dashb
| Ignored Roles | Roles whose members' messages do not count toward streaks. |
| Enable Restore | If enabled, users can restore a lost streak once per loss. |
| Restore Roles | Roles that are allowed to use the restore command. If empty, all users can restore. |
| Restore time limit (days) | How many days after losing a streak users can still restore it with `/streak restore`. Set to `0` for no time limit. Only applies when "Enable Restore" is turned on. |

## Troubleshooting {#troubleshooting}

Expand Down Expand Up @@ -103,6 +104,7 @@ The following data is being stored about every user with an active or previous s
- The last activity date, week, or month (depending on the configured period)
- The previous streak count (for restoration purposes)
- The timestamp of the last restoration
- The timestamp when the streak was last lost (used to enforce the restore time limit)
- Metadata about the entry (date when created and last updated)

To remove all data stored by this module, [purge the module database](/docs/custom-bot/additional-features#reset-module-database).
3 changes: 2 additions & 1 deletion docs/custom-bot/modules/community/birthday.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Let users set their birthday and congratulate them when they have a birthday.
- The bot automatically sends birthday congratulation messages every day at midnight.
- Optionally assign a birthday role to users on their birthday (removed automatically the next day).
- If a user provides their birth year, the congratulation message can include their age.
- Optional pre-birthday notifications posted in the birthday channel a configurable number of days before a user's birthday. Multiple lead times can be configured (e.g. both 7 days and 1 day before).
- Optional pre-birthday notifications posted a configurable number of days before a user's birthday. Multiple lead times can be configured (e.g. both 7 days and 1 day before), and they can optionally be routed to their own channel, separate from the actual congratulation messages.
- `/birthday upcoming` lets any member preview the next N days of upcoming birthdays without browsing the embed.
- Birthday data is automatically removed when a member leaves the server.
- Optional admin birthday management: admins can set, remove, lock, and unlock user birthdays.
Expand Down Expand Up @@ -104,6 +104,7 @@ The configuration is organized into tabs in the dashboard - the rows below are g
| Field | Description |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Enable pre-birthday notifications? | If enabled, the bot posts a notification in the birthday channel a configurable number of days before each user's birthday. |
| (optional) Pre-Birthday-Channel | _Only visible if pre-birthday notifications are enabled._ Optional separate channel for pre-birthday reminders. If empty, they are sent to the notification channel (if set) or otherwise the birthday channel. Use this to keep pre-birthday reminders apart from the actual "Happy birthday" messages. |
| Pre-birthday lead times (days) | _Only visible if pre-birthday notifications are enabled._ List of lead times (in days) before a birthday at which to post a notification. For example, `[1, 7]` sends a notification both 7 days and 1 day before the birthday. |
| Pre-birthday message | _Only visible if pre-birthday notifications are enabled._ The pre-birthday message sent for users who did not provide a birth year. The `%days%` placeholder gives the number of days remaining. |
| Pre-birthday message with age | _Only visible if pre-birthday notifications are enabled._ The pre-birthday message sent for users who did provide a birth year. Supports the `%age%` placeholder for the age the user will turn. |
Expand Down
6 changes: 6 additions & 0 deletions docs/custom-bot/modules/community/serverinfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ Display an auto-updating embed with server statistics and information in a chann

<ModuleOverview moduleName="serverinfo" />

:::tip Looking for more? Try Live Messages
The [Live Messages](/docs/custom-bot/modules/community/live-messages) module can do everything this module does and more: multiple auto-updating messages across different channels, full message formatting (not just a single embed), extra statistics (voice/idle/DND counts, channel-type breakdowns, stickers, and more), and live stats pulled from other modules (tickets, giveaways, economy, levels, and more).

If you only need a single, simple server-information embed, this module stays a great, focused choice. If you want richer or multiple stat displays, use Live Messages instead. There is no automatic migration between the two - you would recreate the content in Live Messages by hand.
:::

## Features {#features}

- Displays an auto-updating embed with customizable server information in a designated channel.
Expand Down
Loading
Loading