Utility¶
The Utility module provides helpful commands for everyday server management and user interaction. These commands cover a wide range of utilities including polls, reminders, user information, encoding tools, and server status checks.
These practical tools enhance server functionality and user experience by helping keep your server organized and engaging. From creating polls to setting reminders and checking server status, the Utility module provides the essential toolkit for active community management.
Command Groups¶
This module includes the following command groups:
Wiki¶
The /wiki command group provides quick access to specialized documentation wikis.
Commands:
/wiki arch- Search the Arch Linux Wiki/wiki atl- Search the All Things Linux Wiki
Commands¶
| Command | Description | Documentation |
|---|---|---|
/ping |
Check bot latency and status | Details |
/poll |
Create a poll with multiple options (Slash only) | Details |
/remindme |
Set a reminder for yourself | Details |
/afk |
Set or clear your AFK status | Details |
/wiki |
Search Wikipedia | Details |
/encode /decode |
Encode or decode text | Details |
/timezones |
View current times across the globe | Details |
/self_timeout |
Time yourself out | Details |
$run |
Run code snippets (Prefix only) | Details |
Common Use Cases¶
Server Status Check¶
Quickly check if the bot is online and responsive to ensure it is functioning correctly.
Steps:
- Use the
/pingcommand in any text channel. - Observe the bot's response time (latency).
Example:
/ping
Creating Polls¶
Get community feedback on decisions or topics by creating interactive polls.
Steps:
- Use the
/pollcommand with a title and comma-separated options. - The bot will create a message with reaction buttons for each option.
- Users can vote by clicking the reactions.
Example:
/poll title:"What should we do next?" options:"Option 1, Option 2, Option 3"
Setting Reminders¶
Set personal reminders for important events or tasks.
Steps:
- Use the
/remindmecommand with a duration and the reminder text. - Tux will set a timer and DM you (or message the channel) when the time expires.
Example:
/remindme time:2h reminder:"Check the announcement channel"
Permissions¶
Bot Permissions¶
Tux requires the following permissions for this module:
- Send Messages - Required for command responses
- Add Reactions - Required for creating interactive polls
- Manage Messages - Required for some utility functions and cleanup
- Embed Links - Required for rich utility responses
User Permissions¶
Most utility commands are available to all users by default. Some advanced commands like $run may require higher permission ranks.
Permission System
Tux uses a dynamic permission system. Configure command permissions via /config commands or see the Permission Configuration guide.