Clone
1
welcomer
Unstable Kitsune edited this page 2025-09-24 00:27:50 -04:00
Welcomer Cog
The Welcomer cog is a configurable system designed to automatically greet new users when they join a server. It features multiple modes to handle different welcome styles, from simple text messages to complex, multi-line embeds.
1. Features
- Multi-Mode System: Supports a simple
normalmode and a specializedsolstiramode for complex, pre-formatted welcome messages. - Fully Configurable: All aspects, including channels, messages, roles, and links, are managed via simple hybrid commands.
- Placeholder Support: The
normalmode message can be personalized with user and server details. - Enable/Disable: The entire system can be toggled on or off without losing saved settings.
2. Admin Commands
All configuration is handled through the /welcomeset command group. These are hybrid commands and can be run with either a slash (/) or your bot's prefix ([p]).
Global Settings
/welcomeset mode <normal|solstira>- Sets the welcome mode for the server.
normalis for the simple, customizable message, whilesolstirais for the special event-style welcome.
- Sets the welcome mode for the server.
/welcomeset toggle- Toggles the entire welcome system on or off for the server.
/welcomeset settings- Displays all the current settings for both
normalandsolstiramodes in a clean embed.
- Displays all the current settings for both
/welcomeset test- Sends a preview of the currently configured welcome message to the channel where the command is run. This is useful for testing your format without needing a new user to join.
/welcomeset reset- Resets all welcomer settings for the server back to their defaults after a confirmation.
Normal Mode Settings (/welcomeset normal ...)
These commands configure the simple welcome message.
/welcomeset normal channel <#channel>- Sets the channel where
normalmode welcome messages will be sent.
- Sets the channel where
/welcomeset normal message <message>- Sets the custom welcome message for
normalmode. You can use placeholders like{user.mention}.
- Sets the custom welcome message for
Solstira Mode Settings (/welcomeset solstira ...)
These commands configure the special, complex welcome message.
/welcomeset solstira channel <#channel>- Sets the channel where the
solstiramode welcome message will be sent.
- Sets the channel where the
/welcomeset solstira role <@role>- Sets the role that will be mentioned in the
solstirawelcome.
- Sets the role that will be mentioned in the
/welcomeset solstira guidelink <link>- Sets the URL for the
guidesection of the message.
- Sets the URL for the
/welcomeset solstira roleslink <link>- Sets the URL for the
rolessection of the message.
- Sets the URL for the
/welcomeset solstira psalink <link>- Sets the URL for the
psasection of the message.
- Sets the URL for the
3. Placeholders for Normal Mode
You can use the following placeholders in your custom normal mode welcome message:
{user}: The user object.{user.mention}: Pings the new user (e.g.,@UnstableKitsune).{user_name}: The new user's name without the discriminator.{server_name}: The name of the server they joined.