Unstable Kitsune
e552ba7552
Refactors simple welcomer to support custom messages, channels, and toggles. Adds command group for admins to manage server-specific settings, placeholders for personalization, and built-in safety checks for permissions and channel validity. Enhances event handling with better error management and logging.
82 lines
2.4 KiB
Markdown
82 lines
2.4 KiB
Markdown
# Welcomer Cog - ver-1.0.0
|
|
A configurable cog to automatically welcome new users when they join your server.
|
|
|
|
# Features
|
|
- Fully Configurable: Set a custom welcome message and channel for each server.
|
|
- Enable/Disable: Easily toggle the welcomer on or off without losing your settings.
|
|
- Placeholder Support: Personalize your welcome message with user and server details.
|
|
- Easy Setup: A simple command group for admins to manage all settings.
|
|
- Permissions: All settings commands require `Manage Server` permissions to use.
|
|
|
|
# Commands
|
|
All configuration is handled through the `[p]welcomeset` command group.
|
|
|
|
[p]welcomeset channel <#channel>
|
|
Sets the channel where welcome messages will be sent.
|
|
|
|
Alias: chnl
|
|
|
|
Example: [p]welcomeset channel #welcome
|
|
|
|
[p]welcomeset message <message>
|
|
Sets the custom welcome message. See the "Placeholders" section below for available variables.
|
|
|
|
Alias: msg
|
|
|
|
Example: [p]welcomeset message Welcome {user.mention} to {server_name}! We're glad you're here.
|
|
|
|
[p]welcomeset toggle
|
|
Toggles the welcomer system on or off for the server.
|
|
|
|
Aliases: on, off
|
|
|
|
Example: [p]welcomeset toggle
|
|
|
|
[p]welcomeset settings
|
|
Displays the current settings for the welcomer in an embed.
|
|
|
|
Aliases: show, status
|
|
|
|
Example: [p]welcomeset settings
|
|
|
|
[p]welcomeset test
|
|
Sends a preview of the current welcome message to the channel where the command is run.
|
|
|
|
Example: [p]welcomeset test
|
|
|
|
[p]welcomeset reset
|
|
Resets all welcomer settings for the server to their default values.
|
|
|
|
Example: [p]welcomeset reset
|
|
|
|
Quick Setup Guide
|
|
Load the Cog:
|
|
|
|
[p]load welcomer
|
|
|
|
Set the Welcome Channel:
|
|
|
|
[p]welcomeset channel #your-welcome-channel
|
|
|
|
Set Your Custom Message:
|
|
|
|
[p]welcomeset message Welcome, {user.mention}! Enjoy your stay in {server_name}!
|
|
|
|
Enable the System:
|
|
|
|
[p]welcomeset toggle
|
|
|
|
The bot will now welcome new members in the channel you specified. You can use [p]welcomeset settings at any time to check your configuration.
|
|
|
|
Placeholders for the Welcome Message
|
|
You can use the following placeholders in your custom welcome message. They will be automatically replaced with the correct information when a new user joins.
|
|
|
|
{user}: The user object itself.
|
|
|
|
{user.mention}: Pings the new user (e.g., @UnstableKitsune).
|
|
|
|
{user_name}: The new user's name (e.g., UnstableKitsune).
|
|
|
|
{server_name}: The name of the server they joined.
|
|
|
|
For full documentation, please visit the [repository wiki](https://git.kitsunic.org/kitsunicWorks/unstable-cogs/wiki). |