diff --git a/welcomer.md b/welcomer.md new file mode 100644 index 0000000..f4629c6 --- /dev/null +++ b/welcomer.md @@ -0,0 +1,60 @@ +# 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 `normal` mode and a specialized `solstira` mode 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 `normal` mode 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 ` + * Sets the welcome mode for the server. `normal` is for the simple, customizable message, while `solstira` is for the special event-style welcome. +* `/welcomeset toggle` + * Toggles the entire welcome system on or off for the server. +* `/welcomeset settings` + * Displays all the current settings for both `normal` and `solstira` modes in a clean embed. +* `/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 `normal` mode welcome messages will be sent. +* `/welcomeset normal message ` + * Sets the custom welcome message for `normal` mode. You can use placeholders like `{user.mention}`. + +### Solstira Mode Settings (`/welcomeset solstira ...`) + +These commands configure the special, complex welcome message. + +* `/welcomeset solstira channel <#channel>` + * Sets the channel where the `solstira` mode welcome message will be sent. +* `/welcomeset solstira role <@role>` + * Sets the role that will be mentioned in the `solstira` welcome. +* `/welcomeset solstira guidelink ` + * Sets the URL for the `guide` section of the message. +* `/welcomeset solstira roleslink ` + * Sets the URL for the `roles` section of the message. +* `/welcomeset solstira psalink ` + * Sets the URL for the `psa` section of the message. + +## 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. \ No newline at end of file