# Table of Contents - [BotGhost Documentation](#botghost-documentation) - [Changelogs | Changelog | BotGhost Documentation](#changelogs-changelog-botghost-documentation) - [Changelogs - 2023 | Changelog | BotGhost Documentation](#changelogs-2023-changelog-botghost-documentation) - [Changelogs - 2025 | Changelog | BotGhost Documentation](#changelogs-2025-changelog-botghost-documentation) - [Changelogs - 2024 | Changelog | BotGhost Documentation](#changelogs-2024-changelog-botghost-documentation) - [Verification | BotGhost Documentation](#verification-botghost-documentation) - [Emoji Manager | BotGhost Documentation](#emoji-manager-botghost-documentation) - [Auto-React | BotGhost Documentation](#auto-react-botghost-documentation) - [Discord Automod | BotGhost Documentation](#discord-automod-botghost-documentation) - [Sticky Messages | BotGhost Documentation](#sticky-messages-botghost-documentation) - [Action Events | BotGhost Documentation](#action-events-botghost-documentation) - [IFTTT | BotGhost Documentation](#ifttt-botghost-documentation) - [Timed Events | BotGhost Documentation](#timed-events-botghost-documentation) - [Modmail | BotGhost Documentation](#modmail-botghost-documentation) - [Polls Filter | BotGhost Documentation](#polls-filter-botghost-documentation) - [Reaction Roles | BotGhost Documentation](#reaction-roles-botghost-documentation) - [Question Of The Day | BotGhost Documentation](#question-of-the-day-botghost-documentation) - [Moderation | BotGhost Documentation](#moderation-botghost-documentation) - [Timed Messages | BotGhost Documentation](#timed-messages-botghost-documentation) - [Polls | BotGhost Documentation](#polls-botghost-documentation) - [Starboard | BotGhost Documentation](#starboard-botghost-documentation) - [Premium Check Condition | BotGhost Documentation](#premium-check-condition-botghost-documentation) - [Objects | BotGhost Documentation](#objects-botghost-documentation) - [ChatGPT | BotGhost Documentation](#chatgpt-botghost-documentation) - [Sticky Roles | BotGhost Documentation](#sticky-roles-botghost-documentation) - [Collections | BotGhost Documentation](#collections-botghost-documentation) - [Text Option | BotGhost Documentation](#text-option-botghost-documentation) - [Suggestions | BotGhost Documentation](#suggestions-botghost-documentation) - [Statistic Channels | BotGhost Documentation](#statistic-channels-botghost-documentation) - [Roblox Verification | BotGhost Documentation](#roblox-verification-botghost-documentation) - [Welcomer | BotGhost Documentation](#welcomer-botghost-documentation) - [Global Chat | BotGhost Documentation](#global-chat-botghost-documentation) - [Media Channels | BotGhost Documentation](#media-channels-botghost-documentation) - [Counting | BotGhost Documentation](#counting-botghost-documentation) - [Temp Voice Channels | BotGhost Documentation](#temp-voice-channels-botghost-documentation) - [Chance Condition | BotGhost Documentation](#chance-condition-botghost-documentation) - [Events | BotGhost Documentation](#events-botghost-documentation) - [Weather | BotGhost Documentation](#weather-botghost-documentation) - [Data Storage | BotGhost Documentation](#data-storage-botghost-documentation) - [Autoresponder | BotGhost Documentation](#autoresponder-botghost-documentation) - [Invite Tracker | BotGhost Documentation](#invite-tracker-botghost-documentation) - [Channel Condition | BotGhost Documentation](#channel-condition-botghost-documentation) - [Webhooks | BotGhost Documentation](#webhooks-botghost-documentation) - [Choice Option | BotGhost Documentation](#choice-option-botghost-documentation) - [Options | BotGhost Documentation](#options-botghost-documentation) - [Image Generation | BotGhost Documentation](#image-generation-botghost-documentation) - [Embed Builder | BotGhost Documentation](#embed-builder-botghost-documentation) - [Channel Option | BotGhost Documentation](#channel-option-botghost-documentation) - [Attachment Option | BotGhost Documentation](#attachment-option-botghost-documentation) - [Number Option | BotGhost Documentation](#number-option-botghost-documentation) - [Role Option | BotGhost Documentation](#role-option-botghost-documentation) - [User Option | BotGhost Documentation](#user-option-botghost-documentation) - [Translation | BotGhost Documentation](#translation-botghost-documentation) - [Music Smart Search Option | BotGhost Documentation](#music-smart-search-option-botghost-documentation) - [Economy & Minigames | BotGhost Documentation](#economy-minigames-botghost-documentation) - [Music | BotGhost Documentation](#music-botghost-documentation) - [Birthdays | BotGhost Documentation](#birthdays-botghost-documentation) - [Leveling | BotGhost Documentation](#leveling-botghost-documentation) --- # BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) ![Page cover](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FPc9eFFzUfACpuJ1Wv4zf%252FBotghost%2520docs%2520banner-01.png%3Falt%3Dmedia%26token%3Df18c9704-70fe-4076-83b9-42dd890aa219&width=1248&dpr=3&quality=100&sign=bd5cd8ee&sv=2) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/welcome.md) . [View Topics](https://documentation.botghost.com/#get-started-with-botghost) arrow-right Thank you for choosing BotGhost! We're excited to help you on your journey to creating your own custom BotGhost bot! Here you'll find everything you need to build and customize your bot. To get started, **ask our AI** a question or check out the **main topics** below. You can also explore our **Table of Contents** on the left, and select the feature you're interested in. If your question is not answered on one of the pages, do not hesitate to join our Discord server at [discord.gg/botghost](https://discord.gg/botghost) for further support! Happy building! [](https://documentation.botghost.com/#get-started-with-botghost) Get started with BotGhost ------------------------------------------------------------------------------------------------ [](https://documentation.botghost.com/getting-started/create-your-first-bot) ![Cover](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F6C2JhTufCe3jQm7wYVzV%252Fcreate%2520bot-01.png%3Falt%3Dmedia%26token%3Df96b0067-d0c5-4605-aa50-749a72f72c15&width=490&dpr=3&quality=100&sign=1e78ae48&sv=2) **Creating a bot** Learn how to create and add to a server your bot. [](https://documentation.botghost.com/premium/our-premium-features) ![Cover](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fw0bYzwT58EMiC1EvyyNO%252Fpremium-01.png%3Falt%3Dmedia%26token%3D54f2788a-53fd-4a47-a8cc-82d7c80057bf&width=490&dpr=3&quality=100&sign=4722c4be&sv=2) **Premium** Discover our premium features and perks. [](https://documentation.botghost.com/changelog/) ![Cover](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F7GS7ersBR7XHQUECTSCU%252Fchangelogs-01.png%3Falt%3Dmedia%26token%3D4205abb5-8cc1-47a6-aefc-70d217dc3b00&width=490&dpr=3&quality=100&sign=23536ef9&sv=2) **Changelogs** See what's new. [](https://documentation.botghost.com/custom-commands-and-events/command-and-event-builder) ![Cover](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F2MCCq13Jo3EAW9ejheQN%252Fcommand%2520builder-01.png%3Falt%3Dmedia%26token%3Dec7c8a19-75f9-447d-b7d7-e15e6f1de7a2&width=490&dpr=3&quality=100&sign=b9fe07f3&sv=2) **Command Builder** Check out our advanced command and event builder. [](https://documentation.botghost.com/custom-commands-and-events/actions) ![Cover](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FTbd8nD5zogbH197PlUub%252Factions-01.png%3Falt%3Dmedia%26token%3D87b8e276-95cf-409e-b32c-ac9c98302055&width=490&dpr=3&quality=100&sign=e6f9625f&sv=2) **Actions** Learn what your BotGhost bot can do without a single line of code needed. [](https://documentation.botghost.com/custom-commands-and-events/variables) ![Cover](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FpOZksKRGx9MlMtVcV7yR%252Fvariables-01.png%3Falt%3Dmedia%26token%3D57616571-6078-4009-a6f9-9409283b9ab4&width=490&dpr=3&quality=100&sign=2eb0b69b&sv=2) **Variables** View a list of all variables you can use in the command builder. Last updated 5 months ago Was this helpful? Was this helpful? --- # Changelogs | Changelog | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/changelog/current.md) . [Previous Year (2025)](https://documentation.botghost.com/changelog/2025) February 7, 2026 [](https://documentation.botghost.com/changelog#botghost-is-now-on-ios) BotGhost is Now on iOS --------------------------------------------------------------------------------------------------- We’re excited to officially launch the **BotGhost iOS app**. Manage your Discord bots anywhere, anytime — straight from your phone. ### [](https://documentation.botghost.com/changelog#new-ios-app) New iOS App * Manage your bots on the go * Get real-time updates * Access all premium features * Clean, fast, and mobile-first experience Download it on the [Appstore](https://apps.apple.com/us/app/botghost/id6757778695) . January 18, 2026 [](https://documentation.botghost.com/changelog#module-updates) Module Updates ----------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/changelog#economy-and-minigames) Economy & Minigames * /lottery view command fixed when viewing the next lottery when there were 10 or more entrants * /lightout now checks if you were the command user for the start button prior to the start of the game * /rob bank now makes the target of the robbery safe as soon as the join message appears, stopping people from trying to rob them twice * /dos no longer causes the bot to keep "thinking" * The "Message Award Cooldown" field in the dashboard can now be set to a value of 1. Previously the limit was 2 * /hangman "This is not your game!" message removed. ### [](https://documentation.botghost.com/changelog#moderation) Moderation * Autopunishments were broken because of a small issue with a flipped comparison condition and it didn't reset the vars after an autopunishment. * /ban add reason fixed to check the correct character limit * /ban add reason will check if it contains invalid characters (kinda) and stop the command * /warn fixed small permissions check for moderators * /case view removed role hierarchy check * typo in /role remove January 8, 2026 [](https://documentation.botghost.com/changelog#economy-module-update) Economy Module Update ------------------------------------------------------------------------------------------------- We can finally get formatted currency into the Economy module! This is now released alongside just a few other items: * /money audit - now shows currency with formatting, eg: 4,000 or 4,500,000 * All other commands that would show currency will also format correctly _Note: The default behaviour is to format the currency with commas as a delimiter, however there is a variable to format it another way, eg: 4.000 or 4.500.000. If you would like to change it, you will need to edit each command._ * /dicebet - If both players roll the same number, instead of both players losing, both players will now win * Finally fixed the issue where user tags were replaced with userids - the module will remember to use tags once again * Some very minor typos and grammatical errors (They were so tiny I don't remember where they were - there also might still be others) January 6, 2026 [](https://documentation.botghost.com/changelog#module-updates-and-bug-fixes--tickets-updates) Module Updates & Bug Fixes + Tickets Updates ------------------------------------------------------------------------------------------------------------------------------------------------ Hey everyone! We're starting the new year with some module bug fixes and a major update to our Tickets module ### [](https://documentation.botghost.com/changelog#tickets-major-update) Tickets - Major Update * We've added a new transcript mode, which uses the Create a transcript action that was released a few weeks ago * In the Transcripts section, you can now choose which transcript mode you want to use (web or thread transcript) * You can select the theme you prefere (Simple or Discord) * You can also setup permissions, to determine who should be able to view or download transcripts, and even lock ticket transcripts behind a password * Transcripts are created when the ticket is closed. If two step close is off, the transcript will be created before the ticket is deleted * Thread based transcripts remain unchanged * Fixed an issue that caused user options to not work as intended * Fixed some visual issues * Improved error handling for thread based transcripts ### [](https://documentation.botghost.com/changelog#starboard) Starboard * Fixed an issue that caused starboard messages to break with characters such as \[\] * Improved overall security and reliability of the module ### [](https://documentation.botghost.com/changelog#leveling) Leveling * Fixed an issue that caused user options to not work as intended Last updated 4 months ago Was this helpful? * [BotGhost is Now on iOS](https://documentation.botghost.com/changelog#botghost-is-now-on-ios) * [New iOS App](https://documentation.botghost.com/changelog#new-ios-app) * [Module Updates](https://documentation.botghost.com/changelog#module-updates) * [Economy & Minigames](https://documentation.botghost.com/changelog#economy-and-minigames) * [Moderation](https://documentation.botghost.com/changelog#moderation) * [Economy Module Update](https://documentation.botghost.com/changelog#economy-module-update) * [Module Updates & Bug Fixes + Tickets Updates](https://documentation.botghost.com/changelog#module-updates-and-bug-fixes--tickets-updates) * [Tickets - Major Update](https://documentation.botghost.com/changelog#tickets-major-update) * [Starboard](https://documentation.botghost.com/changelog#starboard) * [Leveling](https://documentation.botghost.com/changelog#leveling) Was this helpful? --- # Changelogs - 2023 | Changelog | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/changelog/2023.md) . [Current Year](https://botghost.com/docs/changelog/current) [Next Year (2024)](https://documentation.botghost.com/changelog/2024) [](https://documentation.botghost.com/changelog/2023#new-module-invite-tracker-december-22nd-2023) New Module: Invite Tracker - December 22nd, 2023 -------------------------------------------------------------------------------------------------------------------------------------------------------- We are introducing a new module today, that helps you track how many new users your members have invited to your server. You can customise various settings, such as sending a message/DM every time a user is invited, blacklisting users, filtering suspicious invites, giving out role rewards, and changing the behavior of the commands. The module will also automatically check for your existing invites and will import them to your invite counts. This module is available for both free and premium users. [](https://documentation.botghost.com/changelog/2023#ifttt-integration-december-20th-2023) IFTTT Integration - December 20th, 2023 --------------------------------------------------------------------------------------------------------------------------------------- We have just released the ability to connect your discord bot to IFTTT. IFTTT Allows you to connect over 700 different services to your Discord Bot through applets and connections. In BotGhost you can both trigger custom events through outside services on IFTTT or trigger actions on IFTTT through the new IFTTT Action block. ### [](https://documentation.botghost.com/changelog/2023#linking-ifttt-to-botghost) **Linking IFTTT to BotGhost** To get started with IFTTT you must first link your IFTTT account to your BotGhost account. To do so head over to the BotGhost IFTTT page and click Connect to begin this process. This will prompt you to log in and redirect you to the BotGhost dashboard where you must give permission to link your BotGhost account to IFTTT. Click Authorize to confirm the BotGhost x IFTTT link. ### [](https://documentation.botghost.com/changelog/2023#ifttt-applets) **IFTTT Applets** Applets are the backbone of IFTTT. Applets use a customizable script to link two or more apps that normally remain separate. Within BotGhost, we use IFTTT Applets to either trigger custom events or trigger other service actions on IFTTT. ### [](https://documentation.botghost.com/changelog/2023#action-block-triggered-ifttt-triggers) **Action Block Triggered (IFTTT Triggers)** The Action Block Triggered IFTTT Trigger executes an Applet when an Execute an IFTTT Trigger action block in a custom command or event is run. For example, you could trigger a tweet from a custom command, change your apartment lights, or post a new photo to Instagram. ### [](https://documentation.botghost.com/changelog/2023#trigger-a-custom-event-ifttt-actions) **Trigger a Custom Event (IFTTT Actions)** In IFTTT actions are the result of an Applet. They are what are run when triggered by an IFTTT trigger. In BotGhost, the IFTTT Action is the execution of a custom event. This allows you to trigger custom events when something outside of BotGhost happens. For example, you could send notifications of going live on Twitch and Kick or get weather alerts as soon as they happen. ### [](https://documentation.botghost.com/changelog/2023#subscription-for-ifttt) **Subscription for IFTTT** The basics of IFTTT are available for free. Do you want to use all of the features of IFTTT, you can upgrade at [**https://ifttt.com/plans**](https://ifttt.com/plans) . **BotGhost IFTTT Page:** [**https://ifttt.com/botghost**](https://ifttt.com/botghost) [](https://documentation.botghost.com/changelog/2023#november-december-module-updates-december-16th-2023) November - December Module Updates - December 16th, 2023 ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/changelog/2023#starboard) Starboard The Starboard module has been updated. The update includes: * Better attachments and embeds handler. Embeds and attachments are now listed in the fields of the message posted in the Starboard channel * You can now starboard a message that has been sent in the starboard channel * Minor changes as well as some fixes ### [](https://documentation.botghost.com/changelog/2023#chatgpt) ChatGPT We also made the following smaller changes to the ChatGPT module: * Errors are now handled better, in a more user-friendly and simple way * The GPT-4-1106 Preview model is available to use, which is a cheaper model of OpenAI, and has knowledge up to April 2023 * Bug fixes and improvements [](https://documentation.botghost.com/changelog/2023#delete-message-by-id-create-server-invite-action-and-interaction-variables-december-7th-2023) **Delete Message by ID, Create Server Invite Action & Interaction Variables - December 7th, 2023** ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **Delete Message by Id** You can now delete specific messages by their ids using the Delete Message action. You will need to provide a channel id also so that the message can be found. **Create Server Invite Action** The create server invite action allows you to create a server invite to a channel. You can specific the maximum age in seconds, uses, whether to create a unique invite and whether users should be kicked after 24hours if they do not receive a role. You can also specify a variable to use the invite url in other actions. **Interaction Id & Token Variables** We have added {interaction\_token} and {interaction\_id} variables which you can use in API requests. [](https://documentation.botghost.com/changelog/2023#new-premium-module-media-channels-october-31st-2023) New Premium Module: Media Channels - October 31st, 2023 ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- We have created a new utility module with our module creation system, that lets you set up image-only channels across your server! The module allows you to either choose a text or a forum channel during the setup, which will restrict users to only send messages containing images to the channel. You can set up a slow mode across all your media channels, choose the allowed media types/file extensions, maximize the number of images that can be sent, allow GIFs, and set up additional filters. **The module is now available for all premium users** [](https://documentation.botghost.com/changelog/2023#new-premium-module-temporary-voice-channels-october-30th-2023) New Premium Module: Temporary Voice Channels - October 30th, 2023 ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ We are releasing a new module today, which allows your server members to create their personal, temporary voice channels. You will be able to select a voice channel to use as a hub, which people will need to join to have their own channels. Once all users leave a temporary voice channel, it will be deleted automatically. Additionally, you can also configure the channel's name, user limit, and bitrate, the time until a channel is deleted, whether the channel should be locked or not, and various other permission-related settings. **The module is now available for all premium users to use.** [](https://documentation.botghost.com/changelog/2023#free-bot-database-usage-changes--bug-fixes-october-25th-2023) Free Bot Database Usage Changes + Bug Fixes - October 25th 2023 --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * We have changed the way data storage usage is calculated and used across bots. * Usage is now being changed to Free Usage and is only used by non-premium bots. * Non-premium bots will have 5000 database usage to use every month that is shared across all your non-premium bots. * Updating and creating a variable on a free bot still uses 10 database usage. **TLDR:** Only free bots use Data storage usage now 5000 Shared across your free bots Premium bots have unlimited usage still Free usage resets on the 1st of every month. ### [](https://documentation.botghost.com/changelog/2023#bug-fixes) Bug Fixes * Vars can now be used in the topic of the create channel block * Vars can now be used in the emoji id of buttons * Removed the options connector from event nodes * Vars can now be used in the hex of the edit role action * hasRole and isChannel variables have been added to the variable selector * You can now disable premium modules after your premium subscription has expired * Fixed the description of the Add/Remove currency blocks * Fixed some docs links Fixed the wording of the command/event importer * You can now no longer save the Set Variable/Run equation blocks without first selecting a variable * Fixed a bug that caused form inputs to return the variable only when a user closes the form without submitting, and then reopens the form and submits. [](https://documentation.botghost.com/changelog/2023#new-module-rework-leveling-october-23rd-2023) New Module Rework: Leveling - October 23rd 2023 ------------------------------------------------------------------------------------------------------------------------------------------------------- We have updated the levels module using our new module creation system. The module is now called Leveling. This module will allow you to create a fully customizable leveling system for your server with role rewards, voice experience, and much more! The new module includes a lot of new features and improvements, including a better level-up message setup, a custom rank card, voice XP, role boosts, a reworked leaderboard within your server, and much more! **This module is available to all users immediately.** [](https://documentation.botghost.com/changelog/2023#polls-module-october-17th-2023) Polls Module - October 17th, 2023 --------------------------------------------------------------------------------------------------------------------------- We are introducing a new utility module today, Polls. You can use this module to post questions to your server members with pre-defined options, and let them vote on the topic. The module contains various customization settings as well, you are able to show/hide the author, set up the embeds style, configure emoji reactions, use single or multiple-choice modes, and modify other permission-related settings. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252F3Z4lsfyfNgSimS9bluG9%252Fimage.png%3Falt%3Dmedia%26token%3Dfb40d9fa-4ca3-44b4-bcdb-491d7a15fefc&width=768&dpr=3&quality=100&sign=79206291&sv=2) [](https://documentation.botghost.com/changelog/2023#deleting--editing-ephemeral-replies-and-bug-fixes-october-4th-2023) **Deleting + Editing Ephemeral Replies & Bug Fixes - October 4th 2023** ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/changelog/2023#deleting-and-editing-ephemeral-replies) **Deleting and Editing Ephemeral Replies** You can now delete and edit ephemeral (hidden) replies to interactions. This is done the same way as you would edit or delete any other message in the builder. Ephemerals can only be edited in the 'same interaction', meaning you can't edit a command reply with the click of a button. ### [](https://documentation.botghost.com/changelog/2023#bugs) **Bugs** * You can no longer duplicate an API action with the same name. * The market has been updated with the newer actions * Fixed the {Event\_channel\_parent\_id} variable in voice events * Fixed a rounding error in the {solve\_equation} variable (now rounds to two decimal places) * The test request timeout is now the same as the timeout of live requests * Reaction events are now no longer triggered by bots * Conditions with multiple conditions enabled now run at the same time * Removed redundant variables from the status module * Fixed a bug where the input of the title in the embed builder would freeze if the text went over 256 characters * Variables can now be used in the emoji\_id input of buttons * Channel options can now be used in the Purge block * Double quotes are now escaped by the escape\_characters variable * Added newer Discord Permissions * Messages related to logging events are now truncated if they go over 1024 characters. * Fixed a bug with the purge block if you set the message count to 100 * Fixed some descriptions of action blocks in the builder **These fixes + new additions are currently on the beta server only.** [](https://documentation.botghost.com/changelog/2023#timed-events-out-of-beta-september-13th-2023) **Timed Events Out Of Beta - September 13th, 2023** ----------------------------------------------------------------------------------------------------------------------------------------------------------- The Timed Evens module is now out of beta and available to all users. You can access the module here: [https://dashboard.botghost.com/dashboard/timedevents](https://dashboard.botghost.com/dashboard/timedevents) [](https://documentation.botghost.com/changelog/2023#timed-events-september-8th-2023) **Timed Events** - September 8th 2023 -------------------------------------------------------------------------------------------------------------------------------- We have released a new addition to the beta servers: timed events. Timed events allow you to trigger custom events at certain times during the day or on a consistent interval. **Interval Timed Events** Interval-timed events are triggered every set amount of seconds, minutes, hours, and days. You are able to enable and disable certain days for interval events to run on. **Scheduled Timed Events** Scheduled timed events run at exact times throughout the day. You are able to enable and disable certain days for scheduled events to run on. **Timezone** A timezone dropdown has been added to allow you to easily schedule your timed events for your timezone. On the first load of the Timed Events page, the dashboard will automatically set the timezone to your computer's timezone. **Linking a Timed Event to a Custom Event** Once you have added a timed event, create a new custom event and select the timed event you made from the custom event type dropdown. [](https://documentation.botghost.com/changelog/2023#new-premium-module-roblox-verification-september-6th-2023) New Premium Module: Roblox Verification - September 6th 2023 --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- This module allows you to implement a Roblox account verification system for your Discord server. Users can receive a role on verification and/or have their Discord name changed to their Roblox name. Once a user has verified, they will be able to use the **/roblox-profile** command, which will allow them to show off their profile and view the Roblox groups they are a member of. **The module can be accessed by premium users only** [](https://documentation.botghost.com/changelog/2023#new-premium-module-global-chat-september-4th-2023) **New Premium Module: Global Chat - September 4th, 2023** ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- We have released a new module to the dashboard, Global Chat. The module allows you to link messages between multiple text channels, using webhooks or messages sent by your bot. You can configure whether the message should be a webhook or a bot message, the message details, blacklisted words and roles, cooldowns, reactions, and other useful settings. Use the /globalchat-setup command to enable the module for new channels. You can also access additional commands to disable channels, blacklist users and delete messages globally. The module can be accessed by premium users, both on the beta and regular servers. [](https://documentation.botghost.com/changelog/2023#updates-greater-than-out-of-beta-september-4th-2023) **Updates -> Out of Beta - September 4th 2023** -------------------------------------------------------------------------------------------------------------------------------------------------------------- The loops + small additions from August are now all out of beta and can be used by all users. [](https://documentation.botghost.com/changelog/2023#buttons-and-select-menus-rework-loop-timeout-field-keep-components-delete-variable-additions-new-var) **Buttons and Select Menus Rework, Loop timeout field, Keep Components, Delete Variable additions, New Variables & Bug fixes - August 31st, 2023** ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ **Buttons & Menu Options Replies + Emoji Buttons** We have changed the way buttons and menu options respond and work on the beta server. Buttons and menu options will now no longer trigger the 'thinking...' response when clicked or selected. This means you can have interactions that trigger no response at all if you wish. We have also finally added emoji buttons. You can specify a custom emoji id or default emoji to add to the emoji along with the normal button label. **Loop Timeout field** On release, we set a 1-second default timeout between loop iterations. We have now instead added a loop timeout field to loops which lets you specify the timeout between loop iterations. The minimum is 100 ms and the maximum is 10 minutes. **Keep Components on Edit Message** We have added a keep components option to the 'Edit another reply action' for all reply actions. This lets you keep the buttons or select a menu of messages you edit with other reply actions. **Delete All values for Delete Variable** A Delete all option has been added to the Delete Variable block for User and Channel-specific variables. This lets you clear all values of user and channel variables. **New Variables** New {randomCharacters(10)} and {isNumber(10)} variables have been added. randomCharacters generates up to 100 random characters and isNumber returns true or false if the given string is a number or not. **Bug Fixes** * Fixed a bug with the variable change event that caused successive different variable changes to only trigger the first variable that was changed. * Fixed a bug with large numbers (discord ids) being rounded up when being used in conjunction with collection variables. * Fixed a bug that sometimes caused the variable change event not to trigger when the variable change was caused by another event. **These changes are only available on the beta server at this time.** [](https://documentation.botghost.com/changelog/2023#loops-august-29th-2023) **Loops** - _August 29th 2023_ ---------------------------------------------------------------------------------------------------------------- We have released a new Loop action to the beta servers. **How it works** Loops allow you to repeat connected actions and conditions a set amount of times. You can change the number of times a loop is run by setting the loop count with a number or variable. Actions and conditions connected to the Loop X Times block will then be run that many times. Once the loop has finished actions and conditions connected to the 'After Loop' block will be run like normal. **Loop Variables** Loop actions have two unique variables that can be used inside loops: * **{loop\_count}** \- Returns the current loop count. Starts at 1. * **{loop\_index}** - Returns the current loop index. Starts at 0 and is useful for when looping through collections. **Looping Through Collections** Loops are especially useful when combined with collections. By specifying the loop count as the length of a collection, you can easily loop through the values of a collection/array by using the new {loop\_index} variable and the valueAtPosition variable. **Stop a Loop Action** Loops also have a unique **Stop a Loop** action that can be run to stop any running loop. You can use this action with conditions to conditionally stop a loop. **Limitations** We have put some limitations on loops to discourage abuse of the system: * Loops have a timeout of 1sec between each loop. * You can not run loops inside of loops * A max loop count of 1000 exists These limitations may change as we monitor how people are using loops. [](https://documentation.botghost.com/changelog/2023#status-change-and-purge-messages-action-api-text-response-variable-out-of-beta-august-28th-2023) **Status Change & Purge Messages Action, API text response variable** \[Out of beta\] - _August 28th 2023_ --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- The new actions and API text variable are now out of beta and can be used by all members. [](https://documentation.botghost.com/changelog/2023#status-change-and-purge-messages-action-api-text-response-variable-august-17th-2023) **Status Change & Purge Messages Action, API text response variable** - _August 17th 2023_ ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- We have added two new actions and a new API variable to the **beta servers** **Status Change Action** The status change action allows you to change the status and status type of your bot through the command and event builder. This action can only be used on premium bots. **Purge Messages Action** The purge messages action lets you purge up to 100 messages in a channel. **API Text Response Variable** We have added a small helper variable to API responses that returns the entire API response in text form. This can be useful for debugging responses from API endpoints. [](https://documentation.botghost.com/changelog/2023#custom-variable-change-event-voice-channel-events-and-new-variables-update-august-4th-2023) **Custom Variable Change Event, Voice Channel Events and New Variables Update -** _**August 4th 2023**_ ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- * **Custom Variable Change Event** A new event has been added that is executed whenever the value of a custom variable is set. The event executes on a 1 second delay and has the old and new values, variable name, specific user/channel id and variable reference as event variables. * **Voice Channel Events** The voice channel join, switch and leave events have been added. * **New Variables** A {getRankOfUser(BGVAR\_variable)} has been added which returns the rank of a specific user using a number variable. A {previous\_numbers(10)} variable has also been added which returns all preceding numbers of a given number all the way to zero. * **voiceChannelSwitch** a custom event when a user switches the voice channel they are currently in **All events and variables are now out of beta and available to everyone.** [](https://documentation.botghost.com/changelog/2023#custom-variable-change-event-voice-channel-events-and-new-variables-july-26th-2023) **Custom Variable Change Event, Voice Channel Events and New Variables -** _**July 26th 2023**_ --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- We have added some new events and variables to the beta server. **These additions are currently on beta only** * **Custom Variable Change Event** A new event has been added that is executed whenever the value of a custom variable is set. The event executes on a 1 second delay and has the old and new values, variable name, specific user/channel id and variable reference as event variables. * **Voice Channel Events** The voice channel join, switch and leave events have been added. * **New Variables** A {getRankOfUser(BGVAR\_variable)} has been added which returns the rank of a specific user using a number variable. A {previous\_numbers(10)} variable has also been added which returns all preceding numbers of a given number all the way to zero. * **voiceChannelSwitch** a custom event when a user switches the voice channel they are currently in [](https://documentation.botghost.com/changelog/2023#webhook-module-maintenance-july-25th-2023) Webhook Module Maintenance - _July 25th 2023_ -------------------------------------------------------------------------------------------------------------------------------------------------- We apologize for the inconvenience, but we have **temporarily disabled Webhook events** while we perform essential performance updates. This change is necessary to address recent rate limits. Thank you for your understanding and patience! _**Update - July 25th 2023:**_ Great news! The Webhook module is now re-enabled and ready to use, performing better than ever before! [](https://documentation.botghost.com/changelog/2023#small-updates-july-19th-2023) **Small Updates -** _**July 19th 2023**_ -------------------------------------------------------------------------------------------------------------------------------- * Changed the botRestart event to only fire when the bot is actually restarted (not on update) * Added a botUpdate event that fires when the bot is updated through the dashboard * Added an additional roles field to the add and remove roles actions. You can use variables in this field. * Added a 'Set a unique variable' action which allows you to set and create a unique variable for every execution of an action or event. This is a command or event unique variable. * Added {solve\_equation\[1+1\]} variable. Returns the result of the equation within the square brackets. [](https://documentation.botghost.com/changelog/2023#bug-fixes-and-small-changes-july-18th-2023) Bug Fixes & Small Changes - _July 18th 2023_ -------------------------------------------------------------------------------------------------------------------------------------------------- The following bug fixes have been implemented: * that are stored in a custom variable now create a new line. * Currency actions now accept a User ID as a target. * Warnings moderation command reformatted. * Username fix on ticket. * Market UI Fixes and Improvements. * Error logs table on mobile now scrolls side to side. * Dropdown fixes on iOS. * Rewording to make things more clear. * Users now cant interact with of the disabled content/dropdowns/buttons/inputs if the module is disabled/a module that they need premium for. * Updated the random response to show the limit, and the button becomes disabled if they have reached it. * Automod whitelist and blacklist commands prefix fixed. * Embed builder errors, if there is only a space in the body of the embed. * Fixed button embed body text area, when you clicked on a variable it did not populate from the variable editor. * Various UI improvements and fixes. [](https://documentation.botghost.com/changelog/2023#discord-automod-july-18th-2023) **Discord Automod -** _**July 18th 2023**_ ------------------------------------------------------------------------------------------------------------------------------------ A new module has been added to the dashboard with our module creation system, Discord Automod. The module allows you to add new rules to the built-in automod system of Discord. Additionally, you can set up custom punishments that will trigger when a user breaks a set amount of rules. You are able to set up punishment types that Discord's default system doesn't offer, such as custom timeout lengths, kicks and bans. Upon creating 100 rules with the bot, your bot will also receive the "Uses Automod" badge. This module is available to all users immediately. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FQydFAgKYRUuJRKxmRYVT%252Fimage.png%3Falt%3Dmedia%26token%3D75b9ae92-0804-4a7d-9638-c88e7f7d6dd6&width=768&dpr=3&quality=100&sign=540deb3e&sv=2) [](https://documentation.botghost.com/changelog/2023#starboard-july-17th-2023) **Starboard -** _**July 17th 2023**_ ------------------------------------------------------------------------------------------------------------------------ We have released a new module using our new module creation system: **Starboard**. The starboard allows you to highlight and post the most liked messages in your server to a special server. You can fully configure the module to your liking including the emoji used, amount of reactions required, starboard channel, colors and more. You may also whitelist or blacklist certain channels for the starboard. This module is available to all users immediately. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FjXjGTWRXUhqq9LCdFNg3%252Fimage.png%3Falt%3Dmedia%26token%3Db9555d14-7a2c-4dfe-b62a-7030030f543a&width=768&dpr=3&quality=100&sign=a98c95a&sv=2) [](https://documentation.botghost.com/changelog/2023#webhook-events-and-server-join-event-july-5th-2023) **Webhook Events & Server Join Event -** _**July 5th 2023**_ -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- We have added two new event types to the beta servers Webhook Custom Events and the Server Join Event. **Server Join Event** The server join event is triggered whenever your bot joins a new server. This event has no variables however you can use the default variables to access information about the server. **Webhook Custom Events** Webhooks are an advanced feature that allow you to trigger custom events whenever something happens outside of BotGhost. This essentially allows you to hook up external services to your BotGhost hosted bot. This is done through sending a POST HTTP request to the internal BotGhost API that will trigger a linked custom event. The process for setting up and using webhooks is the following: 1. Create a Webhook. Head over to the new webhooks module and create a new webhook. This will give you a unique URL which you will need to send your POST request to. On this page you can also generate and see your API key which you must pass as an Authorization header with your request. 2. Create a Custom Event. Once you have made a webhook you can create a custom event the same way as any other event. When selecting the event type, select your newly made webhook from the dropdown. You can then configure your event like normal. This event will be triggered when the BotGhost API receives a POST request to that webhook's URL. 3. Send your POST request. When you are ready you can now send a POST request to that webhooks URL. You must pass along your API token as an Authorization header. Please read the webhook documentation and API reference for more information on how to setup your POST request. If all is done correctly your custom event should be triggered and you should receive a 200 response from the botghost API. **PLEASE READ THE WEBHOOK DOCUMENTATION BELOW BEFORE ASKING FOR SUPPORT. THIS UPDATE IS TARGETED TOWARDS MORE ADVANCED USERS. Docs:** [**https://docs.botghost.com/custom-commands-and-events/webhooks**](https://docs.botghost.com/custom-commands-and-events/webhooks) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252F5lWwdM2cRQiC7ADEuUfi%252Fimage.png%3Falt%3Dmedia%26token%3D4fe9c91f-8e23-438c-bfd4-1ffe102afb3c&width=768&dpr=3&quality=100&sign=b3957256&sv=2) [](https://documentation.botghost.com/changelog/2023#reaction-roles-update-june-28th-2023) **Reaction Roles Update -** _**June 28th 2023**_ ------------------------------------------------------------------------------------------------------------------------------------------------ We have updated the reaction roles module using our new module creation system. The module now uses the command builder and a slot system to add custom events with unique configurations. The old reaction roles module has been depreciated and will be hidden to new users or users who have not enabled the module. If you are currently still using the old system the module will still show until you disable it. You are able to use both the new and old systems at the same time. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252Fz0Zrkhuc1hTGIqftEog9%252Fimage.png%3Falt%3Dmedia%26token%3D1b503b4c-94df-4157-88d8-fc6c91d307c6&width=768&dpr=3&quality=100&sign=f808a07&sv=2) [](https://documentation.botghost.com/changelog/2023#new-events-and-new-variable-june-27th-2023) **New Events and New Variable - June 27th 2023** ------------------------------------------------------------------------------------------------------------------------------------------------------ We are happy to announce the addition of four new events to the event builder: **•** When a thread is created **•** When a thread is updated **•** When a thread is deleted **•** When the bot starts or is restarted In addition, we have also added a new variable called **{bot\_id}**. Using this variable returns in the Discord ID of your bot. This variable can be used in the API Request action. Both of these additions are currently in beta. With an active premium subscription, you can enable the beta features in your settings menu of the BotGhost dashboard ([https://btghst.info/settings](https://btghst.info/settings) ). [](https://documentation.botghost.com/changelog/2023#activity-requirements-free-bots-june-16th-2023) A**ctivity requirements free bots -** _**June 16th 2023**_ -------------------------------------------------------------------------------------------------------------------------------------------------------------------- We have changed the way activity is checked for on free bots. Free bots will now be turned offline if a command (or button/select menu) is not used at least once every 7 days. If your bot goes offline you can of course turn your bot back online at any time which will reset the activity tracker. This is due to a recent surge in bot creation which has led to increased strain on the servers. **This change does not affect premium bots which have no activity requirements.** Thanks all. [](https://documentation.botghost.com/changelog/2023#auto-react-june-15th-2023) **Auto-React -** _**June 15th 2023**_ -------------------------------------------------------------------------------------------------------------------------- We have released a new module using our new module creation system. This module will automatically add reactions to new messages sent in a channel or channels. The module also has settings to ignore embeds, set whitelisted roles and check for certain words. As this uses our new module system premium users can edit the logic of the event behind this module. Free users can edit the settings of individual blocks inside the event. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252F3KHMycQGT3nmjFoHI43R%252Fimage.png%3Falt%3Dmedia%26token%3D24942147-ddb2-42d0-a20a-d9222eefc827&width=768&dpr=3&quality=100&sign=8f8c7f41&sv=2) [](https://documentation.botghost.com/changelog/2023#collections-out-of-beta-june-5th-2023) **Collections \[Out of beta\] -** _**June 5th 2023**_ ------------------------------------------------------------------------------------------------------------------------------------------------------ The collections update is now out of beta and can be used by all users. If you have any suggestions or come across any bugs please report them in their respective channels in our Discord server, [https://discord.gg/botghost](https://discord.com/botghost) . [](https://documentation.botghost.com/changelog/2023#collections-june-1st-2023) **Collections -** _**June 1st 2023**_ -------------------------------------------------------------------------------------------------------------------------- We have added a new data storage type to the beta servers: **Collections**. Collections (arrays) are a special data type that allow you to store a group of text or numbers. Collections consist of an ordered list using numbered positions starting from 0 to access specific items. Collections can be global, server specific, channel specific or user specific. Some examples of collections or arrays: * \[1,2,3,4,5\] * \[hello, one, two, three\] * \[\] * \[warning 1, warning 2\] * \[giveaway entrant 1, giveaway entrant 2\] **Set Variable Options** Collections have specific operations within the Set a Variable action block. These operations manipulate the collection in a certain way: * Push value to front * Push value to end * Remove first value * Remove last value * Set value at position * Remove value at position * Remove value in collection * Clear collection **Collection Variables** Collections also have their own specific function variables: * {lowestValue({array})} * {highestValue({array})} * {lengthOfCollection({array})} * {valueAtPosition({array}),\[2\]} * {positionOfValue({array}),\[hello\]} * {collectionCharacterLength({array})} * {getRandomFromCollection({array})} * {printAllValues({array}),\[hello\]} _**Disclaimer:**_ _Collections are intended to be used in much more complex systems by our more knowledgeable users. Collections will also form the backbone for many soon to be released custom modules and reworked old modules. We ask that before asking for support you watch some videos about arrays/collections and how they are used and test out collections for yourself._ [View collection docs](https://docs.botghost.com/data-storage/data-storage/collections) [](https://documentation.botghost.com/changelog/2023#bug-fixes-and-small-changes-may-24th-2023) **Bug Fixes & Small Changes -** _**May 24th 2023**_ -------------------------------------------------------------------------------------------------------------------------------------------------------- * Fixed the Free Premium Twitter system * Fixed a bug that allowed you to delete the error handler using multi select * Fixed a bug that disabled the options condition if you had only one conditioned added * Removed an empty option in the button settings * Removed the redundant music embed color settings * Fixed the category selector for the ticket category * Changed the server redirect in the Dashboard * Added a warning when trying to send a button in DMs when using 'the user' option. * Updated the premium table to reflect recent changes * Fixed select previews in the logging module * Fixed the reddit module * Fixed a bug that caused the statistics module to not create Member Count channels on new bots * Fixed a visual issue with the Automod commands [](https://documentation.botghost.com/changelog/2023#verification-may-16th-2023) **Verification -** _**May 16th 2023**_ ---------------------------------------------------------------------------------------------------------------------------- We have released a new module to all users: Verification. The Verification module allows you to easily verify new server members using either a Captcha image, Number generator or a basic button. Once users pass verification, they are given a specified verified role which you can configure in the module. Run the /verification-setup command to setup a verification panel in a channel. New users will have a certain amount of time and verification fails before they are automatically kicked from the server. This module uses our new custom module system meaning all commands and events are completely customizable. Feel free to edit the module's commands and events in the builder. If you make a mistake you can always reset the module back to its default settings. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FlBe2KBN49JT1kRnh5zPa%252Fimage.png%3Falt%3Dmedia%26token%3Db11ce892-891b-446e-aafe-9e282ece95ea&width=768&dpr=3&quality=100&sign=ab2e539a&sv=2) [](https://documentation.botghost.com/changelog/2023#sticky-messages-may-11th-2023) **Sticky Messages -** _**May 11th 2023**_ ---------------------------------------------------------------------------------------------------------------------------------- We have released a new module to all users: Sticky Messages. Sticky messages allow you to highlight important messages by sticking them near the bottom of a text channel. Members with a certain role are able to run the /sticky-post command to send a sticky message to a channel. The message will then be resent whenever a certain message count is reached in that channel. You can then rerun the /stick-post command to either delete or create a new message. You are able to fully customize the sticky message sent as well as create a default sticky message for your server. This module uses our new module creation system which allows you to fully customize the events and commands in the module. Feel free to edit the event and command to your needs. If you make a mistake you can always reset the module back to its default settings. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FmFnJ3vvipq0ONU3OGQG8%252Fimage.png%3Falt%3Dmedia%26token%3De176ee22-582f-430b-b183-188a972d6a20&width=768&dpr=3&quality=100&sign=1c47a32a&sv=2) [](https://documentation.botghost.com/changelog/2023#depreciation-of-music-module-may-5th-2023) Depreciation of Music Module - _May 5th 2023_ -------------------------------------------------------------------------------------------------------------------------------------------------- Over the past year or so YouTube has been cracking down on Music Bots and tightening loopholes on how 3rd party apps can rip and stream audio from YouTube videos. This has resulted in it becoming a cat and mouse game of YouTube fixing a loophole and then us trying to find a new way to stream audio through the Discord bots. Over the past few weeks this has became more and more difficult as YouTube launch more measures to stop 3rd party streaming apps. With that in mind we have decided to retire the Music Module entirely until further notice. If you purchased premium within the last 60 days and would like a refund you can do so through our billing-support options. [](https://documentation.botghost.com/changelog/2023#welcome-banners-update-may-3rd-2023) Welcome Banners Update - _May 3rd 2023_ -------------------------------------------------------------------------------------------------------------------------------------- We have made some changes to the new welcome banners module to ensure it's more stable and more customizable. The module will now use an API hosted directly by BotGhost, to avoid the possible outages that happened frequently while using a public API. You can now customise various colors of the banner image, such as the text colors, the background color and the avatar border color. The background image is not required from now on, you can simply use a background color instead of it. To access all of these new changes, refresh the module page and click the orange update button. _Emojis won't appear in the banner as of now, but we'll implement a fix to that soon._ Please report bugs and suggestions in our Discord support server, https://discord.gg/botghost. [](https://documentation.botghost.com/changelog/2023#welcome-banners-april-27th-2023) Welcome Banners - _April 27th 2023_ ------------------------------------------------------------------------------------------------------------------------------ A new Welcome Banners module has been added for all users using the new module system. This modules uses the POPCAT API to send a customizable welcome banner whenever someone joins the server in a user defined welcoming channel. You can customize all fields of the welcome banner from within the module, and send the banner through either a plain text or embed message. You can also toggle on whether or not to also send the banner to the users DMs. Like all modules using the new module system, you can also fully customize the Welcome Banners event. This module is available to all users immediately (No beta). ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252Fg9UmNKE7ShUCiwLFX9Wp%252FD6CBED8F-5310-4FFD-8C63-819047FDBD6D.png%3Falt%3Dmedia%26token%3D44235373-b6a9-4f0d-b939-83c16633e7f2&width=768&dpr=3&quality=100&sign=f1524887&sv=2) [](https://documentation.botghost.com/changelog/2023#twitter-module-disabled-april-27th-2023) Twitter module disabled - _April 27th 2023_ ---------------------------------------------------------------------------------------------------------------------------------------------- Due to big daddy Elon shutting down the free Twitter API (and now charging $42,000/month for what used to be free) we can no longer get updates from Twitter. We have plans to replace this module with Zapier integration in the future however we currently have no ETA on when this will be released. For the time being the Twitter module will be temporarily disabled until either the Zapier functionality is released or Elon Musk reverts his decision. [](https://documentation.botghost.com/changelog/2023#changes-to-revoking-premium-tokens-april-25th-2023) Changes to revoking premium tokens - _April 25th 2023_ -------------------------------------------------------------------------------------------------------------------------------------------------------------------- Due to some issues concerning duplicate premium tokens and the revoking system, we have decided to change the way revoking works. Starting immediately, revoking a premium token can only be done by creating a ticket through the #billing-support channel on our server ([https://discord.gg/botghost](https://discord.gg/botghost) ) or by sending an email to [billing@botghost.com](mailto:billing@botghost.com) . Users with a monthly, yearly, or lifetime unlimited token subscription can instantly delete premium bots without having to revoke the token. However, if you have a premium subscription and want to delete your premium bot without an unlimited subscription, you must request a token revoke through the #billing-support channel or by emailing [billing@botghost.com](mailto:billing@botghost.com) . Please make sure to create the ticket on the Discord account with the premium subscription. If the ticket is not created on the right Discord account, we will not be able to fulfill your request. If emailing without creating a ticket via our Discord server, we may ask for additional information associated to your account to confirm the ownership status. _Free premium cannot be revoked. Wait until the free premium expires to delete a bot._ Since October 13rd, 2025 all billing support requests must be sent to our [Help Center](https://help.botghost.com/support/home) . [](https://documentation.botghost.com/changelog/2023#premium-gifting-april-25th-2023) Premium Gifting - April _25th 2023_ ------------------------------------------------------------------------------------------------------------------------------ We have added the ability to gift 3 different types of BotGhost premium to other users. You can now gift people either 30 days, 365 days or Unlimited lifetime premium through purchasing upgrade codes in the dashboard. Some FAQs: * Gifts are a one time purchase at the same price of their respective subscription (monthly, yearly, lifetime unlimited). * Once purchased, you can copy a Gift code at the bottom of the gifting page and send it to another person to claim. * Gifts can then be claimed on the gifting page. * Gifts that have been claimed can not be refunded. Gifts that are unclaimed can be refunded within 7 days of purchase similar to subscriptions. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FLo25AJqVSv0W3PczHUC6%252F22971EDD-02E9-4615-B483-D155FF48F36B.png%3Falt%3Dmedia%26token%3Dac8dbc24-7398-42c6-8359-5ae553ef9a03&width=768&dpr=3&quality=100&sign=62e5594b&sv=2) [](https://documentation.botghost.com/changelog/2023#four-new-modules-out-of-beta-april-18th-2023) Four new modules out of beta - _April 18th 2023_ -------------------------------------------------------------------------------------------------------------------------------------------------------- The four new modules are now out of beta and can be used by all members. These modules are: _Counting ChatGPT Image Generation Modmail_ If you have any suggestions or come across any bugs please report them in their respective channels in our Discord server, https://discord.gg/botghost . [](https://documentation.botghost.com/changelog/2023#release-modmail-module-march-15th-2023) Release Modmail Module - _March 15th 2023_ -------------------------------------------------------------------------------------------------------------------------------------------- The final module to be released in this update is the Modmail module. The module uses the same system we use in this server to allow users to contact staff by DMing the bot. **Usage** The module creates posts in a forum channel of your choosing whenever a user dm's your bot. Staff members can then send messages to the post to have those messages sent to the user through DMs. You can customize the title and description of the opening message through the module. **Ban Command + Permissions** You can ban problematic users from opening tickets using the /modmail-ban command. You can also set the required permissions that your staff members must have to be able to use the command. This module is currently in beta. Please report any bugs or feedback in the feedback channel in our Discord server, https://discord.gg/botghost . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FwErtVHKlg2tQfsBCxKy2%252F1FE190FB-7DC4-4FE4-89AD-9A26AF56C82D.gif%3Falt%3Dmedia%26token%3D8437aa78-217a-4deb-8b4e-38582ef3ae55&width=768&dpr=3&quality=100&sign=bab9384&sv=2) [](https://documentation.botghost.com/changelog/2023#release-image-generation-module-april-14th-2023) Release Image Generation Module - _April 14th 2023_ -------------------------------------------------------------------------------------------------------------------------------------------------------------- The 3rd module to be released is the Image Generation module. This module uses OpenAI's Dall-E to generate images from user supplied prompts. Like the ChatGPT module this module also requires you to supply your own API key from OpenAI. You can get an API key here https://platform.openai.com/account/api-keys. **/imagine** The imagine command is the only command in the module. You can use this command to generate images using the AI. Dall-E works best when experimenting with different art styles so get creative. This module is currently in beta. Please report any bugs or feedback in the feedback channel in our Discord server, https://discord.gg/botghost . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FePk9XWS6M9Rq00HlhNq3%252F44ED1E62-F84D-4BA4-8C27-2AFEC46DEE99.png%3Falt%3Dmedia%26token%3D822ca387-eeda-46d7-8014-0a7bc4edd298&width=768&dpr=3&quality=100&sign=66018005&sv=2) [](https://documentation.botghost.com/changelog/2023#release-chatgpt-module-april-13th-2023) Release ChatGPT Module - _April 13th 2023_ -------------------------------------------------------------------------------------------------------------------------------------------- The second module to be released is the ChatGPT Module. This module lets you interact with and chat with ChatGPT using your own API key. You can select from GPT-3.5 or GPT-4 if you have access. You can generate an API key on the OpenAI platform page here https://platform.openai.com/account/api-keys. **Chat Mode** When in chat mode, your bot will automatically reply to its @mentions with a ChatGPT-generated reply. A channel is required to be selected for chat mode. **Commands** This module has two commands. The /respond command generates an AI response to a prompt. The /edit-text command edits some provided text based on your instructions. This module is currently in beta. Please report any bugs or feedback in the feedback channel in our Discord server, https://discord.gg/botghost . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FivvOY3VqnRBeCTwhiOIC%252FD6F5111A-FEE8-49BE-A90A-CD882FF16AD6.png%3Falt%3Dmedia%26token%3Dbed29386-b7e6-40bd-9162-e595e80a575e&width=768&dpr=3&quality=100&sign=225211ca&sv=2) [](https://documentation.botghost.com/changelog/2023#new-module-system-four-new-modules-increased-limits-module-favoriting-april-12th-2023) New Module System, Four New Modules, Increased Limits, Module Favoriting - _April 12th 2023_ --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **• New Module System** We have created a new module system that allows us to create custom modules without our developers having to hard code them. This system uses inputs that are linked to a variable in combination with custom commands and events to create a module on the dashboard. This allows us to create modules without having to hard code systems from scratch, meaning we can create and update modules more quickly. You are able to completely modify the modules commands and events just like a custom command or event. Do note that these modules commands and events count towards your free limits. Over the next 4 days we will be releasing 4 entirely new modules, starting with... • **Counting Module (beta)** The counting module is the first module to be released with this new system. This module copies the functionality in the counting channel in our Discord server, https://discord.gg/botghost . As mentioned above, this system uses some custom variables with an event and command to recreate the system in this server. Feel free to edit the event and command to your liking. If you mess up, you can always reset the module back to its default settings. Please report any bugs or feedback in the feedback channel in our Discord server, https://discord.gg/botghost . • **Increased Limits** Due to this new module system using custom commands and events, free users will quickly hit their command, event and database call limits. To accommodate for this we have increased the free limits to the following: Custom Commands 5 -> 8 Database calls 1000 -> 5000 Custom event limits will stay the same for now. Premium users obviously are still unlimited. • **Module Favoriting** Due to the four new modules and new modules coming in the future, your most used modules may become hidden under modules you never intend to use. To fix this, we have created a module favoriting system that allows you to pin modules to the top of the dashboard. These favorites are account wide and persist across all your bots. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FUGbxYdEI7BIeHcfQ9msE%252FF31BBF8C-45E8-4041-83F0-1C04E4A5DB34.png%3Falt%3Dmedia%26token%3D314b5925-b2bc-4a32-8d54-ba123818607e&width=768&dpr=3&quality=100&sign=839d9f0c&sv=2) [](https://documentation.botghost.com/changelog/2023#modals-out-of-beta-only-march-20th-2023) Modals out of Beta Only - _March 20th 2023_ ---------------------------------------------------------------------------------------------------------------------------------------------- The new modal - 'Send a Form' - action for the command and event builder is now out of beta and can be used by all members. [](https://documentation.botghost.com/changelog/2023#release-modals-form-action-march-10th-2023) Release Modals (Form) Action - _March 10th 2023_ ------------------------------------------------------------------------------------------------------------------------------------------------------ A new 'Send a Form' action has been added to the beta server. This action lets you build a form (modal) and collect and use user responses. Use the new Form builder to add and edit inputs to your form and then use the associated variables throughout other actions and variables. Any changes to your form will be reflected live in the Form preview. Important to note: Forms must be the first reply to an interaction. You are unable to link a Form action to the tree if a reply has already been sent to that interaction. An interaction occurs when either: * A command is used * A button is clicked * A select menu option is selected As this update changed a lot of back end logic for the command and event builder, please report any bugs directly in this forum post: https://discord.com/channels/822426820447567872/1083592429099290714 This update is currently in beta only. [](https://documentation.botghost.com/changelog/2023#bug-fixes-and-small-changes-march-1st-2023) Bug Fixes & Small Changes - _March 1st 2023_ -------------------------------------------------------------------------------------------------------------------------------------------------- * Fixed a bug that caused some Twitch announcements to not announce for some users. * Added the /volume command to the dashboard. Previously it would show in Discord but not in the Music module on the Dashboard. * Fixed a bug that caused the builder to crash when deleting multiple blocks containing a condition or button action. * Implemented a compression system that should reduce the size of large bots. This in turn should reduce the occurrence of 'Network Error' save fails. * Fixed a bug that caused event variables to no longer work after a button or select menu interaction. * Variables can now be used in the targeting fields for the Currency Condition * Changed the Currency conditions value field to a text input so that variables can be used. * Fixed a bug that allowed users to connect children blocks to their parent. You can't make loops stop trying 😡 . * Added the {server\_owner\_id} variable. * Fixed some styling issues on the home page for mobile. [](https://documentation.botghost.com/changelog/2023#changes-data-storage-module-and-migration-to-global-commands-february-22th-2023) Changes Data Storage module and Migration to Global Commands - _February 22th 2023_ ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ • **Free Users Data Storage Changes** - Simplified the way data storage usage is tracked and used for free users. In the new system, creating or interacting with a variable will use 10 storage calls. Free users now have a maximum usage of 1000 calls. Calls are reset at the start of each month (and have been reset today). Users with any paid subscription still have unlimited usage. **• Migration to Global Commands** \- Migrated all commands to the global command system. Previously, commands were server specific due to limitations which made global commands take around an hour to update. This should have no effect on smaller bots, however larger bots should now see command changes roll out across servers near instantly. [](https://documentation.botghost.com/changelog/2023#bug-fixes-and-small-changes-february-14th-2023) Bug Fixes & Small Changes - _February 14th 2023_ ---------------------------------------------------------------------------------------------------------------------------------------------------------- * Fixed a bug with the {user\_status} variable that would cause it to return null or an error when the user is offline. * Buttons after the first row that should be disabled should now disable correctly. * You no longer have to have created a bot to be able to access and work on cocreator bots. * The usage limit of 500 is now active for non-premium members. A paid subscription is required to remove this limit. You will not be able to set the value of any variables if you do not have a paid subscription and go over the 500 usage limit. Members with a paid subscription do not have any limit. Usage is account-wide. * Messages in DMs should now be deleted correctly when deleted by a Delete a Message block. * Variable targets in the DM block should now work for embeds * {event\_reason} should now work correctly in the ban event. * Variables in the User ID targeting field for Custom Variable conditions should now work correctly. * Updated the YouTube module to not create channels when sending. The module will now only post in the channel that was selected. * Updated the Twitch module to not create channels when sending. The module will now only post in the channel that was selected. * Updated the Reddit module to not create channels when sending. The module will now only post in the channel that was selected. * Child options of select menus will now be deleted when the parent action is deleted. * Beta features should now show correctly when using co-create if the bot you are working on has beta enabled. * Fixed a bug where Button messages sent in a newly created channel could not be pinned or deleted. Last updated 5 months ago Was this helpful? * [New Module: Invite Tracker - December 22nd, 2023](https://documentation.botghost.com/changelog/2023#new-module-invite-tracker-december-22nd-2023) * [IFTTT Integration - December 20th, 2023](https://documentation.botghost.com/changelog/2023#ifttt-integration-december-20th-2023) * [Linking IFTTT to BotGhost](https://documentation.botghost.com/changelog/2023#linking-ifttt-to-botghost) * [IFTTT Applets](https://documentation.botghost.com/changelog/2023#ifttt-applets) * [Action Block Triggered (IFTTT Triggers)](https://documentation.botghost.com/changelog/2023#action-block-triggered-ifttt-triggers) * [Trigger a Custom Event (IFTTT Actions)](https://documentation.botghost.com/changelog/2023#trigger-a-custom-event-ifttt-actions) * [Subscription for IFTTT](https://documentation.botghost.com/changelog/2023#subscription-for-ifttt) * [November - December Module Updates - December 16th, 2023](https://documentation.botghost.com/changelog/2023#november-december-module-updates-december-16th-2023) * [Starboard](https://documentation.botghost.com/changelog/2023#starboard) * [ChatGPT](https://documentation.botghost.com/changelog/2023#chatgpt) * [Delete Message by ID, Create Server Invite Action & Interaction Variables - December 7th, 2023](https://documentation.botghost.com/changelog/2023#delete-message-by-id-create-server-invite-action-and-interaction-variables-december-7th-2023) * [New Premium Module: Media Channels - October 31st, 2023](https://documentation.botghost.com/changelog/2023#new-premium-module-media-channels-october-31st-2023) * [New Premium Module: Temporary Voice Channels - October 30th, 2023](https://documentation.botghost.com/changelog/2023#new-premium-module-temporary-voice-channels-october-30th-2023) * [Free Bot Database Usage Changes + Bug Fixes - October 25th 2023](https://documentation.botghost.com/changelog/2023#free-bot-database-usage-changes--bug-fixes-october-25th-2023) * [Bug Fixes](https://documentation.botghost.com/changelog/2023#bug-fixes) * [New Module Rework: Leveling - October 23rd 2023](https://documentation.botghost.com/changelog/2023#new-module-rework-leveling-october-23rd-2023) * [Polls Module - October 17th, 2023](https://documentation.botghost.com/changelog/2023#polls-module-october-17th-2023) * [Deleting + Editing Ephemeral Replies & Bug Fixes - October 4th 2023](https://documentation.botghost.com/changelog/2023#deleting--editing-ephemeral-replies-and-bug-fixes-october-4th-2023) * [Deleting and Editing Ephemeral Replies](https://documentation.botghost.com/changelog/2023#deleting-and-editing-ephemeral-replies) * [Bugs](https://documentation.botghost.com/changelog/2023#bugs) * [Timed Events Out Of Beta - September 13th, 2023](https://documentation.botghost.com/changelog/2023#timed-events-out-of-beta-september-13th-2023) * [Timed Events - September 8th 2023](https://documentation.botghost.com/changelog/2023#timed-events-september-8th-2023) * [New Premium Module: Roblox Verification - September 6th 2023](https://documentation.botghost.com/changelog/2023#new-premium-module-roblox-verification-september-6th-2023) * [New Premium Module: Global Chat - September 4th, 2023](https://documentation.botghost.com/changelog/2023#new-premium-module-global-chat-september-4th-2023) * [Updates -> Out of Beta - September 4th 2023](https://documentation.botghost.com/changelog/2023#updates-greater-than-out-of-beta-september-4th-2023) * [Buttons and Select Menus Rework, Loop timeout field, Keep Components, Delete Variable additions, New Variables & Bug fixes - August 31st, 2023](https://documentation.botghost.com/changelog/2023#buttons-and-select-menus-rework-loop-timeout-field-keep-components-delete-variable-additions-new-var) * [Loops - August 29th 2023](https://documentation.botghost.com/changelog/2023#loops-august-29th-2023) * [Status Change & Purge Messages Action, API text response variable \[Out of beta\] - August 28th 2023](https://documentation.botghost.com/changelog/2023#status-change-and-purge-messages-action-api-text-response-variable-out-of-beta-august-28th-2023) * [Status Change & Purge Messages Action, API text response variable - August 17th 2023](https://documentation.botghost.com/changelog/2023#status-change-and-purge-messages-action-api-text-response-variable-august-17th-2023) * [Custom Variable Change Event, Voice Channel Events and New Variables Update - August 4th 2023](https://documentation.botghost.com/changelog/2023#custom-variable-change-event-voice-channel-events-and-new-variables-update-august-4th-2023) * [Custom Variable Change Event, Voice Channel Events and New Variables - July 26th 2023](https://documentation.botghost.com/changelog/2023#custom-variable-change-event-voice-channel-events-and-new-variables-july-26th-2023) * [Webhook Module Maintenance - July 25th 2023](https://documentation.botghost.com/changelog/2023#webhook-module-maintenance-july-25th-2023) * [Small Updates - July 19th 2023](https://documentation.botghost.com/changelog/2023#small-updates-july-19th-2023) * [Bug Fixes & Small Changes - July 18th 2023](https://documentation.botghost.com/changelog/2023#bug-fixes-and-small-changes-july-18th-2023) * [Discord Automod - July 18th 2023](https://documentation.botghost.com/changelog/2023#discord-automod-july-18th-2023) * [Starboard - July 17th 2023](https://documentation.botghost.com/changelog/2023#starboard-july-17th-2023) * [Webhook Events & Server Join Event - July 5th 2023](https://documentation.botghost.com/changelog/2023#webhook-events-and-server-join-event-july-5th-2023) * [Reaction Roles Update - June 28th 2023](https://documentation.botghost.com/changelog/2023#reaction-roles-update-june-28th-2023) * [New Events and New Variable - June 27th 2023](https://documentation.botghost.com/changelog/2023#new-events-and-new-variable-june-27th-2023) * [Activity requirements free bots - June 16th 2023](https://documentation.botghost.com/changelog/2023#activity-requirements-free-bots-june-16th-2023) * [Auto-React - June 15th 2023](https://documentation.botghost.com/changelog/2023#auto-react-june-15th-2023) * [Collections \[Out of beta\] - June 5th 2023](https://documentation.botghost.com/changelog/2023#collections-out-of-beta-june-5th-2023) * [Collections - June 1st 2023](https://documentation.botghost.com/changelog/2023#collections-june-1st-2023) * [Bug Fixes & Small Changes - May 24th 2023](https://documentation.botghost.com/changelog/2023#bug-fixes-and-small-changes-may-24th-2023) * [Verification - May 16th 2023](https://documentation.botghost.com/changelog/2023#verification-may-16th-2023) * [Sticky Messages - May 11th 2023](https://documentation.botghost.com/changelog/2023#sticky-messages-may-11th-2023) * [Depreciation of Music Module - May 5th 2023](https://documentation.botghost.com/changelog/2023#depreciation-of-music-module-may-5th-2023) * [Welcome Banners Update - May 3rd 2023](https://documentation.botghost.com/changelog/2023#welcome-banners-update-may-3rd-2023) * [Welcome Banners - April 27th 2023](https://documentation.botghost.com/changelog/2023#welcome-banners-april-27th-2023) * [Twitter module disabled - April 27th 2023](https://documentation.botghost.com/changelog/2023#twitter-module-disabled-april-27th-2023) * [Changes to revoking premium tokens - April 25th 2023](https://documentation.botghost.com/changelog/2023#changes-to-revoking-premium-tokens-april-25th-2023) * [Premium Gifting - April 25th 2023](https://documentation.botghost.com/changelog/2023#premium-gifting-april-25th-2023) * [Four new modules out of beta - April 18th 2023](https://documentation.botghost.com/changelog/2023#four-new-modules-out-of-beta-april-18th-2023) * [Release Modmail Module - March 15th 2023](https://documentation.botghost.com/changelog/2023#release-modmail-module-march-15th-2023) * [Release Image Generation Module - April 14th 2023](https://documentation.botghost.com/changelog/2023#release-image-generation-module-april-14th-2023) * [Release ChatGPT Module - April 13th 2023](https://documentation.botghost.com/changelog/2023#release-chatgpt-module-april-13th-2023) * [New Module System, Four New Modules, Increased Limits, Module Favoriting - April 12th 2023](https://documentation.botghost.com/changelog/2023#new-module-system-four-new-modules-increased-limits-module-favoriting-april-12th-2023) * [Modals out of Beta Only - March 20th 2023](https://documentation.botghost.com/changelog/2023#modals-out-of-beta-only-march-20th-2023) * [Release Modals (Form) Action - March 10th 2023](https://documentation.botghost.com/changelog/2023#release-modals-form-action-march-10th-2023) * [Bug Fixes & Small Changes - March 1st 2023](https://documentation.botghost.com/changelog/2023#bug-fixes-and-small-changes-march-1st-2023) * [Changes Data Storage module and Migration to Global Commands - February 22th 2023](https://documentation.botghost.com/changelog/2023#changes-data-storage-module-and-migration-to-global-commands-february-22th-2023) * [Bug Fixes & Small Changes - February 14th 2023](https://documentation.botghost.com/changelog/2023#bug-fixes-and-small-changes-february-14th-2023) Was this helpful? --- # Changelogs - 2025 | Changelog | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/changelog/2025.md) . [Current Year](https://botghost.com/docs/changelog/current) [Next Year (2026)](https://documentation.botghost.com/changelog) [Previous Year (2024)](https://documentation.botghost.com/changelog/2024) [](https://documentation.botghost.com/changelog/2025#more-bug-fixes--improvements-december-18th-2025) More Bug Fixes + Improvements - December 18th, 2025 -------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/changelog/2025#bug-fixes) Bug Fixes * Fixed spacing issues on mobile on the **Premium Upgrade** page * Fixed a missing image on one of the **Home Page solution** pages * Updated misleading wording around **Music actions** on the Premium page * Fixed the **Manage Subscription** button for Stripe subscriptions in **Settings** * Fixed a **Message Builder** issue when using **Collab Mode** * Fixed **Component V2 buttons** where custom styles were not being respected * Fixed **Allowed Mentions** options not showing for non-beta bots * Fixed a double square bracket issue with the `ignoreVariables` variable ### [](https://documentation.botghost.com/changelog/2025#additions-and-changes) Additions & Changes * Added **ID / Variable support** to role permission overwrites in the **Create Channel** action * Added a page to **/market** explaining where it went 🙂 * Improved builder tab switching so commands/events now **center and organize correctly** [](https://documentation.botghost.com/changelog/2025#bug-fixes-and-improvements-december-17th-2025) Bug Fixes & Improvements - December 17th, 2025 ------------------------------------------------------------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/changelog/2025#bug-fixes-1) Bug Fixes * Fixed a mismatch between **variable name length** and their **references** * Fixed **Link your Discord Account** showing after already being linked * Fixed **Create Transcript** showing incorrect message counts when **filter bot messages** is enabled * Fixed missing **function variables** in the variable editor for **user number custom variables** * Fixed **custom emoji rendering** in the Discord embed preview * Fixed incorrect **tutorial steps** for the **Create Channel** action * Fixed an issue where importing a **Custom Event from an Action Event** could delete the wrong node * Fixed **Custom Event Selector** display issues on **mobile** * Fixed validation issues when adding **empty embed fields** * Removed the old **Guides** button from the dashboard header * Removed the redundant **Action Events** tag in the Custom Event Selector ### [](https://documentation.botghost.com/changelog/2025#additions-and-changes-1) Additions & Changes * Added guard rails when using **BotGhost transcripts** inside **File Components** (Components V2) * Added a new field to **rename File Components** in Components V2 _Note: remember to include the file extension (.html, .pdf, etc.)_ * Redesigned the **Custom Event Selector** to work better on **mobile** [](https://documentation.botghost.com/changelog/2025#new-premium-music-system-release-beta-november-20th-2025) New Premium Music System Release (Beta) - November 20th, 2025 --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Today we’re launching our completely new, fully built-from-scratch **Premium Music System**. This is an entirely new feature set with its own audio engine, Smart Search, actions, events, variables, and a complete music module. The entire system is **Premium-only permanently** and currently available in **BETA ONLY**, so please enable Beta Mode before testing. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FaBgVYk5dmlioplI3dwat%252Fimage.png%3Falt%3Dmedia%26token%3D5ad200b1-0853-44a5-9e3f-b893e932e128&width=768&dpr=3&quality=100&sign=fe0e36c2&sv=2) ### [](https://documentation.botghost.com/changelog/2025#how-it-works) How It Works **Create Player:** Required before using any music feature. This connects the bot to voice and starts the audio engine. **Search & Add:** Search for songs, browse results, or add tracks directly into the queue. **Play:** Playback begins as soon as the queue has tracks. **Controls:** Pause, resume, skip, stop, replay, and seek. **Queue:** View, remove, clear, or shuffle the queue at any time. **Audio:** Adjust volume, set loop modes, enable AutoPlay, toggle AutoLeave, or apply filters like bassboost, nightcore, vaporwave, 8D, tempo, and more. ### [](https://documentation.botghost.com/changelog/2025#music-smart-search) Music Smart Search A new command option type that gives users real-time Spotify autocomplete inside Discord. As they type, the system displays up to 25 formatted results. Selecting one provides: `{option.result}` – stable track ID `{option.title}` – “Song – Artist” label Typing manually without selecting a result returns the raw input, supporting song names, URLs, and custom queries. No setup required and no API keys needed. ### [](https://documentation.botghost.com/changelog/2025#music-actions-19) Music Actions (19) Create Player, Add to Queue, Play Queue, Pause, Resume, Stop, Disconnect, Skip, Seek, Set Volume, Set Loop Mode, Set AutoPlay, Set AutoLeave, Replay Track, Remove From Queue, Shuffle Queue, Apply Filter, Clear Filters, Search Tracks. All actions are new, built for advanced command building, automations, menus, DJ tools, and fully custom music systems. ### [](https://documentation.botghost.com/changelog/2025#music-events-29) Music Events (29) Track events: start, end, stuck, exception, queue finished Player controls: play, pause, resume, stop, skip, seek, shuffle Queue events: added, removed Settings: volume, loop mode, autoplay, autoleave Connection: connect, disconnect, moved, auto-leave triggered Filters: updated System: player created, updated, destroyed, node switched, socket closed These enable complete automation, reactive features, and dynamic music experiences. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252Ft6PoVwVpCHLukGEMHzqR%252Fimage.png%3Falt%3Dmedia%26token%3Daf72433e-e8fd-49a4-a057-f36c31a9ad60&width=768&dpr=3&quality=100&sign=63ddf0c&sv=2) ### [](https://documentation.botghost.com/changelog/2025#music-variables) Music Variables **Object Variables:** `{MusicPlayer}`, `{MusicCurrentTrack}`, `{MusicQueue}`, `{MusicSearchResult}` **Helper Variables:** Search results, track metadata (title, artist, URL, requester), durations, position, remaining time, progress %, queue length, next track, total queue duration, formatted lists, and player state (playing, paused, connected, ready, loop mode text, volume %, autoplay, autoleave). ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FzbHBzbOp7WcBOUY8bKVQ%252Fimage.png%3Falt%3Dmedia%26token%3D4dd49b8c-7109-46bc-a71c-8166f3cd5895&width=768&dpr=3&quality=100&sign=c8998d6e&sv=2) ### [](https://documentation.botghost.com/changelog/2025#music-module) Music Module A full plug-and-play music system using all the new actions and events. It includes complete prebuilt commands for playback, queue management, filters, and more. You can customize any command, change logic, adjust permissions, reset the module, or remove it entirely. It works as both a ready-to-use system and a blueprint for your own custom features. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252Fs1bdMbKgTQF6C4IsqERq%252Fimage.png%3Falt%3Dmedia%26token%3D97a2665a-23f4-44cd-8e17-801bf55a66d2&width=768&dpr=3&quality=100&sign=187fba81&sv=2) ### [](https://documentation.botghost.com/changelog/2025#whats-coming-next) What’s Coming Next Variable support for dropdown options, success/error handlers, improvements to first-track playback stutter, fixes for rare track-related crashes, further Lavalink refinements, and general stability improvements. [](https://documentation.botghost.com/changelog/2025#reintroduction-of-the-message-builder-module-november-5th-2025) Reintroduction of the Message Builder Module - November 5th, 2025 ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- We’ve rebuilt and reintroduced the **Message Builder** with a brand-new templating system, improved embed tools, and full integration with the Command and Event Builders. You can now **create, save, and reuse professional Discord messages** anywhere in your bot. The new Message Builder is **available to all users immediately**. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FjgNICvHT5BiBCuz1VPGs%252Fimage.png%3Falt%3Dmedia%26token%3D8343f962-730b-40ac-b955-8f4c7f1cc2d6&width=768&dpr=3&quality=100&sign=334ede54&sv=2) ### [](https://documentation.botghost.com/changelog/2025#what-is-the-message-builder) What is the Message Builder The Message Builder lets you design and manage embeds visually — no code needed. You can preview messages live, save them as templates, send them to channels or webhooks, and load them directly into commands and events. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FDEp15a6v5u3NqnwqUky6%252Fimage.png%3Falt%3Dmedia%26token%3D49e0e2fa-f8a7-461e-915e-7982f0b9980f&width=768&dpr=3&quality=100&sign=79a91b3c&sv=2) ### [](https://documentation.botghost.com/changelog/2025#key-features) Key Features * **Visual Message Creation** – Build up to 10 embeds with markdown, colors, fields, images, and timestamps. * **Template System** – Save, edit, and reuse templates across your bot. * **Smart Validation** – Live counters and error checks keep messages within Discord limits. * **Multiple Send Options** – Send via Bot, Webhook, or load templates in commands/events. * **Mobile Friendly** – Works seamlessly on all devices with live preview and autosave. ### [](https://documentation.botghost.com/changelog/2025#advanced-message-block-integration) Advanced Message Block Integration The **Advanced Message** block in the Command and Event Builders now fully integrates with the Message Builder: * **Load templates** you’ve created in the Message Builder. * **Save new templates** directly from within your command or event — they’ll instantly appear in the Message Builder module. This two-way sync makes it easy to manage and reuse professional messages without recreating them each time. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252Fg0pxWBETAWAuD56FdGSM%252Fimage.png%3Falt%3Dmedia%26token%3D2b74c4de-edb2-48c2-b563-1c46703ccf4d&width=768&dpr=3&quality=100&sign=f302ad0b&sv=2) ### [](https://documentation.botghost.com/changelog/2025#free-vs-premium) Free vs Premium **Free Users:** Up to 5 templates with full builder access. **Premium Users:** Unlimited templates and usage in all commands/events. ### [](https://documentation.botghost.com/changelog/2025#common-uses) Common Uses Welcome messages • Server rules • Announcements • Help menus • Event notifications • FAQs • Changelogs The updated Message Builder is live under **Message Builder** in your dashboard. [](https://documentation.botghost.com/changelog/2025#create-transcript-action-beta-october-28th-2025) Create Transcript Action (Beta) - October 28th, 2025 --------------------------------------------------------------------------------------------------------------------------------------------------------------- We’ve released the brand new **Create Transcript** action — a powerful new feature that lets you generate secure, HTML archives of any Discord channel. Perfect for support tickets, meeting logs, moderation evidence, and more. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252Fq4334LAbwUtxIHQxki3d%252Fimage.png%3Falt%3Dmedia%26token%3Dc3c86964-3b82-4954-b6c8-d980ffaae4cc&width=768&dpr=3&quality=100&sign=f6b2e4e8&sv=2) ### [](https://documentation.botghost.com/changelog/2025#what-are-transcripts) What Are Transcripts Transcripts let you save and view complete chat histories in a clean, searchable HTML format. They include: * Full message content with markdown, embeds, and attachments, * Usernames, avatars, and timestamps, * Message links that jump directly back to Discord, * Optional password protection for sensitive data ### [](https://documentation.botghost.com/changelog/2025#how-it-works-1) How It Works Add the new **Create Transcript** action inside your commands or events under **Message Actions**. * Choose a **Target Channel** (current or specific), * Give your transcript a **custom name** (supports variables like `{user_name}` or `{server}`), * Add an **optional tag** for organization (support, moderation, meetings, etc.), * Set **message limits** (1–1000), * Optionally filter by **date range**, * Choose whether to **include bot messages**, * You can also access your transcript URLs later in the command via optional variables ### [](https://documentation.botghost.com/changelog/2025#themes) Themes You can choose between two transcript layouts: * **Simple Theme** — Clean, modern design with full customization Customization options include: * Primary and background colors * Message density * Avatar and timestamp visibility * Custom header text ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FWRhcRUYPjqc8qywN6cFj%252Fimage.png%3Falt%3Dmedia%26token%3Dd88759a3-0697-405f-9c9a-b251320f1d0d&width=768&dpr=3&quality=100&sign=bf35f5b9&sv=2) * **Discord Theme** — Authentic Discord-style interface that replicates the chat layout ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FFseOKVB6pwdnwepBQSnh%252Fimage.png%3Falt%3Dmedia%26token%3D8823a6e9-f61d-4a25-9fec-49fbff2ef11a&width=768&dpr=3&quality=100&sign=7c267b7b&sv=2) ### [](https://documentation.botghost.com/changelog/2025#password-protection) Password Protection Keep private transcripts secure: * Enable password protection in settings, * Passwords are required for **view**, **download**, and **raw access**, * Passwords are securely hashed with bcrypt, Ideal for confidential support tickets, HR logs, or moderation records. ### [](https://documentation.botghost.com/changelog/2025#managing-transcripts) Managing Transcripts All your transcripts can be viewed directly on the dashboard on the [**Transcripts Page**](https://dashboard.botghost.com/dashboard/transcripts) . From this page, you can: * View, download, or delete transcripts, * Search and filter by name, tag, or server, * See creation date, message count, and password status ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252F1MerkDe2Tswe4Y9HWcIW%252Fimage.png%3Falt%3Dmedia%26token%3D68b6b37a-918d-4de9-aade-01ae721b422b&width=768&dpr=3&quality=100&sign=4c48e42c&sv=2) ### [](https://documentation.botghost.com/changelog/2025#tips-and-notes) Tips & Notes * Limit messages to only what’s needed for faster generation, * Use tags and descriptive names for better organization, * Secure sensitive transcripts with passwords, * Transcripts automatically delete after **365 days** Transcripts are currently in **beta only**. You can enable beta in the settings page of your bot. [](https://documentation.botghost.com/changelog/2025#module-builder-removal--twitch-youtube-module-depreciation--block-floating-helper-text-october-17t) Module Builder Removal + Twitch/YouTube Module Depreciation + Block Floating Helper Text - October 17th, 2025 --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/changelog/2025#module-builder-removal) Module Builder Removal The **Custom Module Builder** has been removed. While powerful, it was built on top of the **old JSON-based module system**, making it overly complicated, hard to maintain, and confusing for new users. This architecture also made future integration with **BotPanel** difficult and unintuitive. We plan to rebuild this system from the ground up into something **far simpler and cleaner**, focusing on **assigning inputs and custom variables (BGVARS)** that can be easily controlled and reused. This approach will make future integrations seamless and much easier to understand. You can still re-enable the old builder from **Settings → Show Custom Module Builder** if you wish to view or edit old modules. ### [](https://documentation.botghost.com/changelog/2025#twitch--youtube-modules-depreciation) Twitch + YouTube Modules Depreciation The old **Twitch** and **YouTube Custom Modules** have been **deprecated** (unless already enabled). They’ve been replaced with new, simplified modules that — when clicked — **instantly open the Custom Event Builder** with the **corresponding Twitch or YouTube event pre-selected**. This removes unnecessary steps and aligns everything under the cleaner **event-based workflow**. ### [](https://documentation.botghost.com/changelog/2025#new-helper-text-for-blocks) New: Helper Text for Blocks You can now add **Helper Text** to any block: * Floating label beside your block for quick notes, * Customizable **icon**, **border color**, and **position**, * Great for reminders, explanations, or TODOs inside complex setups ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252F2ufoTGzYpEaZQ7pOIcXb%252Fimage.png%3Falt%3Dmedia%26token%3De1e77609-ec0f-4c79-a45f-d8df77928f32&width=768&dpr=3&quality=100&sign=a80f0bed&sv=2) [](https://documentation.botghost.com/changelog/2025#youtube-video-upload-action-event-october-16th-2025) YouTube Video Upload Action Event - October 16th, 2025 --------------------------------------------------------------------------------------------------------------------------------------------------------------------- We’ve added a new **YouTube Video Upload** Action Event to BotGhost. Your bot can now automatically notify your Discord server whenever a YouTube channel uploads a new video — no webhooks or external integrations required. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FveicQ3MGF87wgS84xMgX%252Fimage.png%3Falt%3Dmedia%26token%3D7d18b903-0b34-48d2-9483-e0abb6ba436b&width=768&dpr=3&quality=100&sign=91da620b&sv=2) ### [](https://documentation.botghost.com/changelog/2025#overview) Overview The **YouTube Video Upload** event monitors any YouTube channel and posts an automatic message when a new video is uploaded. You can include the video’s title, description, thumbnail, duration, and live subscriber count directly in your Discord message or embed. Perfect for communities that want instant updates from their favorite creators, gaming channels, or news sources. ### [](https://documentation.botghost.com/changelog/2025#key-features-1) Key Features * Instant notifications within seconds of a new upload * No IFTTT, webhooks, or external setup needed * Works with any YouTube channel * Accepts all formats: URLs, @handles, or Channel IDs * Includes 19 dynamic variables for channel and video info * Automatically filters private, unlisted, and premieres * Built-in duplicate protection ### [](https://documentation.botghost.com/changelog/2025#setup-guide) Setup Guide 1. Go to **Custom Events** in your BotGhost dashboard 2. Click **\+ New Event** 3. Select **YouTube Video Upload** from the Action Events list 4. Enter any YouTube channel — paste a link, handle, or channel ID 5. Click **Validate Channel** to confirm the channel and subscribe 6. Configure your **Send or Edit a Message** block 7. Save the event ### [](https://documentation.botghost.com/changelog/2025#available-variables) Available Variables **Channel Data:** * `{event_youtube_channel_name}` – Channel name, * `{event_youtube_channel_title}` – Display title * `{event_youtube_channel_icon}` – Channel avatar * `{event_youtube_channel_description}` – Channel description * `{event_youtube_channel_subscribers}` – Subscriber count * `{event_youtube_channel_videos}` – Total videos * `{event_youtube_channel_views}` – Total views * `{event_youtube_channel_url}` – Channel link **Video Data:** * `{event_youtube_video_title}` – Video title * `{event_youtube_video_description}` – Video description * `{event_youtube_video_thumbnail}` – HD thumbnail * `{event_youtube_video_url}` – Video link * `{event_youtube_video_duration}` – Duration * `{event_youtube_video_upload_time}` – Upload date/time * `{event_youtube_video_views}` – View count * `{event_youtube_video_likes}` – Like count * `{event_youtube_video_comments}` – Comment count ### [](https://documentation.botghost.com/changelog/2025#highlights) Highlights * Works instantly — typically under 30 seconds * Always accurate — stats are updated every upload * Handles high-frequency channels reliably * Fully customizable messages and embeds * Uses your own bot to post directly to your server This new Action Event makes YouTube notifications effortless to set up and fully customizable inside the BotGhost builder. Just validate a channel, configure your message, and your bot will automatically post new video alerts. [](https://documentation.botghost.com/changelog/2025#twitch-alerts-action-event-october-15th-2025) Twitch Alerts Action Event - October 15th, 2025 ------------------------------------------------------------------------------------------------------------------------------------------------------- We’ve added a new **Twitch Alerts Action Event** to BotGhost. This event makes setting up Twitch alerts simple and automatic — no need for webhooks, IFTTT, or any external setup. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FjKwrlhBqgjwT3JGqPkhA%252Fimage.png%3Falt%3Dmedia%26token%3Ddee255d8-ca0b-4f41-a2a5-0586ddfc4900&width=768&dpr=3&quality=100&sign=968e941e&sv=2) ### [](https://documentation.botghost.com/changelog/2025#overview-1) Overview The new **Twitch Stream Online** Action Event instantly notifies your Discord server when a Twitch streamer goes live. Your bot can post messages or embeds with full stream information such as title, game, thumbnail, and viewer count. This replaces the old manual process and allows you to create alerts entirely within the BotGhost builder. ### [](https://documentation.botghost.com/changelog/2025#key-features-2) Key Features * Instant notifications when a stream goes live * No IFTTT, webhooks, or external setup required * Pre-configured block for fast setup * Full Twitch data available as variables * Works with any public Twitch channel ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FPB8yC0WmBrgBHL06CejV%252Fimage.png%3Falt%3Dmedia%26token%3Dad99168b-47e3-427a-94ee-fca9769c224d&width=768&dpr=3&quality=100&sign=8af160be&sv=2) ### [](https://documentation.botghost.com/changelog/2025#how-to-use) How to Use 1. Go to **Custom Events** in your BotGhost dashboard and create a new event. 2. Select **Twitch Stream Online** from the Action Events list 3. Enter a Twitch username or URL and click **Validate Channel** 4. Customize the **Send or Edit a Message** block for your alert 5. Save the event This update makes setting up Twitch alerts effortless — just one click and your bot will automatically announce when your favorite streamers go live. [](https://documentation.botghost.com/changelog/2025#slash-command-autocomplete-october-8th-2025) Slash Command Autocomplete - October 8th, 2025 ----------------------------------------------------------------------------------------------------------------------------------------------------- We’ve added support for **Autocomplete** in slash command options. This feature allows your commands to provide dynamic, searchable suggestions to users as they type into a text option. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FbN3oWQmn835xFEnTJts6%252Fimage.png%3Falt%3Dmedia%26token%3D616859e5-6ebf-4ea8-a732-a569a888383a&width=768&dpr=3&quality=100&sign=a4ea3104&sv=2) ### [](https://documentation.botghost.com/changelog/2025#what-is-autocomplete) What Is Autocomplete Autocomplete displays a list of suggestions while a user types into a slash command field. It helps users quickly find valid inputs without needing to remember exact terms or make guesses. ### [](https://documentation.botghost.com/changelog/2025#how-it-works-2) How It Works * **Available on Text Options** – When creating a slash command, you’ll now see an “Autocomplete” toggle on text options. * **Configure Choices** – Click “Configure Autocomplete” to open a modal where you can add up to 25 choices. * **Label & Value Pairs** – Each choice has a label (visible to users) and a value (sent to the command). * **Automatic Filtering** – Discord automatically filters these suggestions based on what the user types. * **Easy Management** – You can reorder, add, or remove choices as needed with a live counter showing how many are configured. ### [](https://documentation.botghost.com/changelog/2025#benefits) Benefits * **Improved User Experience** – Users can easily find valid command options without typing errors. * **Cleaner Commands** – Avoids typos and inconsistent input. * **Dynamic & Modern** – Makes slash commands feel smoother and more interactive. ### [](https://documentation.botghost.com/changelog/2025#notes) Notes * Only available on **Text options**. * You can configure **up to 25 choices per option**. * Autocomplete and static choices cannot be used together. * Variables cannot be used in autocomplete since it runs before the command executes. This feature was suggested by the community [here](https://discord.com/channels/822426820447567872/1421016837558374502) — thank you to everyone who shares their ideas. [](https://documentation.botghost.com/changelog/2025#components-v2-message-builder-6th-october-2025) Components V2 Message Builder - 6th October, 2025 ----------------------------------------------------------------------------------------------------------------------------------------------------------- We’ve introduced the new **Components V2 Message Builder**, which brings Discord’s latest **Display Components system** to BotGhost. This allows you to visually create advanced messages with up to **40 components** in a single layout. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FZ0289en3xNWBimypKRhH%252Fimage.png%3Falt%3Dmedia%26token%3Da374ce49-22be-4357-a743-e32224d9b9f4&width=768&dpr=3&quality=100&sign=7381a6f8&sv=2) ### [](https://documentation.botghost.com/changelog/2025#overview-2) Overview Components V2 lets you build Discord messages using a **drag-and-drop interface** that supports containers, sections, text, buttons, menus, and other display elements. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252Foted0OKdvzKemEwZoWVy%252Fimage.png%3Falt%3Dmedia%26token%3D59021a80-8671-45cb-a30c-72a4ae5d61d7&width=768&dpr=3&quality=100&sign=d5b9217d&sv=2) ### [](https://documentation.botghost.com/changelog/2025#available-component-types) Available Component Types * **Container:** Root wrapper for grouping sections and text * **Section:** Organizes content and can include an accessory button * **Text:** Add formatted text with mention control * **Button:** Interactive button component * **Select Menu:** Dropdown menu for user selections * **Thumbnail:** Displays images with optional spoilers or descriptions * **Separator:** Divider line between content * **Media Gallery:** Show multiple media items * **File:** Attach files with optional spoiler protection * **Action Row:** Automatically created for buttons and menus ### [](https://documentation.botghost.com/changelog/2025#buttons-and-menus) Buttons and Menus Buttons and select menus are now created **directly inside the builder**: * Dropping one onto the canvas automatically creates an **Action Row** * Each Action Row can contain **up to 5 buttons** or **1 select menu** (not both) * Buttons can also be added as **accessories** to sections * The builder automatically validates and prevents invalid configurations ### [](https://documentation.botghost.com/changelog/2025#structure-and-limits) Structure and Limits * **40 components maximum** per message * **Containers** must be top-level elements * **Sections** can be nested within Containers but not each other * **Action Rows** can only contain buttons or menus * Empty Containers or invalid setups will show validation warnings ### [](https://documentation.botghost.com/changelog/2025#allowed-mentions-beta) Allowed Mentions (Beta) A new **Allowed Mentions** system has been added to both the standard Message Builder and Components V2. You can now control who gets pinged in messages: * **Simple Mode:** Allow or block user, role, or everyone mentions * **Advanced Mode:** Specify exact user or role IDs allowed to be pinged ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252F1B7fdHR7SPJeXjKVGGTP%252Fimage.png%3Falt%3Dmedia%26token%3D1ace97c6-1428-484b-a708-dadb926f3dfb&width=768&dpr=3&quality=100&sign=8500cc34&sv=2) ### [](https://documentation.botghost.com/changelog/2025#beta-status) Beta Status Components V2 is currently in **BETA**. This means it is buggy and subject to change. A preview for the message builder is still in the works. Enable Beta Features in your settings to access it. ### [](https://documentation.botghost.com/changelog/2025#whats-coming-next-1) What's coming next? * Full music update with actions and events * Update regarding what we have planned for free users (tomorrow) [](https://documentation.botghost.com/changelog/2025#massive-discord-event-system-update-september-29th-2025) Massive Discord Event System Update - September 29th, 2025 ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- We’ve rolled out one of the **biggest expansions ever** to our event system! This update introduces **brand new events**, upgrades many existing ones, and brings in a huge range of **new Object Variables** for deeper automation. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FYtpa7D0wVhHQrH4SLHLu%252Fimage.png%3Falt%3Dmedia%26token%3D1e0cdcbd-641d-4567-bca6-1794614652ee&width=768&dpr=3&quality=100&sign=b0ee556&sv=2) ### [](https://documentation.botghost.com/changelog/2025#id-33-new-events) 33 New Events #### [](https://documentation.botghost.com/changelog/2025#auto-moderation) Auto Moderation * `autoModerationActionExecution` * `autoModerationRuleCreate` * `autoModerationRuleDelete` * `autoModerationRuleUpdate` #### [](https://documentation.botghost.com/changelog/2025#application-commands) Application Commands * `applicationCommandPermissionsUpdate` #### [](https://documentation.botghost.com/changelog/2025#channels) Channels * `channelPinsUpdate` #### [](https://documentation.botghost.com/changelog/2025#guild-management) Guild Management * `guildAuditLogEntryCreate` * `guildIntegrationsUpdate` * `guildFeaturesUpdate` * `guildOwnerUpdate` * `guildPartnerAdd` * `guildPartnerRemove` * `guildNameUpdate` * `guildAfkChannelAdd` * `guildAfkChannelRemove` * `guildBannerAdd` * `guildBannerRemove` #### [](https://documentation.botghost.com/changelog/2025#messages) Messages * `messageReactionRemoveAll` * `messageReactionRemoveEmoji` #### [](https://documentation.botghost.com/changelog/2025#stage-instances) Stage Instances * `stageInstanceCreate` * `stageInstanceUpdate` * `stageInstanceDelete` #### [](https://documentation.botghost.com/changelog/2025#stickers) Stickers * `stickerCreate` * `stickerUpdate` * `stickerDelete` #### [](https://documentation.botghost.com/changelog/2025#threads) Threads * `threadListSync` * `threadMembersUpdate` * `threadMemberUpdate` #### [](https://documentation.botghost.com/changelog/2025#other-voice) Other / Voice * `typingStart` * `voiceServerUpdate` #### [](https://documentation.botghost.com/changelog/2025#discord-logs-extras) Discord-logs Extras * `guildChannelTopicUpdate` * `guildMemberEntered` * `voiceStreamingStart` * `voiceStreamingStop` ### [](https://documentation.botghost.com/changelog/2025#id-24-updated-events) 24 Updated Events We’ve enhanced existing events with new object variables and more detail. * **Roles**: `guildMemberRoleAdd`, `guildMemberRoleRemove` → `{Role}` * **Reactions**: `messageReactionAdd`, `messageReactionRemove` → `{Reaction}` * **Emoji**: `emojiCreate`, `emojiUpdate`, `emojiDelete` → `{Emoji}` * **Guild Scheduled Events**: all 5 scheduled event triggers → `{GuildScheduledEvent}` * **Guild Bans**: `guildBanAdd`, `guildBanRemove` → `{GuildBan}` * **Presence**: `presenceUpdate` → `{Presence}` * **Voice State**: all 9 voice events + streaming start/stop → `{VoiceState}` ### [](https://documentation.botghost.com/changelog/2025#id-11-new-object-variables) 11 New Object Variables We’ve added a powerful set of object variables you can now use across events: * `{Sticker}` * `{AuditLogEntry}` * `{StageInstance}` * `{AutoModerationRule}` * `{AutoModerationActionExecution}` * `{Reaction}` * `{Emoji}` * `{GuildScheduledEvent}` * `{GuildBan}` * `{Presence}` * `{VoiceState}` ### [](https://documentation.botghost.com/changelog/2025#what-this-means) What This Means * Automate **auto-moderation**, **reactions**, **voice activity**, **scheduled events**, **stickers**, and more * Access detailed context with simple **object variables** This update is fully **backward compatible** – your existing events still work, but now you can do so much more. [](https://documentation.botghost.com/changelog/2025#add-roles-to-all-users--remove-roles-from-all-users-september-28th-2025) Add Roles to All Users + Remove Roles from All Users - September 28th, 2025 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FfolR3Q3X9PeG9nLvTUhG%252Fimage.png%3Falt%3Dmedia%26token%3Dbee2cba1-0581-44c4-8563-56872b4e5339&width=768&dpr=3&quality=100&sign=f272ebd8&sv=2) ### [](https://documentation.botghost.com/changelog/2025#add-role-to-all-users) Add Role to All Users * Instantly give a role to everyone in your server, * Perfect for server events, promotions, or new role setups, * Saves hours of manual assigning on large servers ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FXUuYxDybEJTaIfZdlV7G%252Fimage.png%3Falt%3Dmedia%26token%3D611e9d95-9f19-410e-8b25-2d1a89e3911e&width=768&dpr=3&quality=100&sign=6f53385f&sv=2) ### [](https://documentation.botghost.com/changelog/2025#remove-roles-from-all-users) Remove Roles from All Users * Instantly remove a role from everyone in your server * Clean up old or unused roles in one click * Restructure or reset your permission system with ease * Includes a **“Nuclear Option”** to strip _all roles from all users_ (with built-in safety checks) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252F9OK4F8L0TMj2B5sNqP9S%252Fimage.png%3Falt%3Dmedia%26token%3D7efc09f6-b730-4ff2-98b0-fd55a3ec1474&width=768&dpr=3&quality=100&sign=35e84be3&sv=2) ### [](https://documentation.botghost.com/changelog/2025#safety--configuration) Safety + Configuration * Respect's role hierarchy (won’t touch roles above your bot) * Option to include/exclude bots * Custom audit log reasons * Double confirmation + extra warnings for irreversible actions These new role actions are now available in the **Role Actions** section of your Command + Event Builder. [](https://documentation.botghost.com/changelog/2025#new-forum-post-option--auto-role-on-join-event-september-25th-2025) New Forum Post Option + Auto Role on Join Event – September 25th, 2025 ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/changelog/2025#send-a-message-update) Send a Message Update We’ve added a new **“Send the message in a new forum post”** option to the **Send a Message** action. With this, you can now: * Create a brand-new forum post in any forum channel. * Set a custom title for the new post. * Use all the normal message options inside the post. ### [](https://documentation.botghost.com/changelog/2025#update-auto-role-on-join-event) Update: Auto Role on Join Event We are introducing a new category of Action Events – powerful pre-built events and actions that act like multiple blocks in one, making it much easier to create common bot features. The first of these is the Auto Role on Join event. When a user joins your server, this event will automatically assign roles to them. ### [](https://documentation.botghost.com/changelog/2025#features) Features: * Roles to Assign – Pick one or multiple roles that should be added automatically. * Reason Logging – Provide a reason that shows in the server’s audit log. * Assignment Delay – Delay role assignment by up to 5 minutes (useful for spam prevention). * Filter Bots – Optionally prevent bots from being assigned roles. * Require Verification – Only assign roles to members with verified phone numbers. * Customizable – Add more blocks (welcome messages, logging, etc.) to the event like a normal custom event. This is just the beginning – more pre-configured events and blocks are on the way, including: * Welcome card events/blocks * YouTube/Twitch/Reddit notification events * Temp Ban/Unban + Temp Mute * Auto moderation logging * Add/Remove roles from all users * Reaction Role menus ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FEKkb9ZxR8Ed44LXOj2Pz%252Fimage.png%3Falt%3Dmedia%26token%3D0da1af53-61a6-431e-b4aa-a2cda8f8dad4&width=768&dpr=3&quality=100&sign=f4959c27&sv=2) [](https://documentation.botghost.com/changelog/2025#bug-fixes-september-23rd-2025) Bug Fixes - September 23rd, 2025 ------------------------------------------------------------------------------------------------------------------------- We’ve patched a number of bugs across the builder and dashboard. ### [](https://documentation.botghost.com/changelog/2025#builders--ui) Builders + UI * Fixed key field hiding/showing incorrectly when switching variable types * Fixed short text input (set to _Text_) showing number fields * Fixed variables rename not updating in conditions * Fixed conditional displays shrinking inputs when stacked outside slot containers * Fixed component variable resetting when moved to another section * **Fixed Input Switcher issues:** * Default message not saving * Default switch (plain/embed) not saving * Variables missing in block settings and selector * Listed variables not working ### [](https://documentation.botghost.com/changelog/2025#timed-events) Timed Events * Fixed random crashes in timed events tab * Fixed channel variable selection hiding channel ID input in delete variable action ### [](https://documentation.botghost.com/changelog/2025#variables) Variables * Fixed duplicated “Basic Variables” sub header in variable editor ### [](https://documentation.botghost.com/changelog/2025#other) Other * Fixed default command cooldowns and permissions returning errors or nothing * Fixed inability to delete block templates * Fixed save required banner briefly appearing in test mode [](https://documentation.botghost.com/changelog/2025#command--events-tab-updates-september-17th-2025) Command + Events Tab Updates - September 17th, 2025 -------------------------------------------------------------------------------------------------------------------------------------------------------------- As promised, we’ve further extended the functionality of the **Commands + Events Tab** within the builder! You can now: * View **custom module commands and events** directly in the builder * **Switch** between commands and events you are working on * **Create** new commands and events inside the builder * Quickly access **custom module settings** from the builder * **Edit, enable, or disable** custom module commands and events without leaving the builder [](https://documentation.botghost.com/changelog/2025#bug-fixes-september-15th-2025) Bug Fixes - September 15th, 2025 ------------------------------------------------------------------------------------------------------------------------- Stability improvements and bug fixes across the builder and modules. * Fixed text cursor jumping in custom modules * Removed **“New”** tags from modules * Fixed false Save Required popup * Fixed duplicated edit IDs when duplicating blocks * Removed old experimental mobile builder toggle **(mobile is now default)** * Fixed shop item props not saving correctly on creation [](https://documentation.botghost.com/changelog/2025#major-command--event-builder-overhaul-september-12th-2025) Major Command + Event Builder Overhaul - September 12th, 2025 ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- We’ve merged core bot management directly into the Builder. You can now work end-to-end without leaving the page—fewer tabs, less context switching, faster iteration. ### [](https://documentation.botghost.com/changelog/2025#whats-included-all-inside-the-builder) What’s Included (All Inside the Builder) * **Error Logs** • View recent errors with a quick **Refresh** button. * **Custom Variables / Data Storage** • Create, edit, and delete variables in place; newly created variables appear instantly in all selectors. * **Custom Commands & Events** • Enable/disable, delete, and (soon) jump straight into editing other commands/events from here. * **Timed Events** • Create, manage, delete, and set your **Timezone** and **Default Server** for timers. * **Block Templates** • Your saved templates live here. We’ll be shipping curated defaults for common patterns (CDs, loop users, etc.) next. > This overhaul aims to flatten the learning curve and keep everything you tweak most often within arm’s reach. In-builder, step-by-step tutorials for each tab are coming soon. ### [](https://documentation.botghost.com/changelog/2025#variables-tab) Variables Tab * Create, edit, and delete **custom variables** without leaving your flow. * **Instant availability**: new variables show up immediately in any variable selector. * Get a clear, at-a-glance view of what exists before you wire it into logic. ### [](https://documentation.botghost.com/changelog/2025#errors-tab) Errors Tab * A focused **feed of your bot’s errors**, right inside the Builder. * Functions like the old error logs page, now with a handy **Refresh**. ### [](https://documentation.botghost.com/changelog/2025#commands-events-tab) Commands / Events Tab * Quickly **enable/disable** or **delete** existing commands and events. * **Coming soon:** jump into editing another command/event without leaving the Builder. * **Also coming:** create brand-new commands/events directly from this tab. ### [](https://documentation.botghost.com/changelog/2025#timed-events-tab) Timed Events Tab * **Create, manage, and delete** timers from one place. * Configure your **Timezone** and **Default Server** so schedules behave exactly as expected. ### [](https://documentation.botghost.com/changelog/2025#block-templates-tab) Block Templates Tab * Find and organize your **block templates**. * **Soon:** a growing library of curated templates for high-demand patterns (CDs, user loops, and more). ### [](https://documentation.botghost.com/changelog/2025#bug-fixes-and-improvements) Bug Fixes & Improvements * Fixed an issue where **Custom Modules** wouldn’t show when **Beta** was disabled. * Fixed a bug preventing **forms (modals)** from connecting to the **After Loop** block. * Added **up/down arrows** to inputs inside a **slot** to easily reorder them. * Fixed **variable group positioning** on the **Data Storage** page. * **New bots** are now created with a set of **default, common Timed Events** to help you get started faster. [](https://documentation.botghost.com/changelog/2025#object-variable-collections--variable-selector-update-september-11th-2025) Object Variable Collections + Variable Selector Update - September 11th, 2025 ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ ### [](https://documentation.botghost.com/changelog/2025#exposing-collections-on-object-variables) Exposing Collections on Object Variables All object variable **properties that return a Manager or Collection** will now return an **array of IDs** (or values if IDs aren’t available). This means you can now directly work with lists inside your commands and events, without needing extra steps. **Examples:** * `{Role.members}` → `[memberId1, memberId2, ...]` * `{Channel.members}` → `[memberId1, memberId2, ...]` * `{Member.roles}` → `[roleId1, roleId2, ...]` This is a **major update** — every object property that previously gave a manager/collection will now return a usable array. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FGwWxKM8s0wfc2EHsW1LQ%252Fimage.png%3Falt%3Dmedia%26token%3D62107795-280d-460c-8a99-c7d82f9653b5&width=768&dpr=3&quality=100&sign=7c3269bb&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FV8TsGPRee3lz5SLht0ja%252Fimage.png%3Falt%3Dmedia%26token%3D6aee87c0-3aa5-465f-93f8-6e8b2681b74c&width=768&dpr=3&quality=100&sign=4d276db7&sv=2) ### [](https://documentation.botghost.com/changelog/2025#updated-variable-selector-easier-object-usage) Updated Variable Selector (easier Object usage) * **Secondary page** on click for all object variables showing **all available properties**. * **Context-aware insertion:** the object changes based on the event. * Example: in a **Message Send** event, the **Message** object is inserted as `{Message.}` (no `[id]` part). * Designed to make selecting and using object properties **faster and clearer**. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FjBz0MVPHOKoU5ETikvdA%252Fimage.png%3Falt%3Dmedia%26token%3Dcc02bf5f-6653-4d1c-900b-bb0a0eae9a29&width=768&dpr=3&quality=100&sign=e03a6e20&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FsBi9yUoUSHxqdy306dmG%252Fimage.png%3Falt%3Dmedia%26token%3De7d384fd-8120-4a7c-948e-3f17aa9f632a&width=768&dpr=3&quality=100&sign=4174f297&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FkKTQ0bqsZHkUZylPd4Eb%252Fimage.png%3Falt%3Dmedia%26token%3D0a3d59bb-3487-4a91-bcde-ec00ebd12554&width=768&dpr=3&quality=100&sign=b9054b4b&sv=2) ### [](https://documentation.botghost.com/changelog/2025#custom-module-builder-out-of-beta) Custom Module Builder Out of Beta The **Custom Module Builder** is now out of beta! * We were still in the middle of testing when the Discord situation began, so your reports will help us polish and stabilize it quickly. ### [](https://documentation.botghost.com/changelog/2025#bug-fixes-2) Bug Fixes * Fixed **Leave Server** buttons not working on the `/servers` page * Fixed **mobile event builder** crash on first load due to the new tutorial. * Fixed **target switching** when changing event types with a preconfigured **Advanced Message**—target now updates to a valid option. * Fixed a **visual bug** with examples in the **Equation** block. * Fixed a **visual bug** in the **Variable Search Selector** that showed **Number** variables as **Text**. * Fixed an issue where **CTRL+C / CTRL+V** duplicated a block’s internal `editId`, which could cause the **wrong message block** to be edited. [](https://documentation.botghost.com/changelog/2025#api--actions-update-september-10th-2025) API + Actions Update - September 10th, 2025 ---------------------------------------------------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/changelog/2025#api-updates) API Updates * Removed guard rails around the **/users/@me** route. Discord has stealthily removed the token previously returned with the PATCH request on this route (undocumented change, no response to report). * Fixed **Test Request** for the API Action in the dashboard. It now works correctly with **RAW JSON body mode**. ### [](https://documentation.botghost.com/changelog/2025#new-action) New Action * **Server Leave Action** – Added a new action that allows you to force the bot to leave a server. ### [](https://documentation.botghost.com/changelog/2025#bug-fixes-3) Bug Fixes * Fixed a bug where **error messages** were not being triggered after a button or menu interaction. [](https://documentation.botghost.com/changelog/2025#variable-editor-additions--bug-fixes-september-8th-2025) Variable Editor Additions + Bug Fixes - September 8th, 2025 ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ ### [](https://documentation.botghost.com/changelog/2025#variable-editor-additions) Variable Editor Additions * **Created Variables in Editor** – Variables generated during command/event execution now appear in the editor. * **Coverage** – Unique variables; API Request variables; Create Role/Channel/Thread/Invite; Send/Edit Message; Text Manipulation. * **Categories** – Added categories to make the editor easier to navigate. ### [](https://documentation.botghost.com/changelog/2025#bug-fixes-4) Bug Fixes * Fixed a bug with enabling modules (Weather, Translator) that caused the enable button to fail. * Fixed custom modules disappearing during random actions on the dashboard. * Fixed the IFTTT link showing a Cloudflare error. * Fixed updates after setting intents to NEVER in the dashboard. * Fixed modules with default timed events (Timed Messages, Status, etc.) not being added on enable/reset. * Fixed a typo in the Thread Edit and Thread Create actions. * Fixed Docs links in Voice actions. * Fixed an issue when creating the first command in a module where saving twice showed “A command with this name already exists”. [](https://documentation.botghost.com/changelog/2025#message-object-raw-json-body-mode--variable-selector-fixes-september-5th-2025) {Message} Object, Raw JSON Body Mode + Variable Selector fixes - September 5th, 2025 ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/changelog/2025#message-object) {Message} Object The full **{Message} Object** has been added to **Message Events**. You can now access message data directly when working with message-based triggers. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FRc99u4cnhWalbkQCnmFk%252Fimage.png%3Falt%3Dmedia%26token%3D7fc97c78-f864-4cff-8bf2-e1391ad8cbfe&width=768&dpr=3&quality=100&sign=b7e4ab80&sv=2) ### [](https://documentation.botghost.com/changelog/2025#raw-json-body-mode) Raw JSON Body Mode The **API Request block** now supports **Raw JSON Body Mode**. This gives you full control to write and send your own JSON payloads, instead of being limited to the key/data system. ### [](https://documentation.botghost.com/changelog/2025#variable-selector-fix) Variable Selector Fix We’ve fixed an issue where some variables were missing from the Variable Selector. It should now display **all variables**. If you notice any still missing, please report them in the thread below. [](https://documentation.botghost.com/changelog/2025#new-variable-selector-september-2nd-2025) New Variable Selector - September 2nd, 2025 ----------------------------------------------------------------------------------------------------------------------------------------------- We’ve released a brand new **Variable Selector** across the builder. ### [](https://documentation.botghost.com/changelog/2025#modernized-interface) Modernized Interface The new selector is cleaner and easier to navigate, making it faster to find exactly what you need. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FkSxf8LLVDxp3xcCQkv7P%252Fimage.png%3Falt%3Dmedia%26token%3Df913727b-b3dd-47c4-807e-afebf16f066c&width=768&dpr=3&quality=100&sign=bde193a5&sv=2) ### [](https://documentation.botghost.com/changelog/2025#grouped-by-type) Grouped by Type Variables are now organized into clear groups based on: * **Category** – e.g. User, Server, Channel, Option * **Data Type** – text, number, boolean, etc. * **Variable Name** – listed in a structured, searchable way ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FSLcfVYpAOxpjPAx8vtWw%252Fimage.png%3Falt%3Dmedia%26token%3D5d145f29-af61-4925-ada8-4dc30c8a7cc5&width=768&dpr=3&quality=100&sign=f4e5e1e5&sv=2) [](https://documentation.botghost.com/changelog/2025#bug-fixes-september-1st-2025) Bug Fixes - September 1st, 2025 ----------------------------------------------------------------------------------------------------------------------- We’ve rolled out a series of fixes and improvements across multiple areas of the platform. ### [](https://documentation.botghost.com/changelog/2025#homepage) Homepage * Fixed 404 errors on the mobile layout * Fixed redirect errors on the homepage * Removed invalid links to the old BotGhost blog ### [](https://documentation.botghost.com/changelog/2025#builder-and-dashboard) Builder and Dashboard * Enabled conditions for all events regardless of required components (usable via BGVARS and APIs) * Fixed a visual bug when deleting custom module events that caused the wrong event to be deleted * Fixed issues with Options and Role actions, and Options and Channel actions * Options converted to text now return IDs automatically instead of mentionables * Disabled the old embed builder * Fixed a visual bug with the edit component action where changes incorrectly affected connected menus * Fixed a bug with the Create Server block’s optional variable field * Updated documentation links throughout the builder * Removed redundant USE\_SOUNDBOARD permission * Corrected a typo in the IFTTT Trigger action * Fixed a bug where changing a variable’s default value did not update immediately * Fixed a bug with role options not working in some fields * Thread created timestamps are now automatically converted to seconds for Discord Unix compatibility * Added missing fields to the Slot input type in the module builder * Fixed a bug with Dropdown (Select) and Multi-Channel select not loading default channel filters * Fixed a bug causing Slot Inputs to not update when switching between pages * Added placeholder input for Long Text input in the module builder * Ensured emojis render correctly in the Message Builder * Fixed a scrolling issue in the new selectors ### [](https://documentation.botghost.com/changelog/2025#collab-mode) Collab Mode * Test requests now work properly in collab mode * Fixed a bug preventing bots from being turned online via the inactivity popup in collab mode [](https://documentation.botghost.com/changelog/2025#module-updates-june-14th-2025) Module Updates - June 14th, 2025 ------------------------------------------------------------------------------------------------------------------------- Today we're releasing a few updates to some of our modules. ### [](https://documentation.botghost.com/changelog/2025#chatgpt-major-update) ChatGPT - Major Update The module has been reworked from scratch * Simpler and more intuitive design * You can now toggle individual features * Added channel and role restrictions for the respond and edit text commands. * Models can now be chosen individually for each mode * Added the most recent and updated ChatGPT models, including models of the o (reasoning) series. * You can now add a personality to your assistant. * Updated Chat Mode * Configure chat mode for multiple channels with different settings * Choose whether your bot should only respond to mentions or to all messages * Respond with an embed or a plain text message * Added role restrictions * Fixed an issue that caused the AI to not respond when using certain characters in the prompt ### [](https://documentation.botghost.com/changelog/2025#birthdays) Birthdays * Fixed an issue that caused birthdays to incorrectly display in various messages * Fixed a spelling mistake in the `/birthday view` command ### [](https://documentation.botghost.com/changelog/2025#welcomer) Welcomer * The DM Reactions setting has been removed * Fixed an issue that caused a "Cannot loop inside a loop" error to occur on user join ### [](https://documentation.botghost.com/changelog/2025#leveling) Leveling * Fixed an issue that caused colors of the card to swap with certain settings ### [](https://documentation.botghost.com/changelog/2025#image-generation) Image Generation * Fixed an issue that caused the API Key setting to not accept longer API keys ### [](https://documentation.botghost.com/changelog/2025#starboard) Starboard * Improved stability and error handling [](https://documentation.botghost.com/changelog/2025#interaction-token-update-and-bug-fixes-june-2nd-2025) Interaction Token Update & Bug Fixes - June 2nd, 2025 --------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/changelog/2025#interaction-token-vulnerability) Interaction Token Vulnerability We were recently made aware of a potential vulnerability that, under very specific conditions, allowed the `interaction_token` button/select menu variable to be hijacked by echoing user input in specific custom events. This could be used to force the bot to send a message containing a button that, when clicked, executed API requests — and in some cases, was exploited to retrieve bot tokens. We’ve now implemented **guardrails** around the `interaction_token` variable, similar to how we protect the `TOKEN_SECRET` variable. This issue has been fully **fixed**. This vulnerability was **largely contained to bots within this server and GhostBuddy**, and the user who discovered it **responsibly reported it to us early**, which helped limit any impact. If your bot uses modals or reflects user input (e.g., echoing messages in embeds or **ModMail** systems), we **recommend regenerating your bot token** as a precaution — even though the vulnerability is now resolved. While we take every precaution to secure your bots and their data, **you are solely responsible for your bot’s security**. Please practice safe development habits and stay vigilant. ### [](https://documentation.botghost.com/changelog/2025#botghost-proxy-downtime) BotGhost Proxy Downtime We recently experienced downtime with our proxy provider, which led to latency in API actions and Discord-based features. This issue has now been **fully resolved** and things should be back to normal. ### [](https://documentation.botghost.com/changelog/2025#custom-slot-bug-fix) Custom Slot Bug Fix We’ve fixed a visual bug where custom slots weren’t properly creating their associated events when added. This should now behave as expected. [](https://documentation.botghost.com/changelog/2025#economy-module-update-june-1st-2025) Economy Module Update - June 1st, 2025 ------------------------------------------------------------------------------------------------------------------------------------- A small update has been released for the Economy module: * Fixed `/balance` not showing the correct amount when viewing another user’s profile * Added audit log resets to `/ec admin` * Reworked parts of the _Chance dice_ game, including an inactivity timeout that will automatically end abandoned games * **Chance dice** was basically broken when I released it and would not account for multiple games, or multiple different people running the command. Apologies for that, this update should fix all the broken things for that minigame. [](https://documentation.botghost.com/changelog/2025#economy-updates-may-26th-2025) Economy Updates - May 26th, 2025 ------------------------------------------------------------------------------------------------------------------------- * New command - /money audit * This command will allow you to track your most recent 20 economy money changes. Did someone steal from you? How much did you get from /work? It will all be tracked here. * New minigame - /chance-dice * This minigame is all about luck... With a teeny bit of strategy. You need to roll dice, collect points and be the first to hit the winning number. The game takes place over multiple rounds but be careful, the more you roll, the higher the chance of hitting ☠️ and scoring 0 for that round! * New minigame - /turbotac * TurboTac _(patent pending)_ is a new version of Tic Tac Toe where you can only have a total of 4 pieces on the board. This means that when you place your fifth piece, your oldest placed piece will be removed. This adds a new spin on the original game and should make for some interesting matches! Fixes: * Mastermind life issue when correctly guessing on your last life fixed * Embed typo fixed for /job apply * Fixed {msg\_item\_limit} var in /shop buy when purchasing Mystery Boxes * Changed the URLs in /job apply to be www.google.com instead of botghost.com * Fixed an issue that occurred after the Mystery box re-work where if you entered a larger quantity then 1 when purchasing, it would take all your money but only give you one box. Now it will only take 1 box and charge you correctly for it. * /dicebet stats fix * Economy autorole will now assign roles based on holding + bank balance. Before it was holding only. * /scratchcard comparison condition checking the wrong amount when purchasing [](https://documentation.botghost.com/changelog/2025#module-builder--botghost-fixes-may-12th-2025) Module Builder + BotGhost Fixes - May 12th, 2025 -------------------------------------------------------------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/changelog/2025#module-builder-fixes-and-improvements) Module Builder Fixes & Improvements We’ve rolled out a number of fixes and polish to the Module Builder system: * Fixed a bug that allowed slot inputs to be dragged and dropped back into itself * Fixed icon display issue * Fixed a bug with the channel filter on single-select channel inputs * Fixed a bug that caused editing/deleting a command/event to affect the wrong one * Removed the label field from long text input * Added visual support for max length on long text inputs * Added row support to long text inputs * Fixed a visual issue with long module names in the side menu * Added user-created custom modules to the mobile menu * Fixed a bug with default shop items not being added properly * Fixed a bug with slots not being added correctly * Fixed missing "+" button on emoji selector inputs ### [](https://documentation.botghost.com/changelog/2025#botghost-updates) BotGhost Updates A wide range of fixes and enhancements throughout the platform: * Fixed: Slot events now run properly without needing to be manually force saved * Deprecated: Hardcoded automod module removed * Hidden: Webhook API key regeneration hidden in collab mode * Fixed: Advanced message channel selector crash when adding default channels * Fixed: Delete all keys option for channel-type variables * Fixed: Edit component action now triggers correctly (not just on button/menu clicks) * Fixed: Custom variable value change event now works with channel variables * Fixed: Guild member boost event reliability * Added: Variable support for additional roles, users, mentionables, and channels in select menus * Fixed: Bugs with the additional roles field in select menus * Added: `{event_user_name}` and `{event_user_display_name}` to deafen/mute events * Fixed: Role update event now fires on position change * Updated: Max label length for buttons from 32 → 80 * Fixed: Server invite create action now handles success/errors properly * Fixed: Docs link in advanced message select menu * Removed: Leave Server button in collab mode * Fixed: Importing multiple commands now works correctly * Updated: Docs links for React to a Message action * Fixed: `displayName` variable bug in DMs * Fixed: Not all modules appearing in module search * Updated: Error logs now refresh correctly when switching bots * Added: Indicator for missing timed events during timed custom event import * Fixed: Save-required banner sticking after switching bots * Fixed: Redundant modules showing in side menu * Fixed: Typo in request builder modal * Fixed: Collab mode showing incorrect banners * Fixed: Voting progress display issue on ModBuddy [](https://documentation.botghost.com/changelog/2025#major-release-custom-module-builder-beta-may-10th-2025) Major Release: Custom Module Builder (Beta) - May 10th, 2025 ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ We’re excited to announce the full release of the **Custom Module Builder**, a powerful new system that lets you design, build, and manage your own feature modules for your bot — all through a clean drag-and-drop interface! ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FmUmZ65gDMgemyhxRxFVN%252Fimage.png%3Falt%3Dmedia%26token%3D1d1c7fbd-06a9-470f-b5f1-d15c654fb9be&width=768&dpr=3&quality=100&sign=a598408e&sv=2) ### [](https://documentation.botghost.com/changelog/2025#what-is-the-module-builder) What is the Module Builder? The Module Builder allows you to create **fully customizable modules** made up of **input blocks and sections**. These sections define configurable fields that your users can interact with — such as dropdowns, text inputs, toggles, and more. Each input you add becomes a variable that can be referenced directly in your commands and events, giving you a flexible way to create dynamic behavior based on server-specific settings. * Drag and drop input blocks like **short text**, **channel select**, or **role select** * Group blocks into **sections** like "Command Settings" or "Moderation Settings" * Use the collected values inside commands/events using smart variables With this system, you no longer need to hard-code settings — just let server owners configure them through BotPanel. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FMxhyJOwjICgOJiGX7BNN%252Fimage.png%3Falt%3Dmedia%26token%3De986c287-8f0c-4be6-9e15-388d753de0ec&width=768&dpr=3&quality=100&sign=b6659eb5&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FtCfZf9WG0w9nKdH1g6qY%252Fimage.png%3Falt%3Dmedia%26token%3Deaa59c82-5d87-4cdf-ba56-60c0ac266020&width=768&dpr=3&quality=100&sign=d718cac0&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252F29NB6RimkR1z0zxhjII1%252Fimage.png%3Falt%3Dmedia%26token%3D42c372a7-e76b-47be-b599-d5e94be5946f&width=768&dpr=3&quality=100&sign=8f932943&sv=2) ### [](https://documentation.botghost.com/changelog/2025#why-use-the-module-builder) Why Use the Module Builder? * **BotPanel Integration** — Let users tweak your bot’s features for their specific server needs, without touching your source logic. * **Edit bot behavior without editing commands/events directly** — Perfect for separating config from code. ### [](https://documentation.botghost.com/changelog/2025#beta-status-1) Beta Status The Module Builder is currently in **beta** and may contain bugs or unfinished elements. [](https://documentation.botghost.com/changelog/2025#variable-formats--selector-fixes-may-5th-2025) Variable Formats + Selector Fixes - May 5th, 2025 ---------------------------------------------------------------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/changelog/2025#variable-and-formatting-improvements) Variable & Formatting Improvements * Formatted the **timestamp variable** in the message delete event to use **seconds** instead of milliseconds (works better with Discord formatting). * Added two new variables: * **numberWithCommas** – formats large numbers like `1,000,000` * **numberWithDots** – formats large numbers like `1.000.000` ### [](https://documentation.botghost.com/changelog/2025#builder-improvements) Builder Improvements * Increased the **block template limit** from 100 to 1000. * Updated the **server selector** in timed events to match the new scalable selector system. * Increased the **z-index** of the channel selector so it doesn’t get placed under other elements. * Added **"The Message"** option to the **React to Message** action. ### [](https://documentation.botghost.com/changelog/2025#permissions-and-ui-fixes) Permissions & UI Fixes * Added guardrails to prevent invalid **permission bitfields** in edit actions. * Fixed an issue where **command options** wouldn’t render properly in role/channel selectors. * Added the new **USE\_EXTERNAL\_SOUNDS** permission bit field. [](https://documentation.botghost.com/changelog/2025#bug-fixes--custom-event-improvements-april-22nd-2025) Bug Fixes + Custom Event Improvements - April 22nd, 2025 ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ ### [](https://documentation.botghost.com/changelog/2025#mobile--builder-fixes) Mobile + Builder Fixes * Fixed a bug with the new **role selectors on mobile**. * Fixed a visual bug where clicking **copy on an option** in the builder could cause toast spam. ### [](https://documentation.botghost.com/changelog/2025#custom-events--conditions) Custom Events + Conditions * You can now **import custom events directly** from the custom event selector. * Fixed a bug with the **text manipulation action** when used in message deletion events. * Fixed a bug that caused **slot events in custom modules** to reset to the default page after saving. * Added a new **"Condition Name" field** for role/channel conditions to help with better organization. [](https://documentation.botghost.com/changelog/2025#role--channel-selector-rework-april-17th-2025) Role + Channel Selector Rework - April 17th, 2025 ---------------------------------------------------------------------------------------------------------------------------------------------------------- Today we’ve reworked how role and channel selectors function throughout the dashboard to improve performance and usability. ### [](https://documentation.botghost.com/changelog/2025#new-selector-system) New Selector System Users in 200+ servers were experiencing infinite loading issues when opening role/channel dropdowns. We've fixed this by introducing a new method: * Select a specific server before loading roles/channels * OR manually input a Role/Channel ID if you already know it This makes selection faster and removes unnecessary load times on large bots. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FC4HLYYelK6GgulO0nFgg%252Fimage.png%3Falt%3Dmedia%26token%3D3134bc39-4fb5-470c-aeee-ae494a690006&width=768&dpr=3&quality=100&sign=6cb199f2&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FL6zjVCU8G5m9QyMVIE1k%252Fimage.png%3Falt%3Dmedia%26token%3D6133c526-69b3-430f-b39b-cbf8be1ec14d&width=768&dpr=3&quality=100&sign=2b6e079e&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252Fck22zJoRZeJQwHZRalNG%252Fimage.png%3Falt%3Dmedia%26token%3D05a35e55-786e-4e8b-9726-5dd401951085&width=768&dpr=3&quality=100&sign=c53c5a67&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FnIrp4LOBH3SL2UzO2NfE%252Fimage.png%3Falt%3Dmedia%26token%3Dab5b25ea-fbf7-480f-ab9e-ef09637f7b94&width=768&dpr=3&quality=100&sign=134f548b&sv=2) ### [](https://documentation.botghost.com/changelog/2025#visual-fixes-and-improvements) Visual Fixes & Improvements * Fixed alignment issue with the **color picker** in custom modules * Fixed alignment of **type tags** on custom variables [](https://documentation.botghost.com/changelog/2025#server-leave-custom-event--custom-event-selector-ui--server-list-ui-improvements-april-15th-2025) Server Leave Custom Event + Custom Event Selector UI + Server List UI Improvements - April 15th, 2025 ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- A few new improvements have landed today based on requests from our priority hosting members during the recent QNA session! ### [](https://documentation.botghost.com/changelog/2025#new-custom-event-guildleave) New Custom Event: `guildLeave` You can now use the new `guildLeave` custom event, which triggers whenever your bot leaves a server. Perfect for clean-up actions or logs. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FmJ34HYLz8DjHH6FMPP5L%252Fimage.png%3Falt%3Dmedia%26token%3D5b88289b-ff66-4815-b391-081a3f8d8036&width=768&dpr=3&quality=100&sign=66592f39&sv=2) ### [](https://documentation.botghost.com/changelog/2025#custom-event-selector-improvements) Custom Event Selector Improvements We’ve polished up the custom event selector with: * A search field to quickly find events * Categories to better organize the list ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FOGrSEtH2JcP8PRn08rA1%252Fimage.png%3Falt%3Dmedia%26token%3D51b4d972-54d1-489d-9427-370900b40dae&width=768&dpr=3&quality=100&sign=666398e&sv=2) ### [](https://documentation.botghost.com/changelog/2025#server-list-upgrades) Server List Upgrades Managing large bots just got easier: * You can now load past 200 servers by scrolling to the bottom of the list and clicking Load more servers * Added ability to leave a server by ID ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252Frb10wcTZgbBxMpTyTEvW%252Fimage.png%3Falt%3Dmedia%26token%3Daffd0a1c-5e64-4554-bd17-f25ca8ec8e14&width=768&dpr=3&quality=100&sign=bf611062&sv=2) [](https://documentation.botghost.com/changelog/2025#builder-fixes-and-ui-updates-march-31st-2025) Builder Fixes & UI Updates - March 31st, 2025 ----------------------------------------------------------------------------------------------------------------------------------------------------- We've pushed a few fixes to smooth out the experience in the command/event builder: * **Sort Function Fixed** – The sort function in the builder now works as expected. * **Reorder/Sort Buttons** – These now **move correctly** when toggling the aside menu, so everything stays in place visually. * **Handle Position Bug** – Fixed a **visual bug** with the position of drag handles that caused misalignment in some cases. [](https://documentation.botghost.com/changelog/2025#priority-hosting-now-available-march-29th-2025) Priority Hosting Now Available - March 29th, 2025 ----------------------------------------------------------------------------------------------------------------------------------------------------------- We’re excited to introduce **Priority Hosting**, our new premium hosting tier designed for developers who need enhanced performance, stability, and influence. ### [](https://documentation.botghost.com/changelog/2025#key-features-3) Key Features **Infrastructure** * Exclusive server pods (~10 bots per pod vs 1–2k standard) * AWS m8g.8xlarge with Graviton4 processors * 32 vCPUs, 128 GiB memory, 15 Gbps bandwidth * Sub-1 minute downtime during updates * Enhanced API rate limits, 40k IOPS, 1,250 MB/s throughput **Storage & Reliability** * 365-day button/menu retention (vs 30 days) * Advanced back-off and monitoring systems **Community & Access** * VIP Discord role + private Priority Hosting Member channels * Monthly Q&As with staff/founder * Early access to features via alpha.botghost.com * Priority bug fixes and feedback influence * Real-time downtime and maintenance alerts **Subscription & Benefits** * $15/month, managed via Stripe * One subscription covers all bots on your account * Cancel anytime; benefits last through the billing cycle * 7-day money-back guarantee * Enterprise-grade performance, optimized for high-traffic and large-scale bots * Improved reliability, multi-tasking, and latency handling To learn more and upgrade, visit: [**https://dashboard.botghost.com/dashboard/priohosting**](https://dashboard.botghost.com/dashboard/priohosting) ### [](https://documentation.botghost.com/changelog/2025#why-does-priority-hosting-cost-extra-on-top-of-a-premium-subscription) Why does Priority Hosting cost extra on top of a premium subscription? Priority Hosting is designed primarily for larger bot developers with bots in thousands of servers who need **enterprise-grade performance and reliability**. The significantly higher server costs of the **AWS m8g.8xlarge instances with Graviton4 processors**, combined with the **drastically reduced bot density** (only ~10 bots per instance vs 1–2 thousand), requires additional investment beyond our standard premium subscription. This specialized infrastructure ensures your high-traffic bots receive the **dedicated resources, processing power, and reliability** needed to serve large communities — without performance degradation. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FDSpuW0JtW7nM34wffVTP%252Fimage.png%3Falt%3Dmedia%26token%3D060c13f5-05c0-4928-890a-8257f5993359&width=768&dpr=3&quality=100&sign=d11cfcdf&sv=2) [](https://documentation.botghost.com/changelog/2025#server-migration-march-25th-2025) Server Migration - March 25th, 2025 ------------------------------------------------------------------------------------------------------------------------------- We recently undertook a server migration to move the bots to much larger more powerful servers. These servers are much more burstable and should provide more overhead for more resource intensive bots. This was also done to make way for a new Priority Hosting update. [](https://documentation.botghost.com/changelog/2025#new-mobile-builder--ui-improvements-march-24th-2025) New Mobile Builder + UI Improvements - March 24th, 2025 ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- We’re excited to announce the release of the **new mobile-friendly command/event builder** for BotGhost — along with general mobile and UI improvements across the dashboard! ### [](https://documentation.botghost.com/changelog/2025#mobile-builder-experimental) Mobile Builder (Experimental) You can now use the builder easily on mobile devices! This version includes a new layout optimized for smaller screens and better touch controls. #### [](https://documentation.botghost.com/changelog/2025#how-to-enable) How to Enable: * Head over to the **Builder** * Click **Settings** * Toggle **"Experimental Mobile Mode"** * The builder will automatically refresh with the new layout! ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FUo70kKDdUhKnHgFGOWJK%252Fimage.png%3Falt%3Dmedia%26token%3Dbf47f659-16d8-4841-8e6f-3779277a25e4&width=768&dpr=3&quality=100&sign=1009bc10&sv=2) ### [](https://documentation.botghost.com/changelog/2025#general-ui-improvements) General UI Improvements We’ve also made a handful of improvements to the UI across the dashboard to enhance mobile usability: * Improved layout spacing and padding * Better scroll and touch support * Fixed various alignment and visibility issues ### [](https://documentation.botghost.com/changelog/2025#bug-fixes-5) Bug Fixes * Fixed a primitive object conversion bug that some people were getting in modules/events. [](https://documentation.botghost.com/changelog/2025#module-updates-march-23rd-2025) Module Updates - March 23rd, 2025 --------------------------------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/changelog/2025#translation) Translation * Bot will respect the emojis selected and only attempt to translate when a configured emoji is used * Removed "Bot is thinking" API call as it was causing event delays * Added some additional error management * Updated the translation embed to use the new message block ### [](https://documentation.botghost.com/changelog/2025#moderation) Moderation * Autopunishments have been adjusted. The previous system would only trigger an autopunishment ONCE, and it was expected that the bot creator would add additional autopunishments for greater and greater numbers of rule breaks. This system wasn't as intuitive as I had originally thought. Autopunishments now work by resetting the number of warns/mutes when a configured autopunishment triggers. For example if a user received 3 warns which triggers a timeout, his autopunishment warn counter will RESET so that the autopunishment can trigger again in the future. * The temporary Role and Ban timed event has been updated to check every 20 seconds, down from 3 minutes. [](https://documentation.botghost.com/changelog/2025#economy-module-updates-march-21th-2025) Economy Module Updates - March 21th, 2025 ------------------------------------------------------------------------------------------------------------------------------------------- Some updates have been released for the Economy Module: * Changed all "Send Error Log" blocks to Embed replies so that our error logs stop getting spammed * Safe mode slightly changed - the only way to disable safe mode now is to earn 10k or more * Lucky Box logic in /shop buy changed to match on itemid instead of name. This will mean that Lucky Box functionality no longer breaks if you change the name of the box in the dashboard * Lucky Box (slight) rework - Lucky boxes have had a rework that removes the ability to purchase multiple boxes at once. The command logic for this was clunky and caused issues with balance, so now Lucky Boxes can only be purchased one at a time. * Lottery fix for 10+ entrees. It should no longer give the EOF error when announcing the winnings * Timed event for Lottery set to "Run once for all servers" to accomodate BotPanel * Scratchcard and Matchpairs have been updated to use the Emoji field on buttons, making the emojis standardised across platforms [](https://documentation.botghost.com/changelog/2025#botghost-fixes-updates-march-17th-2025) BotGhost Fixes/Updates - March 17th, 2025 ------------------------------------------------------------------------------------------------------------------------------------------- * Fixed an issue where 2 reward codes were being generated for GhostBuddy voting. If you got both, enjoy. * Fixed a bug affecting the additional roles field in add/remove role actions. * Fixed a dashboard crash when trying to edit a Role or Channel menu using the edit component action. * Resolved an issue where adding a 5th server would sometimes incorrectly enforce a 4-server limit. * You can now edit buttons on ephemeral (hidden) messages—only for buttons attached to the original interaction. [](https://documentation.botghost.com/changelog/2025#botghost-fixes-updates-march-4th-2025) BotGhost Fixes/Updates - March 4th, 2025 ----------------------------------------------------------------------------------------------------------------------------------------- * Added the channel component to the thread delete event. * `Set Variable`, `Delete Variable`, and `Equation Variable` no longer rely on API requests to retrieve member IDs, reducing 404 errors. * These actions also no longer require API requests for channel IDs, further minimizing errors. * Fixed an issue where events requiring a server ID would not save properly when "Run once for all servers" was enabled. * The `{Role.}` variable now works correctly in role events. * `Add Role` and `Remove Role` actions now support cross-server role management. [](https://documentation.botghost.com/changelog/2025#top.gg-autoposter-and-botghost-updates-february-28th-2025) Top.gg Autoposter & BotGhost Updates - February 28th, 2025 ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/changelog/2025#top.gg-autoposter) Top.gg Autoposter We've added a new feature that automatically posts your server count to top.gg every 30 minutes! Simply add your bot's top.gg token in your BotGhost settings, and you're all set. More top.gg events are coming soon! ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FfuFmCTG1bgNwuG3Jg2Rc%252Fimage.png%3Falt%3Dmedia%26token%3Da4090422-1552-4623-83d3-3f69d4dafc76&width=768&dpr=3&quality=100&sign=71a30576&sv=2) ### [](https://documentation.botghost.com/changelog/2025#botghost-fixes) BotGhost Fixes * Fixed a bug where buttons weren't updating variables, which affected forms and other actions. [](https://documentation.botghost.com/changelog/2025#bug-fixes-module-changes-february-27th-2025) Bug Fixes, Module Changes - February 27th, 2025 ------------------------------------------------------------------------------------------------------------------------------------------------------ **We have released some bug fixes and updates to modules. Details below:** ### [](https://documentation.botghost.com/changelog/2025#economy) Economy: #### [](https://documentation.botghost.com/changelog/2025#minor-changes) Minor Changes: * Lottery Event is set to "Run once for a specific server" by default * Various fixes to /rob bank. It should be more reliable when users join the heist with more validation. Percentage split also adjusted * Blackjack money added should not be incorrect in some cases anymore * /ec cooldowns will now show you your cooldowns in a better format * /rob player now steals a percentage of their holding balance, making it more effective on users with a higher balance * /ec admin - When uploading emojis the error message is more descriptive. 90% of failures are usually because the emoji already exists on the bot, but the command was not clear on how to solve this issue. #### [](https://documentation.botghost.com/changelog/2025#major-changes) Major Changes: * Many of the minigames that relied on editing the component array via API have been completely revamped to use the new Edit Component Block (yay!). This has resulted in significant performance improvements across the board with these games. Notably matchpairs and hangman * /tictac - Updated to use the Edit Component block * /matchpairs - Updated to use the Edit Component block * /hangman - Updated to use the the Edit Component block * /scratchcard - Updated to use the Edit Component block #### [](https://documentation.botghost.com/changelog/2025#new-games) New Games: * The economy module is a gift that keeps on giving! In this update we have added TWO new minigames. * /lightout - Lights Out is a puzzle game where the objective is to turn off all the lights on a grid. Pressing a button toggles that light and the adjacent lights directly above, below, and to either side. * /mastermind - The goal of Mastermind is for the Codebreaker (you) to guess the exact colors and positions of a secret code created by the Codemaker (the bot) in as few attempts as possible. ### [](https://documentation.botghost.com/changelog/2025#weather) Weather: * There was an issue with the weather module where users who ran the command that were too far behind (or ahead) of UTC+0 would see a discrepancy in the Day + Timestamp in the 3 day forecast. To correct this we have added the option for users to select a default timezone that they reside in when running the command. This will show up inside the embed to inform the user that they should set a default timezone. It can be reset using the command as well. ### [](https://documentation.botghost.com/changelog/2025#invite-tracker) Invite Tracker: * The /invites-leaderboard had some issues in the command tree which caused it to run slowly. We have redesigned it completely to drastically improve performance * A bug in the Leaves Handler event has also been fixed ### [](https://documentation.botghost.com/changelog/2025#status-module) Status Module: * Fixed an issue where the status could cause some error log messages to appear [](https://documentation.botghost.com/changelog/2025#botghost-updates-february-26th-2025) BotGhost Updates - February 26th, 2025 ------------------------------------------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/changelog/2025#botghost-api-and-bug-fixes) BotGhost API & Bug Fixes * **Increased API Limit** - Premium users now have a raised API limit of **100 requests per 10 seconds** (previously 20). * **Fixed Button/Menu Interactions** - Resolved an issue where interactions were being deleted even if used in the past 30 days. * **Fixed Webhook Event Loops** - Loops inside webhook events no longer return a Custom Events error. [](https://documentation.botghost.com/changelog/2025#webhook-object-updates-february-25th-2025) Webhook Object Updates - February 25th, 2025 ------------------------------------------------------------------------------------------------------------------------------------------------- We've got a few quick updates for you, along with a quick reminder about our **40% off sale** ending soon! [](https://documentation.botghost.com/changelog/2025#new-webhook-object-beta-only) New Webhook Object (beta only) ---------------------------------------------------------------------------------------------------------------------- You can now use the `{Webhook}` object to access: * `**{Webhook.body}**` – View the data sent with a webhook. * `**{Webhook.url}**` – Get the URL that triggered the webhook. * `**{Webhook.headers}**` – Access the headers for advanced integrations. This opens up more possibilities for interacting with external services! [](https://documentation.botghost.com/changelog/2025#edit-component-action-february-10th-2025) Edit Component Action - February 10th, 2025 ----------------------------------------------------------------------------------------------------------------------------------------------- Today we are releasing the edit component action to the beta servers. This button allows you to edit buttons and select menus attached to a previously sent message. ### [](https://documentation.botghost.com/changelog/2025#edit-component-action) Edit Component Action Simply select any amount of buttons or menu and you can then change the settings of them after they have been sent. For example this allows you to: * Disable a button/menu after it is sent * Change the style of a button * Change the label of a button * Add options to a select menu * Change component ordering on a message * Remove components from a message ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252Fd6ew1WWoDTT1QmyJlJQF%252Fimage.png%3Falt%3Dmedia%26token%3Dd5ff95ec-529d-4dda-96db-a6a89a399b0f&width=768&dpr=3&quality=100&sign=767f1cb4&sv=2) ### [](https://documentation.botghost.com/changelog/2025#example-commands) Example Commands To help you all understand how this block works <@225647195771240448> has created 2 example commands which you can import: * **A Basic Edit Button Command (CMD\_8c136d10-75a3-438b-a8b6-30a0d4458413)** - A basic command showing how to disable buttons and reset their state. * **Lights Out Game (CMD\_302d7ca9-c9ee-4df5-9eb3-de384eb19686)** - An advanced command that lets you play the Lights Out game where the goal is to turn out all the lights with the minimum amount of clicks. ### [](https://documentation.botghost.com/changelog/2025#hiding-of-old-reply-blocks) Hiding of Old Reply Blocks I have also hidden by default the old outdated reply blocks. If you still want to use them, you can go to settings and untick **Hide Legacy Reply Actions** ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FYYmU6CQBGxdRebAsJmYs%252Fimage.png%3Falt%3Dmedia%26token%3D3e32de31-a2ee-4c80-9370-eb8bc0fdcdb6&width=768&dpr=3&quality=100&sign=4fa4c164&sv=2) [](https://documentation.botghost.com/changelog/2025#qol-additions--builder-settings-january-30th-2025) QOL Additions + Builder Settings - January 30th, 2025 ------------------------------------------------------------------------------------------------------------------------------------------------------------------ ### [](https://documentation.botghost.com/changelog/2025#builder-settings) Builder Settings Added the start of a builder settings page. This page houses various settings and defaults that change how the builder works. More settings will be added later, for now we have added: * **Auto Save** - automatically saves the command or event every X seconds if possible. * **Color Settings** - change the default colors of every block in the builder * **Block Defaults** - added a default color option for embeds and default condition type for the comparison condition ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FSG4UiRgiPlqIezQ0GM1l%252Fimage.png%3Falt%3Dmedia%26token%3D023a00e3-7f56-471a-82ca-3b7a7a962121&width=768&dpr=3&quality=100&sign=5e7685c1&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FLUnNegn3pyGRBwEEYpLg%252Fimage.png%3Falt%3Dmedia%26token%3Dbec01932-278b-44bf-8a1b-ba51b3e7bc48&width=768&dpr=3&quality=100&sign=cdae1bbf&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FSsGy4gfyyhJdzK0mvXlX%252Fimage.png%3Falt%3Dmedia%26token%3Dc123a92d-318e-4e5c-bae2-c15883034ed3&width=768&dpr=3&quality=100&sign=9b1203f2&sv=2) ### [](https://documentation.botghost.com/changelog/2025#qol-improvements) QOL Improvements We have also added a few QOL improvements throughout the dashboard. * **Module Search Bar** \- Added a search bar to the modules page. You can now search modules/builders by name. * **Note block**\- Added a new note block. This block lets you set a title, description and color and is useful for documenting how your command/event works. * **Last Saved Warning** - Added a last saved warning if you havent saved in a while. * **Set Comparison type before adding** - Set comparison type of comparison condition before adding it. * **Set default comparison condition type** - Set the default comparison condition type to equals to. [](https://documentation.botghost.com/changelog/2025#bug-fixes-january-28th-2025) Bug Fixes - January 28th, 2025 --------------------------------------------------------------------------------------------------------------------- * Fixed a bug with the {Invite} Object. It should now work with {Invite\[ID\].property} as expected. * Fixed the Role delete event. * Fixed a bug that caused buttons to not send on large commands * Fixed a bug that caused a visual error when deleting slots in custom modules. * Fixed a bug that caused error logs to not be sent to the error handling tree inside of events. * Fixed a bug with variables inside of the add/remove role action. * Fixed a bug with errors not being sent when a member could not be retrieved inside of the add/remove role action. * Fixed some bugs resulting around free limits switching up after sending an update to your bot. (Command limits, guild limits, activity warnings etc). [](https://documentation.botghost.com/changelog/2025#module-updates-bug-fixes-january-3rd-2025) Module Updates/Bug Fixes - January 3rd, 2025 ------------------------------------------------------------------------------------------------------------------------------------------------- We have released some updates/bug fixes to the following modules: ### [](https://documentation.botghost.com/changelog/2025#counting) Counting * Fixed an issue with the webhook setting where the webhook was not being created successfully * Added a check to stop the count increasing if the webhook failed to send * Added an automatic channel slowmode if the 5 second cooldown option is toggled on ### [](https://documentation.botghost.com/changelog/2025#youtube) YouTube * Corrected issue that could cause errors in the error-log if the API query did not return the correct status code * YouTube Module compatibility with BotPanel ### [](https://documentation.botghost.com/changelog/2025#verification) Verification * Changed the limit and restrictions on how long someone can go unverified in a server before being kicked. New limits are - 60 seconds min, 850 seconds (~15 minutes) max ### [](https://documentation.botghost.com/changelog/2025#weather-1) Weather * Fixed an issue where mph was being displayed for Wind Gusts despite kph being selected * Updated the module to use the new Send a Message block, making edits to the weather embed much, much easier * Various formatting improvements **Head to the respective module page via the** [**BotGhost Dashboard**](https://dashboard.botghost.com/dashboard/modules) **and hit Update Module and Save Changes to apply the changes.** Last updated 5 months ago Was this helpful? * [More Bug Fixes + Improvements - December 18th, 2025](https://documentation.botghost.com/changelog/2025#more-bug-fixes--improvements-december-18th-2025) * [Bug Fixes](https://documentation.botghost.com/changelog/2025#bug-fixes) * [Additions & Changes](https://documentation.botghost.com/changelog/2025#additions-and-changes) * [Bug Fixes & Improvements - December 17th, 2025](https://documentation.botghost.com/changelog/2025#bug-fixes-and-improvements-december-17th-2025) * [Bug Fixes](https://documentation.botghost.com/changelog/2025#bug-fixes-1) * [Additions & Changes](https://documentation.botghost.com/changelog/2025#additions-and-changes-1) * [New Premium Music System Release (Beta) - November 20th, 2025](https://documentation.botghost.com/changelog/2025#new-premium-music-system-release-beta-november-20th-2025) * [How It Works](https://documentation.botghost.com/changelog/2025#how-it-works) * [Music Smart Search](https://documentation.botghost.com/changelog/2025#music-smart-search) * [Music Actions (19)](https://documentation.botghost.com/changelog/2025#music-actions-19) * [Music Events (29)](https://documentation.botghost.com/changelog/2025#music-events-29) * [Music Variables](https://documentation.botghost.com/changelog/2025#music-variables) * [Music Module](https://documentation.botghost.com/changelog/2025#music-module) * [What’s Coming Next](https://documentation.botghost.com/changelog/2025#whats-coming-next) * [Reintroduction of the Message Builder Module - November 5th, 2025](https://documentation.botghost.com/changelog/2025#reintroduction-of-the-message-builder-module-november-5th-2025) * [What is the Message Builder](https://documentation.botghost.com/changelog/2025#what-is-the-message-builder) * [Key Features](https://documentation.botghost.com/changelog/2025#key-features) * [Advanced Message Block Integration](https://documentation.botghost.com/changelog/2025#advanced-message-block-integration) * [Free vs Premium](https://documentation.botghost.com/changelog/2025#free-vs-premium) * [Common Uses](https://documentation.botghost.com/changelog/2025#common-uses) * [Create Transcript Action (Beta) - October 28th, 2025](https://documentation.botghost.com/changelog/2025#create-transcript-action-beta-october-28th-2025) * [What Are Transcripts](https://documentation.botghost.com/changelog/2025#what-are-transcripts) * [How It Works](https://documentation.botghost.com/changelog/2025#how-it-works-1) * [Themes](https://documentation.botghost.com/changelog/2025#themes) * [Password Protection](https://documentation.botghost.com/changelog/2025#password-protection) * [Managing Transcripts](https://documentation.botghost.com/changelog/2025#managing-transcripts) * [Tips & Notes](https://documentation.botghost.com/changelog/2025#tips-and-notes) * [Module Builder Removal + Twitch/YouTube Module Depreciation + Block Floating Helper Text - October 17th, 2025](https://documentation.botghost.com/changelog/2025#module-builder-removal--twitch-youtube-module-depreciation--block-floating-helper-text-october-17t) * [Module Builder Removal](https://documentation.botghost.com/changelog/2025#module-builder-removal) * [Twitch + YouTube Modules Depreciation](https://documentation.botghost.com/changelog/2025#twitch--youtube-modules-depreciation) * [New: Helper Text for Blocks](https://documentation.botghost.com/changelog/2025#new-helper-text-for-blocks) * [YouTube Video Upload Action Event - October 16th, 2025](https://documentation.botghost.com/changelog/2025#youtube-video-upload-action-event-october-16th-2025) * [Overview](https://documentation.botghost.com/changelog/2025#overview) * [Key Features](https://documentation.botghost.com/changelog/2025#key-features-1) * [Setup Guide](https://documentation.botghost.com/changelog/2025#setup-guide) * [Available Variables](https://documentation.botghost.com/changelog/2025#available-variables) * [Highlights](https://documentation.botghost.com/changelog/2025#highlights) * [Twitch Alerts Action Event - October 15th, 2025](https://documentation.botghost.com/changelog/2025#twitch-alerts-action-event-october-15th-2025) * [Overview](https://documentation.botghost.com/changelog/2025#overview-1) * [Key Features](https://documentation.botghost.com/changelog/2025#key-features-2) * [How to Use](https://documentation.botghost.com/changelog/2025#how-to-use) * [Slash Command Autocomplete - October 8th, 2025](https://documentation.botghost.com/changelog/2025#slash-command-autocomplete-october-8th-2025) * [What Is Autocomplete](https://documentation.botghost.com/changelog/2025#what-is-autocomplete) * [How It Works](https://documentation.botghost.com/changelog/2025#how-it-works-2) * [Benefits](https://documentation.botghost.com/changelog/2025#benefits) * [Notes](https://documentation.botghost.com/changelog/2025#notes) * [Components V2 Message Builder - 6th October, 2025](https://documentation.botghost.com/changelog/2025#components-v2-message-builder-6th-october-2025) * [Overview](https://documentation.botghost.com/changelog/2025#overview-2) * [Available Component Types](https://documentation.botghost.com/changelog/2025#available-component-types) * [Buttons and Menus](https://documentation.botghost.com/changelog/2025#buttons-and-menus) * [Structure and Limits](https://documentation.botghost.com/changelog/2025#structure-and-limits) * [Allowed Mentions (Beta)](https://documentation.botghost.com/changelog/2025#allowed-mentions-beta) * [Beta Status](https://documentation.botghost.com/changelog/2025#beta-status) * [What's coming next?](https://documentation.botghost.com/changelog/2025#whats-coming-next-1) * [Massive Discord Event System Update - September 29th, 2025](https://documentation.botghost.com/changelog/2025#massive-discord-event-system-update-september-29th-2025) * [33 New Events](https://documentation.botghost.com/changelog/2025#id-33-new-events) * [24 Updated Events](https://documentation.botghost.com/changelog/2025#id-24-updated-events) * [11 New Object Variables](https://documentation.botghost.com/changelog/2025#id-11-new-object-variables) * [What This Means](https://documentation.botghost.com/changelog/2025#what-this-means) * [Add Roles to All Users + Remove Roles from All Users - September 28th, 2025](https://documentation.botghost.com/changelog/2025#add-roles-to-all-users--remove-roles-from-all-users-september-28th-2025) * [Add Role to All Users](https://documentation.botghost.com/changelog/2025#add-role-to-all-users) * [Remove Roles from All Users](https://documentation.botghost.com/changelog/2025#remove-roles-from-all-users) * [Safety + Configuration](https://documentation.botghost.com/changelog/2025#safety--configuration) * [New Forum Post Option + Auto Role on Join Event – September 25th, 2025](https://documentation.botghost.com/changelog/2025#new-forum-post-option--auto-role-on-join-event-september-25th-2025) * [Send a Message Update](https://documentation.botghost.com/changelog/2025#send-a-message-update) * [Update: Auto Role on Join Event](https://documentation.botghost.com/changelog/2025#update-auto-role-on-join-event) * [Features:](https://documentation.botghost.com/changelog/2025#features) * [Bug Fixes - September 23rd, 2025](https://documentation.botghost.com/changelog/2025#bug-fixes-september-23rd-2025) * [Builders + UI](https://documentation.botghost.com/changelog/2025#builders--ui) * [Timed Events](https://documentation.botghost.com/changelog/2025#timed-events) * [Variables](https://documentation.botghost.com/changelog/2025#variables) * [Other](https://documentation.botghost.com/changelog/2025#other) * [Command + Events Tab Updates - September 17th, 2025](https://documentation.botghost.com/changelog/2025#command--events-tab-updates-september-17th-2025) * [Bug Fixes - September 15th, 2025](https://documentation.botghost.com/changelog/2025#bug-fixes-september-15th-2025) * [Major Command + Event Builder Overhaul - September 12th, 2025](https://documentation.botghost.com/changelog/2025#major-command--event-builder-overhaul-september-12th-2025) * [What’s Included (All Inside the Builder)](https://documentation.botghost.com/changelog/2025#whats-included-all-inside-the-builder) * [Variables Tab](https://documentation.botghost.com/changelog/2025#variables-tab) * [Errors Tab](https://documentation.botghost.com/changelog/2025#errors-tab) * [Commands / Events Tab](https://documentation.botghost.com/changelog/2025#commands-events-tab) * [Timed Events Tab](https://documentation.botghost.com/changelog/2025#timed-events-tab) * [Block Templates Tab](https://documentation.botghost.com/changelog/2025#block-templates-tab) * [Bug Fixes & Improvements](https://documentation.botghost.com/changelog/2025#bug-fixes-and-improvements) * [Object Variable Collections + Variable Selector Update - September 11th, 2025](https://documentation.botghost.com/changelog/2025#object-variable-collections--variable-selector-update-september-11th-2025) * [Exposing Collections on Object Variables](https://documentation.botghost.com/changelog/2025#exposing-collections-on-object-variables) * [Updated Variable Selector (easier Object usage)](https://documentation.botghost.com/changelog/2025#updated-variable-selector-easier-object-usage) * [Custom Module Builder Out of Beta](https://documentation.botghost.com/changelog/2025#custom-module-builder-out-of-beta) * [Bug Fixes](https://documentation.botghost.com/changelog/2025#bug-fixes-2) * [API + Actions Update - September 10th, 2025](https://documentation.botghost.com/changelog/2025#api--actions-update-september-10th-2025) * [API Updates](https://documentation.botghost.com/changelog/2025#api-updates) * [New Action](https://documentation.botghost.com/changelog/2025#new-action) * [Bug Fixes](https://documentation.botghost.com/changelog/2025#bug-fixes-3) * [Variable Editor Additions + Bug Fixes - September 8th, 2025](https://documentation.botghost.com/changelog/2025#variable-editor-additions--bug-fixes-september-8th-2025) * [Variable Editor Additions](https://documentation.botghost.com/changelog/2025#variable-editor-additions) * [Bug Fixes](https://documentation.botghost.com/changelog/2025#bug-fixes-4) * [{Message} Object, Raw JSON Body Mode + Variable Selector fixes - September 5th, 2025](https://documentation.botghost.com/changelog/2025#message-object-raw-json-body-mode--variable-selector-fixes-september-5th-2025) * [{Message} Object](https://documentation.botghost.com/changelog/2025#message-object) * [Raw JSON Body Mode](https://documentation.botghost.com/changelog/2025#raw-json-body-mode) * [Variable Selector Fix](https://documentation.botghost.com/changelog/2025#variable-selector-fix) * [New Variable Selector - September 2nd, 2025](https://documentation.botghost.com/changelog/2025#new-variable-selector-september-2nd-2025) * [Modernized Interface](https://documentation.botghost.com/changelog/2025#modernized-interface) * [Grouped by Type](https://documentation.botghost.com/changelog/2025#grouped-by-type) * [Bug Fixes - September 1st, 2025](https://documentation.botghost.com/changelog/2025#bug-fixes-september-1st-2025) * [Homepage](https://documentation.botghost.com/changelog/2025#homepage) * [Builder and Dashboard](https://documentation.botghost.com/changelog/2025#builder-and-dashboard) * [Collab Mode](https://documentation.botghost.com/changelog/2025#collab-mode) * [Module Updates - June 14th, 2025](https://documentation.botghost.com/changelog/2025#module-updates-june-14th-2025) * [ChatGPT - Major Update](https://documentation.botghost.com/changelog/2025#chatgpt-major-update) * [Birthdays](https://documentation.botghost.com/changelog/2025#birthdays) * [Welcomer](https://documentation.botghost.com/changelog/2025#welcomer) * [Leveling](https://documentation.botghost.com/changelog/2025#leveling) * [Image Generation](https://documentation.botghost.com/changelog/2025#image-generation) * [Starboard](https://documentation.botghost.com/changelog/2025#starboard) * [Interaction Token Update & Bug Fixes - June 2nd, 2025](https://documentation.botghost.com/changelog/2025#interaction-token-update-and-bug-fixes-june-2nd-2025) * [Interaction Token Vulnerability](https://documentation.botghost.com/changelog/2025#interaction-token-vulnerability) * [BotGhost Proxy Downtime](https://documentation.botghost.com/changelog/2025#botghost-proxy-downtime) * [Custom Slot Bug Fix](https://documentation.botghost.com/changelog/2025#custom-slot-bug-fix) * [Economy Module Update - June 1st, 2025](https://documentation.botghost.com/changelog/2025#economy-module-update-june-1st-2025) * [Economy Updates - May 26th, 2025](https://documentation.botghost.com/changelog/2025#economy-updates-may-26th-2025) * [Module Builder + BotGhost Fixes - May 12th, 2025](https://documentation.botghost.com/changelog/2025#module-builder--botghost-fixes-may-12th-2025) * [Module Builder Fixes & Improvements](https://documentation.botghost.com/changelog/2025#module-builder-fixes-and-improvements) * [BotGhost Updates](https://documentation.botghost.com/changelog/2025#botghost-updates) * [Major Release: Custom Module Builder (Beta) - May 10th, 2025](https://documentation.botghost.com/changelog/2025#major-release-custom-module-builder-beta-may-10th-2025) * [What is the Module Builder?](https://documentation.botghost.com/changelog/2025#what-is-the-module-builder) * [Why Use the Module Builder?](https://documentation.botghost.com/changelog/2025#why-use-the-module-builder) * [Beta Status](https://documentation.botghost.com/changelog/2025#beta-status-1) * [Variable Formats + Selector Fixes - May 5th, 2025](https://documentation.botghost.com/changelog/2025#variable-formats--selector-fixes-may-5th-2025) * [Variable & Formatting Improvements](https://documentation.botghost.com/changelog/2025#variable-and-formatting-improvements) * [Builder Improvements](https://documentation.botghost.com/changelog/2025#builder-improvements) * [Permissions & UI Fixes](https://documentation.botghost.com/changelog/2025#permissions-and-ui-fixes) * [Bug Fixes + Custom Event Improvements - April 22nd, 2025](https://documentation.botghost.com/changelog/2025#bug-fixes--custom-event-improvements-april-22nd-2025) * [Mobile + Builder Fixes](https://documentation.botghost.com/changelog/2025#mobile--builder-fixes) * [Custom Events + Conditions](https://documentation.botghost.com/changelog/2025#custom-events--conditions) * [Role + Channel Selector Rework - April 17th, 2025](https://documentation.botghost.com/changelog/2025#role--channel-selector-rework-april-17th-2025) * [New Selector System](https://documentation.botghost.com/changelog/2025#new-selector-system) * [Visual Fixes & Improvements](https://documentation.botghost.com/changelog/2025#visual-fixes-and-improvements) * [Server Leave Custom Event + Custom Event Selector UI + Server List UI Improvements - April 15th, 2025](https://documentation.botghost.com/changelog/2025#server-leave-custom-event--custom-event-selector-ui--server-list-ui-improvements-april-15th-2025) * [New Custom Event: guildLeave](https://documentation.botghost.com/changelog/2025#new-custom-event-guildleave) * [Custom Event Selector Improvements](https://documentation.botghost.com/changelog/2025#custom-event-selector-improvements) * [Server List Upgrades](https://documentation.botghost.com/changelog/2025#server-list-upgrades) * [Builder Fixes & UI Updates - March 31st, 2025](https://documentation.botghost.com/changelog/2025#builder-fixes-and-ui-updates-march-31st-2025) * [Priority Hosting Now Available - March 29th, 2025](https://documentation.botghost.com/changelog/2025#priority-hosting-now-available-march-29th-2025) * [Key Features](https://documentation.botghost.com/changelog/2025#key-features-3) * [Why does Priority Hosting cost extra on top of a premium subscription?](https://documentation.botghost.com/changelog/2025#why-does-priority-hosting-cost-extra-on-top-of-a-premium-subscription) * [Server Migration - March 25th, 2025](https://documentation.botghost.com/changelog/2025#server-migration-march-25th-2025) * [New Mobile Builder + UI Improvements - March 24th, 2025](https://documentation.botghost.com/changelog/2025#new-mobile-builder--ui-improvements-march-24th-2025) * [Mobile Builder (Experimental)](https://documentation.botghost.com/changelog/2025#mobile-builder-experimental) * [General UI Improvements](https://documentation.botghost.com/changelog/2025#general-ui-improvements) * [Bug Fixes](https://documentation.botghost.com/changelog/2025#bug-fixes-5) * [Module Updates - March 23rd, 2025](https://documentation.botghost.com/changelog/2025#module-updates-march-23rd-2025) * [Translation](https://documentation.botghost.com/changelog/2025#translation) * [Moderation](https://documentation.botghost.com/changelog/2025#moderation) * [Economy Module Updates - March 21th, 2025](https://documentation.botghost.com/changelog/2025#economy-module-updates-march-21th-2025) * [BotGhost Fixes/Updates - March 17th, 2025](https://documentation.botghost.com/changelog/2025#botghost-fixes-updates-march-17th-2025) * [BotGhost Fixes/Updates - March 4th, 2025](https://documentation.botghost.com/changelog/2025#botghost-fixes-updates-march-4th-2025) * [Top.gg Autoposter & BotGhost Updates - February 28th, 2025](https://documentation.botghost.com/changelog/2025#top.gg-autoposter-and-botghost-updates-february-28th-2025) * [Top.gg Autoposter](https://documentation.botghost.com/changelog/2025#top.gg-autoposter) * [BotGhost Fixes](https://documentation.botghost.com/changelog/2025#botghost-fixes) * [Bug Fixes, Module Changes - February 27th, 2025](https://documentation.botghost.com/changelog/2025#bug-fixes-module-changes-february-27th-2025) * [Economy:](https://documentation.botghost.com/changelog/2025#economy) * [Weather:](https://documentation.botghost.com/changelog/2025#weather) * [Invite Tracker:](https://documentation.botghost.com/changelog/2025#invite-tracker) * [Status Module:](https://documentation.botghost.com/changelog/2025#status-module) * [BotGhost Updates - February 26th, 2025](https://documentation.botghost.com/changelog/2025#botghost-updates-february-26th-2025) * [BotGhost API & Bug Fixes](https://documentation.botghost.com/changelog/2025#botghost-api-and-bug-fixes) * [Webhook Object Updates - February 25th, 2025](https://documentation.botghost.com/changelog/2025#webhook-object-updates-february-25th-2025) * [New Webhook Object (beta only)](https://documentation.botghost.com/changelog/2025#new-webhook-object-beta-only) * [Edit Component Action - February 10th, 2025](https://documentation.botghost.com/changelog/2025#edit-component-action-february-10th-2025) * [Edit Component Action](https://documentation.botghost.com/changelog/2025#edit-component-action) * [Example Commands](https://documentation.botghost.com/changelog/2025#example-commands) * [Hiding of Old Reply Blocks](https://documentation.botghost.com/changelog/2025#hiding-of-old-reply-blocks) * [QOL Additions + Builder Settings - January 30th, 2025](https://documentation.botghost.com/changelog/2025#qol-additions--builder-settings-january-30th-2025) * [Builder Settings](https://documentation.botghost.com/changelog/2025#builder-settings) * [QOL Improvements](https://documentation.botghost.com/changelog/2025#qol-improvements) * [Bug Fixes - January 28th, 2025](https://documentation.botghost.com/changelog/2025#bug-fixes-january-28th-2025) * [Module Updates/Bug Fixes - January 3rd, 2025](https://documentation.botghost.com/changelog/2025#module-updates-bug-fixes-january-3rd-2025) * [Counting](https://documentation.botghost.com/changelog/2025#counting) * [YouTube](https://documentation.botghost.com/changelog/2025#youtube) * [Verification](https://documentation.botghost.com/changelog/2025#verification) * [Weather](https://documentation.botghost.com/changelog/2025#weather-1) Was this helpful? --- # Changelogs - 2024 | Changelog | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/changelog/2024.md) . [Current Year](https://botghost.com/docs/changelog/current) [Next Year (2025)](https://documentation.botghost.com/changelog/2025) [Previous Year (2023)](https://documentation.botghost.com/changelog/2023) [](https://documentation.botghost.com/changelog/2024#server-stability-fixes--free-bot-restriction-changes-november-21th-2024) Server Stability Fixes + Free Bot Restriction Changes - November 21th, 2024 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Over the last few days we have released a few updates to combat growing server stability problems. Some of these include: * Adding new servers * Fixing some problems with BP that caused commands/buttons to occasionally fail. * Moving large bots (10k+ servers) onto dedicated priority servers. This is something we may release in the future, however if you have a bot that is in 500+ servers and want to pay to have your bot placed onto one of these priority servers you can DM [Tomtoise](https://discord.com/users/136327647792726016) . * Added further restrictions on free bots. As part of this update we have added further restrictions on non premium bots. Non premium bots going forward have the following new restrictions: * Custom command + event limits have been changed to 3. * Free bots will go offline if they do not have a command used at least once every 48hours. There is a 7 day grace period after the bot is first created. * Free bots can only be added to a maximum of 5 servers. We will continue to monitor the effect these changes have on our servers and they may change going forward. These changes only effect new free bots made after these changes were deployed. Old non premium bots are not effected. Premium bots are of course also not effected. [](https://documentation.botghost.com/changelog/2024#module-updates-october-27th-2024) Module Updates - October 27th, 2024 ------------------------------------------------------------------------------------------------------------------------------- We have released some updates for the Moderation Module and the Economy and Minigames Module: ### [](https://documentation.botghost.com/changelog/2024#economy-and-minigames) Economy & Minigames * Edited the reference to "botghostmoney" in the currency prefix description on the module page to make the module [BotPanel](https://botpanel.gg/) friendly. * Various small changes to commands to improve performance and to prepare the module for the new message block ### [](https://documentation.botghost.com/changelog/2024#moderation) Moderation * Back by popular demand, the /say command is included in the Moderation module again. It also has logging so you can track who uses it. * EDIT - Fixed the say command so it doesn't continue _thinking_ all the time * Fixed a check in /case view that would not show cases for users who have left/been banned from the server * Various other small fixes [](https://documentation.botghost.com/changelog/2024#moderation-module-update-september-29th-2024) Moderation Module Update - September 29th, 2024 ------------------------------------------------------------------------------------------------------------------------------------------------------- We have released an update to the Moderation module: * Fixed issue with /role temp not allowing days - You can now use d in the duration field, eg: 7d * Corrected a small issue in the calculation of time in the /ban and role temp commands * **Added functionality to /ban add - If the user has left the server when you try and ban, the command will ask if you want to ban by ID. Simply paste the ID into the form and the user will be banned.** [](https://documentation.botghost.com/changelog/2024#module-updates-september-22nd-2024) Module Updates - September 22nd, 2024 ----------------------------------------------------------------------------------------------------------------------------------- We have released some updates for the Moderation Module and the Economy and Minigames Module: ### [](https://documentation.botghost.com/changelog/2024#economy-and-minigames-1) Economy & Minigames * mg\_match\_button\_tracker has been changed to a user object. Please see the video recording attached for more info. The video has sound. * /ec admin now uploads the emojis to the bot, instead of the server. Please see more information [here](https://discord.com/developers/docs/change-log#application-emoji) . If you want to use this, just upload the emojis again * Fixed issue with lottery announcing twice * Edited Economy Autorole cooldown from 60 seconds to 10 seconds. This should clear up any confusion with roles not being added. * If Economy autorole fails to add a role it should send an error to the error log in the dashboard * /hangman fixed issue with word generation * /shop buy will tell you how much money you need if you try and buy something but don't have enough money * Small changes to /rob bank to hopefully make it more reliable * /5dice small fix to stop negative rolls from occurring ### [](https://documentation.botghost.com/changelog/2024#moderation-1) Moderation * You can now edit case reasons if you have administrator permissions using /case view * Fixed typo in /purge log message * /channel unlock permissions should allow everyone to speak * /mute remove should now successfully remove timeouts again [](https://documentation.botghost.com/changelog/2024#tickets-module-rework-out-of-beta-september-14th-2024) Tickets Module Rework - Out of Beta - September 14th, 2024 --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- The tickets module is now out of beta and is available for all users. During its beta state, more features were added to the module, along the already existing ones: * The module uses now the new message block, all reply blocks have been replaced * API Requests to send messages are not used anymore and have been replaced by the send or edit a message block. This also applies to transcripts * Added a new setting that allows you to customize the welcome message when a ticket is created. This also grants you access to a wide range of variables you can use to add information to it * When a ticket is created, a link to the transcript channel will be logged * Added a `/ticket update-counts` command. Premium users can use this command to update their tickets' counts (Global counts, Panel specific counts and user specific counts). You can increase / decrease the count by 1, reset it or set a custom value. Only integers greater than or equal to 0 can be used for the custom value * More minor additions and fixes [](https://documentation.botghost.com/changelog/2024#advanced-message-action-update-out-of-beta-september-13th-2024) Advanced Message Action Update: Out of Beta - September 13th, 2024 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- The new Advanced Message Action update and all the updates associated with it are now out of beta and free to use for all users. Fixed bugs: * Select menus with no descriptions * API Requests with variables * Forms with required components set to false still being required. * Required permissions on commands. * Fixed a bug with the {first\_channel\_id} variable. * Fixed a bug with empty command and option descriptions. * Message created not triggering in dms * Fixed a bug with some variables and delete events. * Fixed a bug with the old button commands that had an emoji and no label. * Depreciated Search + Trivia modules * Re added back the Automod detection to on message create * Fixed a bug with attachments after an interaction [](https://documentation.botghost.com/changelog/2024#new-update-bug-fixes-september-5th-2024) New Update Bug Fixes - September 5th, 2024 --------------------------------------------------------------------------------------------------------------------------------------------- Below are some bug fixes for the updates currently on beta. This message will be updated over time with more fixes. ### [](https://documentation.botghost.com/changelog/2024#send-or-edit-a-message) Send or Edit a Message * Fixed a bug that caused the optional message variable to not work correctly after a button or select menu. * Fixed a bug that caused connected actions to not run * Fixed a bug that caused UNIX timestamps to not work in the timestamp variable field in embeds * Fixed a bug with editing messages after a button or menu interaction * Removed the required fields on various inputs in both the button and menu options * Allowed forms to be connected to the new buttons and menus after an interaction * Fixed a bug with hidden replies in buttons and menus * Removed the handle from the LINK button in the builder * Removed the required setting on the Description field of Select menu options * Fixed a bug with Keep Components when editing another message * Buttons can now have either an emoji or label * Fixed a bug with link buttons that had the same URL overriding each other * Duplicating an Embed field with inline will now keep the inline value intact * Added further sanitization to the Embed Preview * Fixed a bug with using the new reply action in events and replying to button/menu interactions * Fixed a bug with the optional variable field and select menus * Fixed a bug with the mentionable select menu and variables ### [](https://documentation.botghost.com/changelog/2024#react-to-a-message) React to a Message * Added server emojis to the emoji picker in the action ### [](https://documentation.botghost.com/changelog/2024#beta-fixes) Beta fixes * Fixed errors with the delete all key of Object Variables * Fixed a bug with variables returning incorrect values * Fixed a bug with Forms and the LONG input option * Fixed some problems with Permission Bit Fields * Added much more detailed error handling to Discord.js errors [](https://documentation.botghost.com/changelog/2024#major-update-new-advanced-message-message-builder-new-menu-types-discord.js-v14-update-react-to-mess) Major Update: New Advanced Message, Message Builder, New Menu Types, Discord.js v14 Update, React to Message block - September 4th, 2024 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Today we are releasing the new **Send or Edit a Message** action. This action combines all the existing action blocks into one and adds countless new options and possibilities for your messages. We are also updating our backend to Discord.js v14, adding all new select menu types and a new React to Message block. We are also announcing some new actions that are being added soon to help compliment this new action. ### [](https://documentation.botghost.com/changelog/2024#send-or-edit-a-message-action) Send or Edit a Message Action The new Send or Edit a Message action combines all the existing message actions (excluding the random reply action) into one and adds a new Message builder and component handling. The new action allows you to: * Construct an Advanced message using the **Message Builder** * Add buttons and menus using buttons on the block instead of in the blocks settings * Have either message content, or a blank message with buttons and menus. * Add buttons and menus on the same message * Use all the new Discord select menu types * Edit and reply to specific messages * Order buttons and menus onto specific rows * Order buttons and menus based on weight * Programmatically hide and show embeds using variables * Have buttons and menus and run connected actions after the message has been sent * Disable buttons and menus by default * Change the style of buttons via variables ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252F8uljDedCxGH1zbPBeBsk%252Fimage.png%3Falt%3Dmedia%26token%3D96b699c5-934f-492e-b949-6fac42cc6814&width=768&dpr=3&quality=100&sign=1232127d&sv=2) ### [](https://documentation.botghost.com/changelog/2024#message-builder) Message Builder This new action uses our new Message Builder. This builder allows you to fully create an advanced message utilizing all embed options and fields. This builder allows you to: * Add up to 10 embeds to a message. * Use all embed options available on Discord. * Add fields to your embeds. * Have message content and embeds on the same message. * See a preview of how your message will look. * Hide and show embeds using variables ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FA4kKOrbuupLI7HnobqMc%252Fimage.png%3Falt%3Dmedia%26token%3D98b59072-27a0-4faa-a454-7b1d41686b15&width=768&dpr=3&quality=100&sign=efd1e6c6&sv=2) ### [](https://documentation.botghost.com/changelog/2024#new-select-menu-types) New Select Menu Types With this new action we have added all the new select menu types added in Discord.js v14. These new menus and their options include: * Basic (Text) menu * Role menu * Channel menu * User menu * Mentionable menu For the new menu types, all their supported default role, channel and user options are supported via dropdown and variables. ### [](https://documentation.botghost.com/changelog/2024#new-button--select-menu-options-and-capabilities) New Button + Select Menu Options and Capabilities Some of these include: * The ability to add buttons and menus to the same message * The ability to order buttons and menus on a row via their weight (has variable support) * The ability to add buttons and menus to specific action rows (has variable support) * Options to hide or show buttons and menus via variables * Options to Disable a button or menu by default (has variable support) * The ability to hide a specific basic text menu option via variable ### [](https://documentation.botghost.com/changelog/2024#react-to-a-message-block) React to a Message Block The new action does not have the normal react to message field present on the old reply blocks. Instead a new **React to a Message** action has been added. This action allows you to: * React to a message sent by another action. * React to a specific message via channel id and message id (has variable support) * Add additional reactions using variables. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FJ8NDUhMpz0JvZE2U2Q63%252Fimage.png%3Falt%3Dmedia%26token%3Df7daa33a-85e3-414f-a905-a102231bba94&width=768&dpr=3&quality=100&sign=ac4cc238&sv=2) ### [](https://documentation.botghost.com/changelog/2024#discord.js-v14-update) Discord.js v14 Update This new block utilises a lot of newer features only found in Discord.js v14. With this new action we have updated our backend to a new custom v14 of Discord.js. This update features a lot of breaking changes so if you find any odd bugs or interactions please report them in <#1280722662523670569> ### [](https://documentation.botghost.com/changelog/2024#planned-additions-to-the-new-message-action) Planned Additions to the New Message Action We are also announcing some planned additions that will come soon once this action goes out of beta. These include: * Edit component action to edit the buttons/menus of a message after they have been sent. * JSON Editor for the Message builder * Error and Success Handles **(THESE CHANGES ARE BETA ONLY)** [](https://documentation.botghost.com/changelog/2024#moderation-module-release-out-of-beta-september-2nd-2024) Moderation Module Release - Out of Beta - September 2nd, 2024 --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **The new Moderation module is now out of beta and is available to all users.** This module is available to **free** and **premium** users. Please remember to disable beta if you are no longer testing anything to ensure your bot is stable and fast. [](https://documentation.botghost.com/changelog/2024#increased-beta-server-capacity-august-30th-2024) Increased Beta Server Capacity - August 30th, 2024 ------------------------------------------------------------------------------------------------------------------------------------------------------------- Due to an increase in the use of the beta servers I have doubled the capacity and hardware of our beta application servers. If you are currently on a slower beta server simply restart your bot to go onto one of the newer nodes. [](https://documentation.botghost.com/changelog/2024#moderation-module-release-beta-august-27th-2024) Moderation Module Release \[BETA\] - August 27th, 2024 ----------------------------------------------------------------------------------------------------------------------------------------------------------------- **Today we are pleased to announce that we are releasing the new and improved Moderation module!** The module replaces the hardcoded Moderation module as we shift towards making all the BotGhost modules completely customisable. The new Moderation module has all the same functionality as the old, but includes some neat new features, such as: * A full case ID system, allowing you to track cases server wide on all users * Moderation actions like mutes, warns and bans are assigned Case ID's, which store the details of the punishment, such as reason, moderator, time, etc * Case ID's can be seen on a users moderation history and details can be viewed by looking up the case number * Automatic punishments - You can configure a punishment to happen automatically after a set criteria, such as 3 warns = automatic timeout (Limited to 1 for free users and 10 for premium users) * Temporary ban system, allowing you to ban users for a certain period of time * Temp role system, allowing administrators to apply temp roles to users * Notes - Add notes to users that only moderators and above can see * Nickname moderation * Slowmode modification * Channel lock and unlock The new Moderation module is currently only available on BETA, which can be enabled in the Settings page of the BotGhost dashboard. BETA is only available for Premium users. NOTE: BETA servers are slower than LIVE, so please be patient if you experience any slowness or interaction timeouts on BETA **This module is available to free AND premium users, but BETA is only available to premium users. We will announce when the module is out of BETA and available for free users.** [](https://documentation.botghost.com/changelog/2024#tickets-module-rework-august-26th-2024) Tickets Module Rework - August 26th, 2024 ------------------------------------------------------------------------------------------------------------------------------------------- Today, the Tickets module is getting a big update, coming out with a bunch of new features such as multi-panels, automations and ticket limits! The module works with a new "panel" system. This means that you can customize each button (or select menu option) of your ticket creation message with different settings. Simply add your connected panels in the "Connected Panels" field and send your panel: this will send more panels into one single message. You can also customize the name of your ticket or setup a /ticket create command users can use. Limits are also coming to the module: set a maximum number of tickets users can have opened at once! Last but not least, you can now setup automations for your tickets, to close or delete them after some hours of inactivity! This module is currently **beta only**. [](https://documentation.botghost.com/changelog/2024#dashboard-custom-command-event-and-variable-grouping-august-26th-2024) Dashboard Custom Command, Event and Variable Grouping - August 26th, 2024 ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- We have added the ability to create groups for your Custom commands, events and variables in the dashboard. These allow you to create and add groups which let you section out your commands, events and variables. This should make the dashboard much more organised and easy to read for users with lots of commands, events or variables. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FZ4Tr2QhPWBKHzYL9cAVv%252Fimage.png%3Falt%3Dmedia%26token%3D006ef7c2-18bc-4c50-945f-bad1f1f5fefe&width=768&dpr=3&quality=100&sign=15d947ad&sv=2) [](https://documentation.botghost.com/changelog/2024#error--success-handles-out-of-beta-august-22nd-2024) Error + Success Handles out of Beta - August 22nd, 2024 ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- The error and success handles update is now out of beta and can be used by all members. [](https://documentation.botghost.com/changelog/2024#variable-editor-in-builder-august-21st-2024) Variable Editor in Builder - August 21st, 2024 ----------------------------------------------------------------------------------------------------------------------------------------------------- We have added the ability to create new Custom Variables from within the Command and Event Builder. This means you can create new variables without having to go to the Data storage page. Simply click the **New Variable** button at the top of the Set Variable or Run Equation on Variable action blocks. This will open a window that has the same New Variable input as the data storage page. **You must trigger a save by either saving your command/event or exiting the builder to save like normal for your new variable to be saved to your bot.** ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252F4PAT8FBwteSHAdccOS74%252Fimage.png%3Falt%3Dmedia%26token%3Df0e47470-0857-47c2-afaf-454316e82a36&width=768&dpr=3&quality=100&sign=724b1542&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FPTIpA9ytwca60XzFj7ay%252Fimage.png%3Falt%3Dmedia%26token%3Dedf28b78-84d4-48fd-ba89-14c59ec7759c&width=768&dpr=3&quality=100&sign=a2ab805c&sv=2) [](https://documentation.botghost.com/changelog/2024#more-bug-fixes-august-20th-2024) More Bug Fixes - August 20th, 2024 ----------------------------------------------------------------------------------------------------------------------------- * Fixed a bug that caused the dashboard to crash when deleting a block with the Variable Editor open. * Added variable capabilities to the user limit field of the channel create and edit actions. * Added the appropriate character limit to the Option Description field in the command builder. * Added the Event switcher select to the IFTTT custom event even if you have not linked your account yet. * Fixed a bug that caused channels to not be created if using a user option with merge permissions enabled in the create channel action. * Fixed a bug that caused the value of optional variable input's in reply blocks to not change when quickly switching between blocks. * Added a clipboard button to the Send a form action so you can easily copy the form's variable. * Fixed some documentation links throughout the builder. * Added a Copied! popup to some clipboard buttons. * Fixed the Edit a message sent by another action description in some actions. * Creating timed events with a schedule will now automatically re-order the schedules when you add a new schedule to the event. * The channel Create, Edit and Delete custom events will now trigger on Category Channels. * Fixed a bug that caused the Optional Emoji Id field in select menu's to not change when quickly switching between blocks. * Fixed a bug that caused timed events to be created with the same internal Id. * Fixed a bug that caused the create role action to fail if you specified a color hex. * Added validation to the Custom Variable name field to remove characters from the name (similar to the reference). * Removed the Hide Errors ephemeral option from the Error block in events. * Reworded the description on the New Custom Variable input section. * **Added a Deselect button when selecting multiple blocks.** **\- Duplicating, creating a template and deleting multiple variables will cause the builder to deselect after it has completed the desired action.** TLDR: Fixed more things. [](https://documentation.botghost.com/changelog/2024#bug-fixes-august-19th-2024) Bug Fixes - August 19th, 2024 ------------------------------------------------------------------------------------------------------------------- * Fixed a bug that caused the screen to go grey when deleting certain condition blocks. * Temporarily created variables from the create channel/role actions should now persist after button/menu click. * Added a warning to the role/channel delete blocks when using options with the same name. This could cause you to accidentally delete a channel or role if you have options or temporary variables with the same name. * In events, the button action now defaults to the channel id target. * Object vars are now filtered when searching through the Variable Editor. * Added the Variable clipboard to some inputs in the Delete a message action. * Fixed the Object Variables color in some inputs in certain actions. * Unique variable now work correctly in the Message Delete event. * Fixed the error label in the Send a message to a channel action. * When deleting object properties in the Variable Editor the correct property will now be deleted. * **Depreciated the Reddit Module.** * **Depreciated the Meme Creator Module.** * Fixed targeting variables in the Permission Condition. * The Mobile nav on the dashboard should now be the same as on PC. * The collab button on the Mobile nav is now hidden if you are in Collab mode. * Removed the duplicated Settings option in the Mobile nav. * Fixed a bug with editing a chain of messages after a button click. * Removed an error being sent when a button/select menu response is successfully edited. * Fixed the {event\_message\_attachments\_count} variable in message events, and edited it and all attachment variables to the messageEdit event. * Removed the USE\_EXTERNAL\_SOUNDS permission from the dashboard. * Announcing the removal of the Item + Currency conditions (was done earlier). * Fixed a bug with collection variables when the collection was \[0\]. * Fixed a bug causing the edit channel action to edit the permissions of the channel the command/event was used in when merge permissions was enabled and the target should have been another channel. * Fixed a bug which caused the created channel variable to not persist after button/menu click. * Changed the encodeText variable to use encodeURIComponent JS function (was encodeURI). * Changed all variables that use targeting (e.g {channel\_id\[ID\]} to return null if the provided ID or Option does not return a valid target. Previously this would return the channel, user, role that was associated with the command/event. * Removed the outdated command builder tutorial. * **Depreciated the Options Condition. Use the Comparison Condition instead. (They will still work in your commands/events just not appear in the builder).** * **Depreciated the Custom Variable Condition. Use the Comparison Condition instead. (They will still work in your commands/events just not appear in the builder).**\* * Added the ability to use variables in the Disable Text and Disabled clicks required fields of buttons. * Removed the topic field on application side if provided for channels that cannot have a topic as it would cause these channels to not be created/edited. * Fixed default targeting options for all Voice Actions in events. These now default to a Channel/Member Id instead of command targets. * Fixed a bug that caused the error this.options.components?.map is not a function to appear when editing a Select menu with another Select menu. * Added an input for an optional name variable for the thread create action. TLDR: Fixed things. [](https://documentation.botghost.com/changelog/2024#undo--redo-block-deletion-adding-in-the-builder-august-16th-2024) Undo + Redo Block deletion/adding in the Builder - August 16th, 2024 ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ We have added some more key bind's to the builder. Use **Ctrl + Z** to undo placing a block or connection in the builder. Use **Ctrl + Y** to redo a deletion (or an undo) of a block or connection in the builder. The builder will now also store up to 100 block deletions that will persist through saves for you to be able to Redo past deletions. This will not work on old commands/events and will only start saving your command/event's state starting from today. [](https://documentation.botghost.com/changelog/2024#multi-delete-blocks-august-15th-2024) Multi Delete Blocks - August 15th, 2024 --------------------------------------------------------------------------------------------------------------------------------------- We have added the ability to now also delete multiple blocks at a time on the builder. Simply **Shift Click and drag** to select multiple blocks and then click either the **Delete or Backspace** key. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FYBmii3XZntFYERj8ZyBX%252Fimage.png%3Falt%3Dmedia%26token%3D72a078ea-161a-467b-9d68-877c645351e0&width=768&dpr=3&quality=100&sign=f917c9eb&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FmyAAxBy2i0rnHIXdjrVG%252Fimage.png%3Falt%3Dmedia%26token%3D1a2983fa-1703-43f4-9969-f5b503e62319&width=768&dpr=3&quality=100&sign=fc302712&sv=2) [](https://documentation.botghost.com/changelog/2024#builder-save-keybind--macos-keybinds-august-14th-2024) Builder Save Keybind + MacOS Keybinds - August 14th, 2024 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- We have just added the ability to trigger a save in the command and event builder using **Ctrl + S**. This will do the exact same thing as clicking the Save Command/Event button at the top. We have also extended some keybinds so that they can be better used on Mac's. **Instead of clicking CTRL for any keybind you can now use the Command key**. For example, Command + C, Command + V, Command + S. You can also now click the **backspace key to delete a block.** As a reminder, the list of current keybinds includes: * Ctrl/Command + C to copy a block * Ctrl/Command + V to paste a block * Ctrl/Command + S to save a command or event * Shift + Drag to select multiple blocks [](https://documentation.botghost.com/changelog/2024#save-block-templates-august-9th-2024) Save Block Templates - August 9th, 2024 --------------------------------------------------------------------------------------------------------------------------------------- We have just added the ability to save user wide block templates to your command and event builder. This allows you to save frequently used block configurations that you can quickly drag and drop into other commands and events. Simply hold **Shift** and drag select multiple elements. Then click **Save as template**. You can then go to the **Block Templates** section in the builder and drag and drop your saved blocks anywhere on the builder. These templates are **saved on your account so they can then be used on any of your other bots.** ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252Fs26j5dDgHAgvSY4WcPFz%252Fimage.png%3Falt%3Dmedia%26token%3D1292d19f-1f41-4deb-9588-d69588b8cb5e&width=768&dpr=3&quality=100&sign=afbe96d8&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FlkQklp7iZASpQTukWzI6%252Fimage.png%3Falt%3Dmedia%26token%3Dd377d13f-8ebd-40c5-a45a-3c437b49e287&width=768&dpr=3&quality=100&sign=7a2d60d3&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FDHGq9bIoOB4Lr1dmVAaB%252Fimage.png%3Falt%3Dmedia%26token%3D6c12e3f8-314f-44a7-9d18-8243638033f1&width=768&dpr=3&quality=100&sign=6c4d94ce&sv=2) [](https://documentation.botghost.com/changelog/2024#error-and-success-handles-for-actions-beta-august-8th-2024) Error & Success Handles for Actions (beta) - August 8th, 2024 ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- We have added specific error and success handles to actions that interact with the Discord API. These handles (green for success, red for error) allow you to conditionally run actions when the parent block it is connected to encounters an error. This should allow for better error handling and logic for things such as moderation commands. To enable these handles, find the **Enable Success/Error Handles** at the bottom of compatible action blocks. These are available in all actions that perform an action using the Discord API. This excludes reply actions. **This update is currently in beta only** ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FlazHRxVjMcvucPzoRUjU%252Fimage.png%3Falt%3Dmedia%26token%3Deb532183-4bb0-486b-86bd-3b7f2f7851f4&width=768&dpr=3&quality=100&sign=2bce3a71&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FZNHebebEyXy71hq7pzGR%252Fimage.png%3Falt%3Dmedia%26token%3D097b71cf-52ff-4bc9-8e55-41ebf6147790&width=768&dpr=3&quality=100&sign=c7eaed9e&sv=2) [](https://documentation.botghost.com/changelog/2024#copy--paste-single-blocks-and-delete-key-qol-fix-august-8th-2024) Copy + Paste Single Blocks & Delete Key QOL Fix - August 8th, 2024 ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- We have added new key binds to **Ctrl + C** to copy and **Ctrl + V** to paste single blocks in the builder. Blocks will go to your clipboard and can be pasted anywhere at your cursors location in the builder. We have also changed how the Delete key works when deleting a block. Now, if you are **focusing (clicked on) an input, the delete key and new copy paste key binds will not work.** This should stop users from accidently deleting a block when they were intending to delete text inside the block instead. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FVYKoI0HBjhlmApnUHzgL%252Fimage.png%3Falt%3Dmedia%26token%3D87f600c2-6d23-408e-b5c3-104f8de8846e&width=768&dpr=3&quality=100&sign=e9a95835&sv=2) [](https://documentation.botghost.com/changelog/2024#weather-module-july-29th-2024) Weather Module - July 29th, 2024 ------------------------------------------------------------------------------------------------------------------------- Today, we are releasing the weather module to receive statistical information about a location or city. This module features brand new graphics and detailed information, future forecast, with many available options to configure to your measurement scales, or even change the entire design! This module is available to all users immediately. [](https://documentation.botghost.com/changelog/2024#upcoming-old-module-depreciations-july-17th-2024) Upcoming Old Module Depreciations - July 17th, 2024 --------------------------------------------------------------------------------------------------------------------------------------------------------------- Within the next few weeks we will be depreciating and deactivating the **OLD hard coded versions** of the following modules: Reaction Roles Leveling Stats Channels Announcements Timed Messages Twitch YouTube Autoresponder Meme Creator Search **Please note: this only applies to the OLD hard coded outdated versions of these modules, not the new version which uses custom commands and events.** No action is required on your side if you have these modules enabled they will just cease working when removed. Thanks! [](https://documentation.botghost.com/changelog/2024#new-events-july-15th-2024) New Events - July 15th, 2024 ----------------------------------------------------------------------------------------------------------------- Today we have released a few new events to the custom event builder: * Guild Channel Permissions Update * Guild Boost Level Up * Guild Boost Level Down * When a message is pinned * Guild ban removal * Guld Scheduled Event Create, Update, Delete, User join, User remove * Invite create * Invite delete [](https://documentation.botghost.com/changelog/2024#new-guild-channel-user-and-member-object-variables-july-5th-2024) New Guild, Channel, User & Member Object Variables - July 5th, 2024 ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Today we are releasing four new variables that allow you to access all the properties of the Guild, Channel, User & Member Discord.js Objects. These variables and the properties they can access include: * [{Guild}](https://old.discordjs.dev/#/docs/discord.js/13.17.1/class/Guild) * [{Channel}](https://old.discordjs.dev/#/docs/discord.js/13.17.1/class/TextChannel) * [{Member}](https://old.discordjs.dev/#/docs/discord.js/13.17.1/class/GuildMember) * [{User}](https://old.discordjs.dev/#/docs/discord.js/13.17.1/class/User) You can use these variables to access any property (excluding the client option) of their associated Discord.js Object. Some examples: * {Guild.name} * {Guild.roles} * {Channel.position} * {Member.user.username} * {User.banner} * {User\[136327647792726016\].avatar} For more information please have a read over our [Documentation](https://docs.botghost.com/custom-commands-and-events/variables#object-variables) . This update is available to all users (not restricted to beta). ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FKfedeECDSzmeybkSkTMM%252Fimage.png%3Falt%3Dmedia%26token%3Daabc8f4f-1a7f-435e-85b1-87b5034f808d&width=768&dpr=3&quality=100&sign=95da40bf&sv=2) [](https://documentation.botghost.com/changelog/2024#small-update-july-4th-2024) Small update - July 4th, 2024 ------------------------------------------------------------------------------------------------------------------- * We have now rectified the issue where Role items were not adding the roles and were instead giving an error. This should now be resolved * Small fix to /rob bank where it was checking the holding balance instead of the bank balance * Also the Panic button was not working as intended. This has also been fixed **The role issue does not require a module update and should simply start working** The fixes to /rob bank DO require a module update, which you can do the normal way by heading to the Economy and Minigames module in the dashboard and clicking Update Module. [](https://documentation.botghost.com/changelog/2024#economy-and-minigames-module-update-july-3rd-2024) Economy & Minigames Module Update - July 3rd, 2024 --------------------------------------------------------------------------------------------------------------------------------------------------------------- We have just released another update to the Economy & Minigames module. Below are a list of changes/fixes: * **New command: /rob bank - Allows you to team up with others to rob a players bank** * **New item: Mobile phone - Will make /rob bank ping you when you are about to be the victim of a heist** * Combined /ec admin and /ec config into one command - /ec admin * Renamed /rob to /rob player * Split the emoji add function into separate pieces for each game, currently only blackjack and 5dice for now * Reduced /scratchcard cost * /scratchcard now has a slightly increased chance of a win when using lucky dice * /matchpairs cash reward now scales with lives left * /matchpairs will now correctly track wins * /rps betting should be fixed and should now show how much the bet is * Fixed tictactoe "already playing" issue (hopefully) * Shop embeds now reference the correct commands for buying * Fixed an issue with lottery where tickets were not being consumed if nobody won that day * Fixed some wonky maths in the /rob command when you were caught by a watchdog * Fixed /shop buy not deducting money when a user already owns 1 or more of the item * Role items should now correctly grant the role(s) on purchase * The shop in the dashboard now forces "Use on buy" to ON when the item is a Role item * Shop has a new toggle "Unlisted" true/false - If an added item is unlisted, it will not show up in the /shop view command. This is so allow users to add items that can be FOUND instead of bought * /blackjack now deducts the initial bet immediately and the player is automatically dealt 2 cards. The game will immediately end in a win if the player hits 21 on the first two cards * Using /blackjack will now invalidate any unfinished blackjack games that were in progress * Commands and activities that consume an item should now say how much of that item you have left * Reduced the cooldown of /work to 30 minutes * Applied item limits to all preconfigured items in the shop. This is to stop people from dumping all their money into items to avoid a robbery * Changing a command cooldown in /ec admin will now reset the cooldown of that command for all users * Safe mode now tracks bank balances as well (No more depositing money to avoid the safe mode trigger!) [](https://documentation.botghost.com/changelog/2024#new-voice-events--intent-options-june-26th-2024) New Voice Events + Intent Options - June 26th, 2024 -------------------------------------------------------------------------------------------------------------------------------------------------------------- Today we have released a few new voice events for all users. These include: * When a member is server muted * When a member is self muted * When a member is server unmuted * When a member self unmutes * When a member is server deafened * When a member self deafens * When a member is server undeafened * When a member self undeafens We have also released new options for the three privleged intents. These options (avaiable in the settings page) allow you to toggle between 3 modes which change how BotGhost handles privileged intents for your bot. These include: * Auto - Automatically enable the privileged intent only when it is required for your bot to function * Always Enable - Always add the privileged intent * Never Enable - Never enable the privileged intent **DO NOTE: Disable some privileged intents will cause some bot functions to not work correctly. So do so at your own risk** These features are available to all users. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252F1apUJc6QQGRv9uXa33bu%252Fimage.png%3Falt%3Dmedia%26token%3Dd841af57-7bf8-4e96-9b33-7b61fd9c7326&width=768&dpr=3&quality=100&sign=211b9e02&sv=2) [](https://documentation.botghost.com/changelog/2024#welcomer-new-card-backgrounds-june-20th-2024) Welcomer - New Card Backgrounds - June 20th, 2024 --------------------------------------------------------------------------------------------------------------------------------------------------------- Hey everyone! Today, we are releasing to all premium users 8 brand new default card backgrounds for your welcome card in the [Welcomer](https://dashboard.botghost.com/dashboard/module/b65529b9-b196-4088-8fef-3eaff0b0c047/welcomer) module. You can access the new cards by updating the module and setting the "Background" option to "Default Background Image", which will show a new select menu, allowing you to choose your favorite default card. Interested in gaining access to the new default cards and lots of other perks? Upgrade your bot to [Premium](https://docs.botghost.com/premium/pricing-and-subscriptions) and enjoy your new card backgrounds! ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FJzJ0FDvkcaaP5f80865I%252Fimage.png%3Falt%3Dmedia%26token%3D3d345048-ef4b-4538-b332-ba79cc9f052d&width=768&dpr=3&quality=100&sign=baf3dce1&sv=2) [](https://documentation.botghost.com/changelog/2024#economy-update-june-12th-2024) Economy Update - June 12th, 2024 ------------------------------------------------------------------------------------------------------------------------- **Changes:** * Added a "Troubleshooting" option in **/ec admin** so that users can reset specific economy related variables easily if needed SUBCOMMANDS - Here is a list: * /give-money > /money give * /add-money > /money add * /remove-money > /money remove * /economy-leaderboard > /ec leaderboard * /economy-admin > /ec admin * /give-item > /item give * /shop > /shop view * /bank-deposit > /bank deposit * /bank-withdraw > /bank withdraw * /job-list > /job list * /shop-buy > /shop buy * /stats > /ec stats * /minigame-config > /ec config * /cooldowns > /ec cooldowns * /job-apply > /job apply **Fixes:** * Increased /bank deposit cooldown to 6 hours. _Should make depositing your money more strategic to avoid /rob_ * Enforced lower max bet for blackjack (2000 max). _/blackjack can make doubling your money very easy, so setting a max bet to help stabilise any massive economy swings_ * Fixed blackjack issue for doubling. _Doubling was causing an issue with checking if the user had enough to double the bet. This should be fixed_ * Money was not being deducted in /shop buy if the item already existed in the users inventory. This is fixed **In development, NO ETA:** Farming, Roulette, Bank Robbing Note: If you have made changes to your economy commands, updating will **disable** your edited commands but it will **not** delete them. If you want to enable your edited command again, just disable the new, updated command and re-enable your edited version. [](https://documentation.botghost.com/changelog/2024#may-module-changes-june-8th-2024) May Module Changes - June 8th, 2024 ------------------------------------------------------------------------------------------------------------------------------- Lots of changes have been released in the last month, here are them below: ### [](https://documentation.botghost.com/changelog/2024#economy) Economy * A [Major Update](https://documentation.botghost.com/changelog/2024#economy-update-may-28th-2024) was released a few days ago * Added more words to hangman * Embed colours can now be customised on the module page * Added a system to turn off minigame challenges * Added a message suggesting the lottery when user earns over 10k * Implemented an option to choose a channel for Lottery win announcements * Fixed a bug with matchpairs * Fixed the last two matches in match pairs to have green buttons * Fixed matchpairs lose API query * Fixed high-low amount won * Fixed work stats for forgetting to clock in * Increased bank deposit cooldown * Increased cooldowns for minigames * Decreased win amount for hangman * Fixed robbing a user with a watchdog where you could go into negative money * Added amount lost to blackjack embeds * Changed crime lost amount to equal win amount (was double) * Fixed mystery box embed and item limit variable * Increased /beg success chance * Fixed /beg, /crime and /blackjack where you could be left with a negative balance * Various text formatting fixes ### [](https://documentation.botghost.com/changelog/2024#temp-voice-channels) Temp Voice Channels * The module now uses subcommands * Added a new option in the channel lock setting * Fixed a bug that caused the module to not work as intended when switching channels * The voice channel message should now always be sent to the channel ### [](https://documentation.botghost.com/changelog/2024#leveling) Leveling * The module now uses subcommands * Leveling is now disabled in DMs * Added a "Default Card" card type ### [](https://documentation.botghost.com/changelog/2024#suggestions) Suggestions * The module now uses subcommands * Fixed an issue that caused the approval message to DM the approver instead of the suggester ### [](https://documentation.botghost.com/changelog/2024#birthdays) Birthdays * The module now uses subcommands [](https://documentation.botghost.com/changelog/2024#subcommands-may-31st-2024) Subcommands - May 31st, 2024 ----------------------------------------------------------------------------------------------------------------- Today we are releasing the ability to turn your commands into subcommands. This allows you to define multiple commands under one parent command. This brings the maximum total amount of commands you can have on your bot from 100 to 2500. To create a subcommand, simply create a command like normal and put a single space in the name. Each command can have up to 25 subcommands. Do note: If you turn a command into a subcommand, the parent command will no longer be useable. For example, if you have /subcommand 1 and /subcommand 2, you will no longer be able to use just /subcommand. Subcommands allow you to group up related commands. For example: /economy shop /economy buy /economy work ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FPqDktvIJ3tOMN18hyqgv%252Fimage.png%3Falt%3Dmedia%26token%3D8d7ae181-2eba-47ef-b3e0-94af0ba71151&width=768&dpr=3&quality=100&sign=4d01944&sv=2) [](https://documentation.botghost.com/changelog/2024#economy-update-may-28th-2024) Economy Update - May 28th, 2024 ----------------------------------------------------------------------------------------------------------------------- We have released a major update to the new Economy module! **Users who have used the Economy module and added the economy emojis to their server MUST upload them again. You can do this in /minigame-config** **Due to the large number of changes, we recommend updating the module and resetting to default. This will NOT reset your users currency balances** _If you would like to start completely fresh for this update then please run /economy-admin and press "Reset Server Economy" after updating_ Here is a list of the most notable changes: * Shop is back - you will find the new shop inside the module in the dashboard. It works the same as the old shop with some added options * Updated the module to use object variables - This will eliminate all "undefined" issues people were experiencing before * Job Rework - Jobs are customizable from inside the module on the dashboard, just enable "Advanced Jobs" to see a customizable list * You can now add your own commands and events **right inside the module**. Just click the "Add" button in the command or event list inside the module page. * /shop command changed to work with the new shop system * All bot challenges should now be disabled to stop players from gaming the system and getting unlimited money * Watchdogs now have a limit of 3 per player, and have a 60% chance of saving you from a rob, down from 100% * Lottery now has a 30% chance of a winning ticket, but the payout is much higher * Custom emojis for the currency icon should now display correctly in all embeds * /job-status has been renamed to /job-list and has been made clearer * New command: /job-apply - When /work informs you that you eligible for a promotion, you can apply for the new job using this command * You can now buy multiple Mystery and Lucky Mystery Boxes at once - they have also received a buff * Betting negative amounts is no longer possible * Hangman has been redesigned * /dicebet has been completely redesigned and is now PvP * Commands should be more responsive due to loop improvements * /rob now has a Safe Mode - new players have Safe Mode enabled by default. Users with safe mode enabled cannot use /rob and cannot be /robbed. Safe mode can be manually disabled or it is automatically disabled when a user has > 10,000 currency. Safe mode cannot be re-enabled. * Many, many, many other balance changes to currency amounts, formatting and various fixes [](https://documentation.botghost.com/changelog/2024#cocreate-rework-may-28th-2024) Cocreate Rework - May 28th, 2024 ------------------------------------------------------------------------------------------------------------------------- We have pushed an update and total rehaul of the Cocreate module. This update aims to bring the module up to date and open it up to all users. Changes include: * Renaming the module to **Collab** * The module is now free for everyone to use and has no limits. * You can view both people working on your bot and the bots you have been invited to work on within the module. You can also leave any collabs you have accepted. * You can now view the last time someone saved an update on one of your bots * The module now cannot be enabled/disabled. To disable anyone working on your bot, simply remove all the collaborators of that bot. * All old cocreators have been imported into the module. Please go to the module page to check for any old cocreators you no longer want and remove them. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FuYkXhLh1YvSz2RGW4RZk%252Fimage.png%3Falt%3Dmedia%26token%3D4191faab-c450-476a-809a-7dc1b4a00b03&width=768&dpr=3&quality=100&sign=fea729ba&sv=2) [](https://documentation.botghost.com/changelog/2024#object-variables-may-14th-2024) Object Variables - May 14th, 2024 --------------------------------------------------------------------------------------------------------------------------- Today we are releasing a new type of variable: **Object variables.** Object variables let you set key value pairs for a variable, and access them with dot notation. This is especially useful to cut down the amount of variables you have as one variable can have multiple different keys. For example: {BGVAR\_user\_inventory.count} {BGVAR\_user\_inventory.full} {BGVAR\_user.name} {BGVAR\_user.profile} {BGVAR\_user.currency} Object variables can be channel, user and guild specific like other variables. [](https://documentation.botghost.com/changelog/2024#april-module-changes-may-2nd-2024) April Module Changes - May 2nd, 2024 --------------------------------------------------------------------------------------------------------------------------------- Hey, here's a list of all fixes and changes we pushed to our modules in the last 30 days! ### [](https://documentation.botghost.com/changelog/2024#twitch) Twitch * Fixed an issue where the live notification would send multiple times ### [](https://documentation.botghost.com/changelog/2024#counting) Counting * Added a try-catch to the counting module to detect when a webhook is no longer available, it will now create a new webhook for the channel selected in module settings if no webhook is available * Added the ability for users to select the emoji reaction for a successful count ### [](https://documentation.botghost.com/changelog/2024#leveling-1) Leveling * /leaderboard now loads faster * /edit-xp is now faster when adding / removing experience * The maximum number of levels that can be added / removed when adding / removing experience with /edit-xp has been raised from 100 to 250 ### [](https://documentation.botghost.com/changelog/2024#welcomer) Welcomer * Fixed an issue that caused the direct welcome message to not work * Fixed an issue that caused the card to not be sent sometimes ### [](https://documentation.botghost.com/changelog/2024#birthdays-1) Birthdays * Fixed an issue that caused the /next-birthdays command to not work in certain cases * When browsing through pages of the /next-birthdays command, the month name will always be shown at the top of the list * The "Docs" button in the settings page of the module now leads to the correct page * /next-birthdays now loads faster [](https://documentation.botghost.com/changelog/2024#polls-filter-module-april-14th-2024) Polls Filter Module - April 14th, 2024 ------------------------------------------------------------------------------------------------------------------------------------- Due to a recent update, Discord has allowed users to create polls in all channels they can send messages in, which resulted in unwanted polls being posted. With the Polls Filter module, you can now easily block them, send a warning message and even temporarily timeout the user who tried to send the poll! Additionally, you can setup restrictions to allow the usage of polls in certain channels or for only certain roles. [](https://documentation.botghost.com/changelog/2024#march-early-april-module-changes-april-9th-2024) March - Early April Module Changes - April 9th, 2024 --------------------------------------------------------------------------------------------------------------------------------------------------------------- As always here is a list of all changes we pushed to our modules in the last month. ### [](https://documentation.botghost.com/changelog/2024#birthdays-2) Birthdays * Fixed a issue that caused the response of the /birthday command to not work as intended * Fixed a bug that caused the bot to not update the timestamp correctly in some specific cases * Fixed an incorrect title in the /next-birthdays embed * Fixed a bug that caused {age} and {year} to not work in the birthday message * Fixed a bug that caused {age} to return as negative when using /birthday * Added middle timezones such as UTC+4:30 * Admins can now set someone's else birthday * Users can now disallow admins to set their birthday using /birthday-view * Added a new default card * Fixed a spelling mistake in the birthday message * Minor fixes and improvements ### [](https://documentation.botghost.com/changelog/2024#leveling-2) Leveling * Added a brand new default image card * Fixed an issue that caused to return the executor's name when targeting someone else using /rank ### [](https://documentation.botghost.com/changelog/2024#status) Status * Added a new mode named "Command". This allows you to update the status of the bot with /status * Moved /status from the moderation module to the status module ### [](https://documentation.botghost.com/changelog/2024#welcomer-1) Welcomer * General performance updates and improvements to the module ### [](https://documentation.botghost.com/changelog/2024#sticky-messages) Sticky Messages * Fixed an issue with sticky messages that caused them to not be posted as well as fixed an issue preventing the use of linebreaks in messages ### [](https://documentation.botghost.com/changelog/2024#youtube) YouTube * Fixed an issue that caused the YouTube module message to not work with a plain text message type ### [](https://documentation.botghost.com/changelog/2024#statistics-channels) Statistics Channels * Fixed an issue with statistics channels that caused them to not work as intended [](https://documentation.botghost.com/changelog/2024#birthdays-module-april-4rd-2024) Birthdays Module - April 4rd, 2024 ----------------------------------------------------------------------------------------------------------------------------- After months of waiting, one of the most requested modules is finally here, with a lot of exciting features! The [birthdays module](https://dashboard.botghost.com/dashboard/module/99761223-9984-460d-a847-e16e64498099/birthdays) allows you a wide chance of settings and customization. You can set a timezone, change the time your bot will send the "Happy Birthday" message and even create a thread and add the user a temporary special role. Additionally, you can even setup a custom birthday card and a /birthday command that users can run when they're celebrating their own birthday. [](https://documentation.botghost.com/changelog/2024#economy-module-rework-and-minigames-march-14th-2024) Economy Module Rework & Minigames - March 14th, 2024 ------------------------------------------------------------------------------------------------------------------------------------------------------------------- We have revamped the Economy module in BotGhost and added Minigames! #### [](https://documentation.botghost.com/changelog/2024#economy-1) **Economy** Here is a highlight of some of the new features: * Full shop system with items that interact with other commands * Job system with promotions that earn you higher salaries * /fish for a chance to earn money and items * Full lottery system with draws every 24 hours * Economy stats, including a small chance to earn collectibles when using certain commands * Full banking system that earns you interest on money in the bank * Daily bonus and currency for messages #### [](https://documentation.botghost.com/changelog/2024#minigames) **Minigames** We have added some awesome minigames: * Scratchcards - purchase a scratchcard for a chance to win * Dice Bet - Bet on a dice roll with increasing rewards based on the number of sides * Double or Steal - Play against another player and double the bet until someone decides to steal * Hangman - Play a game of hangman, you can add words too! * High Low - Guess if the hidden number is higher or lower than another number * Rock Paper Scissors - Play a game of Rock Paper Scissors with another player * Tic Tac Toe - Play a game of tic tac toe with another player * Blackjack - Play a game of blackjack * Match Pairs - Make matches on a game board, match the entire board to win! * Five Dice - Roll 5 dice 3 times and try to get as many dice of the same as possible This [economy and minigames module](https://dashboard.botghost.com/dashboard/module/5bda821f-56fe-4318-be20-1d2815a04dc3/economy) is available to free and premium users Note: /blackjack and /5dice require the use of emojis. You can add these to your server automatically using the /minigame-config command **Enabling this module will automatically disable the old Economy Module** [](https://documentation.botghost.com/changelog/2024#february-module-changes-march-2nd-2024) February Module Changes - March 2nd, 2024 ------------------------------------------------------------------------------------------------------------------------------------------- In the past few weeks we released more changes to our modules. Here are them below. ### [](https://documentation.botghost.com/changelog/2024#status-1) Status * Fixed an issue with rotating statuses * Fixed a spelling mistake in the settings page * Added a button that leads to the documentation page of the module ### [](https://documentation.botghost.com/changelog/2024#welcomer-2) Welcomer * Added an option to add join roles after the user has accepted server rules * Added a button that leads to the documentation page of the module ### [](https://documentation.botghost.com/changelog/2024#starboard) Starboard * Removed an unnecessary reply block from the tree of the Reaction Removed event * Fixed a bug that caused the module to not work properly if the message contained certain characters * Added a better error handling system * Added a button that leads to the documentation page of the module ### [](https://documentation.botghost.com/changelog/2024#leveling-3) Leveling * Added Channel rewards, which work like role rewards, but are channel based * Added a new level card type named "Embed" * Fixed a bug that caused the rank command to not work as intended with some settings * Fixed a bug that caused role rewards to not be assigned properly when using edit-xp * Smaller changes and improvements ### [](https://documentation.botghost.com/changelog/2024#suggestions-1) Suggestions * Fixed a spelling mistake in the suggest command * Fixed a bug that caused the system to not work across multiple servers * Fixed a bug that caused the module to not work properly if the message contained certain characters * Smaller fixes and improvements ### [](https://documentation.botghost.com/changelog/2024#auto-react) Auto-React * Auto-react now allows the selection of emojis with a built-in emoji selector * Fixed a bug that caused the filtered keywords option to work backwards ### [](https://documentation.botghost.com/changelog/2024#sticky-messages-1) Sticky Messages * Messages are now encoded in an updated way ### [](https://documentation.botghost.com/changelog/2024#statistics-channels-1) Statistics Channels * Statistic channels will no longer display results of unsuccessful requests [](https://documentation.botghost.com/changelog/2024#dashboard-saving-optimizations-and-builder-input-improvements-march-1st-2024) Dashboard Saving Optimizations & Builder Input Improvements - March 1st, 2024 --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **Saving Optimization** We have changed the way bots are saved through the dashboard. This fix is aimed at larger bots which had problems saving due to the size of larger commands and events. If you had problems saving your bot in the past please log into the dashboard and force a save to reduce the size of your bot. Overall this change should make saving faster for all users. **Variable Editor on all Inputs** The variable editor clipboard has been added to all inputs that support it in the builder. This should make it much easier to use variables and options in all actions/conditions. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252F2GLGPI6RdnTmuzJPdvHE%252Fimage.png%3Falt%3Dmedia%26token%3D7ce1900e-185b-4a15-8c45-79bc5f7c659c&width=768&dpr=3&quality=100&sign=188f9a07&sv=2) [](https://documentation.botghost.com/changelog/2024#new-premium-module-emoji-manager-february-25th-2024) New Premium Module: Emoji Manager - February 25th, 2024 ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- We are releasing a new server management module, that will help you manage emojis in your server. The module allows you to create new emojis, copy existing emojis from other servers to yours and restrict certain emojis to selected roles. You're also able to configure role- and permission-based access, and customise the visual settings of certain commands. The key features of the module are copying emojis and restricting them to roles, as that's not available as a feature in the regular client. This [new module](https://dashboard.botghost.com/dashboard/module/c2cde45e-a789-4b31-ad44-5c7ceca5a5cd/emojimanager) is now available for all premium users. [](https://documentation.botghost.com/changelog/2024#module-rewords-translation-and-autoresponder-february-23rd-2024) Module Rewords: Translation and Autoresponder - February 23rd, 2024 ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- We want to ensure that our users have the best experience with modules, while also being able to customise them to their liking. This is why we revamped both the Translation and Autoresponder modules, which are available now. The Translation module now uses DeepL as the main source, we've chosen this service due to it providing reliable translations. In addition, users will now need to use their own DeepL key for the module, with an option of 500.000 characters translated / month, free of charge. Please check the **docs** for steps on how to get a key. This rework is only available for premium users. The Autoresponder module now offers more options, such as channel cooldowns and choosing whether the user should be mentioned or not. This rework can be accessed by both free and premium users. **Reword Modules:** * [Translation](https://dashboard.botghost.com/dashboard/module/6fef2574-418b-47cd-adef-22c9c3e88051/translation) * [Autoresponder](https://dashboard.botghost.com/dashboard/module/8de92a0c-1e68-4577-900d-26e2bda7b396/autoresponder) [](https://documentation.botghost.com/changelog/2024#voice-actions-february-22nd-2024) Voice Actions - February 22nd, 2024 ------------------------------------------------------------------------------------------------------------------------------- We are releasing **6 new voice related actions** to the beta server. These action blocks are: * Join a Voice Channel * Leave a Voice Channel * Voice Move a Member * Voice Kick a Member * Mute or Unmute a Member * Deafen or Undeafen a Member ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FtmTKMextVmBVazcXbRT4%252Fimage.png%3Falt%3Dmedia%26token%3Dcbf79d2c-fa39-481c-bae2-015af7f01a54&width=768&dpr=3&quality=100&sign=87e0934a&sv=2) [](https://documentation.botghost.com/changelog/2024#welcomer-module-rework-february-21st-2024) Welcomer Module Rework - February 21st, 2024 ------------------------------------------------------------------------------------------------------------------------------------------------- In order to make our modules list cleaner, as well as our features to be simpler to find, we have merged the Announcements, Welcome Banners and Auto-Role modules into a single one named Welcomer! The module offers all features of older modules, which have been reorganized and improved. Along these features, you can now send a message when a user gets kicked from the server. You will now also be able to add up to 5 custom reactions to all join, leave, kick and ban messages. All options can be enabled or disabled, basing on your needs. Check out the new module [here](https://dashboard.botghost.com/dashboard/module/b65529b9-b196-4088-8fef-3eaff0b0c047/welcomer) ! [](https://documentation.botghost.com/changelog/2024#thread-actions-publish-a-message-action-bug-fixes-february-20th-2024) Thread Actions, Publish a Message Action, Bug Fixes - February 20th, 2024 --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Four new actions and some bug fixes have been added to the beta server. **Thread Actions** We have added 3 new thread related actions to make managing threads through your bot easier. This includes the Create, Edit and Delete Thread actions. **Publish a Message** The publish a message action simply publishes a message sent in an announcement or news channel. **Bug Fixes** * mobile embed builder fixed * discord invite links updated * copy clipboard icon added to missing blocks * fixed role update event from triggering un-necessarily * leaking data storage fixed * corrected placeholder text from showing on dropdowns if they have default values * fixed some issues with crashing module pages * IFTTT block now does not show up in all searches ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FmqKOKEeqHmUk58fBuZzq%252Fimage.png%3Falt%3Dmedia%26token%3Ddbe9e61b-9153-47e0-9369-8c599309cac4&width=768&dpr=3&quality=100&sign=adf0b8cf&sv=2) [](https://documentation.botghost.com/changelog/2024#manipulate-text-action-february-29th-2024) Manipulate Text Action - February 29th - 2024 -------------------------------------------------------------------------------------------------------------------------------------------------- We have released an advanced new action block called the **Manipulate some text** action. The manipulate text action allows you to run a JS String function on some text and retrieve the result in a variable. You can see a list of string methods in the action or for more detailed descriptions check out the mdn web docs for string methods [here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1194150090-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FlqJCocmqzKryU9USp1nO%252Fuploads%252FKpCgaM7IvGbY2PEc9pDT%252Fimage.png%3Falt%3Dmedia%26token%3D39aa29cd-d360-4913-a049-9a1d18b72e29&width=768&dpr=3&quality=100&sign=335eeed0&sv=2) [](https://documentation.botghost.com/changelog/2024#new-module-rework-status-february-16th-2024) New Module Rework: Status - February 16th - 2024 ------------------------------------------------------------------------------------------------------------------------------------------------------- Today, we are releasing a new module Rework, [status](https://dashboard.botghost.com/dashboard/module/42056fd5-1c1d-4f89-8db7-794fe732424c/status) ! This Rework comes with three new features: you will be able to use all BotGhost's variables, set a different time for each rotating status and a new option to remove the status as a status rotation. This module is premium only. Please note: Enabling this module will disable and delete your old status. [](https://documentation.botghost.com/changelog/2024#id-5-reworked-modules-february-12th-2024) 5 Reworked Modules - February 12th - 2024 --------------------------------------------------------------------------------------------------------------------------------------------- As we want to ensure the upmost stability, reliability and high level of customisability of our modules, we have reworked 5 old hard-coded modules: **Twitch**, **YouTube**, **Statistic Channels**, **Timed Messages** and the **Active Developer Badge** modules. These newer versions of the modules provide more options for you to customise, and can also be edited to your exact preferences thanks to the custom module system. To also ensure the Twitch and YouTube modules stay reliable, you'll need to provide your own API keys from now on. The creation of keys is free of charge at both providers, and we've put together documentation to guide you though the process. If you get stuck while setting up any of the modules, please always check the documentations linked below. **Reworked Modules:** * [**Twitch Integration**](https://dashboard.botghost.com/dashboard/module/818c8227-179d-456b-906b-a1e4476ed563/twitch) * [**YouTube Integration**](https://dashboard.botghost.com/dashboard/module/2678aa9f-2be6-429b-9e49-24e16d89d5e8/youtube) * [**Statistic Channels**](https://dashboard.botghost.com/dashboard/module/ee045a3d-05a6-409a-b435-7d170c5e70c3/statisticchannels) * [**Timed Messages**](https://dashboard.botghost.com/dashboard/module/5f1b4c67-b37b-487c-8287-a694b1e01ce8/timedmessages) * [**Active Developer Badge**](https://dashboard.botghost.com/dashboard/module/be383fbe-8339-433b-a51c-94db234fde38/activedeveloperbadge) [](https://documentation.botghost.com/changelog/2024#upcoming-custom-module-changes-february-10th-2024) Upcoming Custom Module Changes - February 10th, 2024 ----------------------------------------------------------------------------------------------------------------------------------------------------------------- **Data usage removed from Custom Modules** Today we are announcing some upcoming changes to the way custom modules work on BotGhost. Previously, custom modules built with commands and events used data storage and custom variables in their operation. This means that free users quickly used up all their data storage for the month just by using custom modules. Today we are removing custom modules from the data storage system, meaning all custom module commands/events will no longer use data storage. This should simplify how the new modules work and keep custom commands, events and data storage separate from the BotGhost modules. **Custom Module Classification changes** Due to custom modules no longer being restricted by data storage for free users, we are changing a number of our custom modules to premium **for new users**. This change will not take effect today and any users who currently have the 'free' version of these modules will not be effected as long as they do not update the module. The current modules being changed are: Counting: (Free ▶️ Premium) ChatGPT: (Free ▶️ Premium) Image Generation: (Free ▶️ Premium) Modmail: (Free ▶️ Premium) Welcome Banners: Moved into Welcomer \[Locked features\] Verification: (Free ▶️ Premium) Sticky Messages: (Free ▶️ Premium) Discord Automod: (Free ▶️ Premium) Auto-react: (Free ▶️ Premium) Reaction Roles: Unchanged Starboard: (Free ▶️ Premium) Global Chat: Unchanged Roblox Verification: Unchanged Leveling Leveling * Level Card: (Free ▶️ Premium) * Voice EXP: (Free ▶️ Premium) Polls: (Free ▶️ Premium) Temp Voice Channels: Unchanged Media Channels: Unchanged Invite Tracker: (Free ▶️ Premium) Suggestions: Unchanged Sticky Roles: Unchanged QOTD: Unchanged These changes will take effect from **12th of February** for new users. All free users who do not update their modules after this date will keep the free version of these modules. **New Modules** Over the next few days we will also be releasing a whole bunch of new custom modules replacing a number of the old outdated hard coded modules. Modules that were free will mostly remain free (Moderation, economy, Automod etc) in the future. **TLDR:** * Custom modules don't use data storage anymore * Due to that a number of modules are going premium for new users * If you are a free user don't update these modules and you wont be effected * New custom modules coming out soon to replace old outdated broken hard coded modules. [](https://documentation.botghost.com/changelog/2024#january-module-updates-february-7th-2024) January Module Updates - February 7th, 2024 ----------------------------------------------------------------------------------------------------------------------------------------------- Hey everyone! During the last month, we released some changes to our modules. Here's a list of all of them: ### [](https://documentation.botghost.com/changelog/2024#starboard-1) Starboard Released a fix: * Fixed a bug that caused the starboard message to not be posted ### [](https://documentation.botghost.com/changelog/2024#leveling-4) Leveling A bug has also been fixed in the leveling module: * Fixed an issue that caused the {level} variable to show "0" in the level up message instead of the actual level with some specific settings ### [](https://documentation.botghost.com/changelog/2024#suggestions-2) Suggestions The following changes have been released to the new Suggestions module: * Added an option that will lock the thread when a suggestion has been approved or accepted * The "Vote Registered" direct message has been removed * Fixed a spelling mistake in the settings page * Fixed an issue that caused some suggestions to not be posted * Fixed an issue with the reactions handler not removing the "neutral" reaction when the suggestion is upvoted or downvoted [](https://documentation.botghost.com/changelog/2024#new-premium-module-question-of-the-day-january-30th-2024) New Premium Module: Question of The Day - January 30th, 2024 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- A [new module](https://docs.botghost.com/community-engagement/question-of-the-day) that asks daily questions from your server members automatically has been released, with the intention of improving your server retention rates in a fun way. The bot will ask a question every 24 hours, and create a thread for your users to send replies. While the module comes with pre-written questions by default that don't require any setup, you also may choose to add your own questions. Additionally, you can customise the daily message, set up various thread settings, make sending answers private and you can select roles to ping for the daily message. This module is now available for all premium users. [](https://documentation.botghost.com/changelog/2024#new-premium-module-sticky-roles-january-9th-2024) New Premium Module: Sticky Roles - January 9th, 2024 ---------------------------------------------------------------------------------------------------------------------------------------------------------------- We have developed a new module, that allows you to save the roles of members if they leave, and give them back once they rejoin. The module can be customized in a few ways, you can choose not to save roles of the user was kicked or banned, you can whitelist or blacklist roles to save, and you can set up a custom direct message, with a list of roles that the user got back that is sent once they rejoin. Sticky Roles is only available for users with an active premium subscription. [](https://documentation.botghost.com/changelog/2024#new-year-new-bug-fixes-january-5th-2024) New Year, New Bug Fixes - January 5th, 2024 ---------------------------------------------------------------------------------------------------------------------------------------------- Quite a few bugs were fixed last year, here is just a list of them. * Can leave the command builder successfully after a save. * Updated wording on the variable page to a more appropriate title. * The logging module now displays the default channel you selected to apply to all channels (you just need to re-set it in order to display). * `{channel_id{` variable now works as intended. * You can interact with elements inline with the save container. * Mobile popups and modals now appear on top of the premium banner. * Fixed a visual bug with the logging channel not being able to disable events when premium is no longer active on the bot. * Duplicating a **Create a Channel** block now correctly creates a new ID when you duplicate it. * Added the `{api.responseText}` variable to the API/Request builder. * Permissions for channels now only show the permissions that are permitted in a channel. * Long channel and role names now display correctly in channel/role selectors. * The Request Builder modal now displays correctly on mobile devices. * You can now compare decimals with the comparison condition. * Missing permissions will now work as intended. * Mute logging event now shows the correct type of mute, whether it was self mute or a moderator mute. * Target selector for remove role how shows the correct description. * The mobile menu now displays on top of the premium banner. * Ticket emoji now displays correctly when creating a ticket. * Variables can be used in create/edit role colour input. * Channel topic can now take variables in the create or edit blocks. * The correct number of fields now display when loading in an embed in the embed builder. * Character count displays the correct value for the text box. * Permission condition now shows the correct description for the user target. * Form builder now shows correctly on mobile. * Various mobile and desktop UI fixes and updates. * You can now enable/disable the twitch module. * The reload/refresh bot data icon now spins. * A go back button has been added to the variable page to easily go back to the main data storage page. * A better indication that you need to press the bot data reload button has been added. We also added a new [**Merge Permissions**](https://docs.botghost.com/custom-commands-and-events/actions/edit-a-channel#merge-permissions) option to the Edit Channel action in the builder where you can now merge channel permissions so it does not overwrite the permissions, rather only create/edit/remove the permissions that you specified. [](https://documentation.botghost.com/changelog/2024#new-premium-module-suggestions-january-3rd-2024) New Premium Module: Suggestions - January 3rd, 2024 -------------------------------------------------------------------------------------------------------------------------------------------------------------- New year, New module! BotGhost is starting 2024 with a fresh, new module, [suggestions](https://dashboard.botghost.com/dashboard/module/17d130ca-5b40-4554-b11d-ffd889673915/suggestions) ! The new module replaces the old `/suggest` command located in the moderation module, expanding and improving its features. The module offers a high level of customization, allowing you to setup logging, an auto approve / deny system and even an approval channel, where all suggestions will be sent before being posted in your suggestions channel. This module is premium only. Last updated 5 months ago Was this helpful? * [Server Stability Fixes + Free Bot Restriction Changes - November 21th, 2024](https://documentation.botghost.com/changelog/2024#server-stability-fixes--free-bot-restriction-changes-november-21th-2024) * [Module Updates - October 27th, 2024](https://documentation.botghost.com/changelog/2024#module-updates-october-27th-2024) * [Economy & Minigames](https://documentation.botghost.com/changelog/2024#economy-and-minigames) * [Moderation](https://documentation.botghost.com/changelog/2024#moderation) * [Moderation Module Update - September 29th, 2024](https://documentation.botghost.com/changelog/2024#moderation-module-update-september-29th-2024) * [Module Updates - September 22nd, 2024](https://documentation.botghost.com/changelog/2024#module-updates-september-22nd-2024) * [Economy & Minigames](https://documentation.botghost.com/changelog/2024#economy-and-minigames-1) * [Moderation](https://documentation.botghost.com/changelog/2024#moderation-1) * [Tickets Module Rework - Out of Beta - September 14th, 2024](https://documentation.botghost.com/changelog/2024#tickets-module-rework-out-of-beta-september-14th-2024) * [Advanced Message Action Update: Out of Beta - September 13th, 2024](https://documentation.botghost.com/changelog/2024#advanced-message-action-update-out-of-beta-september-13th-2024) * [New Update Bug Fixes - September 5th, 2024](https://documentation.botghost.com/changelog/2024#new-update-bug-fixes-september-5th-2024) * [Send or Edit a Message](https://documentation.botghost.com/changelog/2024#send-or-edit-a-message) * [React to a Message](https://documentation.botghost.com/changelog/2024#react-to-a-message) * [Beta fixes](https://documentation.botghost.com/changelog/2024#beta-fixes) * [Major Update: New Advanced Message, Message Builder, New Menu Types, Discord.js v14 Update, React to Message block - September 4th, 2024](https://documentation.botghost.com/changelog/2024#major-update-new-advanced-message-message-builder-new-menu-types-discord.js-v14-update-react-to-mess) * [Send or Edit a Message Action](https://documentation.botghost.com/changelog/2024#send-or-edit-a-message-action) * [Message Builder](https://documentation.botghost.com/changelog/2024#message-builder) * [New Select Menu Types](https://documentation.botghost.com/changelog/2024#new-select-menu-types) * [New Button + Select Menu Options and Capabilities](https://documentation.botghost.com/changelog/2024#new-button--select-menu-options-and-capabilities) * [React to a Message Block](https://documentation.botghost.com/changelog/2024#react-to-a-message-block) * [Discord.js v14 Update](https://documentation.botghost.com/changelog/2024#discord.js-v14-update) * [Planned Additions to the New Message Action](https://documentation.botghost.com/changelog/2024#planned-additions-to-the-new-message-action) * [Moderation Module Release - Out of Beta - September 2nd, 2024](https://documentation.botghost.com/changelog/2024#moderation-module-release-out-of-beta-september-2nd-2024) * [Increased Beta Server Capacity - August 30th, 2024](https://documentation.botghost.com/changelog/2024#increased-beta-server-capacity-august-30th-2024) * [Moderation Module Release \[BETA\] - August 27th, 2024](https://documentation.botghost.com/changelog/2024#moderation-module-release-beta-august-27th-2024) * [Tickets Module Rework - August 26th, 2024](https://documentation.botghost.com/changelog/2024#tickets-module-rework-august-26th-2024) * [Dashboard Custom Command, Event and Variable Grouping - August 26th, 2024](https://documentation.botghost.com/changelog/2024#dashboard-custom-command-event-and-variable-grouping-august-26th-2024) * [Error + Success Handles out of Beta - August 22nd, 2024](https://documentation.botghost.com/changelog/2024#error--success-handles-out-of-beta-august-22nd-2024) * [Variable Editor in Builder - August 21st, 2024](https://documentation.botghost.com/changelog/2024#variable-editor-in-builder-august-21st-2024) * [More Bug Fixes - August 20th, 2024](https://documentation.botghost.com/changelog/2024#more-bug-fixes-august-20th-2024) * [Bug Fixes - August 19th, 2024](https://documentation.botghost.com/changelog/2024#bug-fixes-august-19th-2024) * [Undo + Redo Block deletion/adding in the Builder - August 16th, 2024](https://documentation.botghost.com/changelog/2024#undo--redo-block-deletion-adding-in-the-builder-august-16th-2024) * [Multi Delete Blocks - August 15th, 2024](https://documentation.botghost.com/changelog/2024#multi-delete-blocks-august-15th-2024) * [Builder Save Keybind + MacOS Keybinds - August 14th, 2024](https://documentation.botghost.com/changelog/2024#builder-save-keybind--macos-keybinds-august-14th-2024) * [Save Block Templates - August 9th, 2024](https://documentation.botghost.com/changelog/2024#save-block-templates-august-9th-2024) * [Error & Success Handles for Actions (beta) - August 8th, 2024](https://documentation.botghost.com/changelog/2024#error-and-success-handles-for-actions-beta-august-8th-2024) * [Copy + Paste Single Blocks & Delete Key QOL Fix - August 8th, 2024](https://documentation.botghost.com/changelog/2024#copy--paste-single-blocks-and-delete-key-qol-fix-august-8th-2024) * [Weather Module - July 29th, 2024](https://documentation.botghost.com/changelog/2024#weather-module-july-29th-2024) * [Upcoming Old Module Depreciations - July 17th, 2024](https://documentation.botghost.com/changelog/2024#upcoming-old-module-depreciations-july-17th-2024) * [New Events - July 15th, 2024](https://documentation.botghost.com/changelog/2024#new-events-july-15th-2024) * [New Guild, Channel, User & Member Object Variables - July 5th, 2024](https://documentation.botghost.com/changelog/2024#new-guild-channel-user-and-member-object-variables-july-5th-2024) * [Small update - July 4th, 2024](https://documentation.botghost.com/changelog/2024#small-update-july-4th-2024) * [Economy & Minigames Module Update - July 3rd, 2024](https://documentation.botghost.com/changelog/2024#economy-and-minigames-module-update-july-3rd-2024) * [New Voice Events + Intent Options - June 26th, 2024](https://documentation.botghost.com/changelog/2024#new-voice-events--intent-options-june-26th-2024) * [Welcomer - New Card Backgrounds - June 20th, 2024](https://documentation.botghost.com/changelog/2024#welcomer-new-card-backgrounds-june-20th-2024) * [Economy Update - June 12th, 2024](https://documentation.botghost.com/changelog/2024#economy-update-june-12th-2024) * [May Module Changes - June 8th, 2024](https://documentation.botghost.com/changelog/2024#may-module-changes-june-8th-2024) * [Economy](https://documentation.botghost.com/changelog/2024#economy) * [Temp Voice Channels](https://documentation.botghost.com/changelog/2024#temp-voice-channels) * [Leveling](https://documentation.botghost.com/changelog/2024#leveling) * [Suggestions](https://documentation.botghost.com/changelog/2024#suggestions) * [Birthdays](https://documentation.botghost.com/changelog/2024#birthdays) * [Subcommands - May 31st, 2024](https://documentation.botghost.com/changelog/2024#subcommands-may-31st-2024) * [Economy Update - May 28th, 2024](https://documentation.botghost.com/changelog/2024#economy-update-may-28th-2024) * [Cocreate Rework - May 28th, 2024](https://documentation.botghost.com/changelog/2024#cocreate-rework-may-28th-2024) * [Object Variables - May 14th, 2024](https://documentation.botghost.com/changelog/2024#object-variables-may-14th-2024) * [April Module Changes - May 2nd, 2024](https://documentation.botghost.com/changelog/2024#april-module-changes-may-2nd-2024) * [Twitch](https://documentation.botghost.com/changelog/2024#twitch) * [Counting](https://documentation.botghost.com/changelog/2024#counting) * [Leveling](https://documentation.botghost.com/changelog/2024#leveling-1) * [Welcomer](https://documentation.botghost.com/changelog/2024#welcomer) * [Birthdays](https://documentation.botghost.com/changelog/2024#birthdays-1) * [Polls Filter Module - April 14th, 2024](https://documentation.botghost.com/changelog/2024#polls-filter-module-april-14th-2024) * [March - Early April Module Changes - April 9th, 2024](https://documentation.botghost.com/changelog/2024#march-early-april-module-changes-april-9th-2024) * [Birthdays](https://documentation.botghost.com/changelog/2024#birthdays-2) * [Leveling](https://documentation.botghost.com/changelog/2024#leveling-2) * [Status](https://documentation.botghost.com/changelog/2024#status) * [Welcomer](https://documentation.botghost.com/changelog/2024#welcomer-1) * [Sticky Messages](https://documentation.botghost.com/changelog/2024#sticky-messages) * [YouTube](https://documentation.botghost.com/changelog/2024#youtube) * [Statistics Channels](https://documentation.botghost.com/changelog/2024#statistics-channels) * [Birthdays Module - April 4rd, 2024](https://documentation.botghost.com/changelog/2024#birthdays-module-april-4rd-2024) * [Economy Module Rework & Minigames - March 14th, 2024](https://documentation.botghost.com/changelog/2024#economy-module-rework-and-minigames-march-14th-2024) * [February Module Changes - March 2nd, 2024](https://documentation.botghost.com/changelog/2024#february-module-changes-march-2nd-2024) * [Status](https://documentation.botghost.com/changelog/2024#status-1) * [Welcomer](https://documentation.botghost.com/changelog/2024#welcomer-2) * [Starboard](https://documentation.botghost.com/changelog/2024#starboard) * [Leveling](https://documentation.botghost.com/changelog/2024#leveling-3) * [Suggestions](https://documentation.botghost.com/changelog/2024#suggestions-1) * [Auto-React](https://documentation.botghost.com/changelog/2024#auto-react) * [Sticky Messages](https://documentation.botghost.com/changelog/2024#sticky-messages-1) * [Statistics Channels](https://documentation.botghost.com/changelog/2024#statistics-channels-1) * [Dashboard Saving Optimizations & Builder Input Improvements - March 1st, 2024](https://documentation.botghost.com/changelog/2024#dashboard-saving-optimizations-and-builder-input-improvements-march-1st-2024) * [New Premium Module: Emoji Manager - February 25th, 2024](https://documentation.botghost.com/changelog/2024#new-premium-module-emoji-manager-february-25th-2024) * [Module Rewords: Translation and Autoresponder - February 23rd, 2024](https://documentation.botghost.com/changelog/2024#module-rewords-translation-and-autoresponder-february-23rd-2024) * [Voice Actions - February 22nd, 2024](https://documentation.botghost.com/changelog/2024#voice-actions-february-22nd-2024) * [Welcomer Module Rework - February 21st, 2024](https://documentation.botghost.com/changelog/2024#welcomer-module-rework-february-21st-2024) * [Thread Actions, Publish a Message Action, Bug Fixes - February 20th, 2024](https://documentation.botghost.com/changelog/2024#thread-actions-publish-a-message-action-bug-fixes-february-20th-2024) * [Manipulate Text Action - February 29th - 2024](https://documentation.botghost.com/changelog/2024#manipulate-text-action-february-29th-2024) * [New Module Rework: Status - February 16th - 2024](https://documentation.botghost.com/changelog/2024#new-module-rework-status-february-16th-2024) * [5 Reworked Modules - February 12th - 2024](https://documentation.botghost.com/changelog/2024#id-5-reworked-modules-february-12th-2024) * [Upcoming Custom Module Changes - February 10th, 2024](https://documentation.botghost.com/changelog/2024#upcoming-custom-module-changes-february-10th-2024) * [January Module Updates - February 7th, 2024](https://documentation.botghost.com/changelog/2024#january-module-updates-february-7th-2024) * [Starboard](https://documentation.botghost.com/changelog/2024#starboard-1) * [Leveling](https://documentation.botghost.com/changelog/2024#leveling-4) * [Suggestions](https://documentation.botghost.com/changelog/2024#suggestions-2) * [New Premium Module: Question of The Day - January 30th, 2024](https://documentation.botghost.com/changelog/2024#new-premium-module-question-of-the-day-january-30th-2024) * [New Premium Module: Sticky Roles - January 9th, 2024](https://documentation.botghost.com/changelog/2024#new-premium-module-sticky-roles-january-9th-2024) * [New Year, New Bug Fixes - January 5th, 2024](https://documentation.botghost.com/changelog/2024#new-year-new-bug-fixes-january-5th-2024) * [New Premium Module: Suggestions - January 3rd, 2024](https://documentation.botghost.com/changelog/2024#new-premium-module-suggestions-january-3rd-2024) Was this helpful? --- # Verification | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/server-management/verification.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FeZIx8rZEZTdzyYjqkYr8%252FScreenshot%25202024-07-02%2520115308.png%3Falt%3Dmedia%26token%3D55a59a7b-946d-452d-a59f-1da3f295bfe8&width=768&dpr=3&quality=100&sign=6dd22bdf&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. BotGhost provides a [Verification module](https://dashboard.botghost.com/dashboard/module/8fc5b3eb-ddd9-4eb2-8a94-c6e607ab9551/verification) for its users. This module will allow you to let new users verify to make sure no bots are joining. [](https://documentation.botghost.com/server-management/verification#settings) Settings -------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/server-management/verification#basic-settings) Basic Settings In this area, you can setup and customize the general settings for the commands and events of this module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FWrdRY01U1ELcDvHB1bLB%252Fimage.png%3Falt%3Dmedia%26token%3D01f49cab-9f5d-4191-b8f3-f2541f57832a&width=768&dpr=3&quality=100&sign=7f246a75&sv=2) #### [](https://documentation.botghost.com/server-management/verification#verification-type) Verification Type Here you can edit the type of verification to set, the pre set type is set to **Captcha Text Input** but you can change it to: Verification Type Details Captcha Text Input This will prompt users with a set of Captcha text. To know more, read about Captcha [here](https://en.wikipedia.org/wiki/CAPTCHA) . Number Input This will prompt users with a set of numbers. They will have to correctly re-write the sequence. Basic Button Press Users only have to press a button to get access to the server. **Default Channel** Here you can select the channel the verification panel is sent to, make sure this is a channel that everyone can see as this is where new users will verify. **Verified Role** Here you can select the role to grant users who pass the verification process. Make sure this role does not have any mod permissions. **Verification Menu** Here you can edit the verification panel message, this is what is sent to the default channel for users to verify with. By default it is an embed message however this can be changed to a plain text message by using the toggle switch in the top right corner of the embed preview. **Button Name** Here you can set the text that is displayed in the button users press to start the verification process. **Logging Channel** Here you can select a channel to set verification logs to, the bot will send failed and success logs to this channel if you have one selected. ### [](https://documentation.botghost.com/server-management/verification#extra-settings) Extra Settings Here you can edit the extra settings for the module, these settings are extra cool functions to really make it uniqe. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FwEIMSCY8bwpVP4laXKdg%252Fimage.png%3Falt%3Dmedia%26token%3D3beecae2-3243-4ba3-9c76-4e64b0ebb2f6&width=768&dpr=3&quality=100&sign=858a2f0f&sv=2) **Success Message** Here you can set the message that is displayed to users upon successful completion of the verification process. **Allowed Attempts** Here you can define a number of attempts a user has to get the verification process correct, users will be kicked if they reach the max amount of failed attempts. You can leave this section blank to disable the auto-kick feature. **Time Limit** Here you can set a time limit in seconds users have to complete the verification process, by default this is disabled but you can set a custom time limit by entering numbers into this section. After the time expires the user will be kicked from the server. * * * [](https://documentation.botghost.com/server-management/verification#commands) Commands -------------------------------------------------------------------------------------------- In this area, you can view and modify the commands of the Verification module. Below you may find some information on each command of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FtbjQb04Sf5hKEzKHJnda%252Fimage.png%3Falt%3Dmedia%26token%3D7263fd03-0190-44ed-a3be-776f75e9d9f5&width=768&dpr=3&quality=100&sign=493deb91&sv=2) **/verification-setup**[](https://documentation.botghost.com/server-management/verification#verification-setup) The verification-setup command will post the verification panel in the channel you selected in the settings above. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F9I8Whfi7lGNsGVblk0DA%252Fimage.png%3Falt%3Dmedia%26token%3D6ccc145b-7216-4374-93c5-c60a5ee1c848&width=300&dpr=3&quality=100&sign=e577b9ed&sv=2) **/verification-add**[](https://documentation.botghost.com/server-management/verification#verification-add) The /verification-add command will manually verify the user selected, this allows them to skip the verification process and gain the defined verified role without doing the verification. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F7Mnb5ceET5TkkCuB292z%252Fimage.png%3Falt%3Dmedia%26token%3D781f63c3-3bf2-46eb-ac0f-50d1bd604cfc&width=300&dpr=3&quality=100&sign=4ba73d0e&sv=2) [](https://documentation.botghost.com/server-management/verification#events) Events ---------------------------------------------------------------------------------------- In this area, you can view and modify the events of the Verification module. Below you may find some information on each event of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FikYQtinsfDLrQYPFwT7r%252Fimage.png%3Falt%3Dmedia%26token%3D79230468-c81d-4b62-87f6-44881775400e&width=768&dpr=3&quality=100&sign=f0a7f60e&sv=2) **Auto-Kick**[](https://documentation.botghost.com/server-management/verification#auto-kick) The auto kick event tracks the failed attempts and time the user is in the server, the event will trigger when the limit has been reached as defined via the settings for the module and kick the user from the server. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intented. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/server-management/verification#settings) * [Basic Settings](https://documentation.botghost.com/server-management/verification#basic-settings) * [Extra Settings](https://documentation.botghost.com/server-management/verification#extra-settings) * [Commands](https://documentation.botghost.com/server-management/verification#commands) * [Events](https://documentation.botghost.com/server-management/verification#events) Was this helpful? --- # Emoji Manager | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/server-management/emoji-manager.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FMBbrbi6OtYIbhfzDe3BB%252Fimage.png%3Falt%3Dmedia%26token%3Df8d5913f-4fbc-4a67-bb5c-c91b24bf8117&width=768&dpr=3&quality=100&sign=c6068537&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. The [Emoji Manager](https://dashboard.botghost.com/dashboard/module/c2cde45e-a789-4b31-ad44-5c7ceca5a5cd/emojimanager) module will allow you to view a list of custom emojis, create a new one in your server, restrict the use of an existing emoji, and copy an emoji from a different server to yours. [](https://documentation.botghost.com/server-management/emoji-manager#settings) Settings --------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/server-management/emoji-manager#permissions-setup) Permissions Setup This section is how you can configure all the permission based necessities for the emoji commands. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F5u0fyhUm0svbZwzXvZ5l%252Fimage.png%3Falt%3Dmedia%26token%3Dd491d132-206c-4da1-b62f-6f216375b798&width=768&dpr=3&quality=100&sign=2d55b260&sv=2) #### [](https://documentation.botghost.com/server-management/emoji-manager#sync-default-permissions) **Sync Default Permissions** This option when enabled, will force users to have the manage expressions permission along with the role based permissions in the rest of the settings. #### [](https://documentation.botghost.com/server-management/emoji-manager#role-permissions-selection-type) **Role Permissions: Selection Type** Type Details Only selected roles If this option is selected then only the selected roles in the field below will be allowed to use the emoji manager commands. All roles except If this option is chosen instead, then all roles in the field below will be the ones which aren't able to use the commands, and the rest of the server roles can. #### [](https://documentation.botghost.com/server-management/emoji-manager#role-permissions-roles) **Role Permissions: Roles** This field is where you can specify and select the server roles that are going to be applied towards the setting above. ### [](https://documentation.botghost.com/server-management/emoji-manager#commands-setup) Commands Setup Define how many emojis should display while using the /emojis-view command, enable logging, and select the desired channel. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FEdHLOF32ZZKPbJ6KwDEo%252Fimage.png%3Falt%3Dmedia%26token%3Df338b632-820f-4a97-8c81-c0ef5d2f0ee4&width=768&dpr=3&quality=100&sign=5a516186&sv=2) #### [](https://documentation.botghost.com/server-management/emoji-manager#emojis-view-emojis-per-page) **Emojis-View: Emojis per Page** This field is where you can input the amount of emojis shown when using the emoji-view command. There is a maximum of 25 emojis and this field only accepts integers. #### [](https://documentation.botghost.com/server-management/emoji-manager#enable-logging) **Enable Logging** Enable this option to log all actions / changes applied to your server's emoji in a channel. This includes the usage of all commands except `/emojis-view`. #### [](https://documentation.botghost.com/server-management/emoji-manager#logging-channel) **Logging Channel** Select a channel in which actions of the module will be logged. _This setting is only visible with_ [Enable Logging](https://documentation.botghost.com/server-management/emoji-manager#enable-logging) _enabled._ * * * [](https://documentation.botghost.com/server-management/emoji-manager#commands) Commands --------------------------------------------------------------------------------------------- In this area, you can view and modify the commands of the Emoji Manager module. Below you may find some information on each command of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FAcRy983iiQ2kPB0fBi7u%252Fimage.png%3Falt%3Dmedia%26token%3D9424e8c3-b8e7-4bd4-a97a-8b1ee0349f49&width=768&dpr=3&quality=100&sign=b66bf923&sv=2) /emojis-view[](https://documentation.botghost.com/server-management/emoji-manager#emojis-view) This command allows you to view all created emojis that were made via this module and other server emojis. /emoji-create[](https://documentation.botghost.com/server-management/emoji-manager#emoji-create) With this command you can create emojis and add them to the server's emojis. /emoji-restrict[](https://documentation.botghost.com/server-management/emoji-manager#emoji-restrict) This command will restrict certain users based off the roles they have from using the commands. /emoji-copy[](https://documentation.botghost.com/server-management/emoji-manager#emoji-copy) This command can copy an emoji from another server and upload it to your server. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/server-management/emoji-manager#settings) * [Permissions Setup](https://documentation.botghost.com/server-management/emoji-manager#permissions-setup) * [Commands Setup](https://documentation.botghost.com/server-management/emoji-manager#commands-setup) * [Commands](https://documentation.botghost.com/server-management/emoji-manager#commands) Was this helpful? --- # Auto-React | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/server-management/auto-react.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FwaF9Jt8bPMCF7UJR0sTQ%252Fimage.png%3Falt%3Dmedia%26token%3D7ef1e6e1-8de4-4d6c-8c52-6084c096c136&width=768&dpr=3&quality=100&sign=f2c86e89&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. BotGhost provides an [Auto-React module](https://dashboard.botghost.com/dashboard/module/d12ee953-765f-47bd-b855-b9dd18fe052e/auto-react) for its users. This module will allow you to automatically add reactions on newly sent messages. [](https://documentation.botghost.com/server-management/auto-react#settings) Settings ------------------------------------------------------------------------------------------ ### [](https://documentation.botghost.com/server-management/auto-react#basic-setup) Basic Setup In this area, you can view and modify the settings of the Auto-React module. Below you may find some information on each setting of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Felt8dWvc4Jk7XOgsFqjS%252Fimage.png%3Falt%3Dmedia%26token%3D28fcb162-09d0-4863-a65e-e29bd501c2ee&width=768&dpr=3&quality=100&sign=80438f47&sv=2) #### [](https://documentation.botghost.com/server-management/auto-react#enabled-channels) Enabled Channels This setting allows you to enable automatic reactions in specific channels. #### [](https://documentation.botghost.com/server-management/auto-react#reaction-emojis) Reaction Emojis This setting allows you to set the emoji to react with. You can use default and custom emojis. ### [](https://documentation.botghost.com/server-management/auto-react#condition-setup) Condition Setup ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FHCTGk4lDVWVYpRttx8Ah%252Fimage.png%3Falt%3Dmedia%26token%3D628b4f57-c1c8-432c-abaf-fa612a4a9aab&width=768&dpr=3&quality=100&sign=606a8665&sv=2) #### [](https://documentation.botghost.com/server-management/auto-react#ignore-embeds) Ignore Embeds This setting allows you to only react to messages that include plain text. #### [](https://documentation.botghost.com/server-management/auto-react#allowed-roles) Allowed Roles This setting allows you to specify what roles the author of the message must have for automatic reactions. By refraining from setting any roles, all users will be subject to the filter regardless of their roles. #### [](https://documentation.botghost.com/server-management/auto-react#check-for-words) Check for Words This setting allows you to specify what words the message must have for automatic reactions. By refraining from setting any words, all messages will be subject to the filter regardless of their content. * * * [](https://documentation.botghost.com/server-management/auto-react#events) Events -------------------------------------------------------------------------------------- In this area, you can view and modify the events of the Auto-React module. Below you may find some information on each event of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fu8qoDEEG66h8ngdwqCly%252Fimage.png%3Falt%3Dmedia%26token%3D4adeaf94-5f86-4ed4-9323-dd6a06b60be6&width=768&dpr=3&quality=100&sign=887d6be3&sv=2) Auto-React[](https://documentation.botghost.com/server-management/auto-react#auto-react) This event is the core of the module: it triggers upon newly sent messages and ensures to filter all messages and automatically react based on the settings you set. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intented. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/server-management/auto-react#settings) * [Basic Setup](https://documentation.botghost.com/server-management/auto-react#basic-setup) * [Condition Setup](https://documentation.botghost.com/server-management/auto-react#condition-setup) * [Events](https://documentation.botghost.com/server-management/auto-react#events) Was this helpful? --- # Discord Automod | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/server-management/discord-automod.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FPtBx2N1jid3MKz1EgnP2%252Fimage.png%3Falt%3Dmedia%26token%3De7b49c06-070a-406f-9c70-0f9b6138dc41&width=768&dpr=3&quality=100&sign=7ed2dee1&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. The [Discord Automod](https://dashboard.botghost.com/dashboard/module/e8564ca2-721a-4257-885a-43d740a67296/discordautomod) module will allow you to edit, add and remove rules from your discord server's automod through your BotGhost bot as well as give you the method to get the new 'Automod Badge' for your bot. [](https://documentation.botghost.com/server-management/discord-automod#settings) Settings ----------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/server-management/discord-automod#basic-settings) Basic Settings In this area, you can setup and customize the general settings for the commands and events of this module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FN8gS33bQ2CuPhMCpHE9u%252FScreenshot_3-7-2024_234249_dashboard.botghost.png%3Falt%3Dmedia%26token%3D995cf707-8c45-4e83-97db-86d39aba27aa&width=768&dpr=3&quality=100&sign=24e7ed7a&sv=2) **Allowed Roles** Here you can select roles which can edit, add & remove automod rules, users without these roles will not be able to remove or add rules. **Logging Channel** Here you can select the channel in which automod logs are sent to, users who trigger the automod will also trigger a message to be sent to the channel specified here. **Default Moderator Message** Here you can set the default moderator message that is displayed to users who break one of the defined automod rules. **Whitelisted Roles** Here you can define some roles that will not trigger the automod, users with these roles will be completely immune to the automod rules and will not trigger the module. **Whitelisted Channels** Here you can select some channels that the automod will ignore, messages sent in these channels that would normally trigger the automod will be ignored. ### [](https://documentation.botghost.com/server-management/discord-automod#punishment-settings) Punishment Settings Here you can customise the punishments members get when they break one of the automod rules or set it to a set amount of rules to be broken before punishment is given. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FD9387ENLZEi70zwGNYBX%252FScreenshot_3-7-2024_235353_dashboard.botghost.png%3Falt%3Dmedia%26token%3D1cea3eb2-7d02-4a1b-99c0-9dd5ffd53558&width=768&dpr=3&quality=100&sign=df18f542&sv=2) **Broken Rules Needed** Here you can define the amount of rules needed to be broken by a user before punishment is given. **Punishment Type** Here you can change the type of punishment the bot will give when a user reaches the defined number of broken rules needed to trigger a punishment. Below are the punishment types you can select: Punishment Types Timeout Member Kick Member Ban Member **Punishment Length** Here you can change the duration for the 'Timeout Member' punishment option. **Checked Rule** Here you can enter the name of the automod rule the event will issue punishments upon. **If you leave the input empty, all automod filters will count!** **Send a DM** **H**ere you can enable/disable DMs being sent to the user upon punishment. **DM Message** Here you can edit the message that is sent to users when they have been punished if you have enabled the '**Send a DM'** setting. To save the punishment settings, you need to click "Add" in the bottom-right corner of the settings. This will reset the fields so you can set up another punishment. ### [](https://documentation.botghost.com/server-management/discord-automod#viewing-active-punishments) Viewing Active Punishments You can edit all active punishments through a list right below the menu. To save the edits you made on the punishment settings, you need to click "Edit" in the bottom-right corner of the settings. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FAB4uuzjqF7l3UcxVgNxe%252Fimage.png%3Falt%3Dmedia%26token%3D156c10d4-a76a-418c-be10-874a944194cf&width=768&dpr=3&quality=100&sign=83ae76fe&sv=2) * * * [](https://documentation.botghost.com/server-management/discord-automod#commands) Commands ----------------------------------------------------------------------------------------------- In this area, you can view and modify the commands of the Discord Automod module. Below you may find some information on each command of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FS8cUqtFbWmmx9lojrI7Z%252Fimage.png%3Falt%3Dmedia%26token%3D09864247-04c1-45f2-aaa4-0472d02a664c&width=768&dpr=3&quality=100&sign=908ac00f&sv=2) **/discord-automod**[](https://documentation.botghost.com/server-management/discord-automod#discord-automod) The discord-automod command allows you to edit, add or remove Discord automod rules with your bot in your server. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FujBl0JpoadWhlzXi7taF%252Fimage.png%3Falt%3Dmedia%26token%3Db4bacd12-eefe-4aef-b8bc-2bf1e7f7a9b7&width=300&dpr=3&quality=100&sign=659649f2&sv=2) [](https://documentation.botghost.com/server-management/discord-automod#events) Events ------------------------------------------------------------------------------------------- In this area, you can view and modify the events of the Discord Automod module. Below you may find some information on each event of the module. All punishments will be ordered by the number in which they were created. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FexKvpTOxEohFkgbhjRaI%252Fimage.png%3Falt%3Dmedia%26token%3Db94e6b06-6aa7-4a63-a899-e3991f41ce3f&width=768&dpr=3&quality=100&sign=71943f43&sv=2) Punishment #...[](https://documentation.botghost.com/server-management/discord-automod#punishment) Once you add an automatic punishment, the corresponding event will be created. This will handle the newly created punishment. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intented. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/server-management/discord-automod#settings) * [Basic Settings](https://documentation.botghost.com/server-management/discord-automod#basic-settings) * [Punishment Settings](https://documentation.botghost.com/server-management/discord-automod#punishment-settings) * [Viewing Active Punishments](https://documentation.botghost.com/server-management/discord-automod#viewing-active-punishments) * [Commands](https://documentation.botghost.com/server-management/discord-automod#commands) * [Events](https://documentation.botghost.com/server-management/discord-automod#events) Was this helpful? --- # Sticky Messages | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/messages/sticky-messages.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F1EYEpH5Z8KKW6dxQ27oC%252Fimage.png%3Falt%3Dmedia%26token%3D5ae912fd-f75a-4a4b-aaa6-9125ba095586&width=768&dpr=3&quality=100&sign=e656f4e2&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. The [Sticky Messages](https://dashboard.botghost.com/dashboard/module/1acdd900-f547-481f-b1ef-725384b5884b/stickymessages) module allows you to send a message to a channel of your choice after a number of messages. This is great for highlighting important information or adding frequent reminders! [](https://documentation.botghost.com/messages/sticky-messages#settings) Settings -------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/messages/sticky-messages#setup) Setup Here you can configure all the settings for the sticky messages module from changing the actual message, the frequency and more. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FLzUMcDSqIsU7QvbJwNpQ%252Fimage_2024-07-09_112831757.png%3Falt%3Dmedia%26token%3D16f96859-9f7e-4929-8d27-ddfe2f99b4d7&width=768&dpr=3&quality=100&sign=e81be6e2&sv=2) #### [](https://documentation.botghost.com/messages/sticky-messages#manager-role) **Manager Role** In this dropdown, you can select a role to allow users with this role to add / remove messages set with the module. #### [](https://documentation.botghost.com/messages/sticky-messages#default-sticky-message) **Default Sticky Message** This field is where you can change the default message that's sent to the channel after a number of messages as defined in the module settings below. #### [](https://documentation.botghost.com/messages/sticky-messages#repost-message-count) **Repost Message Count** In this field you can change how frequent the message is sent. The number that's input is the basis for how many messages until the sticky message is sent. The default value for this is set to 10 and the field only accepts integers. #### [](https://documentation.botghost.com/messages/sticky-messages#show-author) **Show Author** This toggle allows you to enable / disable the ability to show the sticky message author in the embed message. The author is the user who originally posted the sticky message and only works in embeds. #### [](https://documentation.botghost.com/messages/sticky-messages#add-reactions) **Add Reactions** With this toggle, you can enable / disable the option for the bot to add a specified or default reaction to the sticky message when it is sent. #### [](https://documentation.botghost.com/messages/sticky-messages#reaction-emoji) **Reaction Emoji** In this section, you can set the emoji that is added as a reaction to the sticky message, if the above toggle is enabled. You can use both custom emoji's or basic discord emoji's for this. You can find a guide [here](https://documentation.botghost.com/getting-started/standard-practices/advanced-practices#how-can-i-get-a-custom-emojis-id) on how to get the ID and name of a custom emoji. * * * [](https://documentation.botghost.com/messages/sticky-messages#commands) Commands -------------------------------------------------------------------------------------- This area is where you can enable / disable the sticky post command as well as configure the command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FciGckNsW6mpRBorc7l1G%252Fimage_2024-07-09_112753471.png%3Falt%3Dmedia%26token%3Df9f7c274-759d-415e-9151-88d4fa814693&width=768&dpr=3&quality=100&sign=a1b0af49&sv=2) /sticky-post[](https://documentation.botghost.com/messages/sticky-messages#sticky-post) When triggered this command will allow you to send a new sticky message to any channel you select from the command option. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FRARMXPgIGhXRdyUwLtuj%252Fimage.png%3Falt%3Dmedia%26token%3D413abc11-7a9a-4aaa-ba78-ed7e15adba10&width=300&dpr=3&quality=100&sign=758088d&sv=2) [](https://documentation.botghost.com/messages/sticky-messages#events) Events ---------------------------------------------------------------------------------- In this area, you can view and modify the commands of the Sticky Messages module. Below you may find some information on each command of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FlHvdir035OgVihIOvcEH%252Fimage_2024-07-09_112804930.png%3Falt%3Dmedia%26token%3Da660a2f9-23fa-40ba-b263-ce9eb636c69e&width=768&dpr=3&quality=100&sign=7852e758&sv=2) Sticky Messages (Poster)[](https://documentation.botghost.com/messages/sticky-messages#sticky-messages-poster) This event will count the messages in the channels and send the designated sticky message when it reaches the defined message count as set in the settings above. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/messages/sticky-messages#settings) * [Setup](https://documentation.botghost.com/messages/sticky-messages#setup) * [Commands](https://documentation.botghost.com/messages/sticky-messages#commands) * [Events](https://documentation.botghost.com/messages/sticky-messages#events) Was this helpful? --- # Action Events | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/events/action-events.md) . Action Events are a category of pre-built, powerful events in BotGhost that combine multiple actions into a single block. They are designed to simplify the creation of common bot features, allowing you to accomplish complex tasks without needing multiple custom event blocks. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FPQX9CXx3R4QarmLV2hXp%252Fimage.png%3Falt%3Dmedia%26token%3D345eb1f9-af5f-4644-819c-31bf93919e3d&width=768&dpr=3&quality=100&sign=1fa218c3&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/events/action-events#action-event-block) Action Event Block --------------------------------------------------------------------------------------------------------------------------------- ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F8WatmpZSfLh3U2Ejm8kw%252Fimage.png%3Falt%3Dmedia%26token%3D0a66d490-8734-4aac-b7bd-6befcbdf4dcc&width=768&dpr=3&quality=100&sign=74c080a7&sv=2) All action events come with a pre-added block where you can configure settings for the event or other automated actions. In the screenshot above for example, the Auto Role on Join Block is a default block that appears on the Auto Role on Join custom event. It alllows you to add one or more roles to a specific member on join and configure details. [](https://documentation.botghost.com/custom-commands-and-events/events/action-events#available-action-events) Available Action Events ------------------------------------------------------------------------------------------------------------------------------------------- Event Information Auto Role on Join Adds a role when a user joins the server. Twitch Stream Online The event will run when a streamer goes live on Twitch. YouTube Video Upload Triggers when a new video is posted on a YouTube channel. Last updated 8 months ago Was this helpful? * [Action Event Block](https://documentation.botghost.com/custom-commands-and-events/events/action-events#action-event-block) * [Available Action Events](https://documentation.botghost.com/custom-commands-and-events/events/action-events#available-action-events) Was this helpful? --- # IFTTT | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/ifttt.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FGk57sAONqUgYbQ6oKqJP%252F1280px-IFTTT_Logo.svg.png%3Falt%3Dmedia%26token%3D67ba4c21-da18-4328-b872-892cf87f1a13&width=768&dpr=3&quality=100&sign=8fbc5de1&sv=2) IFTTT is short for "If This Then That" and allows you to link up to 700 different apps and services, including Twitter, DropBox, Twitch, and Google Sheets. IFTTT works by creating applets with triggers, queries, and actions. The IFTTT x BotGhost link allows you to trigger IFTTT applets through custom commands and events, as well as triggering BotGhost custom events when other services trigger fires. [](https://documentation.botghost.com/custom-commands-and-events/ifttt#linking-ifttt-to-botghost) Linking IFTTT to BotGhost -------------------------------------------------------------------------------------------------------------------------------- To get started with IFTTT you must first link your IFTTT account to your BotGhost account. To do so head over to the [BotGhost IFTTT page](https://ifttt.com/botghost) and click **Connect** to begin this process. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FiVDqAw1vcnZ6vOMb4quf%252Fimage.png%3Falt%3Dmedia%26token%3D0337a28b-cf5d-422e-9954-e83485cb1d1d&width=768&dpr=3&quality=100&sign=8e2257e5&sv=2) This will prompt you to log in and redirect you to the BotGhost dashboard where you must give permission to link your BotGhost account to IFTTT. Click **Authorize** to confirm the BotGhost x IFTTT link. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F56k9Ag7VyupQAH2b9UVK%252Fimage.png%3Falt%3Dmedia%26token%3D529ab779-60ea-4c3c-9a24-d5e654102f0e&width=768&dpr=3&quality=100&sign=3069274&sv=2) Once complete your accounts are now linked. You can now begin creating Applets using BotGhost triggers, queries, and actions on IFTTT. [](https://documentation.botghost.com/custom-commands-and-events/ifttt#applets) **Applets** ------------------------------------------------------------------------------------------------ Applets are the backbone of IFTTT. Applets use a customizable script to link two or more apps that normally remain separate. Within BotGhost, we use IFTTT Applets to either trigger custom events or trigger other services actions on IFTTT. To create an Applet, once again head over to the [BotGhost IFTTT service page](https://ifttt.com/botghost) and click **Create.** ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FDRGFqafYTBaAPQhEuike%252Fimage.png%3Falt%3Dmedia%26token%3D087ab478-1674-4d4e-ba4f-7b98d9c8b9c2&width=768&dpr=3&quality=100&sign=172b4f4a&sv=2) You will then be prompted to Add at least one trigger and action. Triggers are what causes an applet to run, whilst actions are the end result of an action. Within BotGhost, the IFTTT trigger is executed through an Action block in custom commands or events. In your applet, click **Add** in the If This section and select the **Action Block triggered** IFTTT trigger. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FP2VigRk5RrQ0iI47bkDh%252Fimage.png%3Falt%3Dmedia%26token%3D29f83ac2-b51f-46d8-8983-9a7df42cd10e&width=768&dpr=3&quality=100&sign=8a82e062&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/ifttt#action-block-triggered-ifttt-triggers) Action Block Triggered (IFTTT Triggers) ---------------------------------------------------------------------------------------------------------------------------------------------------------- The Action Block Triggered IFTTT Trigger executes an Applet when an **Execute an IFTTT Trigger** action block in a custom command or event is run. On IFTTT the Action Block Triggered Trigger has three options. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FdqvUtLkwMriHKRVB44Nh%252Fimage.png%3Falt%3Dmedia%26token%3D160a8369-97ae-4bf2-9e0d-536315eb4ab1&width=768&dpr=3&quality=100&sign=80c7c2ca&sv=2) First, select your linked BotGhost account in the **BotGhost account** dropdown. ### [](https://documentation.botghost.com/custom-commands-and-events/ifttt#action-id) Action ID The action ID field is what links your action in BotGhost to your trigger on IFTTT. This field must match the Action ID field in an **Execute an IFTTT Trigger** action in a BotGhost custom command or event. You can name this action ID anything you wish. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FOWVrnsFl9TAQ2Hho0TiC%252Fifttt.png%3Falt%3Dmedia%26token%3D87091ac0-42cb-43e5-b824-5078702e5c7b&width=768&dpr=3&quality=100&sign=7cb57c42&sv=2) ### [](https://documentation.botghost.com/custom-commands-and-events/ifttt#bot) Bot Select the bot you wish to trigger the action from. ### [](https://documentation.botghost.com/custom-commands-and-events/ifttt#execute-an-ifttt-trigger-action) Execute an IFTTT Trigger Action Once you have set up your trigger on IFTTT, you can execute it through an **Execute an IFTTT trigger** action block in a custom command or event on BotGhost. To do so, first, create a custom command or event and drag in the action. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FIXj9q03WoVx1wu6VfC1N%252Fimage.png%3Falt%3Dmedia%26token%3D98d27e25-297c-4615-90e2-36ba67ec581d&width=768&dpr=3&quality=100&sign=69ed06e2&sv=2) In the action, set the **Action ID** to the same Action ID you specified in your trigger on IFTTT. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FOWVrnsFl9TAQ2Hho0TiC%252Fifttt.png%3Falt%3Dmedia%26token%3D87091ac0-42cb-43e5-b824-5078702e5c7b&width=768&dpr=3&quality=100&sign=7cb57c42&sv=2) ### [](https://documentation.botghost.com/custom-commands-and-events/ifttt#variables) Variables You can pass information from your command or event to the action triggered in your Applet through IFTTT ingredients. The **Action Block Triggered** IFTTT Trigger has 10 variable slots you can use to pass through as ingredients. All BotGhost variables can be used in these slots including custom variables. These variables will come through as ingredients named Variable1, Variable2, Variable3... in any connected IFTTT action in your applets. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FNt93rB1gmTWh2TocvEDZ%252Fimage.png%3Falt%3Dmedia%26token%3D98a20bea-a970-4271-9f00-d9b006d99483&width=768&dpr=3&quality=100&sign=29804388&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FdoSpzJMyJqaDxrsADW3I%252Fimage.png%3Falt%3Dmedia%26token%3D35f41e7b-7135-45c9-b08a-1970cb157971&width=768&dpr=3&quality=100&sign=b9126e1d&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/ifttt#trigger-a-custom-event-ifttt-actions) Trigger a Custom Event (IFTTT Actions) -------------------------------------------------------------------------------------------------------------------------------------------------------- In IFTTT actions are the end result of an Applet. They are what are run when triggered by an IFTTT trigger. In BotGhost, the IFTTT Action is the execution of a custom event. Once again create an applet and set a trigger of your choosing. Click the **Add** Section in Then That and choose BotGhost. Click on **Trigger a Custom Event** to add the BotGhost IFTTT Action to your Applet. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FjgusZiZKk86uudZOPTKN%252Fimage.png%3Falt%3Dmedia%26token%3Deaf2524a-1c40-47f3-bab9-7672dfd636c1&width=768&dpr=3&quality=100&sign=20fb6d7a&sv=2) You will then be shown the options for the Action. Once again select your BotGhost account and input the Bot ID of the bot you wish to trigger the custom event of. ### [](https://documentation.botghost.com/custom-commands-and-events/ifttt#event-id) Event ID Similarly to the IFTTT Trigger, we must provide an ID that is the same in BotGhost and IFTTT. If you have not done so already, head over to your BotGhost and create a Custom Event with the type **When an IFTTT Action is executed.** ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FzhBUDkd1F1rFwLvlxirH%252Fimage.png%3Falt%3Dmedia%26token%3D13a70be3-3e75-4687-b3d4-79e95586efc5&width=768&dpr=3&quality=100&sign=10d4a146&sv=2) You will need to input an IFTTT Event ID and then select that Event in your IFTTT Action. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FXA3cLChsZPk4lA8MfruS%252Fiftttt2.png%3Falt%3Dmedia%26token%3D000dd65b-0b53-4aed-a54f-53d727d08a36&width=768&dpr=3&quality=100&sign=5eabc994&sv=2) Enter an event ID and then select that same event in your IFTTT Action. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FJ889K3aipyxxE8nnZ5UG%252Fifttt1.png%3Falt%3Dmedia%26token%3D5061b8dd-deba-4fac-bb39-5b630eab2d36&width=768&dpr=3&quality=100&sign=a208b4ed&sv=2) Then make sure to enter your server ID in the Discord Server ID field in your event. You can then continue to build out your custom event like normal. ### [](https://documentation.botghost.com/custom-commands-and-events/ifttt#ifttt-event-variables) IFTTT Event Variables You can pass variables through to your BotGhost custom event using the 10 IFTTT Variable slots. You can input your text or use ingredients from the execution action. Each variable has its corresponding variable in the event builder. For example, any text or ingredients you put into the **Variable 1 slot**, can be used in your custom event as **{ifttt\_variable1}**. Last updated 2 years ago Was this helpful? * [Linking IFTTT to BotGhost](https://documentation.botghost.com/custom-commands-and-events/ifttt#linking-ifttt-to-botghost) * [Applets](https://documentation.botghost.com/custom-commands-and-events/ifttt#applets) * [Action Block Triggered (IFTTT Triggers)](https://documentation.botghost.com/custom-commands-and-events/ifttt#action-block-triggered-ifttt-triggers) * [Action ID](https://documentation.botghost.com/custom-commands-and-events/ifttt#action-id) * [Bot](https://documentation.botghost.com/custom-commands-and-events/ifttt#bot) * [Execute an IFTTT Trigger Action](https://documentation.botghost.com/custom-commands-and-events/ifttt#execute-an-ifttt-trigger-action) * [Variables](https://documentation.botghost.com/custom-commands-and-events/ifttt#variables) * [Trigger a Custom Event (IFTTT Actions)](https://documentation.botghost.com/custom-commands-and-events/ifttt#trigger-a-custom-event-ifttt-actions) * [Event ID](https://documentation.botghost.com/custom-commands-and-events/ifttt#event-id) * [IFTTT Event Variables](https://documentation.botghost.com/custom-commands-and-events/ifttt#ifttt-event-variables) Was this helpful? --- # Timed Events | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/events/timed-events.md) . The timed events module allows users to setup events to be triggered on the specified days/times selected. This is super handy for reminders or other important messages that need to be sent every so often. [](https://documentation.botghost.com/custom-commands-and-events/events/timed-events#settings) Settings ------------------------------------------------------------------------------------------------------------ Here you can customise the settings for the module, create new events, edit events and more. ### [](https://documentation.botghost.com/custom-commands-and-events/events/timed-events#timezone) Timezone The timezone section allows you to specify the timezone you wish the events to trigger in. By default it will be set to your current timezone on your computer/device. ### [](https://documentation.botghost.com/custom-commands-and-events/events/timed-events#add-a-new-timed-event) Add a new timed event Below you can see a image of the event creator. Here you can select the trigger time, trigger day, name and type of event. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FhDjYIb1gv3D6GBzuXn3q%252Fimage.png%3Falt%3Dmedia%26token%3D77e618f9-dc88-4713-8651-f234e953177b&width=768&dpr=3&quality=100&sign=ef09efbf&sv=2) ### [](https://documentation.botghost.com/custom-commands-and-events/events/timed-events#event-type) Event Type Here you can select between 'Schedule' or 'Interval'. By default it is set to 'Interval'. Selecting the 'Interval' type will allow you to make the event trigger on a interval (Run events every X amount of seconds, minutes, hours or days. The minimum interval is 10 seconds.) (Green = active Red = Disabled) Setting this to Schedule will display some new options: ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fd0lGatVZdFR3POa7A2oH%252Fimage.png%3Falt%3Dmedia%26token%3D5cfb843e-0e54-4f1e-8f0c-945744754df8&width=768&dpr=3&quality=100&sign=a6e75133&sv=2) Here you can set the event to tigger every X day(s) at X time. Example, run the event every Monday at 12:00:00PM. (Green = active Red = Disabled) [](https://documentation.botghost.com/custom-commands-and-events/events/timed-events#active-timed-events) Active Timed Events ---------------------------------------------------------------------------------------------------------------------------------- Here you can find all of your created timed events, you will be able to modify each one by clicking on the event. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FvPi9K3K0quIzHN9hxvSA%252Fimage.png%3Falt%3Dmedia%26token%3D2d256e57-afa6-4403-995c-a157240dd6aa&width=768&dpr=3&quality=100&sign=197e2a1&sv=2) Last updated 2 years ago Was this helpful? * [Settings](https://documentation.botghost.com/custom-commands-and-events/events/timed-events#settings) * [Timezone](https://documentation.botghost.com/custom-commands-and-events/events/timed-events#timezone) * [Add a new timed event](https://documentation.botghost.com/custom-commands-and-events/events/timed-events#add-a-new-timed-event) * [Event Type](https://documentation.botghost.com/custom-commands-and-events/events/timed-events#event-type) * [Active Timed Events](https://documentation.botghost.com/custom-commands-and-events/events/timed-events#active-timed-events) Was this helpful? --- # Modmail | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/server-management/modmail.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F8ON64yxy6qAsTL9yElv0%252Fimage.png%3Falt%3Dmedia%26token%3D8dd5586d-4cc8-4a22-be6a-48b6a07adf32&width=768&dpr=3&quality=100&sign=fb862647&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. The [Modmail](https://dashboard.botghost.com/dashboard/module/249b4aee-5617-4985-b60b-be262e567fc7/modmail) module allows users to send a Direct Message to your bot to open a form thread in a form channel of your choice to contact server staff privately, or report server members and more. [](https://documentation.botghost.com/server-management/modmail#settings) Settings --------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/server-management/modmail#settings-1) Settings Here you can configure the settings for the modmail module, from changing the DM Messages to selecting the form channel you would like it to be posted in. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FshgkeLIRHjhv9YRR5YUR%252Fimage_2024-07-07_212652574.png%3Falt%3Dmedia%26token%3D78ab5a6b-8a15-4317-9b8d-1a64e4128f0a&width=768&dpr=3&quality=100&sign=455140d&sv=2) #### [](https://documentation.botghost.com/server-management/modmail#receive-requests) **Receive Requests** This option is enabled by default and disabling this setting will stop users from opening a modmail thread and instead return a closed message when they direct message your bot. #### [](https://documentation.botghost.com/server-management/modmail#form-channel) **Form Channel** Here you must paste your forum channels ID to allow users to open modmail threads, you can create a forum channel in your discord server, for a guide on how to get a channel ID you can check [here](https://documentation.botghost.com/getting-started/standard-practices/advanced-practices#how-can-i-get-a-channel-id) . #### [](https://documentation.botghost.com/server-management/modmail#dm-message-title) **DM Message Title** This field is where you can edit the direct message title which is sent to users upon contacting your bot via direct messages. #### [](https://documentation.botghost.com/server-management/modmail#dm-message-description) **DM Message Description** Here you can edit the message that is sent to the user upon contacting your bot via DMs. All [variables](https://documentation.botghost.com/custom-commands-and-events/variables) may be used. ### [](https://documentation.botghost.com/server-management/modmail#ban-command) Ban Command This is where you can configure the settings for the `/modmail-ban` command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F2bLRt58xPrQQ1nov3fBP%252Fimage_2024-07-07_213041071.png%3Falt%3Dmedia%26token%3D5e97e445-4429-45f4-bb1f-34349afd3fd2&width=768&dpr=3&quality=100&sign=b821bfac&sv=2) #### [](https://documentation.botghost.com/server-management/modmail#enable-ban-command) **Enable Ban Command** This toggle is where you can enable/disable the ability for staff to use the `/modmail-ban` command. #### [](https://documentation.botghost.com/server-management/modmail#select-the-needed-permissions) Select The Needed Permissions This dropdown section is where you can change the permissions for use of the `/modmail-ban` command, the default value of this is set to **Administrator** but can be changed to: Permission Details Administrator Requires the administrator permission in your server. Server Manager Requires the manage server permission. Moderator Requires the manage permissions. #### [](https://documentation.botghost.com/server-management/modmail#ban-message) **Ban Message** In this field, you can set the message that is displayed to a user when they attempt to make a modmail thread after they have been banned from using modmail. * * * [](https://documentation.botghost.com/server-management/modmail#commands) Commands --------------------------------------------------------------------------------------- In this area, you can view and modify the commands of the Modmail module. Below you may find some information on each command of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FcCsGPzZGDGT1iU3jnjmP%252Fimage.png%3Falt%3Dmedia%26token%3Dc38fad9d-8080-4c77-be59-30665358329e&width=768&dpr=3&quality=100&sign=8fba8beb&sv=2) /modmail-ban[](https://documentation.botghost.com/server-management/modmail#modmail-ban) When triggered, this command will restrict a selected users ability to use the modmail system resulting in a ban message being displayed upon trying to open a new modmail thread. /modmail-clear[](https://documentation.botghost.com/server-management/modmail#modmail-clear) When triggered this command will clear the modmail data for a user allowing them to use the modmail system again, this is useful incase the system breaks and acts as though a user has a thread already open. [](https://documentation.botghost.com/server-management/modmail#events) Events ----------------------------------------------------------------------------------- In this area, you can view and modify the events of the Modmail module. Below you may find some information on each event of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FhKyuqlF50mdyLTZCZPXH%252Fimage.png%3Falt%3Dmedia%26token%3D9dd6b69f-d7d2-4a5f-bf51-db2221beb8ac&width=768&dpr=3&quality=100&sign=eee9fcee&sv=2) Modmail[](https://documentation.botghost.com/server-management/modmail#modmail) This is the main event which detects when a user sends a DM to your bot and starts a thread. Here you can edit the event and customise it to your liking and add onto the pre-existing functionalities of the module. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/server-management/modmail#settings) * [Settings](https://documentation.botghost.com/server-management/modmail#settings-1) * [Ban Command](https://documentation.botghost.com/server-management/modmail#ban-command) * [Commands](https://documentation.botghost.com/server-management/modmail#commands) * [Events](https://documentation.botghost.com/server-management/modmail#events) Was this helpful? --- # Polls Filter | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/server-management/polls-filter.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FW9gvaGyAo3hd6HdYBZaI%252Fimage.png%3Falt%3Dmedia%26token%3D879a0750-2167-4c02-b361-75266cc2855a&width=768&dpr=3&quality=100&sign=d1ea98be&sv=2) The [Polls Filter module](https://dashboard.botghost.com/dashboard/module/5631dcc3-4ef8-49ee-8ab0-7dc763ad44ff/pollsfilter) allows you to filter newly sent messages that contain polls. [](https://documentation.botghost.com/server-management/polls-filter#settings) Settings -------------------------------------------------------------------------------------------- In this area, you can view and modify the settings of the Polls Filter module. Below you may find some information on each setting of the module. ### [](https://documentation.botghost.com/server-management/polls-filter#bot-response) Bot Response ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FQa5zJHY3wB94usYkVMU9%252Fimage.png%3Falt%3Dmedia%26token%3D25f70e7d-379d-413d-8354-6c3234c66f0a&width=768&dpr=3&quality=100&sign=c71613ef&sv=2) #### [](https://documentation.botghost.com/server-management/polls-filter#delete-message) Delete message This setting allows you to automatically delete the filtered message. #### [](https://documentation.botghost.com/server-management/polls-filter#timeout-user) Timeout User This setting allows you to automatically mute the author of the filtered message for a specified number of seconds. #### [](https://documentation.botghost.com/server-management/polls-filter#timeout-member) Timeout Member This setting allows you to customize how long, in seconds, the author of the filtered message should be muted. _This setting is only visible with_ [_Timeout User_](https://documentation.botghost.com/server-management/polls-filter#timeout-user) _enabled._ #### [](https://documentation.botghost.com/server-management/polls-filter#send-a-message-when-the-filter-is-triggered) Send a message when the filter is triggered This setting allows you to automatically send a specified message to the channel the message was filtered in, and optionally delete it after a specified number of seconds. #### [](https://documentation.botghost.com/server-management/polls-filter#message) Message This setting allows you to customize the message that should be sent to the channel the message was filtered in. _This setting is only visible with_ [_Send a message when the filter is triggered_](https://documentation.botghost.com/server-management/polls-filter#send-a-message-when-the-filter-is-triggered) _enabled._ #### [](https://documentation.botghost.com/server-management/polls-filter#delete-notification) Delete Notification This setting allows you to customize how long, in seconds, the specified message should be visible before it gets deleted. To ensure the message does not get deleted, set this setting to `0`. _This setting is only visible with_ [_Send a message when the filter is triggered_](https://documentation.botghost.com/server-management/polls-filter#send-a-message-when-the-filter-is-triggered) _enabled._ #### [](https://documentation.botghost.com/server-management/polls-filter#send-a-dm-when-the-filter-is-triggered) Send a DM when the filter is triggered This setting allows you to automatically direct message the author of the filtered message. #### [](https://documentation.botghost.com/server-management/polls-filter#message-1) Message This setting allows you to customize the direct message that should be sent to the author of the filtered message. _This setting is only visible with_ [_Send a DM when the filter is triggered_](https://documentation.botghost.com/server-management/polls-filter#send-a-dm-when-the-filter-is-triggered) _enabled._ ### [](https://documentation.botghost.com/server-management/polls-filter#filters) Filters ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FTvWuGrpZfbi9S5AT0POx%252Fimage.png%3Falt%3Dmedia%26token%3D2b374e8a-09d0-499d-87b0-38327be827f4&width=768&dpr=3&quality=100&sign=52b3dba7&sv=2) #### [](https://documentation.botghost.com/server-management/polls-filter#channel-restrictions) Channel Restrictions This setting allows you to customize what channels can and cannot contain polls. Restriction Type Information No channel restrictions Server members will be able to send polls everywhere. Enable for all channels except... Server members will be able to send polls in all channels except the channels provided in the menu below. Disable for all channels except... Server members will be able to send polls only in channels provided in the menu below. #### [](https://documentation.botghost.com/server-management/polls-filter#role-restrictions) Role Restrictions This setting allows you to customize what roles can and cannot send polls. Restriction Type Information No role restrictions All server members will be able to send polls. Enable for all channels except... All server members except those with the roles provided in the menu below will be able to send polls. Disable for all channels except... Only server members with the roles provided in the menu will be able to send polls. * * * [](https://documentation.botghost.com/server-management/polls-filter#events) Events ---------------------------------------------------------------------------------------- In this area, you can view and modify the events of the Polls Filter module. Below you may find some information on each event of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FJZX9kUT7OQBljUvmV950%252Fimage.png%3Falt%3Dmedia%26token%3Ded38a2f4-46b6-441d-8d0e-34b16f7d71b5&width=768&dpr=3&quality=100&sign=623a6b52&sv=2) Polls Filter[](https://documentation.botghost.com/server-management/polls-filter#polls-filter) This event is the core of the module: it triggers upon newly sent messages and ensures to filter all messages that contain polls based on the settings you set. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intented. Additionally, a copy of the edited command / event will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/server-management/polls-filter#settings) * [Bot Response](https://documentation.botghost.com/server-management/polls-filter#bot-response) * [Filters](https://documentation.botghost.com/server-management/polls-filter#filters) * [Events](https://documentation.botghost.com/server-management/polls-filter#events) Was this helpful? --- # Reaction Roles | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/messages/reaction-roles.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FsTdnN13VRwx29bRY5IlB%252FScreenshot%25202024-07-09%2520212426.png%3Falt%3Dmedia%26token%3D40bb7b01-17bb-4156-ae77-6a68b3251630&width=768&dpr=3&quality=100&sign=1a30056&sv=2) The Reaction Role module allows you to configure messages that allow users to assign and remove roles by reacting to a message. [](https://documentation.botghost.com/messages/reaction-roles#common-issues) Common Issues ----------------------------------------------------------------------------------------------- Experiencing issues with the module? Check out the common issues below. If your issue is not listed in this page, make sure your module is updated to the latest version. If you are still experiencing issues with the module, join our [support server](https://discord.gg/botghost) to ask for further help. ### [](https://documentation.botghost.com/messages/reaction-roles#the-bot-is-not-reacting-to-the-message) **The bot is not reacting to the message** If the bot is not adding the first reaction to the message, try the following steps: 1 Make sure the [Remove Reaction](https://documentation.botghost.com/messages/reaction-roles#remove-reaction) setting is disabled. 2 If this didn't solve the issue, add the reaction to the message yourself. 3 If you're still experiencing issues, join our [support server](https://discord.gg/botghost) to ask for further help. ### [](https://documentation.botghost.com/messages/reaction-roles#the-bot-doesnt-recognize-an-emoji) **The bot doesn't recognize an emoji** If the bot is not recognizing an emoji and not adding the role, try the following steps: 1 Make sure you added the right unicode character for default emojis, like this: `1️⃣`, or the right name for custom emojis. For instance, if your custom emoji is called `<:BotGhostWave:1048697598355189850>`, only add `BotGhostWave`. 2 If you're still experiencing issues, join our [support server](https://discord.gg/botghost) to ask for further help. ### [](https://documentation.botghost.com/messages/reaction-roles#the-module-is-not-working-at-all) **The module is not working at all** If the module is not doing anything, try the following steps: 1 Check if your bot is on [BotPanel](https://botpanel.gg/) . If it is, enable the module there too and set it up from BotPanel, or remove the bot from BotPanel if you're not intending to use it. 2 Reset your bot's token on the [Discord Developer Portal](https://discord.com/developers/) . Paste your token into your bot's [settings](https://documentation.botghost.com/general-settings-and-collaboration/settings#bot-token) and start the bot. 3 If you're still experiencing issues, join our [support server](https://discord.gg/botghost) to ask for further help. * * * [](https://documentation.botghost.com/messages/reaction-roles#watch-the-tutorial) Watch the Tutorial --------------------------------------------------------------------------------------------------------- * * * [](https://documentation.botghost.com/messages/reaction-roles#settings) Settings ------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/messages/reaction-roles#setup) Setup The Reaction Role module has different configurations which change how roles are given or removed. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F6gkQbtEx8cHwp4q9N4N2%252FScreenshot_9-7-2024_175519_dashboard.botghost.com.jpeg%3Falt%3Dmedia%26token%3D59c87f53-2f76-4e3a-b602-8d95fc712bae&width=768&dpr=3&quality=100&sign=a59157a4&sv=2) #### [](https://documentation.botghost.com/messages/reaction-roles#message-id) **Message ID** Here you will need to enter the [message ID](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID) of the message you wish to use as the reaction roles panel. #### [](https://documentation.botghost.com/messages/reaction-roles#reaction-emoji) **Reaction Emoji** Here you can enter the emoji that is used on the reaction message, this can be discord emojis or custom emojis. #### [](https://documentation.botghost.com/messages/reaction-roles#roles-to-add) **Roles To Add** Here you can select the roles to add to the user when they react to the message. #### [](https://documentation.botghost.com/messages/reaction-roles#roles-to-remove) **Roles To Remove** Here you can select some roles the bot should remove when the user reacts to the message. #### [](https://documentation.botghost.com/messages/reaction-roles#restrict-to-one-reaction) **Restrict To One Reaction** Here you can enable/disable the option to restrict a user's reaction to one reaction at a time. #### [](https://documentation.botghost.com/messages/reaction-roles#remove-reaction) **Remove Reaction** Here you can enable/disable the option for the bot to remove the user's reaction once they have been given the role. #### [](https://documentation.botghost.com/messages/reaction-roles#blacklisted-roles) **Blacklisted Roles** Here you can select some roles that are unable to use this reaction message. Users with this role will not be able to react to the message as the bot will instantly delete it. To save the reaction roles settings, you need to click "Add" in the bottom-right corner of the settings. This will reset the fields so you can set up another reaction role. ### [](https://documentation.botghost.com/messages/reaction-roles#active-reaction-roles) Active Reaction Roles Once you have added a reaction role from the settings above, a new area will appear that contains all the active reaction roles. You may edit / delete any of these active reaction roles on the bottom right of the image below. To save the edits you made on the reaction role settings, you need to click "Edit" in the bottom-right corner of the settings. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F0pWv2jqdCpigtgi7mLkr%252FScreenshot_10-7-2024_152239_dashboard.botghost.com.jpeg%3Falt%3Dmedia%26token%3D421118d8-cd4a-4c9f-9d22-7c50430a7610&width=768&dpr=3&quality=100&sign=e8dc8cca&sv=2) * * * [](https://documentation.botghost.com/messages/reaction-roles#events) Events --------------------------------------------------------------------------------- In this area, you can view and modify the events of the Reaction Roles module. Below you may find some information on each event of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FWOdO6snsoK2G1QL82cOQ%252FScreenshot%25202024-07-10%2520143001.png%3Falt%3Dmedia%26token%3D97615e94-f165-4ce2-b1d0-17ef6de5ae7d&width=768&dpr=3&quality=100&sign=2db7f6b5&sv=2) Reaction Roles #...[](https://documentation.botghost.com/messages/reaction-roles#reaction-roles) Once you add a Reaction Role, the corresponding event will be created. This will handle the newly created Reaction Role. * * * It's advised that you do not edit the events unless you have a good understanding of BotGhost and its Event Builder. If you encounter any issues, you might want to reset the module for it to work again as intented. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Common Issues](https://documentation.botghost.com/messages/reaction-roles#common-issues) * [The bot is not reacting to the message](https://documentation.botghost.com/messages/reaction-roles#the-bot-is-not-reacting-to-the-message) * [The bot doesn't recognize an emoji](https://documentation.botghost.com/messages/reaction-roles#the-bot-doesnt-recognize-an-emoji) * [The module is not working at all](https://documentation.botghost.com/messages/reaction-roles#the-module-is-not-working-at-all) * [Watch the Tutorial](https://documentation.botghost.com/messages/reaction-roles#watch-the-tutorial) * [Settings](https://documentation.botghost.com/messages/reaction-roles#settings) * [Setup](https://documentation.botghost.com/messages/reaction-roles#setup) * [Active Reaction Roles](https://documentation.botghost.com/messages/reaction-roles#active-reaction-roles) * [Events](https://documentation.botghost.com/messages/reaction-roles#events) Was this helpful? --- # Question Of The Day | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/community-engagement/question-of-the-day.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F1mPzD5kY7IHrHfpN58dc%252Fimage.png%3Falt%3Dmedia%26token%3Da01e1135-028d-484a-ba01-42fea48a50c5&width=768&dpr=3&quality=100&sign=3873620e&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. The [Question Of The Day](https://dashboard.botghost.com/dashboard/module/7996e599-c1e4-4975-9f49-928c029a7d70/questionoftheday) module encourages members to engage in your server by answering a daily question that is automatically posted by your bot into a specific channel. [](https://documentation.botghost.com/community-engagement/question-of-the-day#settings) Settings ------------------------------------------------------------------------------------------------------ ### [](https://documentation.botghost.com/community-engagement/question-of-the-day#main-settings) Main Settings ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FfgkZUB4xr9C1W1rewQem%252Fimage.png%3Falt%3Dmedia%26token%3D8727a5e7-fe0d-40da-8b24-ff64377d412b&width=768&dpr=3&quality=100&sign=248d8f3a&sv=2) #### [](https://documentation.botghost.com/community-engagement/question-of-the-day#qotd-channel) **QOTD Channel** The channel where all questions will be automatically posted by your bot including the thread it creates. Inside of the thread is where users can give their answer to the question. #### [](https://documentation.botghost.com/community-engagement/question-of-the-day#mentioned-roles) **Mentioned Roles** Select roles that will be automatically pinged when a new question is posted. #### [](https://documentation.botghost.com/community-engagement/question-of-the-day#private-mode) **Private Mode** When enabled only people with the roles selected under 'Mentioned Roles' will be able to answer questions of the day. #### [](https://documentation.botghost.com/community-engagement/question-of-the-day#qotd-announcement-message) **QOTD Announcement Message** The format of the daily question can be customized here, you can choose between an embed or plain text message. When a new question of the day is created, this message will be sent alongside with the thread connected to it. Below you can find the variables you can use in the message. Variable Description `{question}` Returns the current question of the day. `{day}` Returns the total number of days the module has been posting questions for. #### [](https://documentation.botghost.com/community-engagement/question-of-the-day#created-thread-name) **Created Thread Name** The name of the thread that is created with the daily question, users may put their answer to the question inside of this thread. #### [](https://documentation.botghost.com/community-engagement/question-of-the-day#thread-archive-duration) **Thread Archive Duration** Choose between one of the four options to customize when the thread will be archived when no message has been sent in the thread in the specified duration. #### [](https://documentation.botghost.com/community-engagement/question-of-the-day#thread-slowmode) **Thread Slowmode** The duration of slowmode in seconds for messages that will be applied to the created thread for the question. The maximum slowmode is 6 hours (21600 seconds), this is recommended to use if you want users to only send 1 answer to the question. ### [](https://documentation.botghost.com/community-engagement/question-of-the-day#question-setup) Question Setup ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FcMEwzjz4ked8FP8JSmDJ%252Fimage.png%3Falt%3Dmedia%26token%3Da325a379-55e6-4a1d-b025-a24f2e54abf8&width=768&dpr=3&quality=100&sign=f1f267aa&sv=2) #### [](https://documentation.botghost.com/community-engagement/question-of-the-day#question-generation-setup) **Question Generation Setup** Choose the type of questions that are sent daily, either the ones already created with the module or custom questions that you can input. #### [](https://documentation.botghost.com/community-engagement/question-of-the-day#custom-questions) Custom Questions Input your custom questions in this section, make sure to separate each question with a normal comma. You can use special comma characters such as `٫` to put commas inside of your actual questions. _This setting is only visible with_ [Question Generation Setup](https://documentation.botghost.com/community-engagement/question-of-the-day#question-generation-setup) _set to "Customize Questions"._ #### [](https://documentation.botghost.com/community-engagement/question-of-the-day#skip-previously-asked-questions) **Skip Previously Asked Questions** When enabled all existing questions will be asked first before starting a new round. This can be used to prevent questions from being sent more than once. * * * [](https://documentation.botghost.com/community-engagement/question-of-the-day#events) Events -------------------------------------------------------------------------------------------------- In this area, you can view and modify the event of the Question Of The Day module. Below you may find some information on each event of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FfzCKmjQFHIjlFOyTxOGl%252Fimage.png%3Falt%3Dmedia%26token%3D217fef45-f8d9-4a23-853c-0d271adceaf2&width=768&dpr=3&quality=100&sign=426d600c&sv=2) QOTD Handler[](https://documentation.botghost.com/community-engagement/question-of-the-day#qotd-handler) The event that manages the questions that are sent daily along with the threads that are automatically created when a new question is posted. Make sure to not delete the associated timed event in the [timed events](https://docs.botghost.com/custom-commands-and-events/events/timed-events) module. * * * It's advised that you do not edit the event of this module unless you have a good understanding of BotGhost and its Command and Event Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/community-engagement/question-of-the-day#settings) * [Main Settings](https://documentation.botghost.com/community-engagement/question-of-the-day#main-settings) * [Question Setup](https://documentation.botghost.com/community-engagement/question-of-the-day#question-setup) * [Events](https://documentation.botghost.com/community-engagement/question-of-the-day#events) Was this helpful? --- # Moderation | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/server-management/moderation.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FOaSmaIu2ZBvZQMnktq9Z%252Fimage.png%3Falt%3Dmedia%26token%3D4c7d06d2-4787-451f-a42c-c9cdb8019bb4&width=768&dpr=3&quality=100&sign=76bb1ca4&sv=2) The [Moderation](https://dashboard.botghost.com/dashboard/module/ce84a76f-f0cc-42ce-8ebb-3790db06e943/moderation) module allows you to setup a highly customizable moderation system you can create for your server, with warnings, timeouts, auto-punishments and more features. [](https://documentation.botghost.com/server-management/moderation#common-issues) Common Issues ---------------------------------------------------------------------------------------------------- Experiencing issues with the module? Check out the common issues below. If your issue is not listed in this page, make sure your module is updated to the latest version. If you are still experiencing issues with the module, join our [support server](https://discord.gg/botghost) to ask for further help. It is advised that you [Enable Moderation Logging](https://documentation.botghost.com/server-management/moderation#enable-moderation-logging) to make sure you can see details about possible errors. ### [](https://documentation.botghost.com/server-management/moderation#roles-not-being-added-removed) Roles not being added / removed If the `/role add`, `/role remove` or `/role temp` commands are not working, it is likely because the role that you are trying to add or remove is above the bot's role in your server settings. The steps below will most likely solve your issue: 1 Make sure your bot has the administrator permission in your server. You can check this by looking at the permissions from your bot's role. 2 Make sure the bot's role is at the top of the role list. If this is not the case, drag the role to the top. 3 If you're still experiencing issues, join our [support server](https://discord.gg/botghost) to ask for further help, we'll do our best to solve your issue! ### [](https://documentation.botghost.com/server-management/moderation#users-not-being-muted-kicked-or-banned) Users not being muted, kicked or banned If the `/mute add`, `/kick`, `/ban add` or `/ban temp` command is not working, it is likely because the role of the target user is higher than the role from the bot. You are likely to solve this with the steps below: 1 Make sure your bot has the administrator permission in your server. You can check this by looking at the permissions from your bot's role. 2 Make sure the bot's role is at the top of the role list. If this is not the case, drag the role to the top. 3 If you're still experiencing issues, join our [support server](https://discord.gg/botghost) to ask for further help, we'll do our best to solve your issue! * * * [](https://documentation.botghost.com/server-management/moderation#watch-the-tutorial) Watch the Tutorial -------------------------------------------------------------------------------------------------------------- * * * [](https://documentation.botghost.com/server-management/moderation#settings) Settings ------------------------------------------------------------------------------------------ ### [](https://documentation.botghost.com/server-management/moderation#command-settings) Command Settings ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F2vakL4JTqDyxrZDY3wsi%252Fimage.png%3Falt%3Dmedia%26token%3Da626db5e-8d17-48a5-b4c8-b341608ea00b&width=768&dpr=3&quality=100&sign=770b0c22&sv=2) #### [](https://documentation.botghost.com/server-management/moderation#default-permissions) Default Permissions If you have this enabled, users with the manage messages permission will be able to use moderator commands. Users with the administrator permission will be able to use admin commands. #### [](https://documentation.botghost.com/server-management/moderation#admin-roles) Admin Roles Here you can select one or more roles that you want to allow to use admin commands. Admin roles can access commands that are only meant for managing the server. Examples of these are: `/role add`, `/role remove`, `/role temp` and `/user clear-history` but those may not be all. You can view a list with all commands in [the commands section](https://documentation.botghost.com/server-management/moderation#commands) . #### [](https://documentation.botghost.com/server-management/moderation#moderator-roles) Moderator Roles Here you can select one or more roles that you want to allow to use moderator commands. Moderator roles can only access commands meant for moderating the server, such as: `/ban add`, `/case view` and `/warn`, but those are not all. You can view a list with all commands in [the commands section](https://documentation.botghost.com/server-management/moderation#commands) . #### [](https://documentation.botghost.com/server-management/moderation#enable-moderation-logging) Enable Moderation Logging When enabled, all moderation actions will be logged to a channel. #### [](https://documentation.botghost.com/server-management/moderation#moderation-log-channel) Moderation Log Channel Here you can select the channel where you want to log moderation actions. _This setting only shows if you_ [Enable Moderation Logging](https://documentation.botghost.com/server-management/moderation#enable-moderation-logging) _._ ### [](https://documentation.botghost.com/server-management/moderation#visual-settings) Visual Settings ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F5ND3d7RLdZMRTR9FKcs9%252Fimage.png%3Falt%3Dmedia%26token%3D372ee7e3-b73e-447b-8a20-987b0551ebec&width=768&dpr=3&quality=100&sign=92537abc&sv=2) #### [](https://documentation.botghost.com/server-management/moderation#punishment-color) Punishment Color Here you can select what color that you want to use for punishment messages. Punishment messages are sent to the channel where the punishment has been issued. #### [](https://documentation.botghost.com/server-management/moderation#logging-color) Logging Color Here you can select what colour you want to give to log messages. Log messages are sent to the moderation log channel, if enabled. ### [](https://documentation.botghost.com/server-management/moderation#behaviour-settings) Behaviour Settings ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F2yZTCwLZILcYiSXamfx6%252Fimage.png%3Falt%3Dmedia%26token%3De3a81d78-6680-41ae-8f49-28b7aace3e94&width=768&dpr=3&quality=100&sign=90b268b4&sv=2) #### [](https://documentation.botghost.com/server-management/moderation#send-direct-messages) Send Direct Messages Here you can select whether you want to send a direct message to the user that has been punished. #### [](https://documentation.botghost.com/server-management/moderation#direct-message) Direct Message Here you can edit the message that a user gets after being punished. If the setting above has been disabled, the user will not get any direct message. You can use a set of variables in the direct message, you can read more about that [here](https://documentation.botghost.com/server-management/moderation#variables) . _This setting only shows if the_ [Send Direct Messages](https://documentation.botghost.com/server-management/moderation#send-direct-messages) _setting is enabled._ #### [](https://documentation.botghost.com/server-management/moderation#ban-delete-messages) Ban: Delete Messages Here you can select whether or not you want to delete a user's messages when they have been banned from the server. ### [](https://documentation.botghost.com/server-management/moderation#auto-punishment-settings) Auto-Punishment Settings ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FBvzp2F242VgSRIekjOb8%252Fimage.png%3Falt%3Dmedia%26token%3D842e6fae-5fd4-46ad-9713-4b705e26c0a0&width=768&dpr=3&quality=100&sign=5b691d75&sv=2) #### [](https://documentation.botghost.com/server-management/moderation#trigger-punishment-type) Trigger Punishment Type In this selection, you can select what type of punishment should trigger the auto punishment. #### [](https://documentation.botghost.com/server-management/moderation#warnings-timeouts-needed) Warnings / Timeouts Needed This is the number of warnings or timeouts needed before the auto punishment is triggered. #### [](https://documentation.botghost.com/server-management/moderation#punishment) Punishment Here you can select the type of punishment that a user should get when they reach the amount of warnings / timeouts entered above. #### [](https://documentation.botghost.com/server-management/moderation#timeout-duration) Timeout Duration This is the time a user should be timed out when they trigger an auto-punishment. _This setting is only shown if you selected "Timeout User" in the_ [_Punishment settings_](https://documentation.botghost.com/server-management/moderation#punishment) _._ To save the punishment's settings, you need to click "Add" in the bottom-right corner of the settings. This will reset the fields so you can set up another punishment. ### [](https://documentation.botghost.com/server-management/moderation#punishments) Punishments Here you can manage your currently active punishments. The same settings as [Auto-Punishments](https://documentation.botghost.com/server-management/moderation#auto-punishment-settings) apply. You are able to edit / delete these punishments. A maximum of 10 punishments is present. To save the edits you made on the punishment's settings, you need to click "Edit" in the bottom-right corner of the settings. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fl8ouWMUuC8g1QxGQPt6k%252Fimage.png%3Falt%3Dmedia%26token%3D34c46d98-dfbf-4fa5-a7d5-3da7a6a29560&width=768&dpr=3&quality=100&sign=db79f7b5&sv=2) * * * [](https://documentation.botghost.com/server-management/moderation#variables) Variables -------------------------------------------------------------------------------------------- Here are some module variables that can be used in [the direct message section](https://documentation.botghost.com/server-management/moderation#direct-message) . Variable Details `{action}` This variable will show the type of punishment the user got. For example: warn, mute or ban. `{moderator}` This variable will mention the moderator that gave the punishment. `{time}` This variable will show you the timestamp of the moment the punishment was issued. `{case}` This variable will show you the ID of the moderation case. `{reason}` This variable will return the reason for the punishment, this reason was provided by the moderator. * * * [](https://documentation.botghost.com/server-management/moderation#commands) Commands ------------------------------------------------------------------------------------------ ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F0CSClvuUOr7KqwOf7Vax%252FScreenshot_26-9-2024_193555_dashboard.botghost.com.jpeg%3Falt%3Dmedia%26token%3Dd433b72b-788d-4612-b3e3-4ed3e548e0da&width=768&dpr=3&quality=100&sign=1ca99523&sv=2) /ban add[](https://documentation.botghost.com/server-management/moderation#ban-add) This command allows you to ban a user from the server. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FYayxX62u3nJwtz1eXkBM%252Fimage.png%3Falt%3Dmedia%26token%3D604d7f28-8866-48b6-b733-8dd6b6505215&width=300&dpr=3&quality=100&sign=3dd15549&sv=2) /ban remove[](https://documentation.botghost.com/server-management/moderation#ban-remove) This command allows you to unban a user from the server on ID ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FV1P6hUwVtWpRe0mU9npK%252Fimage.png%3Falt%3Dmedia%26token%3D7b9a4af0-9c5a-4984-b1dd-9a9cbdc35f6d&width=300&dpr=3&quality=100&sign=40f174a5&sv=2) /ban temp[](https://documentation.botghost.com/server-management/moderation#ban-temp) This command allows you to temporarily ban a user from the server ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F9XN2vfzkMUsr3wb3RXSw%252Fimage.png%3Falt%3Dmedia%26token%3D6c03007e-e21e-4572-9237-124f6bef95a5&width=300&dpr=3&quality=100&sign=52d0c4ed&sv=2) /mute add[](https://documentation.botghost.com/server-management/moderation#mute-add) This command allows you to put a user in time-out /mute remove[](https://documentation.botghost.com/server-management/moderation#mute-remove) This command allows you to remove a timeout from a user /role add[](https://documentation.botghost.com/server-management/moderation#role-add) This command allows you to ddd a role to a user /role remove[](https://documentation.botghost.com/server-management/moderation#role-remove) This command allows you to remove a role from a user /role temp[](https://documentation.botghost.com/server-management/moderation#role-temp) This command allows you to temporarily give a user a role, this role will be removed after a selected amount of time /voice deaf[](https://documentation.botghost.com/server-management/moderation#voice-deaf) This command allows you to deafen someone in a voice channel /voice undeaf[](https://documentation.botghost.com/server-management/moderation#voice-undeaf) This command allows you to undeafen someone in a voice channel /kick[](https://documentation.botghost.com/server-management/moderation#kick) This command allows you to kick a user /case view[](https://documentation.botghost.com/server-management/moderation#case-view) This command allows you to get the content of a moderation case /note add[](https://documentation.botghost.com/server-management/moderation#note-add) This command allows you to add a note to a user /note remove[](https://documentation.botghost.com/server-management/moderation#note-remove) This command allows you to remove a note from a user /note view[](https://documentation.botghost.com/server-management/moderation#note-view) This command allows you to get the content of a note from a user /case remove[](https://documentation.botghost.com/server-management/moderation#case-remove) This command allows you to delete a moderation case /user history[](https://documentation.botghost.com/server-management/moderation#user-history) This command allows you to view the punishment history of a user /slowmode[](https://documentation.botghost.com/server-management/moderation#slowmode) This command allows you to enable or edit the slow mode setting of a channel /user clear-history[](https://documentation.botghost.com/server-management/moderation#user-clear-history) This command allows you to clear the punishment history of a user /warn[](https://documentation.botghost.com/server-management/moderation#warn) This command allows you to warn a user /ping[](https://documentation.botghost.com/server-management/moderation#ping) This command allows you to get the latency of the bot /purge[](https://documentation.botghost.com/server-management/moderation#purge) This command allows you to delete up to 100 messages at the same time from a channel /server-info[](https://documentation.botghost.com/server-management/moderation#server-info) This command allows you to get information about the server, such as the server name, member count, description and more /user nick[](https://documentation.botghost.com/server-management/moderation#user-nick) This command allows you to change the nickname of a user /channel lock[](https://documentation.botghost.com/server-management/moderation#channel-lock) This command allows you to change the channel permissions so that no one can send messages anymore /channel unlock[](https://documentation.botghost.com/server-management/moderation#channel-unlock) This command allows you to change the permissions in a channel back so that everyone can send messages again /say[](https://documentation.botghost.com/server-management/moderation#say) This command allows you to send a message with the bot. #### [](https://documentation.botghost.com/server-management/moderation#add-command) \[👑\] Add Command By clicking the add command button you can create your own command for the moderation module using all the module [variables](https://documentation.botghost.com/server-management/moderation#variables) and settings. [](https://documentation.botghost.com/server-management/moderation#events) Events -------------------------------------------------------------------------------------- ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fo04VONv6EDaawrOvLM1x%252Fimage.png%3Falt%3Dmedia%26token%3Dab9303f4-f614-46a4-aebb-4da8b24d21e2&width=768&dpr=3&quality=100&sign=a2aa3a05&sv=2) Moderation Handler[](https://documentation.botghost.com/server-management/moderation#moderation-handler) This event will enforce [the auto-punish settings](https://documentation.botghost.com/server-management/moderation#auto-punishment-settings) . Temporary Role & Ban Check[](https://documentation.botghost.com/server-management/moderation#temporary-role-and-ban-check) This command will make sure temporary roles or bans are removed on time. #### [](https://documentation.botghost.com/server-management/moderation#add-event) \[👑\] Add Event By clicking the add event button you can create your own event for the moderation module using all the module [variables](https://documentation.botghost.com/server-management/moderation#variables) and settings. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 5 months ago Was this helpful? * [Common Issues](https://documentation.botghost.com/server-management/moderation#common-issues) * [Roles not being added / removed](https://documentation.botghost.com/server-management/moderation#roles-not-being-added-removed) * [Users not being muted, kicked or banned](https://documentation.botghost.com/server-management/moderation#users-not-being-muted-kicked-or-banned) * [Watch the Tutorial](https://documentation.botghost.com/server-management/moderation#watch-the-tutorial) * [Settings](https://documentation.botghost.com/server-management/moderation#settings) * [Command Settings](https://documentation.botghost.com/server-management/moderation#command-settings) * [Visual Settings](https://documentation.botghost.com/server-management/moderation#visual-settings) * [Behaviour Settings](https://documentation.botghost.com/server-management/moderation#behaviour-settings) * [Auto-Punishment Settings](https://documentation.botghost.com/server-management/moderation#auto-punishment-settings) * [Punishments](https://documentation.botghost.com/server-management/moderation#punishments) * [Variables](https://documentation.botghost.com/server-management/moderation#variables) * [Commands](https://documentation.botghost.com/server-management/moderation#commands) * [Events](https://documentation.botghost.com/server-management/moderation#events) Was this helpful? --- # Timed Messages | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/messages/timed-messages.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F5QkFF2zKuzTPdCvbTxrI%252Fimage.png%3Falt%3Dmedia%26token%3Dd8a63c2c-66e8-42e0-bbee-0b1beb41552e&width=768&dpr=3&quality=100&sign=cd689bb8&sv=2) The [Timed Messages](https://dashboard.botghost.com/dashboard/module/5f1b4c67-b37b-487c-8287-a694b1e01ce8/timedmessages) module will have your bot send a message to channels at repeated scheduled intervals. [](https://documentation.botghost.com/messages/timed-messages#settings) Settings ------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/messages/timed-messages#create-timed-message) Create Timed Message New timed messages may be created within this part of the module. Click the add button at the very bottom left of this image to add it to the active timed messages. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FJtdTKtfFDMmgPq4eo4QB%252Fimage.png%3Falt%3Dmedia%26token%3D78b230c8-11c2-44fd-8ae5-91374df5e7ed&width=768&dpr=3&quality=100&sign=63c0984a&sv=2) #### [](https://documentation.botghost.com/messages/timed-messages#timed-message-name) **Timed Message Name** This field is the input for a unique name for the timed message. #### [](https://documentation.botghost.com/messages/timed-messages#channel-selection) **Channel Selection** Select any text or announcement channel in your server to send the timed message to. #### [](https://documentation.botghost.com/messages/timed-messages#time-interval-days) **Time Interval - Days** In this field is the delay amount in days between timed messages (If blank it defaults to 0). #### [](https://documentation.botghost.com/messages/timed-messages#time-interval-hours) **Time Interval - Hours** In this field is the delay amount in hours between timed messages (If blank it defaults to 0). #### [](https://documentation.botghost.com/messages/timed-messages#time-interval-minutes) **Time Interval - Minutes** Choose a delay between 0 and 60 minutes with 5-minute intervals. Default is 0 minutes. #### [](https://documentation.botghost.com/messages/timed-messages#message) **Message** This is where you can setup the contents of a [plain text](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/plain-text-reply) or [embed](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/embed-reply) message. You may toggle it by clicking on the switch in the corner. #### [](https://documentation.botghost.com/messages/timed-messages#block-stacked-messages) **Block Stacked Messages** If enabled, when the timed message is executed the bot will check if the last message in the channel was by your bot. If so it will skip the sending of this timed message. To save the timed message settings, you need to click "Add" in the bottom-right corner of the settings. This will reset the fields so you can set up another timed message. ### [](https://documentation.botghost.com/messages/timed-messages#active-timed-messages) Active Timed Messages These are timed events that are already created in the module and can be edited or deleted underneath the options to create / edit a new timed message. To save the edits you made on the rotating status's settings, you need to click "Edit" in the bottom-right corner of the settings. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FP55Pp3IIZxi5pFjPHqdh%252Fimage.png%3Falt%3Dmedia%26token%3Dd5fa8dd0-e19b-42d0-9fca-91de6fd46284&width=768&dpr=3&quality=100&sign=a1eb7132&sv=2) * * * [](https://documentation.botghost.com/messages/timed-messages#events) Events --------------------------------------------------------------------------------- In this area, you can view and modify the events of the Discord Automod module. Below you may find some information on each event of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FbI5XsbUFZqwRykk8nH4k%252Fimage.png%3Falt%3Dmedia%26token%3D0271c964-4b22-49fb-b4e1-dcc039123531&width=768&dpr=3&quality=100&sign=27813131&sv=2) Timed Messages Handler[](https://documentation.botghost.com/messages/timed-messages#timed-messages-handler) This event will search for all active timed events, loop through and send them at a specific interval. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/messages/timed-messages#settings) * [Create Timed Message](https://documentation.botghost.com/messages/timed-messages#create-timed-message) * [Active Timed Messages](https://documentation.botghost.com/messages/timed-messages#active-timed-messages) * [Events](https://documentation.botghost.com/messages/timed-messages#events) Was this helpful? --- # Polls | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/messages/polls.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F4dsZwmnQrnFzbTJgkMag%252Fimage.png%3Falt%3Dmedia%26token%3Dd1a52022-5542-4a87-92e5-2a9b5d592525&width=768&dpr=3&quality=100&sign=bb985953&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. Using the [Polls](https://dashboard.botghost.com/dashboard/module/a1cb21af-b61d-44a6-86b7-5180920fd49d/polls) module you can create and deploy fun and interactive polls for your server members to vote on that are highly customizable. [](https://documentation.botghost.com/messages/polls#settings) Settings ---------------------------------------------------------------------------- ### [](https://documentation.botghost.com/messages/polls#permission-settings) Permission Settings Customize the permissions for the polls. Ranging from editing role and channel permissions and more. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FtBXTL4iKweD6lBwafwst%252Fimage.png%3Falt%3Dmedia%26token%3Da388a15d-362e-4549-971c-8807f1fb9018&width=768&dpr=3&quality=100&sign=ae4fabee&sv=2) #### [](https://documentation.botghost.com/messages/polls#manager-roles) Manager Roles This option will allow you to select some roles to grant manager permissions to using the role dropdown, users with these roles will be able to run the poll-management commands of the module. #### [](https://documentation.botghost.com/messages/polls#whitelisted-channels) Whitelisted Channels This option will allow you to select some channels to restrict the modules usage. When at least one channel is added, users with the manager roles are the only ones who can post polls in that channel. #### [](https://documentation.botghost.com/messages/polls#blacklisted-roles) Blacklisted Roles In this field you can select some roles to block by using the role dropdown. Any user who has the blacklisted role will not be able to vote in a poll. #### [](https://documentation.botghost.com/messages/polls#single-choice) Single Choice This toggle will allow you to enable / disable single choice restrictions for polls. When enabled, users will only be able to choose a single option of the poll. This restriction only applies to one poll at a time. By default this is active. ### [](https://documentation.botghost.com/messages/polls#poll-settings) Poll Settings Configure the message and the contents of the poll in this section. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fw93kvXllu8RCJgtoPH7f%252Fimage.png%3Falt%3Dmedia%26token%3D48943e48-63b7-4ce2-8292-c9d2c6b3f79e&width=768&dpr=3&quality=100&sign=b111fde9&sv=2) #### [](https://documentation.botghost.com/messages/polls#embed-title) Embed Title This field allows you to define the title of the poll messages that get sent. The `{poll.question}` [variable](https://documentation.botghost.com/custom-commands-and-events/variables) can be used to return the configured question. #### [](https://documentation.botghost.com/messages/polls#embed-footer) Embed Footer In this field you can edit the [embed](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/embed-reply) footer for poll messages. #### [](https://documentation.botghost.com/messages/polls#embed-color) Embed Color With this field you can change the color of the poll embeds that get sent. #### [](https://documentation.botghost.com/messages/polls#show-posters-name) Show Posters Name Using this toggle you can choose whether to show the name of the user who posted the poll message. By default this is active. #### [](https://documentation.botghost.com/messages/polls#choice-reactions) Choice Reactions This section is where you can edit the poll emojis. They are in exact order as the questions are presented so it is not recommended to edit this. You can input the [Emoji ID](https://docs.botghost.com/getting-started/standard-practices/advanced-practices#how-can-i-get-a-custom-emojis-id) for custom emojis, or [unicode](https://emojipedia.org/) emojis supported in Discord. * * * [](https://documentation.botghost.com/messages/polls#commands) Commands ---------------------------------------------------------------------------- In this area, you can view and modify the commands of the Polls module. Below you may find some information on each command of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F7P3YAeVgEzfFQMp1XlK6%252Fimage.png%3Falt%3Dmedia%26token%3D5df59707-c7d2-4333-b6c6-2b349513a007&width=768&dpr=3&quality=100&sign=15068338&sv=2) /poll-create[](https://documentation.botghost.com/messages/polls#poll-create) This command allows a user to create a poll with a number of questions. /poll-end[](https://documentation.botghost.com/messages/polls#poll-end) This command is meant to end a active poll and can only be used by manager roles / admins. [](https://documentation.botghost.com/messages/polls#events) Events ------------------------------------------------------------------------ In this area, you can view and modify the events of the Polls module. Below you may find some information on each event of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F5tv698iD9z3tkuU8KhqQ%252Fimage.png%3Falt%3Dmedia%26token%3Dc8d9ade8-8a2b-46b5-9eec-b52bbf330c19&width=768&dpr=3&quality=100&sign=4cf3b18&sv=2) Polls Handler[](https://documentation.botghost.com/messages/polls#polls-handler) The Polls Handler event is the main event that tracks user reactions and counts the total poll votes for any active poll ongoing. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/messages/polls#settings) * [Permission Settings](https://documentation.botghost.com/messages/polls#permission-settings) * [Poll Settings](https://documentation.botghost.com/messages/polls#poll-settings) * [Commands](https://documentation.botghost.com/messages/polls#commands) * [Events](https://documentation.botghost.com/messages/polls#events) Was this helpful? --- # Starboard | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/community-engagement/starboard.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fr809Kc8C0I5BoriBAM5H%252Fimage.png%3Falt%3Dmedia%26token%3Dff637a86-7c38-4b70-a364-9c73f00fafa2&width=768&dpr=3&quality=100&sign=ff639809&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. The [Starboard](https://dashboard.botghost.com/dashboard/module/25f958e7-536c-464c-b3de-d8d4d07eb75a/starboard) module allows users in your server to vote for the most liked message, the message that has the most amount of votes is shared on a starboard for all users of your server to see! The system is based on users reacting to messages with a certain emoji, which are converted into "votes". [](https://documentation.botghost.com/community-engagement/starboard#settings) Settings -------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/community-engagement/starboard#settings-1) Settings In this section of the module, you can edit the main settings of the module. Some of these options are required for the module to work. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F6KknlY9xSdxrQfztpHLy%252Fimage.png%3Falt%3Dmedia%26token%3D853d2c0a-c276-4c75-994e-b885888b7321&width=768&dpr=3&quality=100&sign=6800acf8&sv=2) #### [](https://documentation.botghost.com/community-engagement/starboard#emoji) **Emoji** Here you can edit the emoji that the bot counts as a reaction, you may press on the plus (+) sign to add an emoji that will be used for the module. #### [](https://documentation.botghost.com/community-engagement/starboard#reactions-required) **Reactions Required** Here you can set the total number of reactions needed before the message is added to the starboard, the default value is set to 10. After the number is reached, the message will be posted into the starboard's channel. #### [](https://documentation.botghost.com/community-engagement/starboard#starboard-channel) **Starboard Channel** Set the channel that the starboard will be sent to when a message reaches the chosen number of reactions set in the [Reactions Required](https://documentation.botghost.com/community-engagement/starboard#reactions-required) setting. #### [](https://documentation.botghost.com/community-engagement/starboard#embed-color) **Embed Color** Edit the color of the embed message that is sent to the starboard channel. You can add custom colors by taking advantage of the HEX code input section. #### [](https://documentation.botghost.com/community-engagement/starboard#react-to-the-starboard-message) **React to the starboard message** Here you can enable or disable the bot automatically reacting to the starboard message when its posted to the starboard channel. Reactions to this message will not count towards the reaction count defined in the [Reactions Required](https://documentation.botghost.com/community-engagement/starboard#reactions-required) setting. #### [](https://documentation.botghost.com/community-engagement/starboard#delete-the-starboard-message) **Delete the starboard message** Here you can enable/disable a setting to make the bot automatically delete the starboard message sent in the defined starboard channel if the original message falls below the required reactions as defined in the [Reactions Required](https://documentation.botghost.com/community-engagement/starboard#reactions-required) setting. ### [](https://documentation.botghost.com/community-engagement/starboard#channels) Channels Here you can configure the channel settings for the module, this includes changing the blacklist type and picking the channels for the module to use in your server. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FYKdlsDnDudemWsi7d1Lc%252Fimage.png%3Falt%3Dmedia%26token%3D3705d8f3-8727-48cf-ae35-50dac7779958&width=768&dpr=3&quality=100&sign=c217e36f&sv=2) #### [](https://documentation.botghost.com/community-engagement/starboard#channel-restrictions) **Channel Restrictions** You can setup channel restrictions to allow the usage of voting on messages in certain channels. Blacklist type Description No Channel Restrictions Users will be able to vote on messages in all channels. Disable for these channels... Setting this blacklist type will disable voting on all channels selected. Enable for these channels.., Setting this blacklist type will enable voting on all channels selected. * * * [](https://documentation.botghost.com/community-engagement/starboard#events) Events ---------------------------------------------------------------------------------------- In this area, you can view and modify the events of the Starboard module. Below you may find some information on each event of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FdnDhAal7Xu4Q1MuDZmK3%252Fimage.png%3Falt%3Dmedia%26token%3D38366a27-7383-4410-a255-9aa589a8553e&width=768&dpr=3&quality=100&sign=4fe764c3&sv=2) Starboard Add[](https://documentation.botghost.com/community-engagement/starboard#starboard-add) This event is the main function for the starboard and counts all reactions added to the message if they meet the settings as defined in the module. Starboard Remove[](https://documentation.botghost.com/community-engagement/starboard#starboard-remove) This event will detect when reactions are removed from messages and trigger the [Delete the starboard message](https://documentation.botghost.com/community-engagement/starboard#delete-the-starboard-message) setting if it is enabled. * * * It's advised that you do not edit the events unless you have a good understanding of BotGhost and its Custom Events Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/community-engagement/starboard#settings) * [Settings](https://documentation.botghost.com/community-engagement/starboard#settings-1) * [Channels](https://documentation.botghost.com/community-engagement/starboard#channels) * [Events](https://documentation.botghost.com/community-engagement/starboard#events) Was this helpful? --- # Premium Check Condition | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/conditions/premium-check-condition.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FEc40Jwt2CoiI9etIcAbc%252Fimage.png%3Falt%3Dmedia%26token%3D89c0c4df-32a7-4996-b9c8-15d308565486&width=768&dpr=3&quality=100&sign=6f9e98c1&sv=2) The premium check condition allows you to run actions based off if your bot has premium or not. This condition is mainly used in BotGhost's pre-built modules, however it can be used in any command / event you create. The red block runs when the bot is not premium, while the green one runs when the bot is currently premium. The condition has no settings. Here is a layout for this condition: ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FymtEexK6YwZ140TpEDnc%252Fimage.png%3Falt%3Dmedia%26token%3D91a21c39-9a11-4db9-96aa-7d34ddf9ef42&width=768&dpr=3&quality=100&sign=3af51afe&sv=2) Last updated 2 years ago Was this helpful? Was this helpful? --- # Objects | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/data-storage/objects.md) . Objects are a special data type usually used to store a "group" of data. For example, they can be used to store the birthday of an user, which is made by the day of birth, month and year. They can also be helpful when creating an economy system: you can use an object to store the inventory of a specific user. Here are some examples of object references and their values: * `{BGVAR_object_variable.day}` - 1 * `{BGVAR_object_variable.month}` - 7 * `{BGVAR_object_variable.year}` - 1979 [](https://documentation.botghost.com/custom-commands-and-events/data-storage/objects#how-values-are-stored-in-objects) How Values Are Stored In Objects ------------------------------------------------------------------------------------------------------------------------------------------------------------- Objects store values as properties. Each property has a name (key) and a value that you can assign as base value. In the example above, the "object variable" variable has three properties: "day", "month", and "year". These properties hold the values "1", "7", and "1979", respectively. Objects also have default values you are able to set when creating them in [data storage](https://documentation.botghost.com/custom-commands-and-events/data-storage) . Likewise you are able to remove keys from here as well. In addition to default values, you can create new keys during commands or events by using either the [Set Variable](https://documentation.botghost.com/custom-commands-and-events/actions/custom-variable-actions/set-variable) or [Run Equation on Variable](https://documentation.botghost.com/custom-commands-and-events/actions/custom-variable-actions/run-equation-on-variable) action blocks. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FUqPPwq8o5MkUqVkDvKyh%252Fimage_2024-06-06_182806236.png%3Falt%3Dmedia%26token%3Dea4026dd-db0c-4c0d-a5df-4b4564ba0cfa&width=768&dpr=3&quality=100&sign=8894a588&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/data-storage/objects#displaying-object-values) Displaying Object Values --------------------------------------------------------------------------------------------------------------------------------------------- To display values stored in the object variable, you use a dot notation between the object's variable name, followed by a dot, and the property (key) name. The same key name can be used across different objects, but cannot be used twice in the same object. For example: * `{BGVAR_object_variable.day}` * `{BGVAR_object_variable.year}` * `{BGVAR_cool_variable.day}` This variable can be used anywhere in your command builder and will retrieve the corresponding value for the given object and property. ### [](https://documentation.botghost.com/custom-commands-and-events/data-storage/objects#targeting) Targeting Targeting also works for object variables, when they are user or channel specific. Just like regular variables, you can add the square brackets \[\] at the end of the variable providing the user / channel target, for example: * `{BGVAR_object_variable.day[option_user]}` * `{BGVAR_object_variable.day[{bot_id}]}` * `{BGVAR_object_variable.day[136327647792726016]}` * `{BGVAR_object_variable.day[option_channel]}` * `{BGVAR_object_variable.day[{first_channel_id}]}` If no target is provided, the value of the user who triggered the last interaction (command, event, button or select menu) will be returned for user objects, and the value of the channel the last interaction has been triggered in (command, event, button or select menu) will be returned. [](https://documentation.botghost.com/custom-commands-and-events/data-storage/objects#updating-values) Updating Values --------------------------------------------------------------------------------------------------------------------------- To update a value into an object using any of these 3 action blocks: Block Information [Set Variable](https://documentation.botghost.com/custom-commands-and-events/actions/custom-variable-actions/set-variable) Object variables selected in this block will allow you to set a value for a specific key. [Run Equation on Variable](https://documentation.botghost.com/custom-commands-and-events/actions/custom-variable-actions/run-equation-on-variable) For this action block, a specific key's value will be set as the result of an equation. [Delete Variable](https://documentation.botghost.com/custom-commands-and-events/actions/custom-variable-actions/delete-variable) This action block will allow you to delete a specific key's value or all key values from an object. Check out the object sections on the pages for these actions by clicking the links above for more information. Last updated 5 months ago Was this helpful? * [How Values Are Stored In Objects](https://documentation.botghost.com/custom-commands-and-events/data-storage/objects#how-values-are-stored-in-objects) * [Displaying Object Values](https://documentation.botghost.com/custom-commands-and-events/data-storage/objects#displaying-object-values) * [Targeting](https://documentation.botghost.com/custom-commands-and-events/data-storage/objects#targeting) * [Updating Values](https://documentation.botghost.com/custom-commands-and-events/data-storage/objects#updating-values) Was this helpful? --- # ChatGPT | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/ai/chatgpt.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FIGEqfo6ah0JC5a0kx2F8%252Fimage.png%3Falt%3Dmedia%26token%3Db822a1c9-c7da-4e63-b1dd-8b0bc79329a1&width=768&dpr=3&quality=100&sign=a1e98946&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. The [ChatGPT](https://dashboard.botghost.com/dashboard/module/6e8c5384-e6f8-4282-8125-5ca9b53242c8/chatgpt) module allows users to hold conversations with their bot by using the OpenAI GPT 3.5 Turbo - GPT 4 software. Get it to tell you stories or ask some advanced questions. [](https://documentation.botghost.com/ai/chatgpt#common-issues) Common Issues ---------------------------------------------------------------------------------- Experiencing issues with the module? Check out the common issues below. If your issue is not listed in this page, make sure your module is updated to the latest version. If you are still experiencing issues with the module, join our [support server](https://discord.gg/botghost) to ask for further help. ### [](https://documentation.botghost.com/ai/chatgpt#ai-commands-return-a-429-error) AI commands return a 429 error If a `429` error is returned when trying to use ChatGPT's AI commands, please try the steps below. 1 The OpenAI (ChatGPT) 429 error means your free trial of the API key you're using has expired. To extend your quota and continue using OpenAI, you need to enter your billing details. You can do that in the [OpenAI Developer Platform](https://openai.com/api/) . 2 If you're still experiencing issues, join our [support server](https://discord.gg/botghost) to ask for further help, we'll do our best to solve your issue! * * * [](https://documentation.botghost.com/ai/chatgpt#credentials-setup) Credentials Setup ------------------------------------------------------------------------------------------ 1 Click [here](https://platform.openai.com/account/api-keys) to get started. Log into OpenAI. If you haven't already, Open AI might ask you to verify your phone number before proceeding. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fq9GPD8gYEEKSUJUdOUT0%252Fimage.png%3Falt%3Dmedia%26token%3D21258ead-278d-4369-9e6e-8c74720216e0&width=768&dpr=3&quality=100&sign=4db4d6a7&sv=2) 2 Once you logged in, click on the "Create new secret key button. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FS7gwMVMFJzgROIn9FgNg%252Fimage.png%3Falt%3Dmedia%26token%3D4c28f2f7-66d6-4ffc-a30c-fca4aa336669&width=768&dpr=3&quality=100&sign=7a7c3f78&sv=2) 3 This will prompt you to make a key. Set Owned by "You" and give your app a name. Set the "Permissions" to all. Once done, click on "Create Secret Key" ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F8jDcjid6nM0pn1C4FEQY%252Fimage.png%3Falt%3Dmedia%26token%3Def74a1c9-be35-4a97-8993-e0f087a4c170&width=768&dpr=3&quality=100&sign=372fc88c&sv=2) 4 Copy your key. Make sure to not share it with anyone. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Ft5wYLfCDF4amFI8F4pjO%252FUntitled%2520design.png%3Falt%3Dmedia%26token%3D92f2b404-4afc-45c8-93ba-6316f89c861f&width=768&dpr=3&quality=100&sign=60a63e3b&sv=2) 5 Paste your key into the BotGhost Dashboard in [the OpenAI API Key field](https://documentation.botghost.com/ai/chatgpt#openai-api-key) . * * * [](https://documentation.botghost.com/ai/chatgpt#settings) Settings ------------------------------------------------------------------------ ### [](https://documentation.botghost.com/ai/chatgpt#general-settings) General Settings In this area, you can setup and customize the general settings for the commands and events of this module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FyDrSuSkd8Cg52JGEd2GW%252Fimage.png%3Falt%3Dmedia%26token%3D8b4f24e7-c0e1-4d7e-bfc7-1b2a45277739&width=768&dpr=3&quality=100&sign=99c24fb4&sv=2) #### [](https://documentation.botghost.com/ai/chatgpt#embeds-color) Embeds Color In this setting you can select the color of the embeds in this module. When the bot responds using an embed, the embed will use this color. #### [](https://documentation.botghost.com/ai/chatgpt#openai-api-key) OpenAI API Key In this field is where you will need to enter your OpenAI API key to be able to use the module, you can follow this guide [here](https://platform.openai.com/docs/api-reference/authentication) , to generate your own API key. ### [](https://documentation.botghost.com/ai/chatgpt#respond-command) Respond Command In this area, you can setup and customize the settings of the response command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FlBlUGizCM3CF76GyXwga%252Fimage.png%3Falt%3Dmedia%26token%3Da414152a-d965-47e4-b3a8-00759d65be91&width=768&dpr=3&quality=100&sign=319bfc0e&sv=2) #### [](https://documentation.botghost.com/ai/chatgpt#response-command) Response Command You can toggle this switch to either enable or disable the respond command. This toggle needs to be enabled in order to show the settings below. #### [](https://documentation.botghost.com/ai/chatgpt#model) Model In this section you can select what model of ChatGPT you want to use. The selected Model will reply to the respond command. #### [](https://documentation.botghost.com/ai/chatgpt#channel-restrictions-blacklist-type) Channel Restrictions - Blacklist Type In this menu you can choose the criteria you want to follow to disable the command in certain channels. In the table below you can read what you can choose from. Type Details No Channel Restrictions If this option is selected, no channel restrictions will be applied. Disable for these channels Based on the channels input, the module will not respond in this channel. Enable these channels Based on the channels input, the module will only respond in this channel #### [](https://documentation.botghost.com/ai/chatgpt#channel-restrictions-select-channels) Channel Restrictions - Select Channels In this channel selector you can select the channels that you wish to allow or that you wish to disallow, depending on the selection you made in the [Blacklist Type](https://documentation.botghost.com/ai/chatgpt#channel-restrictions-blacklist-type) . #### [](https://documentation.botghost.com/ai/chatgpt#role-restrictions-blacklist-type) Role Restrictions - Blacklist Type In this menu you can choose the criteria you want to follow to blacklist certain roles from using the command. In the table below you can read what you can choose from. Type Details No Role Restrictions If this option is selected, no role restrictions will be applied. Disable for these roles Based on the role input, the module will not respond to this role. Enable these roles Based on the channels input, the module will only respond to this role. #### [](https://documentation.botghost.com/ai/chatgpt#role-restrictions-select-roles) Role Restrictions - Select Roles In this channel selector you can select the roles that you wish to allow or that you wish to disallow, depending on the selection you made in the [Blacklist Type](https://documentation.botghost.com/ai/chatgpt#role-restrictions-blacklist-type) . #### [](https://documentation.botghost.com/ai/chatgpt#personality) Personality In this field you can describe the personality the responses from the command should follow. ### [](https://documentation.botghost.com/ai/chatgpt#edit-text-command) Edit Text Command In this area, you can setup and customize the settings of the text command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FeOLKtRYUOSanymXv4mOm%252Fimage.png%3Falt%3Dmedia%26token%3Dfebfd229-c0fb-4e1c-97ab-8f0bfe355933&width=768&dpr=3&quality=100&sign=898cb266&sv=2) #### [](https://documentation.botghost.com/ai/chatgpt#edit-text-command-1) Edit Text Command You can toggle this switch to either enable or disable the text command. This toggle needs to be enabled in order to show the settings below. #### [](https://documentation.botghost.com/ai/chatgpt#channel-restrictions-blacklist-type-1) Channel Restrictions - Blacklist Type In this menu you can choose the criteria you want to follow to disable the command in certain channels. In the table below you can read what you can choose from. Type Details No Channel Restrictions If this option is selected, no channel restrictions will be applied. Disable for these channels Based on the channels input, the module will not respond in this channel. Enable these channels Based on the channels input, the module will only respond in this channel #### [](https://documentation.botghost.com/ai/chatgpt#channel-restrictions-select-channels-1) Channel Restrictions - Select Channels In this channel selector you can select the channels that you wish to allow or that you wish to disallow, depending on the selection you made in the [Blacklist Type](https://documentation.botghost.com/ai/chatgpt#channel-restrictions-blacklist-type-1) . #### [](https://documentation.botghost.com/ai/chatgpt#role-restrictions-blacklist-type-1) Role Restrictions - Blacklist Type In this menu you can choose the criteria you want to follow to blacklist certain roles from using the command. In the table below you can read what you can choose from. Type Details No Role Restrictions If this option is selected, no role restrictions will be applied. Disable for these roles Based on the role input, the module will not respond to this role. Enable these roles Based on the channels input, the module will only respond to this role. #### [](https://documentation.botghost.com/ai/chatgpt#role-restrictions-select-roles-1) Role Restrictions - Select Roles In this channel selector you can select the roles that you wish to allow or that you wish to disallow, depending on the selection you made in the [Blacklist Type](https://documentation.botghost.com/ai/chatgpt#role-restrictions-blacklist-type-1) . ### [](https://documentation.botghost.com/ai/chatgpt#chat-mode) Chat Mode In this section you can set up the chat mode for certain channels by adding them here. When chat mode is enabled, your bot will respond to messages in a channel. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fwj20LsnyKyrh4yAqkcRr%252Fimage.png%3Falt%3Dmedia%26token%3D79ba7e92-e764-477e-8a68-a7bba8142085&width=768&dpr=3&quality=100&sign=832085b2&sv=2) #### [](https://documentation.botghost.com/ai/chatgpt#channel) Channel In this menu you can select the channel where you want to enable the chat mode. #### [](https://documentation.botghost.com/ai/chatgpt#model-1) Model In this section you can select what model of ChatGPT you want to use. The selected model will be used to reply to a message. #### [](https://documentation.botghost.com/ai/chatgpt#reply-to-mentions-only) Reply to mentions only This toggle can be enabled if you only want the bot to respond to @mentions, or disabled when you want the bot to respond to every message. #### [](https://documentation.botghost.com/ai/chatgpt#response-type) Response Type In this section you can select whether you want the bot to respond with plain text or embeds. #### [](https://documentation.botghost.com/ai/chatgpt#personality-1) Personality In this field you can describe the personality the responses from the bot should follow. ### [](https://documentation.botghost.com/ai/chatgpt#role-restrictions-blacklist-type-2) Role Restrictions - Blacklist Type In this menu you can choose the criteria you want to follow to blacklist certain roles from using the module. In the table below you can read what you can choose from. Type Details No Role Restrictions If this option is selected, no role restrictions will be applied. Disable for these roles Based on the role input, the module will not respond to this role. Enable these roles Based on the channels input, the module will only respond to this role. ### [](https://documentation.botghost.com/ai/chatgpt#role-restrictions-select-roles-2) Role Restrictions - Select Roles In this channel selector you can select the roles that you wish to allow or that you wish to disallow, depending on the selection you made in the [Blacklist Type](https://documentation.botghost.com/ai/chatgpt#role-restrictions-blacklist-type-2) . To save the channel's settings, you need to click "Add" in the bottom-right corner of the settings. ### [](https://documentation.botghost.com/ai/chatgpt#your-chat-mode-channels) Your Chat Mode Channels Here you can edit your currently active chat modes. You can use the same settings as in the [Chat Mode](https://documentation.botghost.com/ai/chatgpt#chat-mode) section. You are able to edit / delete chat modes with the buttons in the bottom right. You can add up to 100 unique chat modes. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FG90Fge3rsFScptERTpFc%252Fimage.png%3Falt%3Dmedia%26token%3D830fa9b5-bbe5-4598-ac37-cd3fa67131b7&width=768&dpr=3&quality=100&sign=76b02743&sv=2) * * * [](https://documentation.botghost.com/ai/chatgpt#commands) Commands ------------------------------------------------------------------------ In this area, you can view and modify the commands of the ChatGPT module. Below you may find some information on each command of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FWRWVH9epiZTp1UVEZJb8%252Fimage.png%3Falt%3Dmedia%26token%3Dd6a78009-7636-4cb0-9cb6-1a2b72bc2c5d&width=768&dpr=3&quality=100&sign=d7ff37df&sv=2) /respond[](https://documentation.botghost.com/ai/chatgpt#respond) This command when triggered, will send an AI-generated chat response to whatever prompt you input. /edit-text[](https://documentation.botghost.com/ai/chatgpt#edit-text) This command when triggered will edit any text that is input. #### [](https://documentation.botghost.com/ai/chatgpt#add-command) \[👑\] Add Command By clicking the add command button you can create your own command for the ChatGPT module using all the module [variables](https://documentation.botghost.com/custom-commands-and-events/variables) and settings. [](https://documentation.botghost.com/ai/chatgpt#events) Events -------------------------------------------------------------------- In this area, you can view and modify the events of the ChatGPT module. Below you may find some information on each event of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F8ZDoSGbijA9xLlaBZPQ4%252Fimage.png%3Falt%3Dmedia%26token%3D6f005345-741e-4a58-9aa0-2f6d4c3433aa&width=768&dpr=3&quality=100&sign=5e13e548&sv=2) ChatGPT[](https://documentation.botghost.com/ai/chatgpt#chatgpt) This is the only event for the GPT module, it handles all the auto responses from the AI and more. You can edit the event to add new additions, fine tune responses and much more. **\[👑\] Add Event** By clicking the add event button you can create your own event for the ChatGPT module using all the module [variables](https://documentation.botghost.com/custom-commands-and-events/variables) and settings. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 7 months ago Was this helpful? * [Common Issues](https://documentation.botghost.com/ai/chatgpt#common-issues) * [AI commands return a 429 error](https://documentation.botghost.com/ai/chatgpt#ai-commands-return-a-429-error) * [Credentials Setup](https://documentation.botghost.com/ai/chatgpt#credentials-setup) * [Settings](https://documentation.botghost.com/ai/chatgpt#settings) * [General Settings](https://documentation.botghost.com/ai/chatgpt#general-settings) * [Respond Command](https://documentation.botghost.com/ai/chatgpt#respond-command) * [Edit Text Command](https://documentation.botghost.com/ai/chatgpt#edit-text-command) * [Chat Mode](https://documentation.botghost.com/ai/chatgpt#chat-mode) * [Role Restrictions - Blacklist Type](https://documentation.botghost.com/ai/chatgpt#role-restrictions-blacklist-type-2) * [Role Restrictions - Select Roles](https://documentation.botghost.com/ai/chatgpt#role-restrictions-select-roles-2) * [Your Chat Mode Channels](https://documentation.botghost.com/ai/chatgpt#your-chat-mode-channels) * [Commands](https://documentation.botghost.com/ai/chatgpt#commands) * [Events](https://documentation.botghost.com/ai/chatgpt#events) Was this helpful? --- # Sticky Roles | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/server-management/sticky-roles.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FfmzU0qWKkiLl0djSGk6O%252Fimage.png%3Falt%3Dmedia%26token%3D2980beda-2307-42e1-9811-ea23dd3a4234&width=768&dpr=3&quality=100&sign=7fef757e&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. The [Sticky Roles](https://dashboard.botghost.com/dashboard/module/911f6c91-a771-4cd7-b848-807bf4bd6588/stickyroles) module will allow server members to regain some or all of their roles upon leaving and rejoining the server. [](https://documentation.botghost.com/server-management/sticky-roles#settings) Settings -------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/server-management/sticky-roles#role-settings) Role Settings In this area, you can customize how the module functions. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F1HOPihtxYb7baJ3iFiff%252Fimage.png%3Falt%3Dmedia%26token%3D84c36b54-ccee-4c3a-bfc8-8c2ef05cd3b3&width=768&dpr=3&quality=100&sign=8bd3849&sv=2) #### [](https://documentation.botghost.com/server-management/sticky-roles#role-filtering-type) **Role Filtering Type** This is how you specify if certain roles should be added upon rejoining or excluded. Type Details Ignored Roles This selector is how you choose what roles should not be added when a user rejoins. Keep in mind that if this option is enabled, then all other roles besides the ones selected will be added to the user. Allowed Roles This selector is how you choose sticky roles that get added to a user when they rejoin. Excluding roles from the selector while this option is enabled will result in those roles simply not being added. #### [](https://documentation.botghost.com/server-management/sticky-roles#ignore-moderation-actions) **Ignore Moderation Actions** If this switch is enabled then the bot will ignore moderation actions, so if a user is banned or kicked it will still add them upon rejoining. However it is the opposite if it's disabled. #### [](https://documentation.botghost.com/server-management/sticky-roles#send-direct-message) **Send Direct Message** Here you may toggle whether members who get roles back upon rejoining will receive a direct message with a list of those roles. #### [](https://documentation.botghost.com/server-management/sticky-roles#direct-message-setup) **Direct Message Setup** If the direct message option is enabled, then you can configure the message. The message can be toggled to [plain text](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/plain-text-reply) or [embed](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/embed-reply) type and will be sent upon rejoining along with the roles. You can use the `{roles}` [variable](https://documentation.botghost.com/custom-commands-and-events/variables) to list all the roles that were added when the user rejoined. * * * [](https://documentation.botghost.com/server-management/sticky-roles#events) Events ---------------------------------------------------------------------------------------- In this area, you can view and modify the events of the Sticky Roles module. Below you may find some information on each event of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FI6aKSsuvAhoygE0obSn6%252FScreenshot%25202024-01-12%2520210341.png%3Falt%3Dmedia%26token%3D674e09a4-af99-4103-90ea-acbac33a0d01&width=768&dpr=3&quality=100&sign=9d4fac36&sv=2) Events of the sticky roles module Leave Handler[](https://documentation.botghost.com/server-management/sticky-roles#leave-handler) This event stores the roles that a user had upon leaving the server into a custom variable. Join Handler[](https://documentation.botghost.com/server-management/sticky-roles#join-handler) This event re-assigns the stored roles that should be assigned according to the module's customization, and DMs the user if/with any roles were re-assigned (if enabled). * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/server-management/sticky-roles#settings) * [Role Settings](https://documentation.botghost.com/server-management/sticky-roles#role-settings) * [Events](https://documentation.botghost.com/server-management/sticky-roles#events) Was this helpful? --- # Collections | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/data-storage/collections.md) . Collections or arrays are a special data storage type that allows you to store a group of text or numbers. Collections consist of an ordered list using numbered indexes starting from 0 to access specific data. [](https://documentation.botghost.com/custom-commands-and-events/data-storage/collections#how-values-are-stored-in-collections) How Values Are Stored In Collections ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Collection values are stored on positions in the collection. Each position has it's own number to access it, starting at 0. Every value is seperated with a comma. Collections also have default values you are able to set when creating or editing a variable in the [data storage](https://documentation.botghost.com/custom-commands-and-events/data-storage) module. Here are some examples of collection references and their values or arrays: * `{BGVAR_collection}` - \[hello, world, abc, xyz\] * `{valueAtPosition({BGVAR_collection}),[2]}` - abc * `{lengthOfCollection({BGVAR_collection})}` - 4 Collection positions always start at 0. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FPoHv00NF79HdRjbbyAXY%252Fimage.png%3Falt%3Dmedia%26token%3D01d6801d-1366-433b-aad9-ed6f8ed4416d&width=768&dpr=3&quality=100&sign=fb97bc45&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/data-storage/collections#displaying-collection-values) Displaying Collection Values --------------------------------------------------------------------------------------------------------------------------------------------------------- To display values stored in the collection variable, you can target the position of the value. You can also use other variables to access the data in other ways. Below are some examples of targeting positions in the collection variable: * `{BGVAR_collection}` - \[hello, world, abc, xyz\] * `{valueAtPosition({BGVAR_collection}),[0]}` - hello * `{valueAtPosition({BGVAR_collection}),[1]}` - world * `{valueAtPosition({BGVAR_collection}),[2]}` - abc This variable can be used anywhere in your command and event builder and will retrieve the corresponding value for the given position of the collection. ### [](https://documentation.botghost.com/custom-commands-and-events/data-storage/collections#collection-variables) Collection Variables BotGhost offers some variables you can use for any array or collection (even from an [API response](https://documentation.botghost.com/custom-commands-and-events/actions/api-actions/send-an-api-request) ), which allow you to retrieve specific information of the collection. To know more about them, check out the [Variables](https://documentation.botghost.com/custom-commands-and-events/variables#collection-array-variables) page. ### [](https://documentation.botghost.com/custom-commands-and-events/data-storage/collections#targeting) Targeting Targeting also works for collection variables, when they are user or channel specific. Just like regular variables, you can add the square brackets \[\] at the end of the base variable providing the user / channel target, for example: * `{BGVAR_collection[user_id]}` * `{valueAtPosition({BGVAR_collection[user_id]}),[0]}` If no target is provided, the value of the user who triggered the last interaction (command, event, button or select menu) will be returned for user collections, or the value of the channel the last interaction has been triggered in (command, event, button or select menu) will be returned for channel collections. [](https://documentation.botghost.com/custom-commands-and-events/data-storage/collections#updating-collection-values) Updating Collection Values ----------------------------------------------------------------------------------------------------------------------------------------------------- To update a collection value, you can use one of the [variable actions](https://documentation.botghost.com/custom-commands-and-events/actions/custom-variable-actions) below: Block Information [Set Variable](https://documentation.botghost.com/custom-commands-and-events/actions/custom-variable-actions/set-variable) Collection variables selected in this block will allow you to set a value somewhere in a collection. [Delete Variable](https://documentation.botghost.com/custom-commands-and-events/actions/custom-variable-actions/delete-variable) This action block will allow you to delete a collection value. You can not use the Run Equation on Variable action on collections. Last updated 5 months ago Was this helpful? * [How Values Are Stored In Collections](https://documentation.botghost.com/custom-commands-and-events/data-storage/collections#how-values-are-stored-in-collections) * [Displaying Collection Values](https://documentation.botghost.com/custom-commands-and-events/data-storage/collections#displaying-collection-values) * [Collection Variables](https://documentation.botghost.com/custom-commands-and-events/data-storage/collections#collection-variables) * [Targeting](https://documentation.botghost.com/custom-commands-and-events/data-storage/collections#targeting) * [Updating Collection Values](https://documentation.botghost.com/custom-commands-and-events/data-storage/collections#updating-collection-values) Was this helpful? --- # Text Option | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/options/text-option.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FOEnyceQEyRuR0vXgO2jn%252Fimage_2024-06-07_184243639.png%3Falt%3Dmedia%26token%3Dce229746-94be-4e37-ae3c-540f85cc7383&width=768&dpr=3&quality=100&sign=49959e31&sv=2) This block is a plain text option which allows you input a text value when entering your command on Discord. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FZP6uX7IQrs9XWxdqOctu%252Fimage_2024-06-07_152906910.png%3Falt%3Dmedia%26token%3D93573c75-2de7-4f75-9b96-08486e96f4ec&width=768&dpr=3&quality=100&sign=b472c4d8&sv=2) You can retrieve the variable of the option via the **Clipboard** or the block itself. The format of the variable is `{option_optionname}`, where `optionname` is the [name](https://documentation.botghost.com/custom-commands-and-events/options/text-option#option-name) of the option. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F5dvEmba03gvfHMjFjokE%252Fimage_2024-06-08_123442535.png%3Falt%3Dmedia%26token%3Da1564e92-1ba0-4fbf-9151-003521c47a41&width=768&dpr=3&quality=100&sign=7426c7ee&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/text-option#option-name) Option Name ------------------------------------------------------------------------------------------------------------------ This field requires an input for your unique option name. The designated name will then be the reference for your option variable. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FwTAFb2w3JpWegq566V00%252Fimage_2024-06-07_153049549.png%3Falt%3Dmedia%26token%3D50705416-b8b0-419a-a0c3-79c3dd81af18&width=768&dpr=3&quality=100&sign=2d437f60&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/text-option#option-description) Option Description -------------------------------------------------------------------------------------------------------------------------------- The option description field allows you to assign a custom description to your option. It is useful to describe what the option is used for. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FvOMtQ8MVXEwV3Bu4T1zJ%252Fimage_2024-06-07_153207575.png%3Falt%3Dmedia%26token%3D6cf2c0c3-3507-42fd-9569-0139e423c7d3&width=768&dpr=3&quality=100&sign=c48cd3fe&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/text-option#set-required) Set Required -------------------------------------------------------------------------------------------------------------------- With this switch you are able to toggle if the option should be required or not in order to execute the command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F8ZGjl7ltB5dMKqO6Xbja%252Fimage_2024-06-07_153303596.png%3Falt%3Dmedia%26token%3De487b34e-973a-4c52-93db-c2ebebfb6669&width=768&dpr=3&quality=100&sign=60842cc5&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/text-option#add-choices) Add Choices ------------------------------------------------------------------------------------------------------------------ This is an optional section is where you can add choices into your option. Choices allow the user to select something from a fixed set of values. There is a maximum number of 25 choices. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FvBWwEUVG2a0f7KvvrqQw%252Fimage_2024-06-07_153511286.png%3Falt%3Dmedia%26token%3Dfd5dfd36-b4ec-4be1-9bc2-4f2f1c3a72c6&width=768&dpr=3&quality=100&sign=3ff0b47f&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FVGSWUkH0jSJP5LfJxZIc%252Fimage_2024-06-07_180957726.png%3Falt%3Dmedia%26token%3D3c8a00d0-c11e-452f-bd49-c041d43c31e6&width=768&dpr=3&quality=100&sign=96d08a8e&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/text-option#autocomplete) Autocomplete -------------------------------------------------------------------------------------------------------------------- Autocomplete is a feature for slash command text options that shows users a list of suggestions as they type. It makes commands easier to use, reduces typing errors, and creates a smoother experience. Unlike [choices](https://documentation.botghost.com/custom-commands-and-events/options/text-option#add-choices) , the autocomplete feature will add choices to the action that are not required to be the same, meaning you can follow them, but it's not mandatory. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FPmwaUKOrDBtewSRJGSbb%252Fimage.png%3Falt%3Dmedia%26token%3D039c0fdf-2ef8-4725-bf31-76618ad10b81&width=768&dpr=3&quality=100&sign=e2ce88a3&sv=2) Autocomplete can be configured by pressing the "Configure Autocomplete" button located in the settings of the text option. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F12rlKhf0Dha47i8rIS5I%252Fimage.png%3Falt%3Dmedia%26token%3D46f816ff-701a-4bee-b8c9-3b8984aaf696&width=768&dpr=3&quality=100&sign=dc8630b9&sv=2) Basic Mode Bulk Mode The basic settings have been enabled by default when you start to configure autocomplete. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F4oN6zQgQuGEoyIyHI63A%252Fimage.png%3Falt%3Dmedia%26token%3D6ed9f219-f07c-4b9c-ba07-244788b8a691&width=768&dpr=3&quality=100&sign=2dbb4839&sv=2) ### [](https://documentation.botghost.com/custom-commands-and-events/options/text-option#choices) Choices Choices can be addded by pressing the "Add Autocomplete Choice" in the image above. #### [](https://documentation.botghost.com/custom-commands-and-events/options/text-option#label) Label The label is what's shown as choice to the user when they use the command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FPmwaUKOrDBtewSRJGSbb%252Fimage.png%3Falt%3Dmedia%26token%3D039c0fdf-2ef8-4725-bf31-76618ad10b81&width=768&dpr=3&quality=100&sign=e2ce88a3&sv=2) #### [](https://documentation.botghost.com/custom-commands-and-events/options/text-option#value) Value The value is what is returned as the `{option_optionname}` variable. The value is not visible to the user and can be something else than the label. To access bulk mode, you have to enable it in the top of the autocomplete configuration. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FhOQwoxnPMhOO6H82nBXb%252Fimage.png%3Falt%3Dmedia%26token%3D4fc2e502-4201-46a3-bbe7-51f1baaa36af&width=768&dpr=3&quality=100&sign=192a8ffc&sv=2) ### [](https://documentation.botghost.com/custom-commands-and-events/options/text-option#bulk-choices) Bulk Choices Bulk choices can be added by pasting the lable and value seperated with a comma. An example can be found below: When you have added the choices, simple press the "Parse and Replace Choices" button below the field. The choices will then also be visible when in Basic Mode. Last updated 6 months ago Was this helpful? * [Option Name](https://documentation.botghost.com/custom-commands-and-events/options/text-option#option-name) * [Option Description](https://documentation.botghost.com/custom-commands-and-events/options/text-option#option-description) * [Set Required](https://documentation.botghost.com/custom-commands-and-events/options/text-option#set-required) * [Add Choices](https://documentation.botghost.com/custom-commands-and-events/options/text-option#add-choices) * [Autocomplete](https://documentation.botghost.com/custom-commands-and-events/options/text-option#autocomplete) Was this helpful? Copy label1,value1 label2,value2 label3,value3 --- # Suggestions | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/community-engagement/suggestions.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FECBha9Elhl6l0VgBCqpz%252Fimage.png%3Falt%3Dmedia%26token%3Dd78ec4d0-9be2-4907-9221-81ae219604db&width=768&dpr=3&quality=100&sign=c026c6c9&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. With the [Suggestions](https://dashboard.botghost.com/dashboard/module/17d130ca-5b40-4554-b11d-ffd889673915/suggestions) module you can setup a system that allows users to provide suggestions for your server or other things to suggest on of your choice. Users can create suggestions, vote or downvote on other suggestions, and more. Your server's moderators may approve or deny your server's suggestions. [](https://documentation.botghost.com/community-engagement/suggestions#settings) Settings ---------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/community-engagement/suggestions#submit-a-suggestion) Submit a Suggestion In this area, you can customize how your bots' users will submit their suggestions. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F2dDdyxSl5ozjaD7QFyU8%252Fimage.png%3Falt%3Dmedia%26token%3Dd185d3fd-b213-4b51-906b-3f32aed66a0a&width=768&dpr=3&quality=100&sign=1877b6d6&sv=2) Submit a suggestion portion of the suggestions module #### [](https://documentation.botghost.com/community-engagement/suggestions#title) **Title** Here you may choose whether you want your members to be able to, unable to, or have to add a title. The default value for this is set to Disabled. Value Details Disabled Users cannot add a title for their suggestion. Enabled Users can optionally add a title for their suggestion. Enabled and Required Users are required to add a title for their suggestion. #### [](https://documentation.botghost.com/community-engagement/suggestions#image) **Image** Here you may choose whether you want your members to be able to, unable to, or have to add an image. The default value for this is set to Disabled. Value Details Disabled Users cannot upload an image for their suggestion. Enabled Users can optionally upload an image for their suggestion. Enabled and Required Users are required to upload an image for their suggestion. #### [](https://documentation.botghost.com/community-engagement/suggestions#title-minimum-length) **Title minimum length** Here you may choose how long the title of the suggestion may be at its shortest. The default value for this is set to 10. _This setting only shows if_ [Title](https://documentation.botghost.com/community-engagement/suggestions#title) _is enabled (and required)._ #### [](https://documentation.botghost.com/community-engagement/suggestions#title-maximum-length) **Title maximum length** Here you may choose how long the title of the suggestion may be at its longest. The default value for this is set to 200. _This setting only shows if_ [Title](https://documentation.botghost.com/community-engagement/suggestions#title) _is enabled (and required)._ #### [](https://documentation.botghost.com/community-engagement/suggestions#description-minimum-length) **Description minimum length** Here you may choose how long the description of the suggestion may be at its shortest. The default value for this is set to 10. #### [](https://documentation.botghost.com/community-engagement/suggestions#description-maximum-length) **Description maximum length** Here you may choose how long the description of the suggestion may be at its longest. The default value for this is set to 4000. ### [](https://documentation.botghost.com/community-engagement/suggestions#suggestions-management) Suggestions Management In this area, you can customize who can manage your server's suggestions and how. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FOcYiuAIQKtfHJzJrSgQL%252Fqq.png%3Falt%3Dmedia%26token%3Dadd081c3-3133-4699-88db-f22e72cbc416&width=768&dpr=3&quality=100&sign=813271f&sv=2) Suggestions Management portion of the suggestions module #### [](https://documentation.botghost.com/community-engagement/suggestions#manager-roles) **Manager Roles** Here you may choose the roles users must have in order to approve and deny suggestions. #### [](https://documentation.botghost.com/community-engagement/suggestions#enable-logging) **Enable Logging** Here you may toggle whether logs about suggestions are sent to a specific channel. #### [](https://documentation.botghost.com/community-engagement/suggestions#logging-channel) **Logging Channel** Here you may choose the channel where logs for the module will be sent. _This setting only shows if_ [Enable Logging](https://documentation.botghost.com/community-engagement/suggestions#enable-logging) _is enabled._ #### [](https://documentation.botghost.com/community-engagement/suggestions#send-all-suggestions-to-a-channel-for-approval) **Send all suggestions to a channel for approval** Here you may toggle whether suggestions are sent to a private channel where they must be approved or denied. #### [](https://documentation.botghost.com/community-engagement/suggestions#approval-channel) **Approval Channel** Here you may choose the channel where suggestions for approval will be sent. _This setting only shows if_ [Send all suggestions to a channel for approval](https://documentation.botghost.com/community-engagement/suggestions#send-all-suggestions-to-a-channel-for-approval) _is enabled._ #### [](https://documentation.botghost.com/community-engagement/suggestions#hide-the-user-who-approved-or-denied-the-suggestion) **Hide the user who approved or denied the suggestion** Here you may toggle whether the user who approved or denied a suggestion is made public. ### [](https://documentation.botghost.com/community-engagement/suggestions#suggestion) Suggestion In this area, you can customize how the suggestion appears in the voting channel. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FWb9XOcLiA7mHw97xLggJ%252Fscreencapture-dashboard-botghost-dashboard-module-17d130ca-5b40-4554-b11d-ffd889673915-suggestions-2024-07-25-21_23_45%2520%281%29.png%3Falt%3Dmedia%26token%3De38abc14-2d8e-4dce-9337-aa4cf5e06a91&width=768&dpr=3&quality=100&sign=236e5277&sv=2) #### [](https://documentation.botghost.com/community-engagement/suggestions#suggestions-channel) **Suggestions Channel** Here you may choose the channel where suggestions will be posted and voted on. This is required for the system to function correctly. #### [](https://documentation.botghost.com/community-engagement/suggestions#create-thread) **Create Thread** Here you may toggle whether a thread for discussion will be created and attached to the suggestion/voting message in the suggestions channel. #### [](https://documentation.botghost.com/community-engagement/suggestions#lock-thread-on-verdict) **Lock Thread on Verdict** Here you may toggle whether the thread attached to the suggestion will lock when a suggestion is approved or denied. _This setting only shows if_ [Create Thread](https://documentation.botghost.com/community-engagement/suggestions#create-thread) _is enabled._ #### [](https://documentation.botghost.com/community-engagement/suggestions#neutral-option) **Neutral Option** Here you may toggle whether a reaction for indecisiveness is added to the suggestion / voting message in the suggestions channel. #### [](https://documentation.botghost.com/community-engagement/suggestions#upvote-emoji) **Upvote Emoji** Here you may choose the first emoji on the suggestion / voting message, which members can use to show their approval of the suggestion. #### [](https://documentation.botghost.com/community-engagement/suggestions#neutral-emoji) **Neutral Emoji** Here you may choose the next emoji on the suggestion/voting message, which members can use to show they are indecisive on the suggestion. _This setting only shows if_ [Neutral Option](https://documentation.botghost.com/community-engagement/suggestions#neutral-option) _is enabled._ #### [](https://documentation.botghost.com/community-engagement/suggestions#downvote-emoji) **Downvote Emoji** Here you may choose the last emoji on the suggestion / voting message, which members can use to show their disapproval of the suggestion. #### [](https://documentation.botghost.com/community-engagement/suggestions#suggestion-embed-color) **Suggestion Embed color** Here you may choose the color of the embed in the suggestion/voting message. #### [](https://documentation.botghost.com/community-engagement/suggestions#anonymous-suggestions) **Anonymous Suggestions** Here you may toggle whether the author of a suggestion is hidden from the public. #### [](https://documentation.botghost.com/community-engagement/suggestions#message-suggestion-author-for-updates) **Message Suggestion Author for updates** Here you may toggle whether the author of a suggestion receives a direct message when there is an update on their suggestion. ### [](https://documentation.botghost.com/community-engagement/suggestions#automation) Automation In this area, you can customize how a suggestion can automatically be approved or denied based on its votes. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FlXL0xhHz8h3nDczkZKBo%252Fimage.png%3Falt%3Dmedia%26token%3D504b4eff-267d-42f9-bc1d-1287d220d309&width=768&dpr=3&quality=100&sign=9227fc40&sv=2) Automation portion of the Suggestions module #### [](https://documentation.botghost.com/community-engagement/suggestions#auto-approve-type) Auto Approve Type Use this feature to automatically approve a suggestion by a certain type of condition. Disabled Number of Upvotes Difference between upvotes and downvotes Percentage of upvotes Suggestions will not be automatically approved on any condition. The number of upvotes needed for suggestions to be automatically approved. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FCg5MzoaMqgH2A1w9o2kS%252Fimage.png%3Falt%3Dmedia%26token%3D151ad81b-e062-47ce-bcd3-d1cafc81c064&width=768&dpr=3&quality=100&sign=3242dc5c&sv=2) #### [](https://documentation.botghost.com/community-engagement/suggestions#auto-approve-number-of-upvotes) Auto Approve - Number of upvotes This setting allows you to set the minimum number of upvotes required to approve the suggestion automatically. You can only provide whole, positive numbers. Difference between upvotes and downvotes needed for automatic approval of the suggestion. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FO8F3fbxytQy8nPqtHrTk%252Fimage.png%3Falt%3Dmedia%26token%3D45054912-1087-458b-8dfb-31a3e6ffa612&width=768&dpr=3&quality=100&sign=e1352b6e&sv=2) #### [](https://documentation.botghost.com/community-engagement/suggestions#auto-approve-difference) Auto Approve - Difference This setting allows you to set the minimum difference between the upvotes and the downvotes required to approve the suggestion automatically. This means that, if you set this setting to 10, there must be 10 upvotes more than downvotes in order for the suggestion to be approved. You can only provide whole, positive numbers. Percentage of upvotes required for automatic approval of the suggestion. A minimum of upvotes required for the percentage to be checked is required. If there aren't enough upvotes, the suggestion won't be approved, even if the required percentage is reached. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FD1I5RtXxxEgwdAxhpTER%252Fimage.png%3Falt%3Dmedia%26token%3D4b7ce844-e110-4cee-956f-ea8a77126646&width=768&dpr=3&quality=100&sign=fb000a4e&sv=2) #### [](https://documentation.botghost.com/community-engagement/suggestions#auto-approve-percentage-of-upvotes) Auto Approve - Percentage of upvotes This setting allows you to set the minimum percentage of upvotes the suggestion must have in order for it to be approved automatically. You can only provide whole, positive numbers. #### [](https://documentation.botghost.com/community-engagement/suggestions#auto-approve-minimum-upvotes) Auto Approve - Minimum upvotes This setting allows you to set the minimum number of upvotes required for the filter above to work. #### [](https://documentation.botghost.com/community-engagement/suggestions#auto-deny-type) Auto Deny Type Use this feature to automatically deny a suggestion by a certain type of condition. Disabled Number of downvotes Difference between downvotes and upvotes Percentage of downvotes Suggestions will not be automatically denied on any condition. The number of downvotes needed for suggestions to be automatically denied. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FKttnUPAcchJERzckLtFB%252Fimage.png%3Falt%3Dmedia%26token%3D562f8622-2435-49e1-91b7-c5b46053d361&width=768&dpr=3&quality=100&sign=7c269b02&sv=2) #### [](https://documentation.botghost.com/community-engagement/suggestions#auto-deny-number-of-downvotes) Auto Deny - Number of downvotes This setting allows you to set the minimum number of downvotes required to deny the suggestion automatically. You can only provide whole, positive numbers. Difference between the downvotes and upvotes needed for automatic denial of the suggestion. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FgKn2xWOOr4WjZ7IxV7IT%252Fimage.png%3Falt%3Dmedia%26token%3Dc0ba6a9c-fdfe-4596-85b3-369a4641dc2b&width=768&dpr=3&quality=100&sign=db0b62c8&sv=2) #### [](https://documentation.botghost.com/community-engagement/suggestions#auto-deny-difference) Auto Deny - Difference This setting allows you to set the minimum difference between the downvotes and the upvotes required to deny the suggestion automatically. This means that, if you set this setting to 10, there must be 10 downvotes more than upvotes in order for the suggestion to be denied. You can only provide whole, positive numbers. Percentage of downvotes required for automatic denial of the suggestion. A minimum of downvotes required for the percentage to be checked is required. If there aren't enough downvotes, the suggestion won't be rejected, even if the required percentage is reached. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FNNfGkYA8bUUAQMcnBZdM%252Fimage.png%3Falt%3Dmedia%26token%3D8657a1d5-63a6-4aea-a174-b946dc47c7a3&width=768&dpr=3&quality=100&sign=7cd3c528&sv=2) #### [](https://documentation.botghost.com/community-engagement/suggestions#auto-deny-percentage-of-downvotes) Auto Deny - Percentage of downvotes This setting allows you to set the minimum percentage of downvotes the suggestion must have in order for it to be denied automatically. You can only provide whole, positive numbers. #### [](https://documentation.botghost.com/community-engagement/suggestions#auto-deny-minimum-downvotes) Auto Deny - Minimum downvotes This setting allows you to set the minimum number of downvotes required for the filter above to work. ### [](https://documentation.botghost.com/community-engagement/suggestions#restrictions) Restrictions In this area, you can customize who is restricted from posting suggestions and who is not. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FJXA8clh6kPokAsB0qTZG%252FScreenshot%25202024-01-12%2520185054.png%3Falt%3Dmedia%26token%3Db45ac183-3cd8-49fa-99c0-d693b690a73f&width=768&dpr=3&quality=100&sign=66b759f0&sv=2) #### [](https://documentation.botghost.com/community-engagement/suggestions#role-restrictions) **Role Restrictions** Blacklist Type Description No Role Restrictions All users of your server may create suggestions. Disable for these roles... Set this blacklist type if you want everyone to be able to create suggestions, except users with at least one of the roles provided in the menu below. Enable for these roles... Set this blacklist type if you want that only users with at least one of the roles provided in the menu below can post suggestions. [](https://documentation.botghost.com/community-engagement/suggestions#commands) Commands ---------------------------------------------------------------------------------------------- Here you can find the commands for the suggestions system and modify them to your liking. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FxxdYR7f5zW7b8Eu1AFqS%252Fimage.png%3Falt%3Dmedia%26token%3Def3b0425-72d6-4ea3-8566-fefa6752b3d3&width=768&dpr=3&quality=100&sign=1633744a&sv=2) Commands of the suggestions module /suggest[](https://documentation.botghost.com/community-engagement/suggestions#suggest) This command is what your users can run to make and post suggestions. /suggestion-view[](https://documentation.botghost.com/community-engagement/suggestions#suggestion-view) This command will allow you to view the information of a suggestion by its suggestion ID or message ID in the suggestions / voting channel. /suggestion-verdict[](https://documentation.botghost.com/community-engagement/suggestions#suggestion-verdict) This command will allow suggestion managers to approve or deny suggestions by their suggestion ID or message ID in the suggestions / voting channel. [](https://documentation.botghost.com/community-engagement/suggestions#events) Events ------------------------------------------------------------------------------------------ Here you can find the events for the suggestions system and modify them to your liking. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fdsqv7WwITMdSlof42MNT%252Fimage.png%3Falt%3Dmedia%26token%3D52975354-842c-4e02-975e-c107c26bc9e7&width=768&dpr=3&quality=100&sign=b5f605d5&sv=2) Events of the suggestions module Reaction Add[](https://documentation.botghost.com/community-engagement/suggestions#reaction-add) This event modifies the percentage of the votes and removes other reactions from the post when a reaction is added if it is in the suggestions/voting channel. Reaction Remove[](https://documentation.botghost.com/community-engagement/suggestions#reaction-remove) This event modifies the percentage of the votes when a reaction is removed if it is in the suggestions/voting channel. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/community-engagement/suggestions#settings) * [Submit a Suggestion](https://documentation.botghost.com/community-engagement/suggestions#submit-a-suggestion) * [Suggestions Management](https://documentation.botghost.com/community-engagement/suggestions#suggestions-management) * [Suggestion](https://documentation.botghost.com/community-engagement/suggestions#suggestion) * [Automation](https://documentation.botghost.com/community-engagement/suggestions#automation) * [Restrictions](https://documentation.botghost.com/community-engagement/suggestions#restrictions) * [Commands](https://documentation.botghost.com/community-engagement/suggestions#commands) * [Events](https://documentation.botghost.com/community-engagement/suggestions#events) Was this helpful? --- # Statistic Channels | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/server-management/statistic-channels.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FM9dyYIkY6iVpMmGigg03%252Fimage.png%3Falt%3Dmedia%26token%3De3639798-c114-454e-b361-061f2c3ccee4&width=768&dpr=3&quality=100&sign=488c7376&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. BotGhost provides a [Statistic Channels module](https://dashboard.botghost.com/dashboard/module/ee045a3d-05a6-409a-b435-7d170c5e70c3/statisticchannels) for its users. This module will allow you to keep track of metrics and statistics for your server within voice channels in your channel list. [](https://documentation.botghost.com/server-management/statistic-channels#settings) Settings -------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/server-management/statistic-channels#new-counter-setup) New Counter Setup In this area, you can view and modify the settings of the Statistic Channels module. Below you may find some information on each setting of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fn6yN2g3zwUme1UIDc13J%252Fimage.png%3Falt%3Dmedia%26token%3Ddf93e3d8-1019-4e8b-8248-0a9f40fadfbc&width=768&dpr=3&quality=100&sign=7c9634c8&sv=2) **Note:** To set up a new statistic channel, you'll need to create a voice channel. Need help? [View Discord's guide on how to create a voice channel](https://support.discord.com/hc/en-us/articles/19583625604887-Voice-Channels-FAQs#h_01HGXJWRPAZBM3FY6333C9WBQ3) . #### [](https://documentation.botghost.com/server-management/statistic-channels#channel-selection-type) Channel Selection Type This setting allows you to customize how to select your voice channel. Dropdown Menu Channel ID Input The Dropdown Menu option allows you to select your voice channel from a dropdown list of channels in your server. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F7sac76vUENmY8RK6vacZ%252Fimage.png%3Falt%3Dmedia%26token%3Dcbc9e178-7ac0-4092-ad30-d97f01c3ed12&width=768&dpr=3&quality=100&sign=ad9845da&sv=2) #### [](https://documentation.botghost.com/server-management/statistic-channels#channel-selection) Channel Selection This setting allows you to select your voice channel to track the metrics you set for this channel. The Channel ID Input option allows you to select your voice channel by pasting the ID of the channel into the dashboard. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F7YwB8fSfhmLU0PZgmPQW%252Fimage.png%3Falt%3Dmedia%26token%3D87c2bb8f-5987-41d5-b84d-8660fac06082&width=768&dpr=3&quality=100&sign=49dd2668&sv=2) #### [](https://documentation.botghost.com/server-management/statistic-channels#channel-id) Channel ID This setting allows you to paste the ID of your voice channel to track the metrics you set for this channel. You can also use a variable. #### [](https://documentation.botghost.com/server-management/statistic-channels#channel-name) Channel Name This field is where you input the channel name for the statistic channel. You can use the `{value}` [variable](https://documentation.botghost.com/custom-commands-and-events/variables) to reference the metric. To save the statistic channel's settings, you need to click "Add" in the bottom-right corner of the settings. This will create an [Active Counters](https://documentation.botghost.com/server-management/statistic-channels#active-counters) and an [Events](https://documentation.botghost.com/server-management/statistic-channels#events) for those settings. Additionally, the fields in this section will be reset so you can setup another channel. #### [](https://documentation.botghost.com/server-management/statistic-channels#statistic-type) Statistic Type You will be able to choose from one of these metrics to track. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FDHtxlg56UPzpKyHqDHQC%252Fimage.png%3Falt%3Dmedia%26token%3D812dece1-26b3-4a4d-b940-cd6152fdc6a0&width=768&dpr=3&quality=100&sign=91191d24&sv=2) #### [](https://documentation.botghost.com/server-management/statistic-channels#auto-lock-channel) Auto-Lock Channel If this switch is enabled then the channel will be locked, meaning no users will be able to join those channels, unless there is a role or admin permission overriding that. ### [](https://documentation.botghost.com/server-management/statistic-channels#active-counters) Active Counters ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FHMKIcra656xBXyDgdABI%252Fimage.png%3Falt%3Dmedia%26token%3D1609a363-288b-45da-bc77-38b99276da01&width=768&dpr=3&quality=100&sign=c129487b&sv=2) When adding a new statistic channel, it and its settings will appear in this section. All statistic channels will be ordered by the number in which they were created. To view, edit, and delete the settings you selected for that channel, simply click the statistic channel you wish to do so for. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FXTN7nBpHZnVVhASCCf6D%252Fimage.png%3Falt%3Dmedia%26token%3Dec63bdf4-f2f9-4b18-a9f0-5638b22349fd&width=768&dpr=3&quality=100&sign=cf26c889&sv=2) To save the edits you made on the statistic channel's settings, you need to click "Edit" in the bottom-right corner of the settings. * * * [](https://documentation.botghost.com/server-management/statistic-channels#events) Events ---------------------------------------------------------------------------------------------- In this area, you can view and modify the events of the Statistic Channels module. Below you may find some information on each event of the module. All statistic channels will be ordered by the number in which they were created. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F2bl8cHtoNN24RBndNr5m%252Fimage.png%3Falt%3Dmedia%26token%3D9945e76e-d4e7-484b-8365-4f9b962247bd&width=768&dpr=3&quality=100&sign=4cee1ec&sv=2) Statistic Channel #...[](https://documentation.botghost.com/server-management/statistic-channels#statistic-channel) Once a active counter has been added, the corresponding event will be shown in this section. You can edit the logic within them to your liking. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intented. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/server-management/statistic-channels#settings) * [New Counter Setup](https://documentation.botghost.com/server-management/statistic-channels#new-counter-setup) * [Active Counters](https://documentation.botghost.com/server-management/statistic-channels#active-counters) * [Events](https://documentation.botghost.com/server-management/statistic-channels#events) Was this helpful? --- # Roblox Verification | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/game-integrations/roblox-verification.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FmrP8EmmnCOqUfkvu76EB%252Fimage.png%3Falt%3Dmedia%26token%3D17b52d25-9317-4933-9526-0e00da0bdd8f&width=768&dpr=3&quality=100&sign=6ca41e10&sv=2) **T**his module is only available to user with a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) . The [Roblox Verification](https://dashboard.botghost.com/dashboard/module/ab8c166e-af43-46b7-8077-d92b4817b755/robloxverification) module allows users to connect their Roblox account to their in server Discord account, this is incredibly helpful for servers made for a Roblox group or if you want to setup some form of Roblox verification system for your Discord server. [](https://documentation.botghost.com/game-integrations/roblox-verification#settings) Settings --------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/game-integrations/roblox-verification#setup) Setup The setup section of this page allows you to customize your experience with the module. From changing the trigger to adding a role to users upon successful verification and more. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FtG8XepPyCemUygxiX527%252Fimage_2024-07-17_162109728.png%3Falt%3Dmedia%26token%3D63f8f131-5088-4b65-a142-3fd3723e71f6&width=768&dpr=3&quality=100&sign=820fccd&sv=2) Roblox Verification Module Settings #### [](https://documentation.botghost.com/game-integrations/roblox-verification#button-or-command) **Button or Command** Here you can change the trigger method for the verification to either a button or command. Command Button Setting it to a command (default) will allow users to run the `/roblox-verify` command in the server to begin the verification. If the button type is selected then it will send a embed message with a button attached for users to click to start the verification. #### [](https://documentation.botghost.com/game-integrations/roblox-verification#message) Message In this field is where you can edit the button message. You can switch it from an [embed](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/embed-reply) type to a [plain text](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/plain-text-reply) type using the toggle in the top right of the image. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FsujexInapAYbmFUtJHuV%252Fimage.png%3Falt%3Dmedia%26token%3Dd584bb56-a2d7-4a45-9fe5-fe297d23bbb5&width=768&dpr=3&quality=100&sign=c5b4bdc7&sv=2) #### [](https://documentation.botghost.com/game-integrations/roblox-verification#start-verification-button-text) Start Verification Button Text This field is where you can edit the text of the button that users will click to start the verification. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FNRqTKquCnEkXO5Pwt2ZG%252Fimage.png%3Falt%3Dmedia%26token%3Dba357eeb-45dc-4688-9e0a-7952452636e1&width=768&dpr=3&quality=100&sign=abc1e7b8&sv=2) #### [](https://documentation.botghost.com/game-integrations/roblox-verification#confirm-verification-button-text) Confirm Verification Button Text This field is where you can edit the text of the button that users will click to confirm the verification. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F4lZ2yxyCrhcHqpf63aV6%252Fimage.png%3Falt%3Dmedia%26token%3Dbc1599fc-1d97-4c63-ae28-a5e12e44b641&width=768&dpr=3&quality=100&sign=a3398d03&sv=2) #### [](https://documentation.botghost.com/game-integrations/roblox-verification#grant-role) **Grant Role** Toggling this setting on and off will enable / disable the function of the bot giving a role upon successful verification. By default this option is enabled. #### [](https://documentation.botghost.com/game-integrations/roblox-verification#verified-role) **Verified Role** This setting will allow you to choose a role to be granted to the user upon successful verification. _This setting is only visible with_ [Grant Role](https://documentation.botghost.com/game-integrations/roblox-verification#grant-role) _enabled._ #### [](https://documentation.botghost.com/game-integrations/roblox-verification#change-nickname) **Change Nickname** Toggling this setting on and off will enable / disable the function of the bot changing the users nickname upon successful verification. By default this option is enabled. #### [](https://documentation.botghost.com/game-integrations/roblox-verification#username-or-display-name) **Username or Display name** This setting will allow you to choose what nickname the bot should change the users name to upon successful verification. You are able to choose between their Roblox display name or username. _This setting is only visible with_ [Change Nickname](https://documentation.botghost.com/game-integrations/roblox-verification#change-nickname) _enabled._ #### [](https://documentation.botghost.com/game-integrations/roblox-verification#roblox-rankbind-groups) Roblox Rankbind Groups In this section you can paste the ID's of the Roblox groups you wish to attach with rankbinds. There is a limit of 5. #### [](https://documentation.botghost.com/game-integrations/roblox-verification#roblox-gamepasses) Roblox Gamepasses In this section you can paste the ID's of the Roblox gamepasses that should be integrated with the module. * * * [](https://documentation.botghost.com/game-integrations/roblox-verification#commands) Commands --------------------------------------------------------------------------------------------------- In this area, you can view and modify the commands of the Roblox Verification module. Below you may find some information on each command of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FGYoGtFV8zwop1RxSz0KS%252Fimage.png%3Falt%3Dmedia%26token%3D3b333917-fad0-415c-abcf-46f829585327&width=768&dpr=3&quality=100&sign=af52857d&sv=2) /roblox-verify[](https://documentation.botghost.com/game-integrations/roblox-verification#roblox-verify) Depending on the [Button or Command](https://documentation.botghost.com/game-integrations/roblox-verification#button-or-command) setting, this command will start the verification when the user runs it or it will post the button message in the channel the command was ran in for users to click to start the verification process. Note, for the button message to be sent, the command user must have the manage channel**s** permission. /roblox-profile[](https://documentation.botghost.com/game-integrations/roblox-verification#roblox-profile) When this command is ran, it will display the selected users Roblox profile. Additionally, if you leave the user option blank, it will display the command runners profile. This command has a 30 second cooldown period by default, this can only be changed in the command builder itself. /roblox-rank-binds-view[](https://documentation.botghost.com/game-integrations/roblox-verification#roblox-rank-binds-view) When this command is run, it will display the rankbinds for your connected Roblox groups. /roblox-rank-binds-remove[](https://documentation.botghost.com/game-integrations/roblox-verification#roblox-rank-binds-remove) When this command is run, it will allow you to remove one of the rankbinds for your connected Roblox groups /roblox-rank-binds-add[](https://documentation.botghost.com/game-integrations/roblox-verification#roblox-rank-binds-add) When this command is run, it will allow you to add to the rankbinds for your connected Roblox groups. /roblox-gamepass-view[](https://documentation.botghost.com/game-integrations/roblox-verification#roblox-gamepass-view) When this command is run, it will display the gamepass links for your connected Roblox groups. /roblox-gamepass-add[](https://documentation.botghost.com/game-integrations/roblox-verification#roblox-gamepass-add) When this command is run, it will allow you to add to the the gamepass links for your connected Roblox groups. /roblox-gamepass-remove[](https://documentation.botghost.com/game-integrations/roblox-verification#roblox-gamepass-remove) When this command is run, it will allow you to remove one of the gamepass links for your connected Roblox groups. /roblox-update-user[](https://documentation.botghost.com/game-integrations/roblox-verification#roblox-update-user) When this command is run, it will allow you to update a users profile to get up to date information and role connections. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/game-integrations/roblox-verification#settings) * [Setup](https://documentation.botghost.com/game-integrations/roblox-verification#setup) * [Commands](https://documentation.botghost.com/game-integrations/roblox-verification#commands) Was this helpful? --- # Welcomer | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/server-management/welcomer.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FtZBcU2ZLLXaqRv7baPoD%252Fimage.png%3Falt%3Dmedia%26token%3D697190cb-47e8-4193-88e2-03116b6007f3&width=768&dpr=3&quality=100&sign=871142ac&sv=2) Some of the features of this module require a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. You can however use the module with a free subscription. The [Welcomer](https://dashboard.botghost.com/dashboard/module/b65529b9-b196-4088-8fef-3eaff0b0c047/welcomer) module will allow you to send custom welcome banners, messages, reactions, and add roles to users when they join the server. This module will also allow you to send a message when a user is kicked or banned, all in one. [](https://documentation.botghost.com/server-management/welcomer#common-issues) Common Issues -------------------------------------------------------------------------------------------------- Experiencing issues with the module? Check out the common issues below. If your issue is not listed in this page, make sure your module is updated to the latest version. If you are still experiencing issues with the module, join our [support server](https://discord.gg/botghost) to ask for further help. ### [](https://documentation.botghost.com/server-management/welcomer#message-not-sending) Message not sending If your welcome message is not being sent, try the following steps: 1 Check the Discord server permissions of your bot: make sure your bot has the "Send messages" and "View Channel" permissions and that there are no overwrites for the selected channel, or just give your bot the "Administrator" permissions. 2 Check if your bot intents (message intent) are enabled on the [Discord Developer Portal](https://discord.com/developers/applications) . Ensure the message intent is also enabled in the settings page. See [Privileged Intent Options](https://documentation.botghost.com/general-settings-and-collaboration/settings#privileged-intent-options) for more info. 3 If you're still experiencing issues, join our [support server](https://discord.gg/botghost) to ask for further help. ### [](https://documentation.botghost.com/server-management/welcomer#welcome-card-not-working) Welcome card not working If the welcome card isn't working/sending you can try: 1 Check if the image URL is a valid file type (PNG, JPG, JPEG). A valid image url should end with `.png`, `.jpg` or `.jpeg`. 2 Don't use Discord attachment links: after some time, they expire and cannot be used outside of Discord (including BotGhost). 3 If you're still experiencing issues, join our [support server](https://discord.gg/botghost) for further assistance. * * * [](https://documentation.botghost.com/server-management/welcomer#watch-the-tutorial) Watch the Tutorial ------------------------------------------------------------------------------------------------------------ * * * [](https://documentation.botghost.com/server-management/welcomer#settings) Settings ---------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/server-management/welcomer#welcome-card) **Welcome Card** Customize the card to your liking. You can configure many different aspects of the card as below. Features in this section are limited to [Premium](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) users. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FeMndv0VwNXFFyOSXhhVD%252Fimage.png%3Falt%3Dmedia%26token%3D7f44f329-6f53-42b1-b397-a7dbd9d4befe&width=768&dpr=3&quality=100&sign=53df9909&sv=2) #### [](https://documentation.botghost.com/server-management/welcomer#welcome-card-1) \[👑\] Welcome Card Type Details Disabled If the welcome cards are disabled then no cards will be sent when a user joins the server. Send to a channel This selection type will send the welcome card to a specified channel when someone joins. Message the user This dropdown type will send a direct message to the user. Send to a channel and message the user If this option is selected it will send the message to both the channel and the user's direct messages. #### [](https://documentation.botghost.com/server-management/welcomer#channel) \[👑\] Channel Select a channel from your server to send the welcome card to. #### [](https://documentation.botghost.com/server-management/welcomer#background) \[👑\] Background Choose a custom background from your card. You have 3 options for this. Depending on the option chosen it will change the background color. Plain Color background Default Background Image Custom Background Image If "Plain Color" is chosen, you will simply choose from the default color panel. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FVRsUUMt0PfI2R5o8oyfz%252Fimage.png%3Falt%3Dmedia%26token%3Dad9fffa0-de6e-4ebb-8ee7-1568cd2570d0&width=768&dpr=3&quality=100&sign=5615d6d2&sv=2) #### [](https://documentation.botghost.com/server-management/welcomer#background-color) \[👑\] Background - Color This allows you to select the background color that will be used for the card. ### [](https://documentation.botghost.com/server-management/welcomer#example-card) Example Card ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FYJIVpvOh5UQLhW1ZB1rG%252Fimage.png%3Falt%3Dmedia%26token%3D826d0475-deaa-454e-bebb-4ea0877ebdc8&width=768&dpr=3&quality=100&sign=73c6bd33&sv=2) If "Default Background" is chosen you can pick one of the default background cards BotGhost provides, available in 8 colors including Red, Yellow, Blue, Purple and more. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FosPagjanF4QlcKbdOEbw%252Fimage.png%3Falt%3Dmedia%26token%3Deeca02d8-46f7-42ee-b4f1-cfe1c6ee3708&width=768&dpr=3&quality=100&sign=bbfe30ee&sv=2) #### [](https://documentation.botghost.com/server-management/welcomer#background-default-card-color) \[👑\] Background - Default Card Color This setting allows you to pick your favorite color for the default background card. ### [](https://documentation.botghost.com/server-management/welcomer#example-cards) Example Cards ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F1jDmoyTYKfGHEVGvWQOR%252Fimage.png%3Falt%3Dmedia%26token%3De13ab161-2725-4c03-a273-b01bef395db8&width=768&dpr=3&quality=100&sign=28c23fcf&sv=2) If "Custom Background" is chosen then the card can be a color or any image you provide by entering it into the field below. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FfFZtRpkThLnkcQsM5pE9%252Fimage.png%3Falt%3Dmedia%26token%3D569af822-9b39-4215-b0a5-fa941170ae3f&width=768&dpr=3&quality=100&sign=f4467e96&sv=2) #### [](https://documentation.botghost.com/server-management/welcomer#background-image) \[👑\] Background - Image Paste the URL of the image that will be used as a background. Make sure it's a valid image URL (ends with `.png`, `.jpg` or `.jpeg`). You should not use Discord attachment links as they expire after some time and cannot be used outside the platform. The recommended size of the image is 1024x500 pixels. ### [](https://documentation.botghost.com/server-management/welcomer#example-card-1) Example Card ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F1ctD1NXn7A2mKVP455lK%252FWelcome%2520Card%2520reference%2520of%2520the%2520Welcomer%2520Module.jpg%3Falt%3Dmedia%26token%3De0bda508-1219-4c74-83c0-0eb5c985943a&width=768&dpr=3&quality=100&sign=544242e1&sv=2) Welcome Card reference #### [](https://documentation.botghost.com/server-management/welcomer#title-color) \[👑\] Title Color This section represents the color for the title of the welcome card. #### [](https://documentation.botghost.com/server-management/welcomer#description-color) \[👑\] Description Color This section represents the color for the description of the welcome card. #### [](https://documentation.botghost.com/server-management/welcomer#avatar-border-color) \[👑\] Avatar Border Color This section represents the color for the avatar border of the welcome card. #### [](https://documentation.botghost.com/server-management/welcomer#banner-title) \[👑\] Banner Title This section is how you can edit the banner title for the welcome card. [Variables](https://documentation.botghost.com/custom-commands-and-events/variables) can be used. #### [](https://documentation.botghost.com/server-management/welcomer#banner-description) \[👑\] Banner Description This field is how you can edit the banner's description. [Variables](https://documentation.botghost.com/custom-commands-and-events/variables) can be used as well. #### [](https://documentation.botghost.com/server-management/welcomer#channel-reactions) \[👑\] Channel Reactions Choose up to 5 reactions that can be added to the welcome card message. ### [](https://documentation.botghost.com/server-management/welcomer#message-on-join) Message on Join When enabled, this action allows for a message to be sent to a specific channel. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F0OQD3qUcZMrWZK4aFqPt%252Fimage.png%3Falt%3Dmedia%26token%3D37c9434c-b06c-416d-82c6-3b4453aca86e&width=768&dpr=3&quality=100&sign=1e6d2b42&sv=2) #### [](https://documentation.botghost.com/server-management/welcomer#channel-1) Channel Select the channel from this dropdown for the message to be sent to. #### [](https://documentation.botghost.com/server-management/welcomer#welcome-message) Welcome Message This field is where you input the welcome message for when the user joins. You are able to pick from either [plain text](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/plain-text-reply) or [embed](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/embed-reply) response types. You are also able to use the `{card}` variable inside the image url section of the embed response type to show your welcome card in the same message. Some [variables](https://documentation.botghost.com/custom-commands-and-events/variables) can also be used, such as `{user}`. #### [](https://documentation.botghost.com/server-management/welcomer#reactions) Reactions Choose up to 5 reactions that can be added to the message. ### [](https://documentation.botghost.com/server-management/welcomer#direct-message-on-join) Direct message on Join When enabled, this action allows for a message to be sent as a direct message to the user who joined. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FXKuv8gphqlcgR5tjoLHf%252Fimage.png%3Falt%3Dmedia%26token%3Dfab4093f-385e-4ce2-9fac-2b572a213549&width=768&dpr=3&quality=100&sign=7257b813&sv=2) #### [](https://documentation.botghost.com/server-management/welcomer#welcome-direct-message) Welcome Direct Message This field is where you input the welcome message for when the user joins. You are able to pick from either [plain text](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/plain-text-reply) or [embed](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/embed-reply) response types. You are also able to use the `{card}` variable inside the image url section of the embed response type to show your welcome card in the same message. Some [variables](https://documentation.botghost.com/custom-commands-and-events/variables) can also be used, such as `{user}`. ### [](https://documentation.botghost.com/server-management/welcomer#add-role-on-join) Add Role on Join When this switch is enabled, it acts as an auto-role feature for the server, adding any roles from the server to the user who joined. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FzDslxkIlGOeDDzA69uHW%252Fimage.png%3Falt%3Dmedia%26token%3Ddb1ff3cd-7f58-43a4-a4e8-b48ae278866d&width=768&dpr=3&quality=100&sign=e079b8db&sv=2) #### [](https://documentation.botghost.com/server-management/welcomer#roles-to-add-on-join) Roles to add on join This section is where you can add any roles you wish from any server the bot is in. The roles will be added to the user from the respective server they joined. #### [](https://documentation.botghost.com/server-management/welcomer#wait-for-rules-acceptance) Wait for rules acceptance Enabling this switch will add the roles only after the user has accepted the server rules from the membership screening page. The server must have this setup for this to function correctly. ### [](https://documentation.botghost.com/server-management/welcomer#message-on-leave) Message on Leave Define whether you wish to enable or disable the message that gets sent when a user leaves the server. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FBAZm3mzNXUYlmOzd9JW7%252Fimage.png%3Falt%3Dmedia%26token%3Dff062b4d-24c1-4d2c-b5ec-826bce2a956d&width=768&dpr=3&quality=100&sign=cde9590b&sv=2) #### [](https://documentation.botghost.com/server-management/welcomer#channel-2) Channel Select the channel from the dropdown that the message will get sent to upon a user leaving. #### [](https://documentation.botghost.com/server-management/welcomer#leave-message) Leave message This field is where you will input the message that gets sent when the user leaves. [Variables](https://documentation.botghost.com/custom-commands-and-events/variables) can be used. You can also choose from either a [plain text](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/plain-text-reply) or [embed](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/embed-reply) response type. #### [](https://documentation.botghost.com/server-management/welcomer#reactions-1) Reactions Choose up to 5 reactions to be added to the message. ### [](https://documentation.botghost.com/server-management/welcomer#message-on-kick) Message on Kick Define whether you wish to enable or disable the message that gets sent when a user is kicked from the server. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FbEtuvP2RSpWas3IwFLTb%252Fimage.png%3Falt%3Dmedia%26token%3D159c90f4-1ca5-4d3a-856a-e71c508f374e&width=768&dpr=3&quality=100&sign=f925c21b&sv=2) #### [](https://documentation.botghost.com/server-management/welcomer#channel-3) Channel Select the channel from the dropdown that the message will get sent to upon a user that gets kicked. #### [](https://documentation.botghost.com/server-management/welcomer#kick-message) Kick message This field is where you will input the message that gets sent when the user is kicked. [Variables](https://documentation.botghost.com/custom-commands-and-events/variables) can be used. You can also choose from either a [plain text](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/plain-text-reply) or [embed](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/embed-reply) response type. #### [](https://documentation.botghost.com/server-management/welcomer#reactions-2) Reactions Choose up to 5 reactions to be added to the message. ### [](https://documentation.botghost.com/server-management/welcomer#message-on-ban) Message on Ban Define whether you wish to enable or disable the message that gets sent when a user is banned from the server. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FFXUtbGwUJxlJulIGoz2D%252Fimage.png%3Falt%3Dmedia%26token%3D236322a8-8e9d-41a0-8f5e-80aacee37cbf&width=768&dpr=3&quality=100&sign=980aeaf0&sv=2) #### [](https://documentation.botghost.com/server-management/welcomer#channel-4) Channel Select the channel from the dropdown that the message will get sent to upon a user that gets banned. #### [](https://documentation.botghost.com/server-management/welcomer#ban-message) Ban message This field is where you will input the message that gets sent when the user is banned. [Variables](https://documentation.botghost.com/custom-commands-and-events/variables) can be used. You can also choose from either a [plain text](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/plain-text-reply) or [embed](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/embed-reply) response type. #### [](https://documentation.botghost.com/server-management/welcomer#reactions-3) Reactions Choose up to 5 reactions to be added to the message. * * * [](https://documentation.botghost.com/server-management/welcomer#events) Events ------------------------------------------------------------------------------------ In this area, you can view and modify the events of the Welcomer module. Below you may find some information on each event of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FIke7U5B3GXJjMUKXPQev%252Fimage.png%3Falt%3Dmedia%26token%3D62100a0d-061b-462b-a1e6-9be4ca51e26c&width=768&dpr=3&quality=100&sign=b091066e&sv=2) Joins Handler[](https://documentation.botghost.com/server-management/welcomer#joins-handler) This event contains the welcoming card, the message on join, and the role addition. Leaves and Kicks Handler[](https://documentation.botghost.com/server-management/welcomer#leaves-and-kicks-handler) These events contain the message on leave and the message on kick. Bans Handler[](https://documentation.botghost.com/server-management/welcomer#bans-handler) This event contains the message on ban. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Common Issues](https://documentation.botghost.com/server-management/welcomer#common-issues) * [Message not sending](https://documentation.botghost.com/server-management/welcomer#message-not-sending) * [Welcome card not working](https://documentation.botghost.com/server-management/welcomer#welcome-card-not-working) * [Watch the Tutorial](https://documentation.botghost.com/server-management/welcomer#watch-the-tutorial) * [Settings](https://documentation.botghost.com/server-management/welcomer#settings) * [Welcome Card](https://documentation.botghost.com/server-management/welcomer#welcome-card) * [Message on Join](https://documentation.botghost.com/server-management/welcomer#message-on-join) * [Direct message on Join](https://documentation.botghost.com/server-management/welcomer#direct-message-on-join) * [Add Role on Join](https://documentation.botghost.com/server-management/welcomer#add-role-on-join) * [Message on Leave](https://documentation.botghost.com/server-management/welcomer#message-on-leave) * [Message on Kick](https://documentation.botghost.com/server-management/welcomer#message-on-kick) * [Message on Ban](https://documentation.botghost.com/server-management/welcomer#message-on-ban) * [Events](https://documentation.botghost.com/server-management/welcomer#events) Was this helpful? --- # Global Chat | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/messages/global-chat.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FF52F06AdM7ZTVHswxfF9%252Fimage.png%3Falt%3Dmedia%26token%3Dbf4bca83-1388-426b-aacd-4968b3b6c81f&width=768&dpr=3&quality=100&sign=3b9dd89e&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. The [Global Chat](https://dashboard.botghost.com/dashboard/module/41821e81-015f-463d-9999-c5d89b064608/globalchat) module will allow users to connect multiple text channels, even in different servers! [](https://documentation.botghost.com/messages/global-chat#settings) Settings ---------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/messages/global-chat#global-chat-settings) **Global Chat Settings** These are the settings that allow you to customize the [Global Chat](https://dashboard.botghost.com/dashboard/module/41821e81-015f-463d-9999-c5d89b064608/globalchat) module, this will allow you to configure permissions, cooldowns and more. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FrCHeJofqBqX3JqtgzlAK%252Fimage_2024-07-09_113445404.png%3Falt%3Dmedia%26token%3Dff7a6c00-206c-4396-bfa5-7845b09149aa&width=768&dpr=3&quality=100&sign=e93d358&sv=2) #### [](https://documentation.botghost.com/messages/global-chat#admin-role) **Admin Role** This selection will allow you to setup an admin role. Users with these roles will be able to run admin commands paired with the module. They will be able to reset settings, blacklist users and globally delete messages. #### [](https://documentation.botghost.com/messages/global-chat#manager-role) **Manager Role** This selection will allow you to setup a manager role. Users with the roles selected will be able to manage global chat channels. #### [](https://documentation.botghost.com/messages/global-chat#manager-permissions) **Manager Permissions** This setting will allow you to toggle the manager permission and when enabled, users with the manage guild permission can moderate and configure global chat channels. #### [](https://documentation.botghost.com/messages/global-chat#message-type) **Message Type** In this field you can change the type of message that is sent to the other channels, by default this is set to webhook. #### [](https://documentation.botghost.com/messages/global-chat#message-cooldown) **Message Cooldown** This setting will allow you to choose a rate limit in seconds users can send messages with. There is a minimum of 5 seconds. #### [](https://documentation.botghost.com/messages/global-chat#forward-attachment) **Forward Attachment** This toggle will allow you to enable whether or not to include attached images, videos, or GIFs in the message sent to the global chat channels. #### [](https://documentation.botghost.com/messages/global-chat#automatic-reaction) **Automatic Reaction** If you add an emoji to this setting, the bot will automatically react with this emoji to messages sent to global chat channels. You can use the format [here](https://docs.botghost.com/getting-started/standard-practices/advanced-practices#how-can-i-get-a-custom-emojis-id) or a default discord emoji. A default emoji is applied, and if made blank then this setting is disabled. ### [](https://documentation.botghost.com/messages/global-chat#message-settings) Message Settings This section will allow you to customize the global chat messages. The settings are different depending on the type chosen from [Message Type](https://documentation.botghost.com/messages/global-chat#message-type) . Webhook Message Bot Message Choosing this type will make the message sent be in the form of a webhook. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F1AdszOx8sG5OR53r36w1%252Fimage_2024-07-09_113321963.png%3Falt%3Dmedia%26token%3D05fcc7f8-74f3-4dc9-862d-ed2d8c440c8f&width=768&dpr=3&quality=100&sign=105f1434&sv=2) #### [](https://documentation.botghost.com/messages/global-chat#webhook-name) **Webhook Name** This field configures the text that will appear in the username section of the webhook message. [Variables](https://documentation.botghost.com/custom-commands-and-events/variables) can be used in this field. #### [](https://documentation.botghost.com/messages/global-chat#webhook-icon) **Webhook Icon** This field configures an image that appears in the user icon section of the webhook message. You may use the {user\_icon} [variable](https://documentation.botghost.com/custom-commands-and-events/variables) / image link. #### [](https://documentation.botghost.com/messages/global-chat#webhook-message-1) **Webhook Message** In this field you can input the message that is sent to the global chat channels. All [variables](https://documentation.botghost.com/custom-commands-and-events/variables) can be used. Choosing this type will make the message be in the form of the bot's message. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fm3M7pkYwPSLquBg7i3aZ%252Fimage_2024-07-09_113250552.png%3Falt%3Dmedia%26token%3D6da5cad6-2b76-420b-8491-adc85ca3ecb9&width=768&dpr=3&quality=100&sign=5d6d8790&sv=2) #### [](https://documentation.botghost.com/messages/global-chat#message) Message In this field you can input the message that is sent to the global chat channels. All [variables](https://documentation.botghost.com/custom-commands-and-events/variables) can be used. ### [](https://documentation.botghost.com/messages/global-chat#blacklist-settings) Blacklist Settings In this section, you can configure the blacklist settings such as blacklisted roles or blocked expressions. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FtOuqx2CZS4qAmIgPeTVV%252Fimage_2024-07-09_113157215.png%3Falt%3Dmedia%26token%3D520f2e02-ad9b-4b65-b08d-40201d6453a8&width=768&dpr=3&quality=100&sign=c06b6075&sv=2) #### [](https://documentation.botghost.com/messages/global-chat#blacklist-users) **Blacklist Users** This toggle if enabled, allows you give permissions to users with the manager role to be able to blacklist users using the `/globalchat-moderate` command. #### [](https://documentation.botghost.com/messages/global-chat#blacklisted-roles) **Blacklisted Roles** This selection will allow you to choose some roles to restrict the global chat from. Users that have one of these roles can't chat in global-chat channels. #### [](https://documentation.botghost.com/messages/global-chat#blocked-expressions) **Blocked Expressions** In this section you can set some keywords / phrases to block when using global chat. Any global-chat message that contains any of those blocked expressions won't be sent. * * * [](https://documentation.botghost.com/messages/global-chat#commands) Commands ---------------------------------------------------------------------------------- In this area, you can view and modify the commands of the Global Chat module. Below you may find some information on each command of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FjYuFiUUjHGLvNpmx8uRv%252Fimage_2024-07-09_113122555.png%3Falt%3Dmedia%26token%3Ddd044421-594e-4ca9-813c-df9a508e5d0d&width=768&dpr=3&quality=100&sign=96c7f627&sv=2) /globalchat-setup[](https://documentation.botghost.com/messages/global-chat#globalchat-setup) This command will allow you set a global chat channel for the entire system to use. /globalchat-disable[](https://documentation.botghost.com/messages/global-chat#globalchat-disable) This command will disable a current global chat channel so that messages sent in this channel won't be global anymore. /globalchat-moderate[](https://documentation.botghost.com/messages/global-chat#globalchat-moderate) With this command you can punish users and moderate global chat channels. [](https://documentation.botghost.com/messages/global-chat#events) Events ------------------------------------------------------------------------------ In this area, you can view and modify the events of the Global Chat module. Below you may find some information on each event of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FUSEjQtYq3tWlaEK8fGrj%252Fimage_2024-07-09_113138561.png%3Falt%3Dmedia%26token%3D96881ed2-1791-4454-afc6-4341461e606a&width=768&dpr=3&quality=100&sign=278c4e49&sv=2) Global Chat[](https://documentation.botghost.com/messages/global-chat#global-chat) This event handles the main core functions of the module and connects the global chat channels across different servers to each other. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/messages/global-chat#settings) * [Global Chat Settings](https://documentation.botghost.com/messages/global-chat#global-chat-settings) * [Message Settings](https://documentation.botghost.com/messages/global-chat#message-settings) * [Blacklist Settings](https://documentation.botghost.com/messages/global-chat#blacklist-settings) * [Commands](https://documentation.botghost.com/messages/global-chat#commands) * [Events](https://documentation.botghost.com/messages/global-chat#events) Was this helpful? --- # Media Channels | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/messages/media-channels.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FvEAkbnnhwHD21LMOAruf%252Fimage.png%3Falt%3Dmedia%26token%3D9878d44d-1768-4749-9e28-49aee22e82e7&width=768&dpr=3&quality=100&sign=f369120d&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. The [Media Channels](https://dashboard.botghost.com/dashboard/module/c3efeefb-654e-4893-8a16-ede851b62007/mediachannels) module will allow you to define channels where only images can be sent. Regular text messages will be deleted when sent into one of these channels. [](https://documentation.botghost.com/messages/media-channels#settings) Settings ------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/messages/media-channels#channel-setup) Channel Setup In this area, you can choose which channel you would like to become a media channel. Once these settings are configured, click the add button in the bottom right shown in the image below. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FksJurcVJDA0D1TGKnZEr%252Fimage.png%3Falt%3Dmedia%26token%3D73c443ba-412a-41a5-a534-76c3c84c8678&width=768&dpr=3&quality=100&sign=b59abadb&sv=2) #### [](https://documentation.botghost.com/messages/media-channels#channel-type) Channel Type With this selection you can choose what type of channel will become a media channel. You may choose from either a regular text channel or a forum channel. #### [](https://documentation.botghost.com/messages/media-channels#text-channel) Text Channel From this dropdown you can choose the channel from your server that you would like to become a media channel. Reminder that a media channel only allows for images to be sent so no message can be sent without an image. #### [](https://documentation.botghost.com/messages/media-channels#whitelisted-roles) Whitelisted Roles In this selection you can pick roles that you would like whitelisted. Whitelisted roles will not be moderated by the module and users with these roles can send any content they wish. To save the media channel's settings, you need to click "Add" in the bottom-right corner of the settings. This will reset the fields so you can set up another media channel. ### [](https://documentation.botghost.com/messages/media-channels#active-media-channels) Active Media Channels Once you have added a media channel from the settings above, a new area will appear that contains all the active media channels. Currently the maximum is 10 media channels. You may edit / delete any of these active media channels on the bottom right of the image below. To save the edits you made on the media channel's settings, you need to click "Edit" in the bottom-right corner of the settings. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Ff9beWCMVGhrES8JfHMhA%252Fimage.png%3Falt%3Dmedia%26token%3Db3a1ced6-6926-4b0a-b335-7d4b5def6b5a&width=768&dpr=3&quality=100&sign=d635a08e&sv=2) ### [](https://documentation.botghost.com/messages/media-channels#channel-settings) Channel Settings In this section you can configure the channel limits and moderation for your media channels. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FIIMeG2180BrbPgiBnuX1%252Fimage.png%3Falt%3Dmedia%26token%3D7688c343-dee4-439c-8bdc-9dde5f6e2647&width=768&dpr=3&quality=100&sign=bcb17130&sv=2) #### [](https://documentation.botghost.com/messages/media-channels#allow-text-content) Allow Text Content This toggle will allow you to choose if you would like any message's content to contain text alongside an image. #### [](https://documentation.botghost.com/messages/media-channels#allow-gifs-and-embeds) Allow GIFs and Embeds This toggle if enabled, will allow gifs and embeds to be sent to your media channels. #### [](https://documentation.botghost.com/messages/media-channels#block-duplicated-attachments) Block Duplicated Attachments If this toggle is enabled it will block attachments that are sent more than once in a media channel. #### [](https://documentation.botghost.com/messages/media-channels#maximum-attachments-and-embeds) Maximum Attachments and Embeds With this field you can decide how many attachments or embeds can be sent before the message is deleted. The maximum is 100 and the minimum is 0. This field only accepts integers. #### [](https://documentation.botghost.com/messages/media-channels#channel-rate-limit) Channel Rate Limit With this field you can enable a channel rate limit or in other terms, a slowmode in seconds, for your media channel. This field only accepts integers and the maximum is 3600 seconds. If this option is set to 0 that will disable it. #### [](https://documentation.botghost.com/messages/media-channels#allowed-media-type) Allowed Media Type Here you can choose the type of media you want to allow in your channel. If you are looking for customizing the possible file extensions that can be sent, choose the Advanced type. All Media Types Images only Videos only Advanced This option will allow all media types to be sent. This option will only allow images to be sent. This option will only allow videos to be sent. This option will allow you to input certain file types that are allowed in the channel. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F1BCQELJVh68pAd1hANux%252Fimage.png%3Falt%3Dmedia%26token%3Dadbe42cc-7e0a-4823-81d1-447614872bfe&width=768&dpr=3&quality=100&sign=138c550b&sv=2) #### [](https://documentation.botghost.com/messages/media-channels#restrict-file-types) Restrict File Types This field allows you to specify the file types you want to be allowed in your media channel. Input the file extension in the box in the left and click the send key on your keyboard to add it to the list. Type Details All Media Types This option will allow all media types to be sent. Images only This option will only allow images to be sent. Videos only This option will only allow videos to be sent. Advanced This option will allow you to input certain file types that are allowed in the channel. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F1BCQELJVh68pAd1hANux%252Fimage.png%3Falt%3Dmedia%26token%3Dadbe42cc-7e0a-4823-81d1-447614872bfe&width=768&dpr=3&quality=100&sign=138c550b&sv=2) #### [](https://documentation.botghost.com/messages/media-channels#enable-error-message) Enable Error Message This toggle allows you to enable an error message when a message gets deleted inside a media channel. #### [](https://documentation.botghost.com/messages/media-channels#error-message) Error Message If enabled by the toggle above, you can customize the error message that will be sent if a user sends a message without attachments to your media channels. The message will appear for 10 seconds in the media channel, and mention the user. You can use all [variables](https://documentation.botghost.com/custom-commands-and-events/variables) and the {reason} variable to get the deletion reason. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FpMFthnr20E28zoDx6fqe%252Fimage.png%3Falt%3Dmedia%26token%3Dfc5304ed-1637-4e13-879e-2db1297298e8&width=768&dpr=3&quality=100&sign=b990ca6a&sv=2) * * * [](https://documentation.botghost.com/messages/media-channels#events) Events --------------------------------------------------------------------------------- In this area, you can view and modify the events of the Media Channels module. Below you may find some information on each event of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FOB3dg3hadTdUESjtokMh%252Fimage.png%3Falt%3Dmedia%26token%3D5ec0b98c-a381-4ed0-9892-66f6c18da885&width=768&dpr=3&quality=100&sign=b95ce8cf&sv=2) MediaChannel Handler[](https://documentation.botghost.com/messages/media-channels#mediachannel-handler) This is the main event for the module, this will handle the deletion of text messages sent into the media channel. MediaChannel Edit Handler[](https://documentation.botghost.com/messages/media-channels#mediachannel-edit-handler) This is the same as the other handler, except it will only look for messages that get edited to moderate. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/messages/media-channels#settings) * [Channel Setup](https://documentation.botghost.com/messages/media-channels#channel-setup) * [Active Media Channels](https://documentation.botghost.com/messages/media-channels#active-media-channels) * [Channel Settings](https://documentation.botghost.com/messages/media-channels#channel-settings) * [Events](https://documentation.botghost.com/messages/media-channels#events) Was this helpful? --- # Counting | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/fun-modules/counting.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FhH6hTAcMuzVPXkMGyhm0%252Fimage.png%3Falt%3Dmedia%26token%3Da70fd64d-454a-4b13-a7f9-15632dcdea6f&width=768&dpr=3&quality=100&sign=503a75bb&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. The [Counting](https://dashboard.botghost.com/dashboard/module/5206b1e7-f841-4d04-8c09-2f0bfe28b50e/counting) module allows your server members to engage in a fun counting activity, see how high you can go with this unlimited counting module! [](https://documentation.botghost.com/fun-modules/counting#settings) Settings ---------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/fun-modules/counting#general-settings) General Settings Here you can configure the main settings for the counting module, from setting the counting channel to changing the counting mode. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FzKSisNsposhiyHlaDjLf%252Fimage_2024-07-22_210628809.png%3Falt%3Dmedia%26token%3D05bd8af7-2fd7-4fb5-9d94-8e702cf752d8&width=768&dpr=3&quality=100&sign=d3261ab6&sv=2) #### [](https://documentation.botghost.com/fun-modules/counting#counting-mode) **Counting Mode** Here you can change the mode of the counting which will adjust the behavior of the bot in the counting channel. Mode Details Normal This mode will simply add a reaction to the users message if they send the correct number to the channel. Webhook This mode will delete the users message and repost it in a webhook format to make it appear as though a bot version of the user sent it if the count is correct. #### [](https://documentation.botghost.com/fun-modules/counting#channel) **Channel** Here you can select the channel you want the counting event to work in, channels not selected here will not trigger the counting module. #### [](https://documentation.botghost.com/fun-modules/counting#reactions) **Reactions** If this toggle is enabled, and if [Counting Mode](https://documentation.botghost.com/fun-modules/counting#counting-mode) is set to 'Normal', then the bot will add a reaction to the correct number. #### [](https://documentation.botghost.com/fun-modules/counting#reaction-emoji) Reaction Emoji If [Reactions](https://documentation.botghost.com/fun-modules/counting#reactions) is enabled, then you can add the reaction that you want the bot to add to the messages. #### [](https://documentation.botghost.com/fun-modules/counting#allow-multiple-counts) **Allow Multiple Counts** If this toggle is enabled, users will be able to count more than once in a row. #### [](https://documentation.botghost.com/fun-modules/counting#cooldown) **Cooldown** Here you can enable / disable a 5 second channel wide cooldown which will prevent users from sending another count for 5 seconds after one has just been sent. ### [](https://documentation.botghost.com/fun-modules/counting#error-settings) Error Settings Here you can configure the error settings for the counting module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FltrouuaThxJPRN0teGoa%252Fimage.png%3Falt%3Dmedia%26token%3Defe7b6a4-99aa-4d60-b9d6-56edcce78a26&width=768&dpr=3&quality=100&sign=1d558dab&sv=2) #### [](https://documentation.botghost.com/fun-modules/counting#return-errors) **Return Errors** If this toggle is enabled, all errors described in the settings below will be active. #### [](https://documentation.botghost.com/fun-modules/counting#error-message-for-wrong-count) **Error Message For Wrong Count** If [Return Errors](https://documentation.botghost.com/fun-modules/counting#return-errors) is enabled, you can set the message that will be displayed to user for sending the wrong count to the channel. [Variables](https://documentation.botghost.com/custom-commands-and-events/variables) can be used. #### [](https://documentation.botghost.com/fun-modules/counting#error-message-for-counting-twice) **Error Message For Counting Twice** If [Return Errors](https://documentation.botghost.com/fun-modules/counting#return-errors) is enabled and if [Allow Multiple Counts](https://documentation.botghost.com/fun-modules/counting#allow-multiple-counts) is also disabled, you can set the message that will be displayed to user for sending 2 or more counts without waiting for another user to count. #### [](https://documentation.botghost.com/fun-modules/counting#error-message-for-the-cooldown) **Error Message For The Cooldown** If [Return Errors](https://documentation.botghost.com/fun-modules/counting#return-errors) is enabled, you can set the message that will be displayed to the user if they try to count during the 5 second cooldown if [Cooldown](https://documentation.botghost.com/fun-modules/counting#cooldown) is enabled. * * * [](https://documentation.botghost.com/fun-modules/counting#commands) Commands ---------------------------------------------------------------------------------- In this area, you can view and modify the commands of the Counting module. Below you may find some information on each command of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FvfyNNPNCc2rInnNVPoqw%252Fimage_2024-07-22_211952298.png%3Falt%3Dmedia%26token%3De190edd5-2fbd-4a47-bc43-b3b1b19d1334&width=768&dpr=3&quality=100&sign=145c042e&sv=2) /counting-set[](https://documentation.botghost.com/fun-modules/counting#counting-set) This command allows you to set the current count of the module to any new number. [](https://documentation.botghost.com/fun-modules/counting#events) Events ------------------------------------------------------------------------------ In this area, you can view and modify the events of the Counting module. Below you may find some information on each event of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F1wO28L5N22rv5LSbSlUR%252Fimage_2024-07-22_212134184.png%3Falt%3Dmedia%26token%3D7437b1e4-f5c2-4d24-8563-a11338f63962&width=768&dpr=3&quality=100&sign=45f8d6a8&sv=2) Counting[](https://documentation.botghost.com/fun-modules/counting#counting) This event handles all the module functions such as the errors, tracking the number, and all other settings. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/fun-modules/counting#settings) * [General Settings](https://documentation.botghost.com/fun-modules/counting#general-settings) * [Error Settings](https://documentation.botghost.com/fun-modules/counting#error-settings) * [Commands](https://documentation.botghost.com/fun-modules/counting#commands) * [Events](https://documentation.botghost.com/fun-modules/counting#events) Was this helpful? --- # Temp Voice Channels | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/community-engagement/temp-voice-channels.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FJmByNxLWUxCqFByvnVRn%252Fimage.png%3Falt%3Dmedia%26token%3D84831d2d-e7a8-46b5-a051-c0e60a547843&width=768&dpr=3&quality=100&sign=efeab39b&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. The [Temp Voice Channels](https://dashboard.botghost.com/dashboard/module/ca3589f7-3846-4f70-8863-7f601cb29e9f/tempvoicechannels) module allows you to setup an advanced temporary voice channels system in your guild. This module allows users to connect to a main voice channel to create their own cool private temporary channels. [](https://documentation.botghost.com/community-engagement/temp-voice-channels#settings) Settings ------------------------------------------------------------------------------------------------------ ### [](https://documentation.botghost.com/community-engagement/temp-voice-channels#main-settings) Main Settings Find out about what customization options are available with the module and what each of them does. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FXaLa7fy5xK1Ap9vytVWI%252Fimage.png%3Falt%3Dmedia%26token%3Db6e5106b-e72e-4452-adaa-259fb37b79a8&width=768&dpr=3&quality=100&sign=d5429950&sv=2) #### [](https://documentation.botghost.com/community-engagement/temp-voice-channels#channel-creator-hub) Channel Creator Hub This setting allows you to define the 'hub' voice channel users will connect to, to create their own temp voice channels. Only one can be selected. #### [](https://documentation.botghost.com/community-engagement/temp-voice-channels#channel-category) Channel Category This setting allows you to define what category the new temp voice channels will be created in. #### [](https://documentation.botghost.com/community-engagement/temp-voice-channels#role-permission-criteria) Role Permission Criteria This setting will allow you to choose to disable / enable the module functionalities for users with the defined roles. By default this is set to 'No Restrictions'. Type Details No Restrictions All server roles can create temp voice channels. Enabled for these roles only Users with only these certain roles selected will be able to create temp voice channels. Disabled for these roles Users with all other roles besides the ones selected will be able to create temp voice channels. ### [](https://documentation.botghost.com/community-engagement/temp-voice-channels#channel-settings) Channel Settings Here you can customize the channels settings for the newly created voice channels. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FJTUo9X5Hd4NFb7vp9yOX%252Fimage_2024-07-18_210646850.png%3Falt%3Dmedia%26token%3D5c2a544c-6808-458d-a5c3-bb99a47ae023&width=768&dpr=3&quality=100&sign=49a60840&sv=2) #### [](https://documentation.botghost.com/community-engagement/temp-voice-channels#created-channel-name) Created Channel Name Here you can define the name which the channels uses when it is created. [Variables](https://documentation.botghost.com/custom-commands-and-events/variables) can be used. #### [](https://documentation.botghost.com/community-engagement/temp-voice-channels#channel-lock) Channel Lock Here you can choose whether newly created channels should be locked or unlocked by default. Locked channels only allow whitelisted users to join! The default option is set to unlocked. Type Details Follow Server's Permissions The channel will follow your server's permissions. Unlocked No restrictions will be applied and users can join. Locked The channel is restricted and not all users can join unless they are whitelisted. #### [](https://documentation.botghost.com/community-engagement/temp-voice-channels#owner-permissions) Owner Permissions This toggle option will allow you to disable / enable the creator of the voice channel having access to the Manage Channel, Priority Speaker, Move Members and Manage Permissions permission flags to the voice channel they created. #### [](https://documentation.botghost.com/community-engagement/temp-voice-channels#mention-creator) Mention Creator This toggle option when enabled, will ping the voice channel creator once the channel is made along with sending the information. #### [](https://documentation.botghost.com/community-engagement/temp-voice-channels#deletion-wait-time) Deletion Wait Time Here you can define the amount of seconds the module deletes a temporary channel in after all members have left. The maximum is 3600 seconds and only integers are allowed as an input. #### [](https://documentation.botghost.com/community-engagement/temp-voice-channels#user-limit) User Limit Here you can select the maximum number of users allowed to join your channel. When the member count in the channel reaches this defined number, no one else will be able to join unless someone else leaves. The maximum is 99 users and only integers are allowed as an input. #### [](https://documentation.botghost.com/community-engagement/temp-voice-channels#channel-bitrate) Channel Bitrate In this field you can input a number of seconds that discord should handle the voice channels with. Maximum is 96000 and the minimum is 8000. Only integers can be used. * * * [](https://documentation.botghost.com/community-engagement/temp-voice-channels#commands) Commands ------------------------------------------------------------------------------------------------------ In this area, you can view and modify the commands of the Temp Voice Channels module. Below you may find some information on each command of the module. All Commands that come with this module must be used in the created voice channels chat. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FRtWZNzL9srMEjqfb6JwC%252Fimage.png%3Falt%3Dmedia%26token%3Debf7b049-1cba-4a6a-9151-49cc1bcb4206&width=768&dpr=3&quality=100&sign=483c49dc&sv=2) /tempvc-whitelist[](https://documentation.botghost.com/community-engagement/temp-voice-channels#tempvc-whitelist) This command will allow voice channel owners to whitelist a user, once whitelisted they will be able to join their locked voice channel. /tempvc-blacklist[](https://documentation.botghost.com/community-engagement/temp-voice-channels#tempvc-blacklist) This command will allow voice channel owners to blacklist a user, once blacklisted they will not be able to join their voice channel. /tempvc-lock[](https://documentation.botghost.com/community-engagement/temp-voice-channels#tempvc-lock) This command will allow voice channel owners to lock their voice channel. Once locked, only whitelisted users will be able to join it. /tempvc-unlock[](https://documentation.botghost.com/community-engagement/temp-voice-channels#tempvc-unlock) This command will allow voice channel owners to unlocked their voice channel. Once unlocked, all users will be able to join it. /tempvc-kick[](https://documentation.botghost.com/community-engagement/temp-voice-channels#tempvc-kick) This command will allow voice channel owners to kick users from their voice channel. [](https://documentation.botghost.com/community-engagement/temp-voice-channels#events) Events -------------------------------------------------------------------------------------------------- In this area, you can view and modify the events of the Temp Voice Channels module. Below you may find some information on each event of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FgN4z81IUG5uMh7YlE9sz%252Fimage_2024-07-18_211958774.png%3Falt%3Dmedia%26token%3Dac62493e-a840-4848-a111-a672f9d6ff02&width=768&dpr=3&quality=100&sign=3f25cd01&sv=2) VC Join Handler[](https://documentation.botghost.com/community-engagement/temp-voice-channels#vc-join-handler) This event handles the system that procs when users join a temp voice channel. VC Leave Handler[](https://documentation.botghost.com/community-engagement/temp-voice-channels#vc-leave-handler) This event manages deleting the channel after the specified period once all users have left. VC Switch - Join Handler[](https://documentation.botghost.com/community-engagement/temp-voice-channels#vc-switch-join-handler) This event tracks users swapping voice channels to adjust the total member count for the channel they joined. VC Switch - Leave Handler[](https://documentation.botghost.com/community-engagement/temp-voice-channels#vc-switch-leave-handler) This event tracks users swapping voice channels to adjust the total member count for the channel they left. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intented. Additionally, a copy of the edited events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/community-engagement/temp-voice-channels#settings) * [Main Settings](https://documentation.botghost.com/community-engagement/temp-voice-channels#main-settings) * [Channel Settings](https://documentation.botghost.com/community-engagement/temp-voice-channels#channel-settings) * [Commands](https://documentation.botghost.com/community-engagement/temp-voice-channels#commands) * [Events](https://documentation.botghost.com/community-engagement/temp-voice-channels#events) Was this helpful? --- # Chance Condition | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/conditions/chance-condition.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FShzi0vv3w0Jq47u5jZGd%252Fimage.png%3Falt%3Dmedia%26token%3D0d77563c-ce41-40df-8a1e-da6f2d4ed85e&width=768&dpr=3&quality=100&sign=f4e50787&sv=2) This condition sets a percentage chance for actions to be taken. You cannot exceed 100%. The remainder of the blocks percentages are gathered in the else block. [](https://documentation.botghost.com/custom-commands-and-events/conditions/chance-condition#percent-chance) Percent Chance -------------------------------------------------------------------------------------------------------------------------------- This field is where you enter the percentage of how likely the action will be occurring. This field only accepts integers as values. Click the Add Condition button to add the block to your builder. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FPsm4zlyYuhNti3PuzA1R%252Fimage_2024-06-09_224145065.png%3Falt%3Dmedia%26token%3Df0fdfd5b-b033-4a95-b825-78ca1465b612&width=768&dpr=3&quality=100&sign=5f08bb54&sv=2) Here is an example layout of this condition: ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FqKCiDcfpMT5fCwPMzwuR%252FBildschirm%25C2%25ADfoto%25202023-02-13%2520um%252021.01.56.png%3Falt%3Dmedia%26token%3Dd17f4728-0b8c-4fe2-9dd3-e6f1df1ef122&width=768&dpr=3&quality=100&sign=c428b5e0&sv=2) Last updated 2 years ago Was this helpful? Was this helpful? --- # Events | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/events.md) . The [Custom Events](https://dashboard.botghost.com/dashboard/customevents) module is where you can trigger actions based on things that occur in your server, on a timed basis, from an IFTTT trigger, and even from a BotGhost webhook. [](https://documentation.botghost.com/custom-commands-and-events/events#getting-started) Getting Started ------------------------------------------------------------------------------------------------------------- 1 Located in the Custom Events module, you will see the "New Custom Event" section, click the "Custom Event Builder" yellow block to create a new event. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FXDICfQq2LnlzI7wYKpHa%252Fimage.png%3Falt%3Dmedia%26token%3Db9ba49a8-0191-4802-af24-5659dbe680ac&width=768&dpr=3&quality=100&sign=ec546e75&sv=2) Click the "Custom Event Builder" 2 Select a custom event from the options currently provided. These options will activate when a condition is met. For instance, if a user joins your server, you can then have the bot greet them, like the announcement module, and DM them. 3 Under the yellow main block, click on it and set an "Event Nickname". This will be shown in the dashboard if you are ever looking to edit a certain event. You can name it to whatever you'd want. [](https://documentation.botghost.com/custom-commands-and-events/events#blocks) Blocks ------------------------------------------------------------------------------------------- In the custom event builder, the blocks you can use vary to the custom command builder. While creating an event, you cannot use options or certain conditions. As an example, you cannot use a "User Condition" in a timed event as the event has no user trigger. You can however use it if you have at least one button or select menu in your event. [](https://documentation.botghost.com/custom-commands-and-events/events#available-events) Available Events --------------------------------------------------------------------------------------------------------------- The type of events you may use in the custom events builder can be found below. Action Events[](https://documentation.botghost.com/custom-commands-and-events/events#action-events) Action Events are a category of pre-built, powerful events in BotGhost that combine multiple actions into a single block. They are designed to simplify the creation of common bot features, allowing you to accomplish complex tasks without needing multiple custom event blocks. Check out the [Action Events](https://documentation.botghost.com/custom-commands-and-events/events/action-events) page for more information. Timed Events[](https://documentation.botghost.com/custom-commands-and-events/events#timed-events) Timed events are a special type of events that can run on a scheduled (every day at 5 pm) or a set interval (every 10 minutes). Check out the [Timed Events](https://documentation.botghost.com/custom-commands-and-events/events/timed-events) page for more. IFTTT Events[](https://documentation.botghost.com/custom-commands-and-events/events#ifttt-events) IFTTT events can be triggered by IFTTT when something occurs (ex. you've created an applet that triggers a custom event when a video is posted on YouTube). Learn more on how to use them [here](https://documentation.botghost.com/custom-commands-and-events/ifttt#trigger-a-custom-event-ifttt-actions) . Webhook Events[](https://documentation.botghost.com/custom-commands-and-events/events#webhook-events) Webhook events can be triggered by an API Request sent to BotGhost. Learn more on the [Webhooks](https://documentation.botghost.com/custom-commands-and-events/events/webhooks) page. Application Events[](https://documentation.botghost.com/custom-commands-and-events/events#application-events) The application events are based on actions in your server related to application command permissions. * When an application command’s permissions are updated Audit Events[](https://documentation.botghost.com/custom-commands-and-events/events#audit-events) The audit events are based on actions in your server related to Discord’s audit log system. * When an audit log entry is created Auto Moderation Events[](https://documentation.botghost.com/custom-commands-and-events/events#auto-moderation-events) The Auto Moderation events are based on actions in your server related to Discord’s built-in AutoMod feature. * When an Auto Moderation action is executed * When an Auto Moderation rule is created * When an Auto Moderation rule is deleted * When an Auto Moderation rule is updated Boost Events[](https://documentation.botghost.com/custom-commands-and-events/events#boost-events) The boost events are based on actions in your server related to server boosts. * When a member boosts the server for the first time * When a member unboosts the server * When a server boost level increases * When a server boost level decrease Bot Events[](https://documentation.botghost.com/custom-commands-and-events/events#bot-events) The bot events are related to actions that occur within your bot. * When the bot joins a server * When the bot leaves a server * When the bot starts or is restarted * When a custom variable's value changes * When the bot is updated through the dashboard Channel Events[](https://documentation.botghost.com/custom-commands-and-events/events#channel-events) The channel events are based on actions in your server that are related to channels. * When a channel is created * When a channel is deleted * When a channel is updated * When a channel's permissions are updated * When a guild channel’s topic is updated * When a channel’s pins are updated Invite Events[](https://documentation.botghost.com/custom-commands-and-events/events#invite-events) The invite events are based on actions in your server that are related to invites. * When a invite is created * When a invited is deleted Member Events[](https://documentation.botghost.com/custom-commands-and-events/events#member-events) The member events are based on actions in your server that are related to users. * When a new user joins the serer * When a user is banned from the server * When a user is unbanned from the server * When a user leaves or is kicked from the server * When a role is added to a user * When a role is removed from a user * When a guild member is updated * When a user changes their nickname * When a user changes their status * When a guild’s features are updated * When a guild’s ownership is transferred to another user * When a guild becomes a Partner * When a guild loses its Partner status * When a guild’s name is changed * When an AFK channel is set * When the AFK channel is removed * When a guild banner is added * When a guild banner is removed * When a member passes membership screening * When a guild’s integrations are updated Message Events[](https://documentation.botghost.com/custom-commands-and-events/events#message-events) The message events are based on actions in your server that are related to messages. * When a new message is sent * When a message is updated or edited * When a message is deleted * When a message is pinned * When a user starts typing Music Events[](https://documentation.botghost.com/custom-commands-and-events/events#music-events) The music events are events triggered by [music actions](https://documentation.botghost.com/custom-commands-and-events/actions/music-actions) and the [music module](https://documentation.botghost.com/fun-modules/music) . * Track Events * When a track starts playing * When a track finishes playing * When the queue finishes playing * When a track encounters an error * When a track gets stuck/frozen * Player Controls * When playback is started * When playback is paused * When playback is resumed * When a track is skipped * When seeking in a track * When queue is shuffled * When playback is stopped * Queue Events * When a track is added to the queue * When a track is removed from the queue * Settings Events * When AutoPlay is toggled * When AutoLeave is toggled * When the player volume is changed * When player loop mode is changed * Connection Events * When bot connects to voice channel * When bot disconnects from voice channel * When bot is moved to a different voice channel * When bot automatically leaves voice due to inactivity * System Events * When a music player is created * When a music player is destroyed * When a music player switches Lavalink node * When a music player's WebSocket connection closes * When a music player state updates (fires frequently) * Other Music Events * When audio filters are changed * When player is resuming playback * When player has successfully resumed * When player mute status changes * When player deaf status changes * When a user joins the voice channel with the bot * When a user leaves the voice channel with the bot Poll Events[](https://documentation.botghost.com/custom-commands-and-events/events#poll-events) The poll events are based on actions in your server related to the discord builtin poll feature. * When a user votes on a poll * When a user removes their vote on a poll Reaction Events[](https://documentation.botghost.com/custom-commands-and-events/events#reaction-events) The reaction events are based on actions in your server that are related to reactions on messages. * When a reaction is added to a message * When a reaction is removed from a message * When all reactions are removed from a message * When a specific reaction is removed from a message Role Events[](https://documentation.botghost.com/custom-commands-and-events/events#role-events) The role events are based on actions in your server that are related to roles. * When a role is created * When a role is updated * When a role is deleted Scheduled Events Events[](https://documentation.botghost.com/custom-commands-and-events/events#scheduled-events-events) The scheduled events events are based on actions in your server that are related to the scheduled events feature. * When a scheduled event is created * When a scheduled event is updated * When a scheduled event is deleted * When a user joins a scheduled event * When a user leaves a scheduled event Stage Events[](https://documentation.botghost.com/custom-commands-and-events/events#stage-events) The stage events are based on actions in your server related to stage instances. * When a stage instance is created * When a stage instance is deleted * When a stage instance is updated Sticker Events[](https://documentation.botghost.com/custom-commands-and-events/events#sticker-events) The sticker events are based on actions in your server related to stickers. * When a sticker is created * When a sticker is deleted * When a sticker is updated Thread Events[](https://documentation.botghost.com/custom-commands-and-events/events#thread-events) The thread events are based on actions in your server that are related to threads or forum posts. * When a thread is created * When a thread is deleted * When a thread is updated * When thread lists are synced * When thread members are updated * When a thread member is updated Voice Events[](https://documentation.botghost.com/custom-commands-and-events/events#voice-events) The voice events are based on actions in your server that are related to voice channels and users inside of them. * When a member joins a voice channel * When a member switches voice channels * When a member leaves a voice channel * When a member starts streaming in a voice channel * When a member stops streaming in a voice channel * When a member is server muted * When a member self mutes * When a member is server unmuted * When a member self unmutes * When a member is server deafened * When a member self deafens * When a member is server undeafened * When a member self undeafens * When a voice server is updated ### [](https://documentation.botghost.com/custom-commands-and-events/events#variables) **Variables** All specific and special variables can be found in the variable tab, the variable list changes per event type. All event specific variables can be found in the variable list (represented by a clipboard icon), that appears on every input in your event builder. Those vary per event type. Learn more about variables and other variable types in the [Variables](https://documentation.botghost.com/custom-commands-and-events/variables) page. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FhYDnO4FSTrjFPNFSetsD%252Fimage.png%3Falt%3Dmedia%26token%3D6e56828f-fe4c-470a-ac1a-3056304f164d&width=768&dpr=3&quality=100&sign=fe972deb&sv=2) Last updated 7 months ago Was this helpful? * [Getting Started](https://documentation.botghost.com/custom-commands-and-events/events#getting-started) * [Blocks](https://documentation.botghost.com/custom-commands-and-events/events#blocks) * [Available Events](https://documentation.botghost.com/custom-commands-and-events/events#available-events) * [Variables](https://documentation.botghost.com/custom-commands-and-events/events#variables) Was this helpful? --- # Weather | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/utility/weather.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FwEFJFILZg4JeuNVsj0Dq%252Fimage.png%3Falt%3Dmedia%26token%3D8d17c41c-2de0-490b-a7e3-b2b33cce669b&width=768&dpr=3&quality=100&sign=c79dc6&sv=2) The [Weather](https://dashboard.botghost.com/dashboard/module/e09631dc-4f8f-4bf7-a02c-27ea0187d78f/weather) module is a simple way to get the weather of any location in the world directly to your bot. [](https://documentation.botghost.com/utility/weather#settings) Settings ----------------------------------------------------------------------------- ### [](https://documentation.botghost.com/utility/weather#measurement-scales) Measurement Scales ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FSWiThaBzzzJ0TXB65GUF%252Fimage.png%3Falt%3Dmedia%26token%3D82823ef2-f7be-456a-8e56-b241ba97351a&width=768&dpr=3&quality=100&sign=be9893bc&sv=2) #### [](https://documentation.botghost.com/utility/weather#temperature-scale) Temperature Scale The unit of temperature to display the weather temperatures in. Can be set to Celsius or Fahrenheit. #### [](https://documentation.botghost.com/utility/weather#wind-scale) Wind Scale The unit of speed to display the wind speeds in. You are able to display the speeds in miles per hour (MPH) or kilometers per hour (KPH). ### [](https://documentation.botghost.com/utility/weather#embed-configuration) Embed Configuration ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fko0LMupHPBzQxd2Z2j4e%252Fimage.png%3Falt%3Dmedia%26token%3D762a8778-f5de-4693-b9d9-a931ad9f41b8&width=768&dpr=3&quality=100&sign=1376e82&sv=2) #### [](https://documentation.botghost.com/utility/weather#display-images) Display Images The option to display weather related images in the command's embed. #### [](https://documentation.botghost.com/utility/weather#embed-color) Embed Color The embed color for all outputs in the weather command. * * * [](https://documentation.botghost.com/utility/weather#commands) Commands ----------------------------------------------------------------------------- In this area, you can view and modify the command of the Weather module. Below you may find some information on the command of the module. /weather[](https://documentation.botghost.com/utility/weather#weather) Obtain the current and future weather information for any location in the world by providing a base location. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FuJqJh40j1pNyMvLY23Ri%252Fimage.png%3Falt%3Dmedia%26token%3D9bf4ef52-35d8-4502-a2bf-488fcc1e534d&width=300&dpr=3&quality=100&sign=54565700&sv=2) * * * It's advised that you do not edit the command unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited command will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/utility/weather#settings) * [Measurement Scales](https://documentation.botghost.com/utility/weather#measurement-scales) * [Embed Configuration](https://documentation.botghost.com/utility/weather#embed-configuration) * [Commands](https://documentation.botghost.com/utility/weather#commands) Was this helpful? --- # Data Storage | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/data-storage.md) . [Data storage](https://dashboard.botghost.com/dashboard/datastorage) is the first step in unlocking the ability for your bot to store data to be used by your bot, either per server or globally. [](https://documentation.botghost.com/custom-commands-and-events/data-storage#what-are-variables) What are variables ------------------------------------------------------------------------------------------------------------------------- Custom variables are 'placeholders' to store and access data across different commands, interactions and servers! ### [](https://documentation.botghost.com/custom-commands-and-events/data-storage#variable-types) Variable Types Variables can be set to text or numbers, but can also be made specific to a user or channel. Variables can also have a server specific or global scope, meaning it will be the same in all servers. Currently, we offer the following data types: Variable Type Information Text Stores a text value. Number Stores a simple number value. Collection Collections, that are also known as arrays, can store multiple data of the same type. Example, a collection made of User IDs. Learn more [here](https://documentation.botghost.com/custom-commands-and-events/data-storage/collections) . Object Object variables are variables that can store other sub-variables (or properties). Learn more [here](https://documentation.botghost.com/custom-commands-and-events/data-storage/objects) . Which can be either: Type Information Can be Global / Server Specific? Not user / channel specific This means it can't contain a different value basing on the user or channel provided. It can also be global or server specific User Specific This means you can store a different value for every user. Channel Specific This means you can store a different value for each channel in your server. [](https://documentation.botghost.com/custom-commands-and-events/data-storage#creating-a-new-variable) Creating a New Variable ----------------------------------------------------------------------------------------------------------------------------------- To create a new variable, head over to the [data storage](https://dashboard.botghost.com/dashboard/datastorage) module and go to the "New Variable" window. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FEPmGIDxwFoBG8javSlP2%252Fimage.png%3Falt%3Dmedia%26token%3D7a1e066c-b294-4272-99d9-689ad113e62a&width=768&dpr=3&quality=100&sign=307ff665&sv=2) #### [](https://documentation.botghost.com/custom-commands-and-events/data-storage#variable-name) Variable Name In this field you can enter the name of your new variable. This will also be the reference for your variable. #### [](https://documentation.botghost.com/custom-commands-and-events/data-storage#variable-reference) Variable Reference This is your variable reference, it will be `{BGVAR_variable_name}`, depending on what variable name you add. You can use this variable anywhere in your bot to get the variable value. You do not need to enter anything in this field when creating a new variable. #### [](https://documentation.botghost.com/custom-commands-and-events/data-storage#variable-type) Variable Type In this field you can enter the [type of your variable](https://documentation.botghost.com/custom-commands-and-events/data-storage#variable-types) , variables can be set to text or numbers, but can also be made specific to a user or channel. If you select "User" or "Channel" here, you will get another field where you can choose to set the variable type to text, number, collection or object. #### [](https://documentation.botghost.com/custom-commands-and-events/data-storage#default-value) Default Value In this field you can enter a default value that will be in the variable when nothing else has been set. #### [](https://documentation.botghost.com/custom-commands-and-events/data-storage#scope) Scope In this field you can select whether you want to make your variable server specific or global, meaning it will be the same in all servers. ### [](https://documentation.botghost.com/custom-commands-and-events/data-storage#editing-or-deleting-a-variable) Editing or Deleting a Variable To edit a custom variable, simply press the variable you want to edit in the module. You can then edit the variable in this window: ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fmn1MixfZf9MOs2MrkaWM%252Fimage.png%3Falt%3Dmedia%26token%3D219d3a88-b87c-4c7b-a39c-3798c6f68548&width=768&dpr=3&quality=100&sign=35eb3b13&sv=2) Don't forget to press the "Edit Custom Variable" button and save changes! You can also delete a custom variable from storage by pressing the "Delete" button. Deleting a variable will not just clear the value of the variable, this will delete the variable from the storage [](https://documentation.botghost.com/custom-commands-and-events/data-storage#using-your-variable) Using Your Variable --------------------------------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/custom-commands-and-events/data-storage#updating-your-variables-value) Updating Your Variable's Value Interacting with a variable on a non-premium bot will use 1 [call](https://documentation.botghost.com/custom-commands-and-events/data-storage#free-database-usage-calls) . This includes retrieving it in a response and updating it via the actions described below. The delete variable action won't use any calls. To set or clear (delete) custom variables, you can use the Set Variable, Run Equation on Variable or Delete Variable actions in the [command and event builder](https://documentation.botghost.com/custom-commands-and-events/command-and-event-builder) . You can read more about these actions [here](https://documentation.botghost.com/custom-commands-and-events/actions/custom-variable-actions) ! ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FCaN7hQtOMTeOA9swDhaX%252FEFF436DA-6625-413E-8549-5C552E43495F.jpeg%3Falt%3Dmedia%26token%3D872007de-387a-4342-9a13-cf0e16409f5c&width=768&dpr=3&quality=100&sign=481337b6&sv=2) Command Builder actions: Set Variable, Run Equation on Vaiable & Delete Variable ### [](https://documentation.botghost.com/custom-commands-and-events/data-storage#retrieving-your-variable) Retrieving Your Variable You can get data stored in the data storage module by using an associated `{BGVAR_}` variable in other action blocks, for example: `{BGVAR_example}`. You can get user and channel specific variables by targeting them, for example: `{BGVAR_example[ID]}`. You can learn more about targeting [here](https://documentation.botghost.com/custom-commands-and-events/variables#targeting) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FWpY1dzb1srmj125IfSqM%252F51ED887D-5F9D-4305-8FBF-2EF4617B2FDC.jpeg%3Falt%3Dmedia%26token%3D24536b64-5266-44f4-8c45-2ca6c8fc2ff2&width=768&dpr=3&quality=100&sign=104cc596&sv=2) Plain Text Reply with a custom variable, {BGVAR\_exampe} [](https://documentation.botghost.com/custom-commands-and-events/data-storage#free-database-usage-calls) **Free Database Usage (Calls)** --------------------------------------------------------------------------------------------------------------------------------------------- ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FNnCYBgD7gTNFgSrZKdG4%252Fimage.png%3Falt%3Dmedia%26token%3D317d49dd-e868-41c4-bd44-19f1b60a1f00&width=768&dpr=3&quality=100&sign=5419f8c6&sv=2) Every month, users get 500 calls to use across their **free** bots. Free bots will use 1 call every time they either create a variable or update the value of a variable. Only free bots use calls, premium bots can use unlimited data storage. Your calls can not be reset manually, they will automatically reset on the first of each month. The data stored in them will not reset. Experiencing issues with this module or need help? Check out our support options [here](https://documentation.botghost.com/support/botghost-support) ! Last updated 5 months ago Was this helpful? * [What are variables](https://documentation.botghost.com/custom-commands-and-events/data-storage#what-are-variables) * [Variable Types](https://documentation.botghost.com/custom-commands-and-events/data-storage#variable-types) * [Creating a New Variable](https://documentation.botghost.com/custom-commands-and-events/data-storage#creating-a-new-variable) * [Editing or Deleting a Variable](https://documentation.botghost.com/custom-commands-and-events/data-storage#editing-or-deleting-a-variable) * [Using Your Variable](https://documentation.botghost.com/custom-commands-and-events/data-storage#using-your-variable) * [Updating Your Variable's Value](https://documentation.botghost.com/custom-commands-and-events/data-storage#updating-your-variables-value) * [Retrieving Your Variable](https://documentation.botghost.com/custom-commands-and-events/data-storage#retrieving-your-variable) * [Free Database Usage (Calls)](https://documentation.botghost.com/custom-commands-and-events/data-storage#free-database-usage-calls) Was this helpful? --- # Autoresponder | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/messages/autoresponder.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FMZW2hY9KBccAFGsVFZTS%252Fimage.png%3Falt%3Dmedia%26token%3Df4d16829-50bc-4242-a77d-f98cd9281ea1&width=768&dpr=3&quality=100&sign=84365334&sv=2) The [Autoresponder](https://dashboard.botghost.com/dashboard/module/8de92a0c-1e68-4577-900d-26e2bda7b396/autoresponder) module will allow you to set keywords that will trigger a response from the bot. This can be from a simple "hello" to a whole sentence under the settings you select. [](https://documentation.botghost.com/messages/autoresponder#settings) Settings ------------------------------------------------------------------------------------ ### [](https://documentation.botghost.com/messages/autoresponder#autoresponder-setup) Autoresponder Setup Customize the autoresponder in it's entirety and modify certain aspects or nothing at all. Click on the add button at the bottom right to add the autoresponder to the active list. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FMUCxTAiaKb5NQYGBJhsS%252Fimage_2024-07-09_221223244.png%3Falt%3Dmedia%26token%3Da9073427-4e81-4029-bf8a-d0694f78d57f&width=768&dpr=3&quality=100&sign=58e85ef5&sv=2) #### [](https://documentation.botghost.com/messages/autoresponder#trigger-detection-type) **Trigger Detection Type** Define how the bot should handle the trigger keywords, whether the message contains, is equal to, starts with, or ends with a keyword. #### [](https://documentation.botghost.com/messages/autoresponder#trigger-keywords) **Trigger Keywords** Set the keywords that will trigger the autoresponder. Currently, up to 100 keywords for each active autoresponder. To add the keyword, you may press 'Enter' in your keyboard. Added keywords will appear on the right. #### [](https://documentation.botghost.com/messages/autoresponder#message) Message Configure the message content and type, whether you wish to send an embed or plain text. All [variables](https://documentation.botghost.com/custom-commands-and-events/variables) can be used. #### [](https://documentation.botghost.com/messages/autoresponder#channel-cooldown) **Channel Cooldown** In this field you can input the channel cooldown in seconds between autoresponders. #### [](https://documentation.botghost.com/messages/autoresponder#mention-users) **Mention Users** With this selection you can choose whether you to mention the user triggering the keyword or not. #### [](https://documentation.botghost.com/messages/autoresponder#channel-selection-type) **Channel Selection - Type** This section is where you can choose whether to enable all channels except those whitelisted, or the selected channels that can trigger the autoresponder. #### [](https://documentation.botghost.com/messages/autoresponder#channel-selection-channels) **Channel Selection - Channels** Based off [Channel Selection - Type](https://documentation.botghost.com/messages/autoresponder#channel-selection-type) , you can choose channels that will either block or allow the autoresponder to trigger. #### [](https://documentation.botghost.com/messages/autoresponder#role-selection-type) **Role Selection - Type** In this field you can choose whether to enable all roles except those whitelisted, or the selected roles. #### [](https://documentation.botghost.com/messages/autoresponder#role-selection-roles) **Role Selection - Roles** Based off [Role Selection - Type](https://documentation.botghost.com/messages/autoresponder#role-selection-type) , you can choose roles that will either block or allow the autoresponder to trigger. To save the autoresponder's settings, you need to click "Add" in the bottom-right corner of the settings. This will reset the fields so you can set up another autoresponder. ### [](https://documentation.botghost.com/messages/autoresponder#active-responders) Active Responders These are the active autoresponders that will trigger based off many factors such as roles, channels and keywords. The current maximum is 100 for premium users. Once opened, at the bottom right you can edit / delete the auto responder. To save the edits you made on the autoresponder's settings, you need to click "Edit" in the bottom-right corner of the settings. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FybBOKX2UWWtATHMZhYnf%252Fimage_2024-07-09_222401622.png%3Falt%3Dmedia%26token%3Dade866e5-3436-4f9c-8876-1b8950182b66&width=768&dpr=3&quality=100&sign=6c85d932&sv=2) Potential active responders of the Autoresponder module * * * [](https://documentation.botghost.com/messages/autoresponder#events) Events -------------------------------------------------------------------------------- In this area, you can view and modify the events of the Autoresponder module. Below you may find some information on each event of the module. All Autoresponders will be ordered by the number in which they were created. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F9gLmucpJbZQElkiEdWrd%252Fimage_2024-07-09_222634101.png%3Falt%3Dmedia%26token%3D919c6560-d5b4-48a7-9b3b-b2dde934e2aa&width=768&dpr=3&quality=100&sign=503a6e5f&sv=2) Potential Custom Events of the Autoresponder module Autoresponder #...[](https://documentation.botghost.com/messages/autoresponder#autoresponder) Once a autoresponder is added, it's corresponding event will be added as an event. These events control how the autoresponder functions based off the settings you chose and send the message to the channel. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/messages/autoresponder#settings) * [Autoresponder Setup](https://documentation.botghost.com/messages/autoresponder#autoresponder-setup) * [Active Responders](https://documentation.botghost.com/messages/autoresponder#active-responders) * [Events](https://documentation.botghost.com/messages/autoresponder#events) Was this helpful? --- # Invite Tracker | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/community-engagement/invite-tracker.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FbbtNlk2mNzQ76TL6UtKF%252Fimage.png%3Falt%3Dmedia%26token%3D01754363-3705-43f1-b2fc-418c50fd2514&width=768&dpr=3&quality=100&sign=a5a2e39f&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. The [Invite Tracker](https://dashboard.botghost.com/dashboard/module/4cb902a6-dc80-439c-a650-6af2564e8ee6/invitetracker) module will enable members of your community to retrieve leaderboards and specific member statistics for individuals they invite. [](https://documentation.botghost.com/community-engagement/invite-tracker#settings) Settings ------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/community-engagement/invite-tracker#counter-settings) Counter Settings In this area is where you can configure specific messages sent when a new member is invited, roles, restrictions and more. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FjMWi0ky5SqLg77JBgic7%252Fimage_2024-07-22_203035482.png%3Falt%3Dmedia%26token%3D72693db9-d940-4ffa-a024-4237a27b40f2&width=768&dpr=3&quality=100&sign=f90b7ff5&sv=2) #### [](https://documentation.botghost.com/community-engagement/invite-tracker#update-message-type) **Update Message Type** This is where the type of message sent can be configured when a user is invited. No Message Direct Message Message to Channel No Message will be sent in the server if this option is chosen. If this option is selected, when a user is invited they will receive this message in their direct messages. #### [](https://documentation.botghost.com/community-engagement/invite-tracker#update-message) Update Message Here is where you can configure the message being sent. You can use [variables](https://documentation.botghost.com/custom-commands-and-events/variables) such as `{invites}` and `{inviter}` to show stats and more. You can also toggle the message type to choose between [embed](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/embed-reply) or a [plain text](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/plain-text-reply) response. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fsdc0I8dwrLGmQF07k5Nh%252Fimage.png%3Falt%3Dmedia%26token%3Df2051d9d-b5e8-40f7-969c-b90b165d3230&width=768&dpr=3&quality=100&sign=aee22793&sv=2) If this selection is chosen, a message will be sent to a specific channel when a user is invited into the server. #### [](https://documentation.botghost.com/community-engagement/invite-tracker#updates-channel) Updates Channel Here you can choose a text or announcement channel to serve as the channel that receives the invite messages. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FkkdjZRd9XH8EPidRWrKR%252Fimage.png%3Falt%3Dmedia%26token%3Dc86a5382-5ccf-4f6b-bfee-ffe6256db26a&width=768&dpr=3&quality=100&sign=6430e6aa&sv=2) #### [](https://documentation.botghost.com/community-engagement/invite-tracker#update-message-1) Update Message Here is where you can configure the message being sent. You can use [variables](https://documentation.botghost.com/custom-commands-and-events/variables) such as `{invites}` and `{inviter}` to show stats and more. You can also toggle the message type to choose between [embed](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/embed-reply) or a [plain text](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/plain-text-reply) response. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fsdc0I8dwrLGmQF07k5Nh%252Fimage.png%3Falt%3Dmedia%26token%3Df2051d9d-b5e8-40f7-969c-b90b165d3230&width=768&dpr=3&quality=100&sign=aee22793&sv=2) #### [](https://documentation.botghost.com/community-engagement/invite-tracker#ignored-roles) **Ignored Roles** In this field you can choose certain roles to be excluded from the invite counter. This means that if they invite a user it doesn't count towards their total invites. #### [](https://documentation.botghost.com/community-engagement/invite-tracker#filter-suspicious-invites) **Filter Suspicious Invites** If this toggle is enabled, when a user with a relatively low account age is invited, it will not count towards the inviter's total invites. #### [](https://documentation.botghost.com/community-engagement/invite-tracker#minimal-account-age) **Minimal Account Age** Configure the account age in days to trigger the [Filter Suspicious Invites](https://documentation.botghost.com/community-engagement/invite-tracker#filter-suspicious-invites) filter. Only integers can be accepted in this field. _This setting is only visible when_ [Filter Suspicious Invites](https://documentation.botghost.com/community-engagement/invite-tracker#filter-suspicious-invites) _is enabled._ #### [](https://documentation.botghost.com/community-engagement/invite-tracker#hide-left-inviters) **Hide Left Inviters** If this toggle is enabled, users who left the server will not show up on the leaderboard when `/invite-leaderboard` is used. #### [](https://documentation.botghost.com/community-engagement/invite-tracker#register-leaves) **Register Leaves** When this toggle is enabled, if a user that got invited by someone in the server leaves, the inviter's total invite count will decrease by one. ### [](https://documentation.botghost.com/community-engagement/invite-tracker#role-rewards) Role Rewards Here is how to setup roles to be given to members when they meet a certain amount of people invited. You can have up to 10 rewards. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FYsCWkDqPAWAtjYxDpjo9%252Fimage.png%3Falt%3Dmedia%26token%3Ddd42ff6d-b0a2-4c0e-9ea3-145bd58e2e24&width=768&dpr=3&quality=100&sign=6bed654b&sv=2) #### [](https://documentation.botghost.com/community-engagement/invite-tracker#required-invite-count) **Required Invite Count** This field input is how many people need to be invited by a member for the role in this reward to be given. #### [](https://documentation.botghost.com/community-engagement/invite-tracker#role-reward) **Role Reward** The role to be given when the required invite count is met or gone beyond. Only 1 role can be selected per reward. To save the reward's settings, you need to click "Add" in the bottom-right corner of the settings. This will reset the fields so you can set up another reward. ### [](https://documentation.botghost.com/community-engagement/invite-tracker#active-rewards) Active Rewards This area is where you can manage your active role rewards and their settings. To save the edits you made on the reward's settings, you need to click "Edit" in the bottom-right corner of the settings. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FoxGMyRTPgf8GRGbnxy71%252Fimage.png%3Falt%3Dmedia%26token%3Dc763551c-30ca-4884-893e-dada50a3cb21&width=768&dpr=3&quality=100&sign=80d92315&sv=2) * * * [](https://documentation.botghost.com/community-engagement/invite-tracker#commands) Commands ------------------------------------------------------------------------------------------------- In this area, you can view and modify the commands of the Invite Tracker module. Below you may find some information on each command of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FBREfzPf0daD1aF43XHt7%252Fimage.png%3Falt%3Dmedia%26token%3D42a9d291-3f34-4a20-99ca-e16b2bf7bf04&width=768&dpr=3&quality=100&sign=652479ab&sv=2) /invites[](https://documentation.botghost.com/community-engagement/invite-tracker#invites) This command allows you to check the number of invites of anyone in the server. /invites-leaderboard[](https://documentation.botghost.com/community-engagement/invite-tracker#invites-leaderboard) This command displays the leaderboard of members who invited the most users to your server. You can browse through the leaderboard by using the buttons at the bottom of the leaderboard message. [](https://documentation.botghost.com/community-engagement/invite-tracker#events) Events --------------------------------------------------------------------------------------------- In this area, you can view and modify the events of the Invite Tracker module. Below you may find some information on each event of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FUwJriTMW5R9IqbeteAje%252Fimage_2024-07-22_205543705.png%3Falt%3Dmedia%26token%3Deaf035ad-cb8b-4d4f-8add-c0753211cb47&width=768&dpr=3&quality=100&sign=f913dbdf&sv=2) Invites Handler[](https://documentation.botghost.com/community-engagement/invite-tracker#invites-handler) This event edits the invite count for when a user gets invited to your server. Leaves Handler[](https://documentation.botghost.com/community-engagement/invite-tracker#leaves-handler) This event tracks when a user is removed or leaves the server and adjusts the invite count accordingly. Reward #...[](https://documentation.botghost.com/community-engagement/invite-tracker#reward) When a active reward is made from [Role Rewards](https://documentation.botghost.com/community-engagement/invite-tracker#role-rewards) , the corresponding event will be created and automatically gives a user a role dependent on the reward settings. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Settings](https://documentation.botghost.com/community-engagement/invite-tracker#settings) * [Counter Settings](https://documentation.botghost.com/community-engagement/invite-tracker#counter-settings) * [Role Rewards](https://documentation.botghost.com/community-engagement/invite-tracker#role-rewards) * [Active Rewards](https://documentation.botghost.com/community-engagement/invite-tracker#active-rewards) * [Commands](https://documentation.botghost.com/community-engagement/invite-tracker#commands) * [Events](https://documentation.botghost.com/community-engagement/invite-tracker#events) Was this helpful? --- # Channel Condition | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/conditions/channel-condition.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FmHzqoSzfJLopmvpwtyeU%252Fimage.png%3Falt%3Dmedia%26token%3Dcf91306d-2d36-4af5-8bd8-fdfc7223a238&width=768&dpr=3&quality=100&sign=6d9dd3cb&sv=2) This condition will run actions based off the channel that the command / event was triggered in or where a [menu option](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/send-a-message-with-a-select-menu/menu-option) / [button](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/send-a-message-with-attached-buttons/buttons) was clicked. [](https://documentation.botghost.com/custom-commands-and-events/conditions/channel-condition#run-multiple-actions) Run multiple actions --------------------------------------------------------------------------------------------------------------------------------------------- This option allows you to set the condition to run multiple actions at the same time. This means if multiple conditions are met, then each true condition will be run simultaneously. When disabled, only the first met condition will be executed. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FgkJsf2QwTvFRQTCrgkB4%252Fimage_2024-06-10_222911587.png%3Falt%3Dmedia%26token%3D8f9bcc2e-b7ee-4105-b330-75db316f8e85&width=768&dpr=3&quality=100&sign=d5a65ff3&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/conditions/channel-condition#channel) Channel ------------------------------------------------------------------------------------------------------------------- This section is a dropdown menu of channels that may be selected for the condition to compare. Click the refresh icon next to the title if the channel you're looking for isn't showing. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FIiuS98uhw8ZRNifTtAhu%252Fimage_2024-06-10_223010960.png%3Falt%3Dmedia%26token%3Dd07235a6-826d-4610-ba20-4a08b2598e79&width=768&dpr=3&quality=100&sign=c99540c3&sv=2) Click the add condition button to add one or more compared channels to the condition ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FvfEmBi39cGBdDFMqLG8P%252Fimage_2024-06-10_223133483.png%3Falt%3Dmedia%26token%3D6942865e-67d2-47e6-bc6a-a1bce1bbdbc1&width=768&dpr=3&quality=100&sign=827b105c&sv=2) You may individually click on a compared channel to edit the values and more. Click the block on the builder to access the following menu. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FrbQd732p4ikjVVHPRLVb%252Fimage_2024-06-10_223350820.png%3Falt%3Dmedia%26token%3Dafb43533-1644-4afe-9db4-0e71f5db0777&width=768&dpr=3&quality=100&sign=e4f2850&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/conditions/channel-condition#channel-id) Channel ID ------------------------------------------------------------------------------------------------------------------------- In this section you can edit the compared channel by switching the channel ID. [Variables](https://documentation.botghost.com/custom-commands-and-events/variables) may be used this in field or a plain channel ID. [](https://documentation.botghost.com/custom-commands-and-events/conditions/channel-condition#run-when-the-command-is-not-used-in-this-channel) Run when the command is NOT used in this channel ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- This option, when enabled, allows you to run the actions below the selected block when the user does not use the command in the specific channel, instead of running when the user does. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FXjDAcrgciHtR0zxChxTA%252Fimage_2024-06-10_223740851.png%3Falt%3Dmedia%26token%3Def88cb73-73e2-4267-a7c4-26ec9105ec44&width=768&dpr=3&quality=100&sign=dd926a1d&sv=2) Here is an example layout of the condition: ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F0zhvDuRjZmpZWqTIfJVO%252FScreenshot%25202023-02-13%2520at%25201.52.03%2520PM.png%3Falt%3Dmedia%26token%3D77ac6a8a-5490-4dbe-90ec-53c565b32889&width=768&dpr=3&quality=100&sign=dc5663ef&sv=2) Last updated 2 years ago Was this helpful? * [Run multiple actions](https://documentation.botghost.com/custom-commands-and-events/conditions/channel-condition#run-multiple-actions) * [Channel](https://documentation.botghost.com/custom-commands-and-events/conditions/channel-condition#channel) * [Channel ID](https://documentation.botghost.com/custom-commands-and-events/conditions/channel-condition#channel-id) * [Run when the command is NOT used in this channel](https://documentation.botghost.com/custom-commands-and-events/conditions/channel-condition#run-when-the-command-is-not-used-in-this-channel) Was this helpful? --- # Webhooks | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/events/webhooks.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FXaHp2YvYuFkDtN1FOHpR%252Fimage.png%3Falt%3Dmedia%26token%3D5067e885-79bb-49f9-828e-55c904fdba79&width=768&dpr=3&quality=100&sign=9e1901d2&sv=2) [BotGhost webhooks](https://dashboard.botghost.com/dashboard/webhooks) allow you to trigger custom events by sending a POST HTTP request to the internal BotGhost API. This lets you connect external services and pass along data to your BotGhost hosted bot. A BotGhost webhook is NOT the same as a [Discord webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) . * * * [](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#api-key) API Key ------------------------------------------------------------------------------------------------------ To secure your webhook, the module requires you to authenticate with an API key. The owner of the bot can view, copy, and regenerate this key at any time on the Webhooks module. Treat this key like a password to your custom event, and only share it with those who should be able to trigger it. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FguFULuaLFqfQORpDSjYQ%252Fimage.png%3Falt%3Dmedia%26token%3D9aadfec9-0ec0-419f-b0af-ae6c05fa0684&width=768&dpr=3&quality=100&sign=d2ab4130&sv=2) * * * [](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#setting-up-webhooks) Setting Up Webhooks ------------------------------------------------------------------------------------------------------------------------------ ### [](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#creating-a-webhook) Creating a Webhook ![](https://docs.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F9IPyeLmhnwxap8wVYKUJ%252Fimage.png%3Falt%3Dmedia%26token%3Dd8032ef2-693d-47ea-9d38-394dcca50975&width=768&dpr=4&quality=100&sign=568f459d&sv=2) To trigger an event from an external source you must first create a new webhook in your BotGhost dashboard. Enter a descriptive name for your webhook and click **Add Webhook Event**. An Event ID will be prepopulated and a new webhook will be created. ![](https://docs.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FSOKA3z0Oa4c2CKvxtxnq%252Fimage.png%3Falt%3Dmedia%26token%3D255cc0ee-a10a-43e4-a745-fcdbf78a2f3f&width=768&dpr=4&quality=100&sign=fa5230f&sv=2) In the example request section of the newly created webhook, you will see the webhook URL and the required headers and body of the request. View the API reference at the bottom of the page for more information about the required information of the POST request. ### [](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#creating-a-custom-event) Creating a Custom Event Once you have created a webhook, you need to create a custom event to be executed when you submit a POST request to your webhook. This is the same process as creating a normal BotGhost custom event however you must select your webhook as an event type. Go to the Custom Events module and create a new event. Select your webhook as the event type for your new event. ![](https://docs.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F53zgYGR3pGWpIPgoQbo5%252Fimage.png%3Falt%3Dmedia%26token%3D0c2f2696-c325-4dcd-b053-1ee26db84647&width=768&dpr=4&quality=100&sign=dc5272dc&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FquBEg4MKVek1ySjndRvo%252Fimage.png%3Falt%3Dmedia%26token%3Dcf67e3d2-b923-402d-b05b-360bc97e93bb&width=768&dpr=3&quality=100&sign=387b2d23&sv=2) Once you have created your event, you must also set a server id as a base for the event. This is so it can retrieve information about channels and members when your event is executed. ![](https://docs.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FMFwD47NH5hmcPlvmD8ub%252Fimage.png%3Falt%3Dmedia%26token%3D038240ce-79ed-446d-b166-ef747aa33683&width=768&dpr=4&quality=100&sign=3d522add&sv=2) After entering a server id, you can configure your custom event like normal. This event will be triggered when its associated webhook receives a valid HTTP POST request. ### [](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#sending-your-post-request) Sending your POST request Once you have created a webhook and custom event you must send a POST request to the webhook URL. The webhook URL is always in the format `https://api.botghost.com/webhook/{bot_id}/{event_id}` replacing `{bot_id}` with your bot's id and `{event_id}` with the generated webhook event id. You must pass along your API token as an Authorization Header to authenticate your `POST` request. ![](https://docs.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FZkSPrF92pXgDsjYIxkkr%252Fimage.png%3Falt%3Dmedia%26token%3Dad3f324f-824c-43f3-b55d-86dac5a57e35&width=768&dpr=4&quality=100&sign=77300ae0&sv=2) You can also optionally pass along an array of variables to act as event variables with your request. The BotGhost Webhook API expects a JSON formatted array of objects with each variable object having: Key Info `name` A descriptive name for your variable. `variable` The actual variable itself. This must start with `{` and end with `}`. `value` The value of the variable that will be replaced when it is used in the webhook event. Pass these variables along in the body of your request. You can then use any of these supplied variables in the custom event being executed by your webhook. ![](https://docs.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FwUyCMaQOszP0qHoAmay0%252Fimage.png%3Falt%3Dmedia%26token%3Dbcb0de05-c581-48bd-93e5-084528ce49b0&width=768&dpr=4&quality=100&sign=90bb5c4f&sv=2) * * * [](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#api-reference) API Reference ------------------------------------------------------------------------------------------------------------------ Submit a `POST` request to the following endpoint. On success, if a custom event with that webhook event id exists that event will be triggered. Replace `{bot_id}` and `{event_id}` in the URL with your bots id and a webhook event id. `POST` `https://api.botghost.com/webhook/{bot_id}/{event_id}` Send a POST request to trigger a custom event on a bot. Replace `{bot_id}` and `{event_id}` with your bot id and an event id. Event ids are generated after creating a webhook in the webhook module. **Headers** Name Type Description Authorization\* API\_KEY Auhthorization header with your API\_KEY from the webhooks module page. **Request Body** Name Type Description variables Array An array of optional variables to pass along to the webhook. Each variable object should have a name, variable, and value. #### [](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#response) Response When you send your `POST` request to your BotGhost webhook, you may receive different status codes. These codes let you know whether the webhook event was successfully triggered, or if an error occurred. Below you can find detailed information about each status code, what it means, and what to do from there. 200: OK 400: Bad Request 401: Unauthorized 404: Not Found 405: Method Not Allowed 429: Too Many Requests Success! This status is returned when the webhook event has successfully been triggered. If you didn't get the result you expected, double-check your event's logic and try again. Error. This status is returned when the request hasn't been formatted properly. #### [](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#what-went-wrong) What Went Wrong The most common occurrences of this error happen when: * The variables parameter was not formatted as an array * The variables parameter was missing the `name`, `variable`, or `value` key(s) * The variables parameter had an improperly formatted `variable` key #### [](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#how-to-fix) How to Fix Head back to the variables settings under [Sending your POST request](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#sending-your-post-request) and try setting up again. Error. This status is returned when the provided API key is invalid. #### [](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#what-went-wrong-1) What Went Wrong The most common occurrences of this error happen when: * The API key was not provided * The API key has been provided incorrectly * The API key has been regenerated * The bot has been removed from BotGhost #### [](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#how-to-fix-1) How to Fix Head back to the [API Key](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#api-key) settings and try setting up again. Error. This status is returned when the provided URL is invalid. #### [](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#what-went-wrong-2) What Went Wrong The most common occurrences of this error happen when: * The webhook URL has been provided incorrectly * The webhook event has been deleted * The bot has been removed from BotGhost #### [](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#how-to-fix-2) How to Fix Head back to the webhook URL settings under [Sending your POST request](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#sending-your-post-request) and try setting up again. Error. This status is returned when you have sent an API request to your webhook that is not a `POST` request. To fix it, set your request type to `POST` and try again. Error. This status is returned when you have sent too many requests to this URL in a too short amount of time. To fix it, wait a while before trying again. Last updated 1 year ago Was this helpful? * [API Key](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#api-key) * [Setting Up Webhooks](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#setting-up-webhooks) * [Creating a Webhook](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#creating-a-webhook) * [Creating a Custom Event](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#creating-a-custom-event) * [Sending your POST request](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#sending-your-post-request) * [API Reference](https://documentation.botghost.com/custom-commands-and-events/events/webhooks#api-reference) Was this helpful? --- # Choice Option | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/options/choice-option.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FJQ1xkB7heN8B6p8AU5lv%252FBildschirm%25C2%25ADfoto%25202023-02-17%2520um%252005.23.59.png%3Falt%3Dmedia%26token%3Da265fdf8-deb3-4588-8b1e-20add4291d1c&width=768&dpr=3&quality=100&sign=567c7c5b&sv=2) This option block is a choice between `True` or `False` that can be used in later actions / conditions of the command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FSVDaanfvzoGywnRxUmaL%252FBildschirm%25C2%25ADfoto%25202023-02-17%2520um%252005.24.36.png%3Falt%3Dmedia%26token%3D487ecc2a-d862-42c3-a02b-fee326952173&width=768&dpr=3&quality=100&sign=348acfb9&sv=2) You can retrieve the variable of the option via the **Clipboard** or the block itself. The format of the variable is `{option_optionname}`, where `optionname` is the [name](https://documentation.botghost.com/custom-commands-and-events/options/choice-option#option-name) of the option. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F7l53Sjd6fgU8sGvJLYBy%252Fimage_2024-06-08_124418534.png%3Falt%3Dmedia%26token%3Dfcc434ee-5711-442d-a092-00502a3c6905&width=768&dpr=3&quality=100&sign=6b67a02&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/choice-option#option-name) Option Name -------------------------------------------------------------------------------------------------------------------- This field requires an input for your unique option name. The designated name will then be the reference for your option variable. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F5Xsz9M6Zbq78M181Nbqo%252Fimage_2024-06-07_183434741.png%3Falt%3Dmedia%26token%3Da6e30549-8f2f-448b-a843-ec8c700abbe7&width=768&dpr=3&quality=100&sign=77270026&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/choice-option#option-description) Option Description ---------------------------------------------------------------------------------------------------------------------------------- The option description field allows you to assign a custom description to your option. It is useful to describe what the option is used for. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FBLA0U2rli29wlyMnQslm%252Fimage_2024-06-07_183520597.png%3Falt%3Dmedia%26token%3D31fcbdc6-5d1f-4f56-9006-62f530139aff&width=768&dpr=3&quality=100&sign=a0f550c4&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/choice-option#set-required) Set Required ---------------------------------------------------------------------------------------------------------------------- With this switch you are able to toggle if the option should be required or not in order to execute the command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FZdasaits2xqKe9Prpu8h%252Fimage_2024-06-07_182514963.png%3Falt%3Dmedia%26token%3D6c293fc9-954e-4a5d-9496-5fbb04ae304a&width=768&dpr=3&quality=100&sign=e0b59302&sv=2) Last updated 2 years ago Was this helpful? * [Option Name](https://documentation.botghost.com/custom-commands-and-events/options/choice-option#option-name) * [Option Description](https://documentation.botghost.com/custom-commands-and-events/options/choice-option#option-description) * [Set Required](https://documentation.botghost.com/custom-commands-and-events/options/choice-option#set-required) Was this helpful? --- # Options | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/options.md) . Options are purple in color and are used for users to input values into the command, which can then be referenced anywhere within the command with the variable {option\_optionname}. Options function when a command is about to be executed, which creates fields to be able to input values into. Additionally, options are automatically connected to the command when added. They are also only available in commands and aren't required to be in the command. [](https://documentation.botghost.com/custom-commands-and-events/options#option-blocks) Option Blocks ---------------------------------------------------------------------------------------------------------- Block Information [Text Option](https://documentation.botghost.com/custom-commands-and-events/options/text-option) The text option block allows for a text value to be input. [Number Option](https://documentation.botghost.com/custom-commands-and-events/options/number-option) This block allows a number value to be input. [User Option](https://documentation.botghost.com/custom-commands-and-events/options/user-option) This option allows you to select a user from a list of server members. [Channel Option](https://documentation.botghost.com/custom-commands-and-events/options/channel-option) This option allows you to select a channel from a list of server channels. [Role Option](https://documentation.botghost.com/custom-commands-and-events/options/role-option) This option allows you to select a role from your server. [Choice Option](https://documentation.botghost.com/custom-commands-and-events/options/choice-option) With this option you are able to select true or false from a dropdown. [Attachment Option](https://documentation.botghost.com/custom-commands-and-events/options/attachment-option) The attachment option allows you to upload an attachment to the command. [Music Smart Search Option](https://documentation.botghost.com/custom-commands-and-events/options/music-smart-search-option) The music smart search option can be used to let users search for music tracks when using a command. Last updated 6 months ago Was this helpful? Was this helpful? --- # Image Generation | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/ai/image-generation.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FMivVpG4eUIt34074YbGl%252Fimage.png%3Falt%3Dmedia%26token%3D86ca2c97-2dfb-4fe5-8cfb-b382a0e6ede6&width=768&dpr=3&quality=100&sign=2d7c7046&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. The [Image Generation](https://dashboard.botghost.com/dashboard/module/fab3a781-88c6-4bd6-9db0-6c2f68b36931/imagegeneration) module allows users to trigger a command to send a request to the Dall-E API to generate a imaged based off of the prompts the user inputs while using the command. [](https://documentation.botghost.com/ai/image-generation#credentials-setup) Credentials Setup --------------------------------------------------------------------------------------------------- 1 Click [here](https://platform.openai.com/account/api-keys) to get started. Log into OpenAI. If you haven't already, Open AI might ask you to verify your phone number before proceeding. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fq9GPD8gYEEKSUJUdOUT0%252Fimage.png%3Falt%3Dmedia%26token%3D21258ead-278d-4369-9e6e-8c74720216e0&width=768&dpr=3&quality=100&sign=4db4d6a7&sv=2) 2 Once you logged in, click on the "Create new secret key button. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FS7gwMVMFJzgROIn9FgNg%252Fimage.png%3Falt%3Dmedia%26token%3D4c28f2f7-66d6-4ffc-a30c-fca4aa336669&width=768&dpr=3&quality=100&sign=7a7c3f78&sv=2) 3 This will prompt you to make a key. Set Owned by "You" and give your app a name. Set the "Permissions" to all. Once done, click on "Create Secret Key" ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F8jDcjid6nM0pn1C4FEQY%252Fimage.png%3Falt%3Dmedia%26token%3Def74a1c9-be35-4a97-8993-e0f087a4c170&width=768&dpr=3&quality=100&sign=372fc88c&sv=2) 4 Copy your key. Make sure to not share it with anyone. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Ft5wYLfCDF4amFI8F4pjO%252FUntitled%2520design.png%3Falt%3Dmedia%26token%3D92f2b404-4afc-45c8-93ba-6316f89c861f&width=768&dpr=3&quality=100&sign=60a63e3b&sv=2) 5 Paste your key into the BotGhost Dashboard in the [OpenAI API Key](https://documentation.botghost.com/ai/image-generation#openai-api-key) field. * * * [](https://documentation.botghost.com/ai/image-generation#settings) Settings --------------------------------------------------------------------------------- In this area you can configure the main settings for the image generation module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FohNwUVd8hueO1Aff1HzJ%252Fimage_2024-07-10_214158577.png%3Falt%3Dmedia%26token%3D6fbc6fcb-8e1c-4352-a7b3-73f9e0c541b0&width=768&dpr=3&quality=100&sign=93dd7461&sv=2) #### [](https://documentation.botghost.com/ai/image-generation#openai-api-key) **OpenAI API Key** In this field is where you will need to enter your OpenAI API key to be able to use the module, you can follow this guide [here](https://platform.openai.com/docs/api-reference/authentication) , to generate your own API key. #### [](https://documentation.botghost.com/ai/image-generation#generate-multiple-variations) **Generate Multiple Variations** With this toggle you can enable / disable the option for the bot to generate multiple variations of the image, this will allow you to see multiple versions with one trigger. #### [](https://documentation.botghost.com/ai/image-generation#default-image-size) Default Image Size You can choose the image size from one of the following options: * 1024x1024 Pixels * 512x512 Pixels * 256x256 Pixels * * * [](https://documentation.botghost.com/ai/image-generation#commands) Commands --------------------------------------------------------------------------------- In this area, you can view and modify the commands of the Image Generation module. Below you may find some information on each command of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FP9pir62xIQyw2lHYbHSt%252Fimage_2024-07-10_214943606.png%3Falt%3Dmedia%26token%3Deb28d0a2-2f1d-45d3-bcd0-57a6cccc883c&width=768&dpr=3&quality=100&sign=51632cd9&sv=2) /imagine[](https://documentation.botghost.com/ai/image-generation#imagine) Upon being triggered this command generates the image(s) based upon the prompts you submit, here you can edit the command to add additional features or expand on the base module. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Credentials Setup](https://documentation.botghost.com/ai/image-generation#credentials-setup) * [Settings](https://documentation.botghost.com/ai/image-generation#settings) * [Commands](https://documentation.botghost.com/ai/image-generation#commands) Was this helpful? --- # Embed Builder | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/messages/embedbuilder.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FjWceEKQde1WxxAOhPRSm%252Fimage.png%3Falt%3Dmedia%26token%3De6b02938-5585-498b-8d7f-631bc57d8765&width=768&dpr=3&quality=100&sign=100e22b9&sv=2) The Embed Builder makes it very simple and easy to send multiple embeds to server with no effort! Using the Embed Builder you can send, edit, and maximize customizability! [](https://documentation.botghost.com/messages/embedbuilder#general-settings) General Settings --------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/messages/embedbuilder#embed-selector) Embed Selector The Embed Selector lets you choose from all previous / running embeds that have been sent to all servers! Just select which embed you want to edit from the dropdown and get editing right away, taking away the hassle of having to find the message and copy the ID to edit it. Only embeds you've saved using the 'Save Embeds' button will appear here! ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FoUdLAWkUOfyHYj4EAC0o%252Fbg_embed-selector_noembeds.png%3Falt%3Dmedia%26token%3D9eefd8a5-9e7a-4aec-bdba-942804ed17f3&width=768&dpr=3&quality=100&sign=e692b704&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FftEN7qd9iWoJ0NNAzSU7%252Fbg_embed-selector_embedlist.png%3Falt%3Dmedia%26token%3D33669b77-5203-43b7-937a-65d50fba13ed&width=768&dpr=3&quality=100&sign=ffe536ff&sv=2) ### [](https://documentation.botghost.com/messages/embedbuilder#message-link) Message Link The Message Link feature lets you edit embeds without having to re-send the embed, this means all reactions and content underneath it will remain where they are and the message itself with just show as edited. You can only edit messages that are saved in your embed selector, if they aren't there then you wont be able to edit that message. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FJ948bqBVDymA7reDvGzo%252Fbg_message-link_linkpreviewe.png%3Falt%3Dmedia%26token%3Dd5302e9e-169b-460b-8fba-ec97d9fd6988&width=768&dpr=3&quality=100&sign=d093431&sv=2) If your link contains discordapp.com, remove the 'app' ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FOrysQ4xIRdJ2MzCQqkdU%252Fbg_message-link_editedmessage.png%3Falt%3Dmedia%26token%3De0b813b4-33d4-4566-a70c-02bd87a27938&width=768&dpr=3&quality=100&sign=a2f2753a&sv=2) ### [](https://documentation.botghost.com/messages/embedbuilder#channel) Channel The channel option is the place that your embed is going to be sent to, simply select the channel you want your embed to be sent to and it'll be sent there. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FJFLyHf1gy2Iz4gucsBOJ%252Fbg_channel.png%3Falt%3Dmedia%26token%3D9b49e835-accc-4d65-a011-3cca2cda5f28&width=768&dpr=3&quality=100&sign=96d3c167&sv=2) ### [](https://documentation.botghost.com/messages/embedbuilder#embed-content) Embed Content The Embed Content is the non-embedded - plain - text above your embed. This text will appear as a normal message but will remain connected to your embed, meaning they're apart of the same message. If you want to ping channels, roles, or members above your embed and have them get the notification, you can use <#CHANNEL-ID> for channels, <@&ROLE-ID> for roles, and <@!USER-ID> for members of your server. _How to get a Channel, Role or User ID? Click_ [_here_](https://btghst.info/copyID) _!_ ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FTZchapQNIqMRaI19B03T%252Fbg_embedcontent.png%3Falt%3Dmedia%26token%3D0cdbab41-615b-4c7c-a0e5-9936f0ba5862&width=768&dpr=3&quality=100&sign=c46dc115&sv=2) [](https://documentation.botghost.com/messages/embedbuilder#author-settings) Author Settings ------------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/messages/embedbuilder#name) Name The name of your author, this will appear at the top of your embed, even above your title. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FhrH94MPkNOYpsQN9EEcF%252Fbg_authorname.png%3Falt%3Dmedia%26token%3D33d3fc3a-aaf8-44e8-ad6c-418bc19fed60&width=768&dpr=3&quality=100&sign=81ae1297&sv=2) ### [](https://documentation.botghost.com/messages/embedbuilder#url) URL The URL that people will be redirected to after clicking the authors name! ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fys3KKQYAagLoLoM1B65o%252Fbg_authorurlex.png%3Falt%3Dmedia%26token%3Dd3dbcf60-5485-4374-a48e-b60901cb052f&width=768&dpr=3&quality=100&sign=4fe47a7f&sv=2) ### [](https://documentation.botghost.com/messages/embedbuilder#image-url) Image URL The Image URL is the image that will appear next to the authors name. Perfect for adding extra decoration and detail to your embed! ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F9ZhXzZablGf5vmtOotMI%252Fbg_authorimageurl.png%3Falt%3Dmedia%26token%3D127eb2f0-14f6-4879-b033-0c73f5d57fc9&width=768&dpr=3&quality=100&sign=5426ed1a&sv=2) _\*For images the links (URLs) should end with .jpg .jpeg .png or .gif_ [](https://documentation.botghost.com/messages/embedbuilder#body-settings) Body Settings --------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/messages/embedbuilder#title) Title The title of your body, this will represent all of your body's content and will stick out much more than other text, being bold and bigger. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FDT8N2VVITJ6kPkrtrTxk%252Fbg_bodytitle.png%3Falt%3Dmedia%26token%3D730f6f99-3c8b-46d8-a59d-c4978de5b224&width=768&dpr=3&quality=100&sign=68fe32a0&sv=2) ### [](https://documentation.botghost.com/messages/embedbuilder#description) Description The description of your body can contain much more information compared to the title but comes in more of a smaller size. Better for containing more information than any other option. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F2bbwl1vxbjaF4QxJr1al%252Fbg_bodydescription.png%3Falt%3Dmedia%26token%3Da38ed06e-76de-47c2-8d85-d97c9cadc14a&width=768&dpr=3&quality=100&sign=c30642f6&sv=2) The Body's Description can contain up to 4096 characters! ### [](https://documentation.botghost.com/messages/embedbuilder#url-1) URL The URL of the body is the place where the person will be redirected to when they click the title of the body. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F9crr1PRqtkPEPYJlbmDa%252Fbg_bodyurl.png%3Falt%3Dmedia%26token%3D5bac509b-55f9-4c9b-ab08-692ad877cc8b&width=768&dpr=3&quality=100&sign=e66cb2a5&sv=2) [](https://documentation.botghost.com/messages/embedbuilder#fields) Fields ------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/messages/embedbuilder#field-name) Field Name The field name is the 'title' of the field, except it doesn't act like all other titles. Your field names won't appear bigger than the field content in any way other than being bold, it'll just be above the content. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F9dF3azBp8A10qzhj0rUW%252Fbg_fieldname.png%3Falt%3Dmedia%26token%3De28e2ce6-4dca-425f-acb8-3c4df44f7112&width=768&dpr=3&quality=100&sign=ba3af813&sv=2) ### [](https://documentation.botghost.com/messages/embedbuilder#field-content) Field Content Your field content is all of the writing you want to appear below the field name, used to organize your fields with information underneath the field name. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FBjYC2Z2Lt9svzDx60Ezr%252Fbg_fieldcontent.png%3Falt%3Dmedia%26token%3D0a4bdc66-a18c-42d4-982c-4acd48d87b5f&width=768&dpr=3&quality=100&sign=f33c8d1d&sv=2) ### [](https://documentation.botghost.com/messages/embedbuilder#inline-field) **Inline Field** The Inline Field option will make fields arranged in a line form from left to right. You must have at least two fields with both Inline's toggled on for them to appear in a line. You can't have more than three fields Inlined with each other. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F92gegJLExnhuv6GexZuo%252Fbg_fieldinline.png%3Falt%3Dmedia%26token%3Da04c80a2-a015-4f8c-8b6e-006655c2bbe5&width=768&dpr=3&quality=100&sign=5d66161a&sv=2) Inlines only show up on desktop! [](https://documentation.botghost.com/messages/embedbuilder#images) Images ------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/messages/embedbuilder#image-url-1) Image URL The Image URL is the image that will appear at the bottom of the embed. This will show as a bigger image compared to the Thumbnail URL! ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F8snU4ahBmdO3GpMbetEM%252Fbg_imageurl.png%3Falt%3Dmedia%26token%3D9a7b3a8f-196b-4cb5-a8dc-c10b90ff612c&width=768&dpr=3&quality=100&sign=c8ab7daf&sv=2) _\*For images the links (URLs) should end with .jpg .jpeg .png or .gif_ ### [](https://documentation.botghost.com/messages/embedbuilder#thumbnail-url) Thumbnail URL The Thumbnail URL is a image that will appear in the top right of the embed, this image will be in a smaller form than the Image URL but can appear bigger if the image has the right dimensions. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F2zB8Pb8vsWUo4JdzEGRC%252Fbg_thumbnailurl.png%3Falt%3Dmedia%26token%3D652a0ae2-04d6-49dc-a68b-a6b3bc485d22&width=768&dpr=3&quality=100&sign=17a167a3&sv=2) _\*For images the links (URLs) should end with .jpg .jpeg .png or .gif_ ### [](https://documentation.botghost.com/messages/embedbuilder#text) Text The content of your footer, this will display at the bottom of your embed with very tiny, yet, noticeable text. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FB4YNOOPqOIbeBtWVpWQa%252Fbg_footer.png%3Falt%3Dmedia%26token%3Dd9482ad1-e859-4d19-bc80-899eb3eb1ebf&width=768&dpr=3&quality=100&sign=44bff3ea&sv=2) ### [](https://documentation.botghost.com/messages/embedbuilder#image-url-2) Image URL An image appearing to the left of your footer, similar to the author image but appears at the bottom near the footer. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FfOCQwDSTX7IVDbXOmqgb%252Fbg_footerimg.png%3Falt%3Dmedia%26token%3D52f404f1-1f5c-400b-ac38-64516be7edf5&width=768&dpr=3&quality=100&sign=a0f2ae5f&sv=2) _\*For images the links (URLs) should end with .jpg .jpeg .png or .gif_ Experiencing issues with the embed builder module or do you just need help? Checkout our support options [**here**](https://documentation.botghost.com/support/botghost-support) **!** Last updated 1 year ago Was this helpful? * [General Settings](https://documentation.botghost.com/messages/embedbuilder#general-settings) * [Embed Selector](https://documentation.botghost.com/messages/embedbuilder#embed-selector) * [Message Link](https://documentation.botghost.com/messages/embedbuilder#message-link) * [Channel](https://documentation.botghost.com/messages/embedbuilder#channel) * [Embed Content](https://documentation.botghost.com/messages/embedbuilder#embed-content) * [Author Settings](https://documentation.botghost.com/messages/embedbuilder#author-settings) * [Name](https://documentation.botghost.com/messages/embedbuilder#name) * [URL](https://documentation.botghost.com/messages/embedbuilder#url) * [Image URL](https://documentation.botghost.com/messages/embedbuilder#image-url) * [Body Settings](https://documentation.botghost.com/messages/embedbuilder#body-settings) * [Title](https://documentation.botghost.com/messages/embedbuilder#title) * [Description](https://documentation.botghost.com/messages/embedbuilder#description) * [URL](https://documentation.botghost.com/messages/embedbuilder#url-1) * [Fields](https://documentation.botghost.com/messages/embedbuilder#fields) * [Field Name](https://documentation.botghost.com/messages/embedbuilder#field-name) * [Field Content](https://documentation.botghost.com/messages/embedbuilder#field-content) * [Inline Field](https://documentation.botghost.com/messages/embedbuilder#inline-field) * [Images](https://documentation.botghost.com/messages/embedbuilder#images) * [Image URL](https://documentation.botghost.com/messages/embedbuilder#image-url-1) * [Thumbnail URL](https://documentation.botghost.com/messages/embedbuilder#thumbnail-url) * [Footer](https://documentation.botghost.com/messages/embedbuilder#footer) * [Text](https://documentation.botghost.com/messages/embedbuilder#text) * [Image URL](https://documentation.botghost.com/messages/embedbuilder#image-url-2) Was this helpful? --- # Channel Option | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/options/channel-option.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FC1rOFMDsts0bOcFi0HlD%252FBildschirm%25C2%25ADfoto%25202023-02-17%2520um%252005.11.09.png%3Falt%3Dmedia%26token%3D94c6c2cf-f7d7-4e44-95c7-0532554c3b99&width=768&dpr=3&quality=100&sign=55d39da3&sv=2) The channel option block allows for any channel to be selected from the server and used later in the commands actions. Channel IDs may also be used. Only the channels to which the user has access can be selected. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FuJDosAF1anl1TEjsdzkC%252Fimage_2024-06-07_182707065.png%3Falt%3Dmedia%26token%3D2a8786d1-e222-45a9-8c3e-8d699ed87ed8&width=768&dpr=3&quality=100&sign=21380ce4&sv=2) You can retrieve the variable of the option via the **Clipboard** or the block itself. The format of the variable is `{option_optionname}`, where `optionname` is the [name](https://documentation.botghost.com/custom-commands-and-events/options/channel-option#option-name) of the option. Additionally, channel option variables can be combined with other variables to target the channel selected in the option. `{}` brackets must be excluded from the option when used as a target, like in the example below: ❌ Wrong ☑️ Correct `{channel_name[{option_channel}]}` `{channel_name[option_channel]}` `{BGVAR_status[{option_channel}]}` `{BGVAR_status[option_channel]}` ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FBMurDZ83qS9cQFG9aPYe%252Fimage_2024-06-08_124226997.png%3Falt%3Dmedia%26token%3D81cedb03-d5b3-44dd-9a16-516f13a55493&width=768&dpr=3&quality=100&sign=48699c1a&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/channel-option#option-name) Option Name --------------------------------------------------------------------------------------------------------------------- This field requires an input for your unique option name. The designated name will then be the reference for your option variable. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FS6wg4mRllZDMAUpGXVUq%252Fimage_2024-06-07_182337413.png%3Falt%3Dmedia%26token%3D779b567a-efdb-46b4-a741-7bdf066409e1&width=768&dpr=3&quality=100&sign=719880c8&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/channel-option#option-description) Option Description ----------------------------------------------------------------------------------------------------------------------------------- The option description field allows you to assign a custom description to your option. It is useful to describe what the option is used for. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FOEMYz42Odl90gX96iLpc%252Fimage_2024-06-07_182500325.png%3Falt%3Dmedia%26token%3Daa137d0e-e8f6-4f7a-881a-493eda720693&width=768&dpr=3&quality=100&sign=53702f3e&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/channel-option#set-required) Set Required ----------------------------------------------------------------------------------------------------------------------- With this switch you are able to toggle if the option should be required or not in order to execute the command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FZdasaits2xqKe9Prpu8h%252Fimage_2024-06-07_182514963.png%3Falt%3Dmedia%26token%3D6c293fc9-954e-4a5d-9496-5fbb04ae304a&width=768&dpr=3&quality=100&sign=e0b59302&sv=2) Last updated 2 years ago Was this helpful? * [Option Name](https://documentation.botghost.com/custom-commands-and-events/options/channel-option#option-name) * [Option Description](https://documentation.botghost.com/custom-commands-and-events/options/channel-option#option-description) * [Set Required](https://documentation.botghost.com/custom-commands-and-events/options/channel-option#set-required) Was this helpful? --- # Attachment Option | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/options/attachment-option.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FU04NSm0eAoKG0vp0JNz3%252FBildschirm%25C2%25ADfoto%25202023-02-17%2520um%252005.28.45.png%3Falt%3Dmedia%26token%3D46700c6b-8b61-4530-85fc-947d39168cad&width=768&dpr=3&quality=100&sign=fe0906cc&sv=2) This option block will allow you to add an attachment in the form of a file, that can be referenced later in your command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fk23vtJSDb2r494fZKlYo%252FBildschirm%25C2%25ADfoto%25202023-02-17%2520um%252005.29.18.png%3Falt%3Dmedia%26token%3Dd7dcd62b-6349-4892-8670-2a3699ba31c5&width=768&dpr=3&quality=100&sign=3630877e&sv=2) You can retrieve the variable of the option via the **Clipboard** or the block itself. The format of the variable is `{option_optionname}`, where `optionname` is the [name](https://documentation.botghost.com/custom-commands-and-events/options/attachment-option#option-name) of the option. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F9O7GoptGrh1CZ8GiWEZ1%252Fimage_2024-06-08_124502181.png%3Falt%3Dmedia%26token%3D7379fa5f-0531-49f1-bbd1-18d80a12185e&width=768&dpr=3&quality=100&sign=86c85d4a&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/attachment-option#option-name) Option Name ------------------------------------------------------------------------------------------------------------------------ This field requires an input for your unique option name. The designated name will then be the reference for your option variable. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FQbCrRr2Wfo5SPnYHvexm%252Fimage_2024-06-07_183903212.png%3Falt%3Dmedia%26token%3D1c56355a-0dca-40ff-9e82-1de75388ecd5&width=768&dpr=3&quality=100&sign=8c936a1d&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/attachment-option#option-description) Option Description -------------------------------------------------------------------------------------------------------------------------------------- The option description field allows you to assign a custom description to your option. It is useful to describe what the option is used for. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fwh145BkbC8BHLUQMtydt%252Fimage_2024-06-07_183941910.png%3Falt%3Dmedia%26token%3D8c58f76b-4a67-4f30-ba7a-529452b2dc3b&width=768&dpr=3&quality=100&sign=e657535d&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/attachment-option#set-required) Set Required -------------------------------------------------------------------------------------------------------------------------- With this switch you are able to toggle if the option should be required or not in order to execute the command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FZdasaits2xqKe9Prpu8h%252Fimage_2024-06-07_182514963.png%3Falt%3Dmedia%26token%3D6c293fc9-954e-4a5d-9496-5fbb04ae304a&width=768&dpr=3&quality=100&sign=e0b59302&sv=2) Last updated 6 months ago Was this helpful? * [Option Name](https://documentation.botghost.com/custom-commands-and-events/options/attachment-option#option-name) * [Option Description](https://documentation.botghost.com/custom-commands-and-events/options/attachment-option#option-description) * [Set Required](https://documentation.botghost.com/custom-commands-and-events/options/attachment-option#set-required) Was this helpful? --- # Number Option | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/options/number-option.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FonsIwioc84N7Waj1B51k%252Fimage_2024-06-07_184211650.png%3Falt%3Dmedia%26token%3Dd6fec233-70aa-4b19-a1be-97007153a7ae&width=768&dpr=3&quality=100&sign=26b8033e&sv=2) The number option block allows for any integer to be input as a value as used later on in the commands actions. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FfJnd5hEmSdg0MenX9ML4%252Fimage_2024-06-07_181230617.png%3Falt%3Dmedia%26token%3Dd637f98d-de00-44f4-b9f0-0675f18fe079&width=768&dpr=3&quality=100&sign=3a03a009&sv=2) You can retrieve the variable of the option via the **Clipboard** or the block itself. The format of the variable is `{option_optionname}`, where `optionname` is the [name](https://documentation.botghost.com/custom-commands-and-events/options/number-option#option-name) of the option. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FhZibGtGCZsEMEkCIliHp%252Fimage_2024-06-08_124041772.png%3Falt%3Dmedia%26token%3D9cf6ac9c-abfc-439c-88fc-b625084ff326&width=768&dpr=3&quality=100&sign=22b3764b&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/number-option#option-name) Option Name -------------------------------------------------------------------------------------------------------------------- This field requires an input for your unique option name. The designated name will then be the reference for your option variable. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FSZELICRSjHNEpQOVoswY%252Fimage_2024-06-07_181308913.png%3Falt%3Dmedia%26token%3D841d6602-2370-438a-bb92-0a53834b6401&width=768&dpr=3&quality=100&sign=971302b3&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/number-option#option-description) Option Description ---------------------------------------------------------------------------------------------------------------------------------- The option description field allows you to assign a custom description to your option. It is useful to describe what the option is used for. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FfT2A9OvhiZEJApDNO9Ng%252Fimage_2024-06-07_181343351.png%3Falt%3Dmedia%26token%3D75317c68-64ea-4e04-89bd-eaebd368aa81&width=768&dpr=3&quality=100&sign=ca4d7701&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/number-option#set-required) Set Required ---------------------------------------------------------------------------------------------------------------------- With this switch you are able to toggle if the option should be required or not in order to execute the command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FhKIaashIENb9SQ78zTUP%252Fimage_2024-06-07_181410655.png%3Falt%3Dmedia%26token%3D30c7a5ea-8710-4a3b-8885-7f0f04505463&width=768&dpr=3&quality=100&sign=dc5c486b&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/number-option#add-choices) Add Choices -------------------------------------------------------------------------------------------------------------------- This is an optional section is where you can add choices into your option. Choices allow the user to select something from a fixed set of values. There is a maximum number of 25 choices. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FypZpiWmtfKu1RDdNSfv6%252FScreenshot%25202023-02-17%2520at%25209.56.50%2520AM.png%3Falt%3Dmedia%26token%3Dbcf3f9df-4c58-45d8-b8c3-1c4e110a9c61&width=768&dpr=3&quality=100&sign=4217d700&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FopE6AIlwephc2Fzdll1T%252FScreenshot%25202023-02-17%2520at%25209.57.13%2520AM.png%3Falt%3Dmedia%26token%3Dceccc0ca-7062-4998-9007-b7f9cad030cf&width=768&dpr=3&quality=100&sign=93954a1f&sv=2) Last updated 2 years ago Was this helpful? * [Option Name](https://documentation.botghost.com/custom-commands-and-events/options/number-option#option-name) * [Option Description](https://documentation.botghost.com/custom-commands-and-events/options/number-option#option-description) * [Set Required](https://documentation.botghost.com/custom-commands-and-events/options/number-option#set-required) * [Add Choices](https://documentation.botghost.com/custom-commands-and-events/options/number-option#add-choices) Was this helpful? --- # Role Option | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/options/role-option.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FAzwNxgDLNJzTaWotgExg%252FBildschirm%25C2%25ADfoto%25202023-02-17%2520um%252005.18.30.png%3Falt%3Dmedia%26token%3Defb5e862-f3eb-47e5-8d01-c2d99a714a49&width=768&dpr=3&quality=100&sign=3eb8bfae&sv=2) The role option block allows for any role to be selected from the server and used later in the commands actions. Role IDs may also be used. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FtM4jWTu40J4t5hPfrofA%252Fimage_2024-06-08_125034668.png%3Falt%3Dmedia%26token%3Dec889667-999e-4484-a686-ce962c631cc4&width=768&dpr=3&quality=100&sign=6ece7f3&sv=2) You can retrieve the variable of the option via the **Clipboard** or the block itself. The format of the variable is `{option_optionname}`, where `optionname` is the [name](https://documentation.botghost.com/custom-commands-and-events/options/role-option#option-name) of the option. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F18FlPPhO8MoeP8LQCOYk%252Fimage_2024-06-08_124323925.png%3Falt%3Dmedia%26token%3D8957f65d-2346-4c90-88e5-feee695d52c2&width=768&dpr=3&quality=100&sign=17f9c938&sv=2) Only roles that are ping-able by the user can be chosen. [](https://documentation.botghost.com/custom-commands-and-events/options/role-option#option-name) Option Name ------------------------------------------------------------------------------------------------------------------ This field requires an input for your unique option name. The designated name will then be the reference for your option variable. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FVVR5j03w6zhzWwSIJSYX%252Fimage_2024-06-07_183102940.png%3Falt%3Dmedia%26token%3D20a9f7c1-8014-4de6-bf42-04e3aafa94b4&width=768&dpr=3&quality=100&sign=ea4973fa&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/role-option#option-description) Option Description -------------------------------------------------------------------------------------------------------------------------------- The option description field allows you to assign a custom description to your option. It is useful to describe what the option is used for. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FQkUf8inIGLyzQamrnaIN%252Fimage_2024-06-07_183121335.png%3Falt%3Dmedia%26token%3D3af28e3d-de0d-4c7b-85c2-2a18277b45ac&width=768&dpr=3&quality=100&sign=51c1b169&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/role-option#set-required) Set Required -------------------------------------------------------------------------------------------------------------------- With this switch you are able to toggle if the option should be required or not in order to execute the command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FZdasaits2xqKe9Prpu8h%252Fimage_2024-06-07_182514963.png%3Falt%3Dmedia%26token%3D6c293fc9-954e-4a5d-9496-5fbb04ae304a&width=768&dpr=3&quality=100&sign=e0b59302&sv=2) Last updated 2 years ago Was this helpful? * [Option Name](https://documentation.botghost.com/custom-commands-and-events/options/role-option#option-name) * [Option Description](https://documentation.botghost.com/custom-commands-and-events/options/role-option#option-description) * [Set Required](https://documentation.botghost.com/custom-commands-and-events/options/role-option#set-required) Was this helpful? --- # User Option | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/options/user-option.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FvTwyYYn7aU3W7Fq7xq7g%252Fimage_2024-06-07_184134753.png%3Falt%3Dmedia%26token%3D753f22a2-86d7-40fa-bb4c-d842af558528&width=768&dpr=3&quality=100&sign=3d40b57c&sv=2) The user option block allows for any user to be selected from the server and used later in the commands actions. User IDs may also be used. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F3KO5VcIieRrSMmHCLJXc%252Fimage_2024-06-07_181816651.png%3Falt%3Dmedia%26token%3D94c9074d-ba6a-4f09-850c-61d5a6064d4c&width=768&dpr=3&quality=100&sign=4e88cbfb&sv=2) You can retrieve the variable of the option via the **Clipboard** or the block itself. The format of the variable is `{option_optionname}`, where `optionname` is the [name](https://documentation.botghost.com/custom-commands-and-events/options/user-option#option-name) of the option. Additionally, user option variables can be combined with other variables to target the user selected in the option. `{}` brackets must be excluded from the option when used as a target, like in the example below: ❌ Wrong ☑️ Correct `{user_name[{option_user}]}` `{user_name[option_user]}` `{BGVAR_money[{option_user}]}` `{BGVAR_money[option_user]}` ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fm3ugQGknMQb0fQnt0Yea%252Fimage_2024-06-08_124138860.png%3Falt%3Dmedia%26token%3D074a7375-02e5-44e5-b3b4-91af5ffbef7a&width=768&dpr=3&quality=100&sign=2dfb993f&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/user-option#option-name) Option Name ------------------------------------------------------------------------------------------------------------------ This field requires an input for your unique option name. The designated name will then be the reference for your option variable. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FepV9xmmJooC5PYrDwyyY%252Fimage_2024-06-07_181906364.png%3Falt%3Dmedia%26token%3D737b237a-bbcb-4b9f-945d-a707484541c5&width=768&dpr=3&quality=100&sign=5065b43c&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/user-option#option-description) Option Description -------------------------------------------------------------------------------------------------------------------------------- The option description field allows you to assign a custom description to your option. It is useful to describe what the option is used for. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FskxkjohGIbNV7dgMjVk5%252Fimage_2024-06-07_181923947.png%3Falt%3Dmedia%26token%3Df548faec-e349-4c0b-a4e5-b8ef67fdeedf&width=768&dpr=3&quality=100&sign=139b04a&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/user-option#set-required) Set Required -------------------------------------------------------------------------------------------------------------------- With this switch you are able to toggle if the option should be required or not in order to execute the command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FrObC5usM1A0DZ35MHPx8%252Fimage_2024-06-07_182022364.png%3Falt%3Dmedia%26token%3Dfde69d8c-e568-42be-9d63-1dbdceff1611&width=768&dpr=3&quality=100&sign=5d7b4cc3&sv=2) Last updated 2 years ago Was this helpful? * [Option Name](https://documentation.botghost.com/custom-commands-and-events/options/user-option#option-name) * [Option Description](https://documentation.botghost.com/custom-commands-and-events/options/user-option#option-description) * [Set Required](https://documentation.botghost.com/custom-commands-and-events/options/user-option#set-required) Was this helpful? --- # Translation | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/utility/translation.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F4dH0Z7aS6U8JAr2qNwBr%252Fimage.png%3Falt%3Dmedia%26token%3D4986c8a3-21fe-474e-9d0c-be0b773c5159&width=768&dpr=3&quality=100&sign=da195813&sv=2) This module is only available to users with a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) . The [Translation](https://dashboard.botghost.com/dashboard/module/6fef2574-418b-47cd-adef-22c9c3e88051/translation) module allows you to translate texts via a Custom Command, quick-translations by reacting with a specified emoji, daily translation limits, and more! [](https://documentation.botghost.com/utility/translation#credentials) Credentials --------------------------------------------------------------------------------------- The Translation module requires you to add your own DeepL API key in order to handle translations, allowing you to select the account tier and the daily translations limit. To create an API key, follow the steps below. 1 Create an account or log in the official [DeepL website](https://www.deepl.com/pro#developer) . 2 Select the tier you wish to use for your translations, whether it is the Free Tier or Paid Tiers. If you wish to have the free tier, please select 'Sign up for free'. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FGSXZCSOb2a5WF1NmcNks%252F2.%2520DeepL%2520Tiers%2520for%2520the%2520Translation%2520module.jpg%3Falt%3Dmedia%26token%3D1a732973-a0ca-457c-a02f-1ec6b3da61f0&width=768&dpr=3&quality=100&sign=9ab10c39&sv=2) DeepL Tiers for the Translation module 3 Fulfill the following details. This is used to avoid potential misuses of their free API. DeepL will not charge you unless you manually upgrade your current subscription to a paid one. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FgmRCiSBQOKOYjanpgHiN%252F3.%2520DeepL%2520Details%2520for%2520the%2520Translation%2520module.jpg%3Falt%3Dmedia%26token%3D28ac782e-bdf4-40c3-b855-f865c6b84b7b&width=768&dpr=3&quality=100&sign=729ff8aa&sv=2) DeepL Details for the Translation module 4 Once you have successfully fulfilled all the details, accept [DeepL's Terms & Conditions](https://www.deepl.com/en/pro-license_embedded) and press 'Sign up for free'. 5 A similar page will appear upon signing up for free, click on 'Account management' to go to your account settings. If this page does not appear, please go to your [account settings](https://www.deepl.com/your-account/plan) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FK7UvxrSMo3paNxFY2a1C%252F4.%2520DeepL%2520Account%2520Management%2520for%2520the%2520Translation%2520module.jpg%3Falt%3Dmedia%26token%3Dfd975bc2-593e-4938-9433-e4aa97aa05a4&width=768&dpr=3&quality=100&sign=5a97d26&sv=2) DeepL Account Management for the Translation module 6 Get the Authentication Key for DeepL in your [account summary](https://www.deepl.com/your-account/summary) settings located in the bottom right corner. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FfdBnQBDixHujHrpcXwHc%252F5.%2520Authentication%2520Key%2520for%2520DeepL%2520API%2520for%2520the%2520Translation%2520module.jpg%3Falt%3Dmedia%26token%3D6727d967-6eda-4f78-b841-79a006a5019c&width=768&dpr=3&quality=100&sign=13b1dd6f&sv=2) Authentication Key for DeepL API for the Translation module 7 Once copied, paste it in the 'DeepL API Key' field in BotGhost. [](https://documentation.botghost.com/utility/translation#settings) Settings --------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/utility/translation#credentials-1) Credentials This section is where you input the API Key found from [Credentials](https://documentation.botghost.com/utility/translation#credentials) and also change other account settings. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FUHte3YdwLhZBplf1AaZJ%252Fimage.png%3Falt%3Dmedia%26token%3D17d25b05-944a-4e35-9111-0409d115ebdb&width=768&dpr=3&quality=100&sign=c0247cbf&sv=2) #### [](https://documentation.botghost.com/utility/translation#deepl-api-key) **DeepL API Key** Paste your DeepL API Key here. Learn how to get one in the [Credentials](https://documentation.botghost.com/utility/translation#credentials) section. Make sure to not share it with anyone! #### [](https://documentation.botghost.com/utility/translation#deepl-account-tier) **DeepL Account Tier** Set the account tier you selected when getting your API key. Remember to select the correct one as DeepL handles different API domains for free and paid tiers. #### [](https://documentation.botghost.com/utility/translation#daily-translation-limit) **Daily Translation Limit** Define the maximum amount of translations that can be executed per day. Setting this to 0 will disable this limit. ### [](https://documentation.botghost.com/utility/translation#quick-translation) Quick-Translation The following parameters allow you to react with a specific emoji to automatically translate the content of the message, select the channels for quick translations, the required roles, the target language, and toggle if you wish to delete the original message upon successful translation. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FQXzNup6uVKdYuVkxmd4r%252Fimage.png%3Falt%3Dmedia%26token%3Dd10673af-bf20-41b1-91ff-f9f47c00d67b&width=768&dpr=3&quality=100&sign=1a4c42d1&sv=2) #### [](https://documentation.botghost.com/utility/translation#trigger-reactions) **Trigger Reactions** Select up to 10 different emojis to trigger the quick-translations. #### [](https://documentation.botghost.com/utility/translation#quick-translation-channels) **Quick-Translation Channels** Choose the channels you wish to allow for quick-translation. If none is chosen, this feature will be available across all channels. #### [](https://documentation.botghost.com/utility/translation#required-roles) **Required Roles** Select the roles that will require users with these roles to be the ones to use the quick translation. #### [](https://documentation.botghost.com/utility/translation#target-language) **Target Language** Define which language should the messages be translated to when triggering the quick-translations. #### [](https://documentation.botghost.com/utility/translation#delete-original-message) **Delete Original Message** Enable or disable to delete the original message after a successful quick-translation. ### [](https://documentation.botghost.com/utility/translation#translate-command) Translate Command Define the allowed roles and the default DeepL language when using the /translate custom command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FCYH9Gam9f8Yty085bBtV%252Fimage.png%3Falt%3Dmedia%26token%3Dc1ca540b-973b-492f-a877-1835986397cd&width=768&dpr=3&quality=100&sign=eccbfdaf&sv=2) #### [](https://documentation.botghost.com/utility/translation#allowed-roles) **Allowed Roles** Select the roles that users must have to run the `/translation` custom command. #### [](https://documentation.botghost.com/utility/translation#default-language-deepl) **Default Language (DeepL)** Choose the language to translate messages to when using the custom command. #### [](https://documentation.botghost.com/utility/translation#translation-command-reply) Translation Command Reply Customize the reply in the /translate custom command. You can use `{original_message}` and `{translated_message}` to return the content of the original message and the translated content, respectively. All [variables](https://documentation.botghost.com/custom-commands-and-events/variables) can be used. You can also toggle the [embed](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/embed-reply) to a [plain text](https://documentation.botghost.com/custom-commands-and-events/actions/legacy-reply-actions/plain-text-reply) response using the switch in the top right. #### [](https://documentation.botghost.com/utility/translation#character-limit) **Character Limit** Define the maximum amount of characters the command should allow to translate. * * * [](https://documentation.botghost.com/utility/translation#command) Command ------------------------------------------------------------------------------- Find the command for the Translation module and modify them. This will allow you to fine-tune the command's logic to your liking. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FjzpAjGTbAsqoAQTxAK93%252F9.%2520Custom%2520Command%2520for%2520the%2520Translation%2520module.jpg%3Falt%3Dmedia%26token%3D829ae27f-7002-4df3-925d-0881bac561a5&width=768&dpr=3&quality=100&sign=fc4a12dd&sv=2) Custom Command for the Translation module /translate[](https://documentation.botghost.com/utility/translation#translate) Translate the given text to the target language. [](https://documentation.botghost.com/utility/translation#events) Events ----------------------------------------------------------------------------- Explore the events within the Translation module and customize them to your preferences. This allows you to change the events' logic according to your liking and needs. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FHUe5Oi4bzPxTAR0UlIyk%252F10.%2520Events%2520for%2520the%2520Translation%2520module.jpg%3Falt%3Dmedia%26token%3Dba5f002c-9d2e-4958-b705-c2b7b0a549d0&width=768&dpr=3&quality=100&sign=dd0f363c&sv=2) Custom Events for the Translation module Quick-Translation[](https://documentation.botghost.com/utility/translation#quick-translation-1) This event handles the quick-translations, triggered with each reaction added to a message. Daily Limit Handler[](https://documentation.botghost.com/utility/translation#daily-limit-handler) The timed event triggered daily to handle the daily limits. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Credentials](https://documentation.botghost.com/utility/translation#credentials) * [Settings](https://documentation.botghost.com/utility/translation#settings) * [Credentials](https://documentation.botghost.com/utility/translation#credentials-1) * [Quick-Translation](https://documentation.botghost.com/utility/translation#quick-translation) * [Translate Command](https://documentation.botghost.com/utility/translation#translate-command) * [Command](https://documentation.botghost.com/utility/translation#command) * [Events](https://documentation.botghost.com/utility/translation#events) Was this helpful? --- # Music Smart Search Option | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/custom-commands-and-events/options/music-smart-search-option.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FqglyZZ1TbBLmAe7iu9yq%252Fimage.png%3Falt%3Dmedia%26token%3D59a0a07e-c789-408f-b522-1185d28322c8&width=768&dpr=3&quality=100&sign=d935197&sv=2) This option can be used to let users search for music tracks when using a command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FjodlsS6oDMrCyVlOtEaz%252Fimage.png%3Falt%3Dmedia%26token%3Da7295256-61f8-47e3-9f65-f485a0188482&width=768&dpr=3&quality=100&sign=af0f715f&sv=2) There are multiple variables you can use from this option. The format of the variable is `{option_optionname}`, where `optionname` is the [name](https://documentation.botghost.com/custom-commands-and-events/options/music-smart-search-option#option-name) of the option. Variable Information `{option_optionname.result}` This variable should be used in the [Music Queue Add](https://documentation.botghost.com/custom-commands-and-events/actions/music-actions/add-to-queue) and [Music Search](https://documentation.botghost.com/custom-commands-and-events/actions/music-actions/search-tracks) actions. If the user selected an option from the list, this will return the unique ID of the track. `{option_optionname.title}` This variable can be used for messages to a user. It returns the song's title. [](https://documentation.botghost.com/custom-commands-and-events/options/music-smart-search-option#option-name) Option Name -------------------------------------------------------------------------------------------------------------------------------- This field requires an input for your unique option name. The designated name will then be the reference for your option variable. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FgpwfEiu7d0zjtj5hoLPS%252Fimage.png%3Falt%3Dmedia%26token%3De9cee7e0-6b8a-4caf-a6b5-7c11bacc08a6&width=768&dpr=3&quality=100&sign=edfbef66&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/music-smart-search-option#option-description) Option Description ---------------------------------------------------------------------------------------------------------------------------------------------- The option description field allows you to assign a custom description to your option. It is useful to describe what the option is used for. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fne27L0Xe7BZkaHHo6bvC%252Fimage.png%3Falt%3Dmedia%26token%3D5bc3dd12-f3c6-4bc1-9493-211656920d31&width=768&dpr=3&quality=100&sign=70758aa8&sv=2) [](https://documentation.botghost.com/custom-commands-and-events/options/music-smart-search-option#set-required) Set Required ---------------------------------------------------------------------------------------------------------------------------------- With this switch you are able to toggle if the option should be required or not in order to execute the command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F8ZGjl7ltB5dMKqO6Xbja%252Fimage_2024-06-07_153303596.png%3Falt%3Dmedia%26token%3De487b34e-973a-4c52-93db-c2ebebfb6669&width=768&dpr=3&quality=100&sign=60842cc5&sv=2) Last updated 6 months ago Was this helpful? * [Option Name](https://documentation.botghost.com/custom-commands-and-events/options/music-smart-search-option#option-name) * [Option Description](https://documentation.botghost.com/custom-commands-and-events/options/music-smart-search-option#option-description) * [Set Required](https://documentation.botghost.com/custom-commands-and-events/options/music-smart-search-option#set-required) Was this helpful? --- # Economy & Minigames | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/fun-modules/economy-and-minigames.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F70zmIOlTpTwHIywdw8cw%252Fimage.png%3Falt%3Dmedia%26token%3D4de844d8-b1e2-408b-b05c-4947bb002513&width=768&dpr=3&quality=100&sign=cb967114&sv=2) Some of the features of this module require a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. You can however use the module with a free subscription. The [Economy module](https://dashboard.botghost.com/dashboard/module/5bda821f-56fe-4318-be20-1d2815a04dc3/economy&minigames) will allow you to play minigames and set up a custom currency system, daily bonuses, message awards, and economy roles. [](https://documentation.botghost.com/fun-modules/economy-and-minigames#common-issues) Common Issues --------------------------------------------------------------------------------------------------------- Experiencing issues with the module? Check out the common issues below. If your issue is not listed in this page, make sure your module is updated to the latest version. If you are still experiencing issues with the module, join our [support server](https://discord.gg/botghost) to ask for further help. ### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#minigame-commands-not-working) Minigame Commands Not Working If you're not able to play certain minigames such as `/5dice` or `/blackjack`, please try to solve the issue with the steps below: 1 You will need to upload all emojis of the module in your server. If you don't have enough emoji slots in your server to do that, you can upload them in another server you own and invite your bot to it. 2 Run the `/ec admin` command in the server you want emojis to be uploaded in. This command allows you to get access all economy's admin tools. 3 Pick the "Minigame Configuration" option in the menu. Select the minigame you want to upload the emojis of (5dice or blackjack). ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FHb8pbDWTD9TCrvVZdhXs%252Fimage.png%3Falt%3Dmedia%26token%3D08a64866-009d-4c0a-8007-6d89703bd8c1&width=768&dpr=3&quality=100&sign=4ecf348d&sv=2) 4 Confirm and wait a few seconds ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FINQX5bzI9bdnoNl3nmBa%252Fimage.png%3Falt%3Dmedia%26token%3Dd95fd29d-ec1a-40b0-a7ea-6ca593801e79&width=768&dpr=3&quality=100&sign=12108826&sv=2) 5 If you're still experiencing issues, join our [support server](https://discord.gg/botghost) to ask for further help, we'll do our best to solve your issue! [](https://documentation.botghost.com/fun-modules/economy-and-minigames#settings) Settings ----------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#economy-settings) Economy Settings Customize the currency name, prefix, or emoji for the currency, daily bonus, bank interest rates, colors and a lot more. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FhnFkfgoMSs3BjPwhfS4I%252Fimage_2024-07-27_173548368.png%3Falt%3Dmedia%26token%3D23d595eb-f0ec-4e87-bc6e-a9b63dc85c17&width=768&dpr=3&quality=100&sign=f744ab97&sv=2) Economy settings of the Economy & Minigames module #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#currency-name) **Currency Name** In this field you can define your currency name for the whole economy system. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#currency-prefix-or-emoji) **Currency Prefix or Emoji** In this field you can specify a prefix or emoji for your currency to be referenced next to. Learn how to add a custom emoji [here](https://documentation.botghost.com/getting-started/standard-practices/advanced-practices#how-can-i-get-a-custom-emojis-id) . #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#daily-bonus) **Daily Bonus** Here you can set a daily bonus which can be claimed via the `/daily-bonus` command. This field only accepts integers. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#bank-interest) **Bank Interest** In this field you can input an interest amount that is earned when you deposit money into the bank via the `/bank-deposit` command. This is limited to a maximum of 5% a day. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#earn-currency-for-messages) **Earn Currency for Messages** If this toggle is enabled, users will earn currency for every message sent. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#message-award-cooldown) **Message Award Cooldown** This field will allow you to set a cooldown in minutes between each message before giving currency. _This setting only shows when_ [Earn Currency for Messages](https://documentation.botghost.com/fun-modules/economy-and-minigames#earn-currency-for-messages) _is enabled._ #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#message-award-amount) **Message Award Amount** **If** [Earn Currency for Messages](https://documentation.botghost.com/fun-modules/economy-and-minigames#earn-currency-for-messages) is enabled, this field will allow you to customize the amount of currency to give per message to the user. _This setting only shows when_ [Earn Currency for Messages](https://documentation.botghost.com/fun-modules/economy-and-minigames#earn-currency-for-messages) _is enabled._ #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#lottery-channel) Lottery Channel With this setting you can select a channel to serve as the place where the lottery notification of the winner is sent. This setting refers to the `/lottery` command. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#success-color) Success Color This setting changes the color for embeds that are sent with the context of being positive or a winner such as the lottery notification. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#main-color) Main Color This setting controls the color for informative embeds. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#alert-color) Alert Color This setting controls the color for alert / warning type embeds. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#enable-job-editing) Enable Job Editing If this toggle is enabled, a new section will appear that allows you to customize and better integrate jobs in your economy system. Economy Jobs If the [Enable Job Editing](https://documentation.botghost.com/fun-modules/economy-and-minigames#enable-job-editing) toggle is enabled, this section will appear and allow you to add and also customize added / available jobs. This correlates to the `/job-apply` and `/job-list` command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FMcE1wlS1LfEPuN0vJ6at%252Fimage.png%3Falt%3Dmedia%26token%3D47932077-d327-4226-aebe-f9c34bfdf7be&width=768&dpr=3&quality=100&sign=62e6efd4&sv=2) #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#job-title) Job Title In this field you can input the name of the job you wish to add. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#job-description) Job Description In this field you can input a description for the job you wish to add. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#job-salary) Job Salary In this field you can input the amount of currency earned for users with this job. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#shifts-required) Shifts Required In this field you may set a specific amount of shifts in order to receive this job. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#custom-value) Custom Value This field serves as an "Extra info" field where you can input any additional info or values needed. To save the job's settings, you need to click "Add" in the bottom-right corner of the settings. This will reset the fields so you can set up another job. ### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#jobs-title) Jobs Title Here is where all active and available jobs are listed and can be edited or deleted. There is a bunch of prebuilt jobs that come with the module and can be changed, as well as there being a maximum of 30 jobs. To save the edits you made on the job's settings, you need to click "Edit" in the bottom-right corner of the settings. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FN3FSeAMkTPYIYc0iNwFB%252Fimage.png%3Falt%3Dmedia%26token%3D69b46d9a-008e-4d30-b17d-0b508c6fd0f5&width=768&dpr=3&quality=100&sign=764479af&sv=2) ### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#economy-items) Economy Items In this section you can create and edit Items that users can buy with the `/shop-buy` command and see with the `/inventory` command. Click the "New Item" box to create a new item with the settings below. Only [Premium](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) users can add one or more items. Free users who delete one or more items have to reset the module to get them back. Once created you can click on an existing item to delete or edit it. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FSEvBgJyyWqCNNNS34CEQ%252Fimage.png%3Falt%3Dmedia%26token%3Dfecdabad-1fa1-4ff3-91de-84d9a9bae387&width=768&dpr=3&quality=100&sign=dd2b3c16&sv=2) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FUe2c7jEexgfzBzlAF2hR%252Fimage.png%3Falt%3Dmedia%26token%3D05014c43-fcc1-4ca5-9d53-c7f158ab30ee&width=768&dpr=3&quality=100&sign=b4a81700&sv=2) #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#name) Name In this field you can input the name of the item you are creating. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#description) Description In this field you can input the description for the item. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#price) Price Here you can give the item a price that it can be bought at. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#item-limit) Item Limit This field sets the maximum amount of this item that users can buy from the shop via the `/shop-buy` command. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#image) Image Select an Image for the item. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#type) Type This dropdown changes the type of item it will be. Role Item Usable Item Static Item If this option is selected, it will make the item be based off a role, so when used it grants the user a role. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#roles) Roles In this field you can select role(s) that the user will receive upon using the item. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#destroy-on-use) Destroy On Use If this toggle is enabled, the item will be removed from the users inventory if used. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#allow-multiples) Allow Multiples If this toggle is enabled, users can hold more than one of this item in their inventory. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#use-on-buy) Use On Buy If this toggle is enabled, when a user purchases this item, it will be automatically used when purchased. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#unlisted) Unlisted If this toggle is enabled, this specific item will not show up when users browse the shop. If this option is chosen then the item is treated as a regular usable item that does something. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#destroy-on-use-1) Destroy On Use If this toggle is enabled, the item will be removed from the users inventory if used. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#allow-multiples-1) Allow Multiples If this toggle is enabled, users can hold more than one of this item in their inventory. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#use-on-buy-1) Use On Buy If this toggle is enabled, when a user purchases this item, it will be automatically used when purchased. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#unlisted-1) Unlisted If this toggle is enabled, this specific item will not show up when users browse the shop. If this option is chosen then the item won't do anything on it's own and needs another item to have a purpose. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#destroy-on-use-2) Destroy On Use If this toggle is enabled, the item will be removed from the users inventory if used. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#allow-multiples-2) Allow Multiples If this toggle is enabled, users can hold more than one of this item in their inventory. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#unlisted-2) Unlisted If this toggle is enabled, this specific item will not show up when users browse the shop. ### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#economy-roles) Economy Roles In this section you can configure and add the role that can be received if a user reaches a certain currency balance threshold. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FMGx128QRq5AsDWzjG3l8%252F3.%2520Economy%2520Roles%2520settings%2520of%2520the%2520Economy%2520Rework%2520module.jpg%3Falt%3Dmedia%26token%3Dd05756f4-f476-4327-bdc7-84aaa779ceb2&width=768&dpr=3&quality=100&sign=1af7e362&sv=2) Economy Roles settings of the Economy & Minigames module #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#economy-role-amount) **Economy Role Amount** In this field you can specify the amount of currency needed for the user to receive the role from [Economy Roles](https://documentation.botghost.com/fun-modules/economy-and-minigames#economy-roles-1) . #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#economy-roles-1) Economy Roles Select the role that users should earn when they reach the specified criteria above. To add the role, click on 'Add' in the right bottom corner to save your new economy role. Existing ones will appear in the 'Active Economy Roles' field below. ### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#active-economy-roles) Active Economy Roles In this area you can edit or delete the active economy roles. There is a maximum of 10 active roles. Click on an active economy role to edit or delete it. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FnXV4Yrg8V1rDxhR5a5YZ%252Fimage.png%3Falt%3Dmedia%26token%3D79f3da59-eb8e-4da8-9c48-2c66c075f249&width=768&dpr=3&quality=100&sign=332ad796&sv=2) * * * [](https://documentation.botghost.com/fun-modules/economy-and-minigames#commands) Commands ----------------------------------------------------------------------------------------------- In this area, you can view and modify the commands of the Economy & Minigames module. Below you may find some information on each command of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FmKutnkwiAUygrCi5xO4P%252Fimage_2024-07-27_192007487.png%3Falt%3Dmedia%26token%3D4aed73aa-ee59-4b34-a1cc-b3aa28f1df6b&width=768&dpr=3&quality=100&sign=213fd17a&sv=2) ### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#admin-commands) Admin Commands /ec admin[](https://documentation.botghost.com/fun-modules/economy-and-minigames#ec-admin) Allows you to manage the server economy, like resetting a user's balance, managing command cooldowns, or the entire server economy. /money remove[](https://documentation.botghost.com/fun-modules/economy-and-minigames#money-remove) This command is for economy admins only and removes currency from a users existing balance. /money add[](https://documentation.botghost.com/fun-modules/economy-and-minigames#money-add) This command is for economy admins only and adds currency to a users existing balance. ### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#economy-commands) Economy Commands /money give[](https://documentation.botghost.com/fun-modules/economy-and-minigames#money-give) This command gives a user some of your currency. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FzIZfbt1ojqSCycaHjtTE%252Fimage.png%3Falt%3Dmedia%26token%3D5dc7e9c4-8275-4326-9b8e-622f6f06ffb7&width=300&dpr=3&quality=100&sign=2cbb0b23&sv=2) /balance[](https://documentation.botghost.com/fun-modules/economy-and-minigames#balance) This command allows you to check a users currency balance. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fbpbr8WUEO0SHYEf21djv%252Fimage.png%3Falt%3Dmedia%26token%3D1496b0f9-cd54-4476-9d9c-d358d490b49a&width=300&dpr=3&quality=100&sign=144c345d&sv=2) /daily[](https://documentation.botghost.com/fun-modules/economy-and-minigames#daily) This command allows you to claim your daily bonus. [Daily Bonus](https://documentation.botghost.com/fun-modules/economy-and-minigames#daily-bonus) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F01hcT0rf6sXTbgNnK4r7%252Fimage.png%3Falt%3Dmedia%26token%3D1f8f820d-a8e6-47ff-afe6-ca836a3949f9&width=300&dpr=3&quality=100&sign=1559f30f&sv=2) /ec leaderboard[](https://documentation.botghost.com/fun-modules/economy-and-minigames#ec-leaderboard) This command displays the 10 top users with the most currency, either holding or bank. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FhmxYzuHBBn3RKrjHUs38%252Fimage.png%3Falt%3Dmedia%26token%3D54de1076-9389-4343-8e6c-d26a822297cc&width=300&dpr=3&quality=100&sign=7aeb3ce9&sv=2) /item give[](https://documentation.botghost.com/fun-modules/economy-and-minigames#item-give) This command allows a user to give another user an item from their inventory. /shop view[](https://documentation.botghost.com/fun-modules/economy-and-minigames#shop-view) This command allows you to browse through the shop and displays the shop. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FQxpVN8Nk0GWKBnbtnbeC%252Fimage.png%3Falt%3Dmedia%26token%3Ddf0293e4-ac2c-42ce-9d7d-274d8445b67f&width=300&dpr=3&quality=100&sign=85caa56b&sv=2) /inventory[](https://documentation.botghost.com/fun-modules/economy-and-minigames#inventory) This command displays your inventory. /bank deposit[](https://documentation.botghost.com/fun-modules/economy-and-minigames#bank-deposit) This command allows you to deposit currency into the bank that gains interest. /bank withdraw[](https://documentation.botghost.com/fun-modules/economy-and-minigames#bank-withdraw) This command allows you to withdraw money from the bank. /beg[](https://documentation.botghost.com/fun-modules/economy-and-minigames#beg) This command allows you to beg for currency with a low risk. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F4XJlb7kmVR2ZuN4rdHzV%252Fimage.png%3Falt%3Dmedia%26token%3D4825000a-e5d4-4a1b-af28-6825d1195b0e&width=300&dpr=3&quality=100&sign=bee0686e&sv=2) /lottery[](https://documentation.botghost.com/fun-modules/economy-and-minigames#lottery) This command allows you to view the next lottery and also enter into it. /crime[](https://documentation.botghost.com/fun-modules/economy-and-minigames#crime) With this command you can commit a crime that is high risk but also high reward. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FbDYfDM5eR6RAGKoPzvQ5%252Fimage.png%3Falt%3Dmedia%26token%3Ded0778f1-a3a2-4bc7-a2bc-541b78acb271&width=300&dpr=3&quality=100&sign=af0381e7&sv=2) /work[](https://documentation.botghost.com/fun-modules/economy-and-minigames#work) This command allows you to work and gain currency from doing so. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F2X4wssM95PKCB362YDBG%252Fimage.png%3Falt%3Dmedia%26token%3Dec1f111a-35f7-4435-8a87-7537bbbc0a4a&width=300&dpr=3&quality=100&sign=afb07075&sv=2) /shop buy[](https://documentation.botghost.com/fun-modules/economy-and-minigames#shop-buy) This command allows you to buy something from the shop. /fish[](https://documentation.botghost.com/fun-modules/economy-and-minigames#fish) This command allows you to go fishing. /job list[](https://documentation.botghost.com/fun-modules/economy-and-minigames#job-list) This command shows the active job list. [Economy Jobs](https://documentation.botghost.com/fun-modules/economy-and-minigames#economy-jobs) ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FdzzJramtmGn33ky9j1oa%252Fimage.png%3Falt%3Dmedia%26token%3D3d44a434-67da-4af0-bda4-68e133f0f370&width=300&dpr=3&quality=100&sign=46f27f12&sv=2) /rob bank[](https://documentation.botghost.com/fun-modules/economy-and-minigames#rob-bank) This command will attempt to rob a bank, multiple users will need to be in on this. /ec stats[](https://documentation.botghost.com/fun-modules/economy-and-minigames#ec-stats) This command shows your economy stats. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FQs0grhJlqgtCz5WDOtKw%252Fimage.png%3Falt%3Dmedia%26token%3D8163bebb-cf55-48fa-8083-cc4d15fbc613&width=300&dpr=3&quality=100&sign=3f711c21&sv=2) /job apply[](https://documentation.botghost.com/fun-modules/economy-and-minigames#job-apply) This command allows you to apply for a job. /ec cooldowns[](https://documentation.botghost.com/fun-modules/economy-and-minigames#ec-cooldowns) This command checks and shows all your active minigame and economy cooldowns. /rob player[](https://documentation.botghost.com/fun-modules/economy-and-minigames#rob-player) This command will make you attempt to steal an amount of currency from a player but if they catch you then you lose some money. ### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#minigame-commands) Minigame Commands /scratchcard[](https://documentation.botghost.com/fun-modules/economy-and-minigames#scratchcard) This command allows you to buy a scratchcard that could potentially give you a lot of currency. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FPPdn0rfUN5GIE03Wb6e9%252Fimage.png%3Falt%3Dmedia%26token%3D14963dd5-60ba-45cc-9201-b3c8d414979f&width=300&dpr=3&quality=100&sign=7edc7e00&sv=2) /dicebet[](https://documentation.botghost.com/fun-modules/economy-and-minigames#dicebet) This command serves as a minigame and challenges a player to a dice bet. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FDKkSkq6OIyCM9l3oDSp5%252Fimage.png%3Falt%3Dmedia%26token%3Dddc5a718-ef69-42e4-b7f7-16d8a1d71a74&width=300&dpr=3&quality=100&sign=4ff02a57&sv=2) /dos[](https://documentation.botghost.com/fun-modules/economy-and-minigames#dos) This command serves as a minigame and plays a game of double or steal against a user. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FiM0HHeXj2zmGDNPD9660%252Fimage.png%3Falt%3Dmedia%26token%3D323ede87-1b59-4820-90ff-7cff5497eb27&width=300&dpr=3&quality=100&sign=5039cdbd&sv=2) /hangman[](https://documentation.botghost.com/fun-modules/economy-and-minigames#hangman) This command servers as a minigame and plays a game of hangman. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FryGcSmaCmj4jptH3ohXw%252Fimage.png%3Falt%3Dmedia%26token%3D0ddc2fa5-8f07-4e33-a465-a12f8f975659&width=300&dpr=3&quality=100&sign=5b679f6&sv=2) /high-low[](https://documentation.botghost.com/fun-modules/economy-and-minigames#high-low) This command serves as a minigame and plays a game of higher or lower. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FZQUCThwVaePyyG5ytP3p%252Fimage.png%3Falt%3Dmedia%26token%3Dd279bbad-db7d-4a8b-9c2d-20aad871e652&width=300&dpr=3&quality=100&sign=fd96f678&sv=2) /rps[](https://documentation.botghost.com/fun-modules/economy-and-minigames#rps) This command serves as a minigame and plays a game of rock paper scissors. /tictac[](https://documentation.botghost.com/fun-modules/economy-and-minigames#tictac) This command serves as a minigame and plays a game of tic tac toe. /blackjack[](https://documentation.botghost.com/fun-modules/economy-and-minigames#blackjack) This command serves as a minigame and plays a game of blackjack. /matchpairs[](https://documentation.botghost.com/fun-modules/economy-and-minigames#matchpairs) This command serves as a minigame and plays a game of match pairs. /5dice[](https://documentation.botghost.com/fun-modules/economy-and-minigames#id-5dice) This command serves as a minigame and plays a game of 5dice. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FkzgG5VkCN79UA3f0XChb%252Fimage.png%3Falt%3Dmedia%26token%3D9833604f-abf3-4988-a097-c6b515d74baf&width=300&dpr=3&quality=100&sign=da7ac06c&sv=2) /lightout[](https://documentation.botghost.com/fun-modules/economy-and-minigames#lightout) This command allowes you to play Lights Out. It is a puzzle game where the objective is to turn off all the lights on a grid. Pressing a button toggles that light and the adjacent lights directly above, below, and to either side. /mastermind[](https://documentation.botghost.com/fun-modules/economy-and-minigames#mastermind) This command allowes you to play Mastermind, the goal of this game is for the Codebreaker (you) to guess the exact colors and positions of a secret code created by the Codemaker (the bot) in as few attempts as possible. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#add-command) \[👑\] Add Command By clicking the add command button you can create your own command for the economy using all the module [variables](https://documentation.botghost.com/custom-commands-and-events/variables) and settings. [](https://documentation.botghost.com/fun-modules/economy-and-minigames#events) Events ------------------------------------------------------------------------------------------- In this area, you can view and modify the events of the Economy & Minigames module. Below you may find some information on each event of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Ftm1TlITi3p6SGZCULm1h%252Fimage_2024-07-27_225839672.png%3Falt%3Dmedia%26token%3Dd93f300c-2dd1-4e3e-99f0-dd77963edf6a&width=768&dpr=3&quality=100&sign=64fb924c&sv=2) Custom Events of the Economy & Minigames module Bank Interest[](https://documentation.botghost.com/fun-modules/economy-and-minigames#bank-interest-1) This event controls the entire banking system with the related commands. Economy - Lottery[](https://documentation.botghost.com/fun-modules/economy-and-minigames#economy-lottery) This even controls the lottery system and the correlating commands. Economy Autorole[](https://documentation.botghost.com/fun-modules/economy-and-minigames#economy-autorole) This event controls the entire [Economy Roles](https://documentation.botghost.com/fun-modules/economy-and-minigames#economy-roles) system. Currency for Messages[](https://documentation.botghost.com/fun-modules/economy-and-minigames#currency-for-messages) This event adds currency to users based on specific criteria if [Earn Currency for Messages](https://documentation.botghost.com/fun-modules/economy-and-minigames#earn-currency-for-messages) is enabled. #### [](https://documentation.botghost.com/fun-modules/economy-and-minigames#add-event) \[👑\] Add Event By clicking the add event button you can create your own event for the economy using all the module [variables](https://documentation.botghost.com/custom-commands-and-events/variables) and settings. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 1 year ago Was this helpful? * [Common Issues](https://documentation.botghost.com/fun-modules/economy-and-minigames#common-issues) * [Minigame Commands Not Working](https://documentation.botghost.com/fun-modules/economy-and-minigames#minigame-commands-not-working) * [Settings](https://documentation.botghost.com/fun-modules/economy-and-minigames#settings) * [Economy Settings](https://documentation.botghost.com/fun-modules/economy-and-minigames#economy-settings) * [Jobs Title](https://documentation.botghost.com/fun-modules/economy-and-minigames#jobs-title) * [Economy Items](https://documentation.botghost.com/fun-modules/economy-and-minigames#economy-items) * [Economy Roles](https://documentation.botghost.com/fun-modules/economy-and-minigames#economy-roles) * [Active Economy Roles](https://documentation.botghost.com/fun-modules/economy-and-minigames#active-economy-roles) * [Commands](https://documentation.botghost.com/fun-modules/economy-and-minigames#commands) * [Admin Commands](https://documentation.botghost.com/fun-modules/economy-and-minigames#admin-commands) * [Economy Commands](https://documentation.botghost.com/fun-modules/economy-and-minigames#economy-commands) * [Minigame Commands](https://documentation.botghost.com/fun-modules/economy-and-minigames#minigame-commands) * [Events](https://documentation.botghost.com/fun-modules/economy-and-minigames#events) Was this helpful? --- # Music | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/fun-modules/music.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FaSwU0kGfIvvoUC7ZgviX%252Fimage.png%3Falt%3Dmedia%26token%3D1ae7a1c5-8b71-41d8-9c28-dc7855711c9e&width=768&dpr=3&quality=100&sign=9aee6765&sv=2) This module requires a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. If you are looking for instructions on how to use the Music Blocks, please see [Music Actions](https://documentation.botghost.com/custom-commands-and-events/actions/music-actions) . The [Music](https://dashboard.botghost.com/dashboard/music) module gives you access to pre-built commands for the music blocks, allowing your bot to play music in your Discord server! [](https://documentation.botghost.com/fun-modules/music#commands) Commands ------------------------------------------------------------------------------- In this area, you can view and modify the commands of the Music module. Below you may find some information on each command of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F9Ltl6i3C4L4fXQ7xQvQi%252Fimage.png%3Falt%3Dmedia%26token%3Db6229c2c-0f89-4c84-82ac-d967face445b&width=768&dpr=3&quality=100&sign=3c9be54d&sv=2) /music seek[](https://documentation.botghost.com/fun-modules/music#music-seek) This command allows you to go to (or "seek" to) a specific time in the current song that is playing. /music pause[](https://documentation.botghost.com/fun-modules/music#music-pause) This command will pause the currently playing song. Use `/music resume` to resume playing the song. /music queue[](https://documentation.botghost.com/fun-modules/music#music-queue) This command will return every song that is currently in the music queue and information about the currently playing song. /music clear-filters[](https://documentation.botghost.com/fun-modules/music#music-clear-filters) This command will clear all filters added with the `/music apply-filter` command. /music track[](https://documentation.botghost.com/fun-modules/music#music-track) This command returns information about the song that is currently playing, including the title, artist, progress and album art. /music play[](https://documentation.botghost.com/fun-modules/music#music-play) Plays a song in the voice channel you or the bot is currently in. Accepts song titles, URLs, or playlist URLs. /music stop[](https://documentation.botghost.com/fun-modules/music#music-stop) Stops playing music and clears the queue. /music replay[](https://documentation.botghost.com/fun-modules/music#music-replay) Replays the current song from the beginning. /music disconnect[](https://documentation.botghost.com/fun-modules/music#music-disconnect) Disconnects the bot from the voice channel and resets the queue, filters, and settings. /music resume[](https://documentation.botghost.com/fun-modules/music#music-resume) Resumes playback of music paused with `/music pause`. /music set-autoleave[](https://documentation.botghost.com/fun-modules/music#music-set-autoleave) Configure whether to automatically disconnect the bot from the voice channel when the queue ends. /music set-autoplay[](https://documentation.botghost.com/fun-modules/music#music-set-autoplay) Configure whether to automatically queue similar songs when the queue ends. /music apply-filter[](https://documentation.botghost.com/fun-modules/music#music-apply-filter) Apply various sound filters to the music playback. Use `/music clear-filters` to clear them. /music skip[](https://documentation.botghost.com/fun-modules/music#music-skip) Skips the currently playing song. /music remove[](https://documentation.botghost.com/fun-modules/music#music-remove) Remove a specific song from the queue based on queue position. /music shuffle[](https://documentation.botghost.com/fun-modules/music#music-shuffle) Shuffles the music queue. /music set-volume[](https://documentation.botghost.com/fun-modules/music#music-set-volume) Sets the volume of the music (0-200). /music loop[](https://documentation.botghost.com/fun-modules/music#music-loop) Choose whether to loop the currently playing track or queue. [](https://documentation.botghost.com/fun-modules/music#events) Events --------------------------------------------------------------------------- The music module is also provided with two events: ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F8pkjDvYRQlhoTgKlcJON%252Fimage.png%3Falt%3Dmedia%26token%3Ddbfa4027-3e31-49eb-a55e-c79e3b9a18fc&width=768&dpr=3&quality=100&sign=a036c430&sv=2) Set voice channel status to song data[](https://documentation.botghost.com/fun-modules/music#set-voice-channel-status-to-song-data) This event will set the voice channel status to information about the currently playing song when a song starts plating Remove voice status song data[](https://documentation.botghost.com/fun-modules/music#remove-voice-status-song-data) This event will remove the status set by `Set voice channel status to song data` when a song finishes playing. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intented. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 6 months ago Was this helpful? * [Commands](https://documentation.botghost.com/fun-modules/music#commands) * [Events](https://documentation.botghost.com/fun-modules/music#events) Was this helpful? --- # Birthdays | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/fun-modules/birthdays.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FUAqkyhsqbDWwFbRsdZWq%252Fimage.png%3Falt%3Dmedia%26token%3Df39b3ab2-8df8-4e1d-8aef-7691ca0a3336&width=768&dpr=3&quality=100&sign=b7f5b8e&sv=2) Some of the features of this module require a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. You can however use the module with a free subscription. The [Birthdays module](https://dashboard.botghost.com/dashboard/module/99761223-9984-460d-a847-e16e64498099/birthdays) allows users to set their birthdays, view users' birthdays, and receive automatically personalized birthday wishes. [](https://documentation.botghost.com/fun-modules/birthdays#common-issues) Common Issues --------------------------------------------------------------------------------------------- Experiencing issues with the module? Check out the common issues below. If your issue is not listed in this page, make sure your module is updated to the latest version. If you are still experiencing issues with the module, join our [support server](https://discord.gg/botghost) to ask for further help. ### [](https://documentation.botghost.com/fun-modules/birthdays#birthdays-are-not-being-detected) Birthdays are not being detected If no birthday message gets sent on an user's birthday, they don't receive their birthday role or they aren't able to use the `/birthday showcase` command, please try the steps below. 1 Ensure the module is updated to the latest version. You can update it by clicking the "Update Module" button at the top of the settings page of the module. 2 Ensure that the "Default Server" option in your [Timed Events](https://dashboard.botghost.com/dashboard/timedevents) page is set to the server your birthday module runs in. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F6pI9kVUm6PfCZ4a9udzE%252Fimage.png%3Falt%3Dmedia%26token%3Dca50b855-bcca-4a2d-8364-6b9dbe2f0719&width=768&dpr=3&quality=100&sign=9a4157da&sv=2) 3 If you're still experiencing issues, join our [support server](https://discord.gg/botghost) to ask for further help, we'll do our best to solve your issue! * * * [](https://documentation.botghost.com/fun-modules/birthdays#watch-the-tutorial) Watch the Tutorial ------------------------------------------------------------------------------------------------------- * * * [](https://documentation.botghost.com/fun-modules/birthdays#settings) Settings ----------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/fun-modules/birthdays#general-settings) General Settings In this area, you can setup and customize the general settings for the commands and events of this module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FjFtaqediq9IuqBYPd4Kn%252Fimage.png%3Falt%3Dmedia%26token%3Ded01a297-6e3d-4e1c-b7ea-91642c06f20c&width=768&dpr=3&quality=100&sign=28bdd15b&sv=2) #### [](https://documentation.botghost.com/fun-modules/birthdays#timezone) Timezone Here you may choose the timezone you'd like to set times in for this module. It is recommended that you select [your local timezone](https://www.google.com/search?q=what+is+my+timezone&oq=what+is+my+timezone&gs_lcrp=EgZjaHJvbWUyBggAEEUYOTIJCAEQABgKGIAEMg0IAhAAGJECGIAEGIoFMgkIAxAAGAoYgAQyCQgEEAAYChiABDIJCAUQABgKGIAEMgcIBhAAGIAEMgcIBxAAGIAEMgkICBAAGAoYgATSAQgzNzAzajBqNKgCALACAA&sourceid=chrome&ie=UTF-8) . If you want to know more about timezones, the following links may be helpful: * [List of all timezones](https://en.wikipedia.org/wiki/List_of_UTC_offsets) * [Timezones by country](https://en.wikipedia.org/wiki/List_of_time_zones_by_country) * [Daylight saving time countries](https://en.wikipedia.org/wiki/Daylight_saving_time_by_country) #### [](https://documentation.botghost.com/fun-modules/birthdays#time) Time Here you may choose the time that birthday wishes will go off on a users' birthday. This will sync to the timezone you chose above. #### [](https://documentation.botghost.com/fun-modules/birthdays#save-birth-year) Save Birth Year Here you may choose whether the birth year of a user should be allowed to save, not be allowed to save, or be required to save. #### [](https://documentation.botghost.com/fun-modules/birthdays#embeds-color) Embeds Color Here you may choose the color for the embeds of the Birthdays module. This will be used in all messages. ### [](https://documentation.botghost.com/fun-modules/birthdays#birthday-card) Birthday Card In this area, you can setup and customize a custom card that can be used across all messages of the module using the `{card}` variable. Features in this section are limited to [Premium](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) users. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F2dFd0gNLjhDu0LTcGpO7%252Fimage.png%3Falt%3Dmedia%26token%3D6e8a9e5d-5543-4787-a1fd-4739b1d4e2bb&width=768&dpr=3&quality=100&sign=2e601c9e&sv=2) #### [](https://documentation.botghost.com/fun-modules/birthdays#enable-custom-card) \[👑\] Enable Custom card This toggle option allows you to enable the `{card}` variable #### [](https://documentation.botghost.com/fun-modules/birthdays#background) \[👑\] Background This setting allows you to set the background type for your card. Below you may find some information on each background type. Default Background Plain Color Custom Image By selecting this option, the default background image will be used. Cards generated with the default background will look like this: ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F4mmmtEjRsFwENWhARhpl%252Fimage.png%3Falt%3Dmedia%26token%3D70ecdfc2-c994-4971-a4f3-cc5f0eaa86f1&width=768&dpr=3&quality=100&sign=37dbe9d5&sv=2) By selecting this option, you will be able to select a custom plain color for your card's background. The following settings will appear: ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F1XwRTQDdpQSWN0paC9MQ%252Fimage.png%3Falt%3Dmedia%26token%3D5583500f-33e8-4224-a8e3-31423db57af4&width=768&dpr=3&quality=100&sign=dce00588&sv=2) #### [](https://documentation.botghost.com/fun-modules/birthdays#background-color) \[👑\] Background Color Here you may choose the color for the background on the custom card. By selecting this option, you will be able to paste a custom image link for your background The following settings will appear: ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FZTbcqpZ0PjHDAPus09g0%252Fimage.png%3Falt%3Dmedia%26token%3D929901fe-b461-432c-8be8-6f585ee56387&width=768&dpr=3&quality=100&sign=75d03392&sv=2) #### [](https://documentation.botghost.com/fun-modules/birthdays#background-image) \[👑\] Background Image Here you may set the background image on the custom card. This must be a valid image URL. #### [](https://documentation.botghost.com/fun-modules/birthdays#title-color) \[👑\] Title Color Here you may choose the font color for the "title" text on the custom card. #### [](https://documentation.botghost.com/fun-modules/birthdays#description-color) \[👑\] Description Color Here you may choose the font color for the "description" text on the custom card. #### [](https://documentation.botghost.com/fun-modules/birthdays#avatar-border-color) \[👑\] Avatar Border Color Here you may choose the color for the circular border around the user's avatar on the custom card. #### [](https://documentation.botghost.com/fun-modules/birthdays#card-title) \[👑\] Card Title Here you may set the "title" text on the custom card. All [default variables](https://documentation.botghost.com/custom-commands-and-events/variables) can be used, as well as some additional variables that can be found [here](https://documentation.botghost.com/fun-modules/birthdays#module-variables) . #### [](https://documentation.botghost.com/fun-modules/birthdays#card-description) \[👑\] Card Description Here you may set the "description" text on the custom card. All [default variables](https://documentation.botghost.com/custom-commands-and-events/variables) can be used, as well as some additional variables that can be found [here](https://documentation.botghost.com/fun-modules/birthdays#module-variables) . ### [](https://documentation.botghost.com/fun-modules/birthdays#birthday-message) Birthday Message In this area, you can setup and customize a birthday message to display on a users' birthday. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FqBhFt8Ab4Iu83wDrsfYP%252Fimage.png%3Falt%3Dmedia%26token%3D782be4d0-a8cf-41a8-afb5-acbcc66eaac4&width=768&dpr=3&quality=100&sign=2b7e476f&sv=2) #### [](https://documentation.botghost.com/fun-modules/birthdays#send-message-on-birthday) Send Message on Birthday Here you may toggle whether a message is sent on a user's birthday. #### [](https://documentation.botghost.com/fun-modules/birthdays#channel) Channel This menu allows you to select the channel where the birthday message will be sent. If you don't see your channel, make sure to click on the refresh button next to the "Channel" text. #### [](https://documentation.botghost.com/fun-modules/birthdays#message) Message Here you may set the message that is sent on birthday. This message will be sent only if the user has set a birth year. All [default variables](https://documentation.botghost.com/custom-commands-and-events/variables) can be used, as well as some additional variables that can be found [here](https://documentation.botghost.com/fun-modules/birthdays#module-variables) . #### [](https://documentation.botghost.com/fun-modules/birthdays#message-without-birth-year) Message Without Birth Year Here you may set the message that is sent on birthday. This message will be sent only if the user did not set a birth year. All [default variables](https://documentation.botghost.com/custom-commands-and-events/variables) can be used, as well as some additional variables that can be found [here](https://documentation.botghost.com/fun-modules/birthdays#module-variables) . #### [](https://documentation.botghost.com/fun-modules/birthdays#reactions) Reactions Here you may choose up to 5 custom reactions to be added to the message sent. #### [](https://documentation.botghost.com/fun-modules/birthdays#create-thread) Create Thread Here you may toggle whether a thread is created on the message for users to leave their birthday wishes in. #### [](https://documentation.botghost.com/fun-modules/birthdays#lock-thread) Lock Thread Here you may toggle whether the thread created on the message is locked after 24 hours. The [create thread](https://documentation.botghost.com/fun-modules/birthdays#create-thread) setting must be enabled. _This setting is only visible with_ [_Create Thread_](https://documentation.botghost.com/fun-modules/birthdays#create-thread) _enabled._ ### [](https://documentation.botghost.com/fun-modules/birthdays#add-role-on-birthday) Add Role on Birthday In this area, you can setup and customize a function to add a role to the user on their birthday and remove it after 24 hours. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FoxqXy9II9zwY5iyDJNTq%252Fimage.png%3Falt%3Dmedia%26token%3Da70da63e-67b1-4687-847e-52b9358e8ce8&width=768&dpr=3&quality=100&sign=cc5bce5b&sv=2) #### [](https://documentation.botghost.com/fun-modules/birthdays#add-a-role-on-birthday) Add a Role on Birthday Here you may toggle whether a role is added on a user's birthday for 24 hours. #### [](https://documentation.botghost.com/fun-modules/birthdays#role) Role Here you may choose the role that is added to the user on their birthday for 24 hours. If you don't see your channel, make sure to click on the refresh button next to the "Channel" text. ### [](https://documentation.botghost.com/fun-modules/birthdays#birthday-showcase-command) /birthday showcase Command In this area, you can setup and customize the functions of the /birthday command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FkTzKS4Oi1kC7F7jrxTZv%252Fimage.png%3Falt%3Dmedia%26token%3D1f90c077-80ca-4c67-80a1-510e69df1343&width=768&dpr=3&quality=100&sign=f520ccd1&sv=2) #### [](https://documentation.botghost.com/fun-modules/birthdays#enable-birthday-showcase-command) Enable /birthday showcase Command Here you may enable and allow the usage of the `/birthday showcase` command. #### [](https://documentation.botghost.com/fun-modules/birthdays#command-cooldown) Command Cooldown This input allows you to set a cooldown for the command in minutes. Users won't be able to use this command twice wiithin this time range. It cannot be higher than 1440 minutes (24 hours). #### [](https://documentation.botghost.com/fun-modules/birthdays#command-response) Command Response This field allows you to setup the response the bot will return when the command is ran. All [default variables](https://documentation.botghost.com/custom-commands-and-events/variables) can be used, as well as some additional variables that can be found [here](https://documentation.botghost.com/fun-modules/birthdays#module-variables) . ### [](https://documentation.botghost.com/fun-modules/birthdays#commands-permissions) Commands Permissions In this area, you can setup and customize the permissions for running each command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FyySzq80lDGx5GCFL581Z%252Fimage.png%3Falt%3Dmedia%26token%3Df9d540dc-bb24-4ca4-95ce-5e5f731e991f&width=768&dpr=3&quality=100&sign=9e8dc2a&sv=2) #### [](https://documentation.botghost.com/fun-modules/birthdays#admin-roles) Admin Roles Here you may choose the roles who can use the [/birthday-user-manage](https://documentation.botghost.com/fun-modules/birthdays#birthday-user-manage) command. They will be able to set, update, remove birthdays or blacklist users from adding their own birthday. #### [](https://documentation.botghost.com/fun-modules/birthdays#channel-restrictions) Channel Restrictions You can setup channel restrictions to allow the usage of the module's commands only in certain channels. Blacklist Type Information No channel restrictions Users will be able to use the command everywhere. Disable for these channels... Set this blacklist type if you want the commands to work in all channels except the channels provided in the menu below. Enable for these channels... Set this blacklist type if you want the commands to work only in the channels provided in the menu below. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FoauM4WtWXGRfB2gSYsZR%252Fimage.png%3Falt%3Dmedia%26token%3D4fe62802-c2e5-4fae-993d-2c50423f7085&width=768&dpr=3&quality=100&sign=45894fba&sv=2) #### [](https://documentation.botghost.com/fun-modules/birthdays#role-restrictions) Role Restrictions You can setup role restrictions to allow the usage of the module's commands only to certain roles. Blacklist Type Information No role restrictions Everyone will be able to use the commands of the module. Disable for these channels... Set this blacklist type if you want the commands to work for all users, except users with at least one of the roles provided in the menu below. Enable for these channels... Set this blacklist type if you want the commands to work only for users with at least one of the roles provided in the menu below. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FFwOqnq51U6ywR2wVk5iz%252Fimage.png%3Falt%3Dmedia%26token%3De7e6f22e-1dfc-437d-87d3-7cce619f26e0&width=768&dpr=3&quality=100&sign=1173da2b&sv=2) * * * [](https://documentation.botghost.com/fun-modules/birthdays#module-variables) Module Variables --------------------------------------------------------------------------------------------------- The Birthdays module collects information about all users who record their birthdays. This information can be referenced using variables in the text settings of the module page, or in the builders. You can use any of these variables to provide accurate information in birthday messages, cards, etc.: These variables can only be used in the Birthdays module. Variable Description `{target}` Returns an @mention for the target user `{target_id}` Returns the user ID for the target user. Can be used in other [default variables](https://documentation.botghost.com/custom-commands-and-events/variables) or to return the ID in general. `{target_name}` Returns the name for the target user. `{card}` \[👑\] Returns the image URL of the birthday card for the target user. Will return nothing if you have the Enable Custom Card setting disabled. Recommended for use in a plain text message or the image in an embed. This variable requires a premium subscription to work. `{age}` Returns the current age for the target user. `{birthday_timestamp}` Returns the UNIX timestamp of the birthday for the target user. `{day}` Returns the day of birth for the target user. `{month}` Returns the month of birth for the target user. `{year}` Returns the year of birth for the target user. `{current_year}` Returns the current year. * * * [](https://documentation.botghost.com/fun-modules/birthdays#commands) Commands ----------------------------------------------------------------------------------- In this area, you can view and modify the commands of the Birthdays module. Below you may find some information on each command of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FvjgP8AgSk2utz5MkwqN5%252Fimage.png%3Falt%3Dmedia%26token%3D47ddf352-ed36-41e8-ad04-2ba6840e1222&width=768&dpr=3&quality=100&sign=77ccdc92&sv=2) /birthday set[](https://documentation.botghost.com/fun-modules/birthdays#birthday-set) The birthday set command allows you to set your own birthday to a given date. The date must be provided in DD/MM/YYYY format. You can choose whether you want the birth year to be required in the [Save Birth Year](https://documentation.botghost.com/fun-modules/birthdays#save-birth-year) setting. You cannot use this command if you're currently celebreating your birthday. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FPKDYvq36c9jnfqtqksdW%252Fimage.png%3Falt%3Dmedia%26token%3D089fe18c-e97a-4c3d-be81-3debcc282a3e&width=300&dpr=3&quality=100&sign=577ec9b5&sv=2) /birthday remove[](https://documentation.botghost.com/fun-modules/birthdays#birthday-remove) This command allows users to remove their birthday from the system. They can always add it back using [/birthday set](https://documentation.botghost.com/fun-modules/birthdays#birthday-set) . /birthday view[](https://documentation.botghost.com/fun-modules/birthdays#birthday-view) This command allows users to view their own or someone's else birthday. They can also update their personal settings by selecting themselves when running the command. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fuwip3lCJlGHjt3z5qdW8%252Fimage.png%3Falt%3Dmedia%26token%3Dbc02e8e5-0b19-489f-80f4-95ff6d20c268&width=300&dpr=3&quality=100&sign=eb8ef833&sv=2) /birthday upcoming[](https://documentation.botghost.com/fun-modules/birthdays#birthday-upcoming) This command allows users to get a list of all upcoming birthdays. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FqzEkNuzXXhl4FoerUedd%252Fimage.png%3Falt%3Dmedia%26token%3Dd6b6676b-dd20-4eee-b9af-805b0defb4f9&width=300&dpr=3&quality=100&sign=2a4c8192&sv=2) /birthday showcase[](https://documentation.botghost.com/fun-modules/birthdays#birthday-showcase) Users who are currently celebrating their birthday can use this command. You can configure it from the [/birthday showcase Command](https://documentation.botghost.com/fun-modules/birthdays#birthday-showcase-command) section. /birthday user-manage[](https://documentation.botghost.com/fun-modules/birthdays#birthday-user-manage) This command can only be used by server's [admins](https://documentation.botghost.com/fun-modules/birthdays#admin-roles) and allows them to update / edit certain information of the selected user. The list of available settings depends on the current birthday status of the user. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FVv1dVZNdzGzjPi5b3PAH%252Fimage.png%3Falt%3Dmedia%26token%3D844b65d4-ef7f-41af-9eb6-69d0a9b8bac5&width=300&dpr=3&quality=100&sign=e83ad6&sv=2) [](https://documentation.botghost.com/fun-modules/birthdays#events) Events ------------------------------------------------------------------------------- In this area, you can view and modify the events of the Birthdays module. Below you may find some information on each event of the module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FyZC5npIznxeD0luUS7FJ%252Fimage.png%3Falt%3Dmedia%26token%3Dd4130fb5-3c32-468a-821d-afdf0ad94971&width=768&dpr=3&quality=100&sign=d5b07614&sv=2) Birthdays Handler[](https://documentation.botghost.com/fun-modules/birthdays#birthdays-handler) This event is the core of the module: it triggers every 30 minutes and ensures to wish your members a happy birthday. Make sure to not delete the associated timed event in the [timed events](https://documentation.botghost.com/custom-commands-and-events/events/timed-events) module. Leaves Handler[](https://documentation.botghost.com/fun-modules/birthdays#leaves-handler) This event automatically resets birthday data of users who left the server. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intended. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 9 months ago Was this helpful? * [Common Issues](https://documentation.botghost.com/fun-modules/birthdays#common-issues) * [Birthdays are not being detected](https://documentation.botghost.com/fun-modules/birthdays#birthdays-are-not-being-detected) * [Watch the Tutorial](https://documentation.botghost.com/fun-modules/birthdays#watch-the-tutorial) * [Settings](https://documentation.botghost.com/fun-modules/birthdays#settings) * [General Settings](https://documentation.botghost.com/fun-modules/birthdays#general-settings) * [Birthday Card](https://documentation.botghost.com/fun-modules/birthdays#birthday-card) * [Birthday Message](https://documentation.botghost.com/fun-modules/birthdays#birthday-message) * [Add Role on Birthday](https://documentation.botghost.com/fun-modules/birthdays#add-role-on-birthday) * [/birthday showcase Command](https://documentation.botghost.com/fun-modules/birthdays#birthday-showcase-command) * [Commands Permissions](https://documentation.botghost.com/fun-modules/birthdays#commands-permissions) * [Module Variables](https://documentation.botghost.com/fun-modules/birthdays#module-variables) * [Commands](https://documentation.botghost.com/fun-modules/birthdays#commands) * [Events](https://documentation.botghost.com/fun-modules/birthdays#events) Was this helpful? --- # Leveling | BotGhost Documentation [Download now our new iOS App on the\ \ App Store!](https://apps.apple.com/us/app/botghost/id6757778695) For the complete documentation index, see [llms.txt](https://documentation.botghost.com/llms.txt) . This page is also available as [Markdown](https://documentation.botghost.com/community-engagement/leveling.md) . ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FRJNWMiGBVTcm1mqgH4vP%252FScreenshot%25202024-07-16%2520123743.png%3Falt%3Dmedia%26token%3D4e4faddf-9319-4d5f-be59-98aeaaacce6a&width=768&dpr=3&quality=100&sign=93d6bd6a&sv=2) Some of the features of this module require a [Premium Subscription](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) to function. You can however use the module with a free subscription. The [Leveling](https://dashboard.botghost.com/dashboard/module/7c393ff6-f182-44d6-883c-bebd890a2594/leveling) module will allow you to setup a highly customizable leveling system for both text based interactions and voice interactions. [](https://documentation.botghost.com/community-engagement/leveling#watch-the-tutorial) Watch the Tutorial --------------------------------------------------------------------------------------------------------------- * * * [](https://documentation.botghost.com/community-engagement/leveling#settings) Settings ------------------------------------------------------------------------------------------- ### [](https://documentation.botghost.com/community-engagement/leveling#general-settings) General Settings In this area, you can setup and customize the general settings for the commands and events of this module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FGQEOriv5fDvD3HFVOroV%252Fimage.png%3Falt%3Dmedia%26token%3Da7e54947-5fe0-46a0-932c-151a8ed65949&width=768&dpr=3&quality=100&sign=f6b29ab2&sv=2) #### [](https://documentation.botghost.com/community-engagement/leveling#embeds-color) Embeds Color Change the embed color for the public embeds that are set alongside this module such as the leaderboard. #### [](https://documentation.botghost.com/community-engagement/leveling#max-level) Max Level This option will allow you to define a maximum level users can reach with the leveling module. Setting this option to **0** will disable it meaning there will be no level limit. If a limit is defined, users will not be able to surpass it. #### [](https://documentation.botghost.com/community-engagement/leveling#additional-required-xp-per-level) Additional Required XP Per Level This option will allow you to change the default XP increment upon level up. On level up, the required experience will increase by the set amount. For instance, if this setting is set to 50 and the previous level required 200 XP to level up, the next level will require 250 XP. Also, the set amount will correspond to the required experience to reach the level 1. #### [](https://documentation.botghost.com/community-engagement/leveling#clear-leveling-data-on-leave) Clear Leveling Data on Leave This option will allow you to toggle on/off data clearing on user leave, if enabled (default) once a user leaves the server it will automatically clear their activity data. #### [](https://documentation.botghost.com/community-engagement/leveling#send-a-message-on-level-up) Send a Message on Level Up This option will allow you to define how and if a level up message should be sent once a user levels up. By default this is set to disabled however, you can choose between: Selection Action **Disabled** Does not send any message on level up. **Current Channel** Send the message to the channel the user leveled up in. **Custom Channel** Send the message to a selected channel. **Direct Message** Send a direct message to the user that leveled up. **Current Channel & Direct Message** Send a message to the channel the user leveled up in and send a direct message to the user that leveled up. **Custom Channel & Direct Message** Send the message to a selected channel and send a direct message to the user that leveled up. #### [](https://documentation.botghost.com/community-engagement/leveling#custom-channel) Custom Channel In this dropdown you can pick the channel that you would like level up messages to be sent to. _This setting is only visible when a custom channel option has been selected in_ [Send a Message on Level Up](https://documentation.botghost.com/community-engagement/leveling#send-a-message-on-level-up) _._ #### [](https://documentation.botghost.com/community-engagement/leveling#level-up-server-message) **Level Up Server Message** Here you can edit the level up message that is sent to the server when a user levels up. All variables can be used. A list of additional variables you can use is listed in [Variables](https://documentation.botghost.com/community-engagement/leveling#variables) . _This setting is only visible when a server message option has been selected in_ [Send a Message on Level Up](https://documentation.botghost.com/community-engagement/leveling#send-a-message-on-level-up) _._ #### [](https://documentation.botghost.com/community-engagement/leveling#level-up-direct-message) **Level Up Direct Message** Here you can edit the level up message that is sent to the user when they levels up. All variables can be used. A list of additional variables you can use is listed in [Variables](https://documentation.botghost.com/community-engagement/leveling#variables) . _This setting is only visible when a direct message option has been selected in_ [Send a Message on Level Up](https://documentation.botghost.com/community-engagement/leveling#send-a-message-on-level-up) _._ ### [](https://documentation.botghost.com/community-engagement/leveling#level-card-settings) Level Card Settings Features in this section are limited to [Premium](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) users. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FMHhqTEAtIl3NuXkHQ102%252Fimage_2024-07-17_174035530.png%3Falt%3Dmedia%26token%3D1e1de85a-6a65-465f-837b-c091621f8736&width=768&dpr=3&quality=100&sign=31e5daab&sv=2) #### [](https://documentation.botghost.com/community-engagement/leveling#card-type) \[👑\] Card Type Here you can change the type of card you'll be using. Embed Message Default Card Card - Plain Color as Background Custom Image as Background If this dropdown type is selected then the card will be sent as an embed message with the level card settings. ### [](https://documentation.botghost.com/community-engagement/leveling#example-card) Example Card ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FcT5Xp68kLtCHozKsyr5J%252Fimage.png%3Falt%3Dmedia%26token%3Dd5bc63ec-e7d1-4748-8b4b-352a423815b8&width=768&dpr=3&quality=100&sign=ed1e2107&sv=2) If this dropdown type is selected then you can choose to enable and use [\[👑\] Advanced Card Settings](https://documentation.botghost.com/community-engagement/leveling#advanced-card-settings) as well as [\[👑\] Main Color](https://documentation.botghost.com/community-engagement/leveling#main-color) and [\[👑\] Filled Bar Color](https://documentation.botghost.com/community-engagement/leveling#filled-bar-color) **\[👑\] Advanced Card Settings** Enabling the Advanced Settings for the level card above will display a wide range of new advanced customization option for the level card. By default it is set to disabled. This is not compatible with the Embed Card option. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FFaMstG681Sba9ZCQVcYo%252Fimage.png%3Falt%3Dmedia%26token%3Ded6f9ce9-be0e-4886-812a-b101e2ed0aa3&width=768&dpr=3&quality=100&sign=e6ab6e38&sv=2) #### [](https://documentation.botghost.com/community-engagement/leveling#main-color) \[👑\] Main Color Here you can change the color of the text for the level card using Hexadecimal (HEX). This option is only available with Advanced Settings disabled. #### [](https://documentation.botghost.com/community-engagement/leveling#circle-color) \[👑\] Circle Color Here you can change the user icon outline color for the level card using Hexadecimal (HEX). #### [](https://documentation.botghost.com/community-engagement/leveling#empty-bar-color) \[👑\] Empty Bar Color Here you can change the Fill Bar/Progress bar background for the level card using Hexadecimal (HEX). #### [](https://documentation.botghost.com/community-engagement/leveling#filled-bar-color) \[👑\] Filled Bar Color Here you can change the Fill Bar/Progress bar color when its full for the level card using Hexadecimal (HEX). #### [](https://documentation.botghost.com/community-engagement/leveling#level-text-color) \[👑\] Level Text Color Here you can change the level text color for the level card using Hexadecimal (HEX). #### [](https://documentation.botghost.com/community-engagement/leveling#experience-progress-color) \[👑\] Experience Progress Color Here you can change the experience progress text color for the level card using Hexadecimal (HEX). #### [](https://documentation.botghost.com/community-engagement/leveling#experience-percentage-color) \[👑\] Experience Percentage Color Here you can change the experience percentage text color for the level card using Hexadecimal (HEX). ### [](https://documentation.botghost.com/community-engagement/leveling#example-card-1) Example Card ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FlLy6boa7mOjUfZdM9Wno%252Flyst5oa1a1ap83jpi1u.webp%3Falt%3Dmedia%26token%3Da65e9af4-aad4-4fc5-a84c-75b1337cfb62&width=768&dpr=3&quality=100&sign=1173efdb&sv=2) If this dropdown type is selected then you can choose to enable and use [\[👑\] Advanced Card Settings](https://documentation.botghost.com/community-engagement/leveling#advanced-card-settings) as well as [\[👑\] Main Color](https://documentation.botghost.com/community-engagement/leveling#main-color) and [\[👑\] Filled Bar Color](https://documentation.botghost.com/community-engagement/leveling#filled-bar-color) . #### [](https://documentation.botghost.com/community-engagement/leveling#background-color) \[👑\] Background Color Here you can change the background color for the level card as a plain color. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FJ2yPrSqSFr8wI8lYLUSy%252Fimage.png%3Falt%3Dmedia%26token%3D0e61a1d8-b977-4d4f-b743-90326543103a&width=768&dpr=3&quality=100&sign=95ec9c31&sv=2) #### [](https://documentation.botghost.com/community-engagement/leveling#advanced-card-settings) \[👑\] Advanced Card Settings Enabling the Advanced Settings for the level card above will display a wide range of new advanced customization option for the level card. By default it is set to disabled. This is not compatible with the Embed Card option. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FFaMstG681Sba9ZCQVcYo%252Fimage.png%3Falt%3Dmedia%26token%3Ded6f9ce9-be0e-4886-812a-b101e2ed0aa3&width=768&dpr=3&quality=100&sign=e6ab6e38&sv=2) #### [](https://documentation.botghost.com/community-engagement/leveling#circle-color-1) \[👑\] Circle Color Here you can change the user icon outline color for the level card using Hexadecimal (HEX). #### [](https://documentation.botghost.com/community-engagement/leveling#empty-bar-color-1) \[👑\] Empty Bar Color Here you can change the Fill Bar/Progress bar background for the level card using Hexadecimal (HEX). #### [](https://documentation.botghost.com/community-engagement/leveling#filled-bar-color-1) \[👑\] Filled Bar Color Here you can change the Fill Bar/Progress bar color when its full for the level card using Hexadecimal (HEX). #### [](https://documentation.botghost.com/community-engagement/leveling#level-text-color-1) \[👑\] Level Text Color Here you can change the level text color for the level card using Hexadecimal (HEX). #### [](https://documentation.botghost.com/community-engagement/leveling#experience-progress-color-1) \[👑\] Experience Progress Color Here you can change the experience progress text color for the level card using Hexadecimal (HEX). #### [](https://documentation.botghost.com/community-engagement/leveling#experience-percentage-color-1) \[👑\] Experience Percentage Color Here you can change the experience percentage text color for the level card using Hexadecimal (HEX). #### [](https://documentation.botghost.com/community-engagement/leveling#main-color-1) \[👑\] Main Color Here you can change the color of the text for the level card using Hexadecimal (HEX). #### [](https://documentation.botghost.com/community-engagement/leveling#filled-bar-color-2) \[👑\] Filled Bar Color Here you can change the color of the filled (left) half of the progress bar on the card using Hexadecimal (HEX). ### [](https://documentation.botghost.com/community-engagement/leveling#example-card-2) Example Card ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FeNuco2gEITPcYH6sUh0b%252Flyst7bkrpjeclvbx02.webp%3Falt%3Dmedia%26token%3D16807b75-dacd-4aa2-8734-8ff9b5ca9e8c&width=768&dpr=3&quality=100&sign=7a929c93&sv=2) If this dropdown type is selected then you can choose to enable and use [\[👑\] Advanced Card Settings](https://documentation.botghost.com/community-engagement/leveling#advanced-card-settings) as well as [\[👑\] Main Color](https://documentation.botghost.com/community-engagement/leveling#main-color) and [\[👑\] Filled Bar Color](https://documentation.botghost.com/community-engagement/leveling#filled-bar-color) . #### [](https://documentation.botghost.com/community-engagement/leveling#background-image) \[👑\] Background Image Choose the image you would like to use as the background and input it in the form of a URL. A default link is provided. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FsiAwnrw5BCCIp5asdjGs%252Fimage.png%3Falt%3Dmedia%26token%3D16646e30-bf74-4996-87de-582e718f57a9&width=768&dpr=3&quality=100&sign=9474a813&sv=2) #### [](https://documentation.botghost.com/community-engagement/leveling#advanced-card-settings-1) \[👑\] Advanced Card Settings Enabling the Advanced Settings for the level card above will display a wide range of new advanced customization option for the level card. By default it is set to disabled. This is not compatible with the Embed Card option. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FFaMstG681Sba9ZCQVcYo%252Fimage.png%3Falt%3Dmedia%26token%3Ded6f9ce9-be0e-4886-812a-b101e2ed0aa3&width=768&dpr=3&quality=100&sign=e6ab6e38&sv=2) #### [](https://documentation.botghost.com/community-engagement/leveling#circle-color-2) \[👑\] Circle Color Here you can change the user icon outline color for the level card using Hexadecimal (HEX). #### [](https://documentation.botghost.com/community-engagement/leveling#empty-bar-color-2) \[👑\] Empty Bar Color Here you can change the Fill Bar/Progress bar background for the level card using Hexadecimal (HEX). #### [](https://documentation.botghost.com/community-engagement/leveling#filled-bar-color-3) \[👑\] Filled Bar Color Here you can change the Fill Bar/Progress bar color when its full for the level card using Hexadecimal (HEX). #### [](https://documentation.botghost.com/community-engagement/leveling#level-text-color-2) \[👑\] Level Text Color Here you can change the level text color for the level card using Hexadecimal (HEX). #### [](https://documentation.botghost.com/community-engagement/leveling#experience-progress-color-2) \[👑\] Experience Progress Color Here you can change the experience progress text color for the level card using Hexadecimal (HEX). #### [](https://documentation.botghost.com/community-engagement/leveling#experience-percentage-color-2) \[👑\] Experience Percentage Color Here you can change the experience percentage text color for the level card using Hexadecimal (HEX). #### [](https://documentation.botghost.com/community-engagement/leveling#main-color-2) \[👑\] Main Color Here you can change the color of the text for the level card using Hexadecimal (HEX). #### [](https://documentation.botghost.com/community-engagement/leveling#filled-bar-color-4) \[👑\] Filled Bar Color Here you can change the color of the filled (left) half of the progress bar on the card using Hexadecimal (HEX). ### [](https://documentation.botghost.com/community-engagement/leveling#example-card-3) Example Card ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FvxMSVpYeHMCmTLLzD98l%252Flystr7imdd0wm8ydfoa.webp%3Falt%3Dmedia%26token%3D8487f0dc-3302-4855-b74a-f044a33fccd7&width=768&dpr=3&quality=100&sign=b7b2db37&sv=2) ### [](https://documentation.botghost.com/community-engagement/leveling#message-xp-settings) Message XP Settings View the settings for message function of the Leveling module and what they do. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FXL7gMKBVAREdZlM9Nacc%252Fimage.png%3Falt%3Dmedia%26token%3D86233ded-e760-4aef-b88e-876559cbec72&width=768&dpr=3&quality=100&sign=3a1841a2&sv=2) #### [](https://documentation.botghost.com/community-engagement/leveling#minimum-xp-per-message) Minimum XP per Message Here you can set the minimum number of XP points that will be given per message in numerical format (1, 2, 3, 4, etc). #### [](https://documentation.botghost.com/community-engagement/leveling#maximum-xp-per-message) Maximum XP per Message Here you can set the maximum number of XP points that will be given per message in numerical format (1, 2, 3, 4, etc). #### [](https://documentation.botghost.com/community-engagement/leveling#cooldown) Cooldown Here you can define the cooldown period between messages receiving and not receiving XP points, messages sent during the specified cooldown period will not grant the user any experience points. This option takes a numerical format (1, 2, 3, 4, etc). Setting this to 0 will disable the cooldown completely. ### [](https://documentation.botghost.com/community-engagement/leveling#voice-xp-settings) Voice XP Settings Features in this section are limited to [Premium](https://documentation.botghost.com/premium/premium-and-priority-hosting-plans#premium-plans) users. The leveling module also comes with a voice channel XP function which allows users to accumulate XP points by partaking in a voice channel. By joining a voice channel, the bot will follow a precise formula, which is: `A * ( 1 - e ^ ( - B * secs in voice ) )`. This will give a different amount of XP basing on the time in seconds the user has remained in the voice channel. However, the amount of XP given per second will slowly decrease, to prevent spam / AFK users (example if the user stays for a second he will get 1 point, 2 secs 2.9 points, 3 secs 3.7 and so on). It will be calculated once the user leaves the voice. A and B are parameters and can be edited using the 'Voice XP Settings'. A is the max XP that can be gained in a session, and B the "speed" that value A will be reached. However, the recommended values are 1000 and 0,0005. The user does not need to talk to gain XP. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FKVWdhHV1GR5YPMHbKUAQ%252Fimage.png%3Falt%3Dmedia%26token%3D7ebca788-94ad-43f5-828a-40f548d5c7bb&width=768&dpr=3&quality=100&sign=37fe634a&sv=2) #### [](https://documentation.botghost.com/community-engagement/leveling#enable-voice-xp) \[👑\] Enable Voice XP Enabling/Disabling this option will activate/deactivate the ability to use the voice XP function, respectively. The below settings will only be displayed when it is enabled and hidden when disabled. By default this option is disabled. #### [](https://documentation.botghost.com/community-engagement/leveling#minimum-time-in-voice) \[👑\] Minimum Time in Voice This setting allows you to configure the minimum time in seconds required to stay in the voice channel to gain at least 1 experience point. This is defined by seconds and takes a a numerical format (1, 2, 3, 4, etc). #### [](https://documentation.botghost.com/community-engagement/leveling#xp-per-session-a) \[👑\] XP per Session _(A)_ This option will allow you to define the maximum amount of XP an user can gain by staying in a voice channel without leaving. The recommended value for this setting is 1000. Do not change this value if you don't know what you're doing, otherwise the XP may be given incorrectly. #### [](https://documentation.botghost.com/community-engagement/leveling#xp-gain-speed-b) \[👑\] XP Gain Speed _(B)_ This option will allow you to define the bot will give users XP by staying in a voice channels. The recommended value for this setting is 0,0005. Do not change this value if you don't know what you're doing, otherwise the XP may be given incorrectly. #### [](https://documentation.botghost.com/community-engagement/leveling#cooldown-1) \[👑\] Cooldown Here you can define the cooldown period between receiving and not receiving XP points, during the specified cooldown period XP points will not be granted to the user. This option takes a numerical format (1, 2, 3, 4, etc). Setting this to 0 will disable the cooldown completely. ### [](https://documentation.botghost.com/community-engagement/leveling#channels-and-roles) Channels & Roles Find out about the Channel & Role settings for the Leveling module. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FoyYPdSDGdX3HJGYNDIHQ%252Fimage.png%3Falt%3Dmedia%26token%3D4021d1a7-cf49-4371-8442-796519904cde&width=768&dpr=3&quality=100&sign=e0f02a0a&sv=2) #### [](https://documentation.botghost.com/community-engagement/leveling#admin-role) Admin Role Here you can select the role which will be considered admins. users with these roles will be able to edit other users' XP. #### [](https://documentation.botghost.com/community-engagement/leveling#channel-restrictions) Channel Restrictions Here you can set some channel restrictions choosing between None, Disable on all channels except or enable on all channels except. When enabled a new channel selection box will be displayed allowing you to input channels. Type Details No Channel Restrictions If this option is selected, no channel restrictions will be applied. Disable for these channels Based on the channels input, they will not provide XP for users. Enable these channels Based on the channels input, only these channels grant XP, the rest won't. #### [](https://documentation.botghost.com/community-engagement/leveling#role-restrictions) Role Restrictions Here you can set some role restrictions choosing between None, Disable on all roles except or enable on all roles except. When enabled a new role selection box will be displayed allowing you to input roles. Type Details No role restrictions If this option is selected, no role restrictions will be applied. Disable for these roles Based on the roles input, users who have these roles won't gain XP. Enable these roles Based on the roles input, only users with these roles gain XP, the rest won't. ### [](https://documentation.botghost.com/community-engagement/leveling#role-rewards) Role Rewards Find out information about the Role Rewards settings for the leveling module and how each function works. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fdn4l0qVeMjMmaQCx5cQh%252Fimage.png%3Falt%3Dmedia%26token%3D93b3c74d-95c5-4371-b039-06936cf1b48d&width=768&dpr=3&quality=100&sign=2d83d666&sv=2) #### [](https://documentation.botghost.com/community-engagement/leveling#stack-rewards) Stack Rewards This option will allow you to enable/disable reward stacking, when enabled the role rewards will stack. #### [](https://documentation.botghost.com/community-engagement/leveling#level) Level Input the level that this role reward shall be given at. #### [](https://documentation.botghost.com/community-engagement/leveling#role-reward) Role Reward In this field you can select the role you would like to give. To save the role reward's settings, you need to click "Add" in the bottom-right corner of the settings. This will reset the fields so you can set up another role reward. ### [](https://documentation.botghost.com/community-engagement/leveling#your-role-rewards) Your Role Rewards Here you can manage your currently active role rewards. The same settings as [Role Rewards](https://documentation.botghost.com/community-engagement/leveling#role-rewards) apply. You are able to edit / delete these rewards in the bottom right. A maximum of 100 role rewards is present. To save the edits you made on the role reward's settings, you need to click "Edit" in the bottom-right corner of the settings. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FE3KQtIWF2myW7FevJxGP%252Fimage.png%3Falt%3Dmedia%26token%3D4640af0f-4c26-4383-819e-f0ae7be37b89&width=768&dpr=3&quality=100&sign=1629e5b3&sv=2) ### [](https://documentation.botghost.com/community-engagement/leveling#xp-boosters) XP Boosters Find out information about the XP Boost settings for the leveling module and how each function works. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FS9lxlhd69BiMHUPOwS1f%252Fimage_2024-07-17_182240998.png%3Falt%3Dmedia%26token%3Dfd2d2e88-a34d-48f3-bd4a-9f764c85fc4c&width=768&dpr=3&quality=100&sign=b387679e&sv=2) #### [](https://documentation.botghost.com/community-engagement/leveling#sum-xp-boosts) Sum XP Boosts Enabling this option will sum the XP boosts, where as disabling will disable it. This is set to disabled by default but can be toggled on and off as desired. #### [](https://documentation.botghost.com/community-engagement/leveling#randomize-boosts) Randomize Boosts Enabling this option will make it so instead of giving the set amount of xp boost to the user, the amount of experience received from the boost will go around 1% and the boost percentage assigned to the user. #### [](https://documentation.botghost.com/community-engagement/leveling#boost-percentage) Boost Percentage This field modifies the percentage of XP that the user will receive when boosted. #### [](https://documentation.botghost.com/community-engagement/leveling#boost-type) Boost Type Channel Boost Role Boost This type of boost will make an increase in XP in a certain channel. #### [](https://documentation.botghost.com/community-engagement/leveling#boosted-channel) Boosted Channel In this selection you can choose the channel in which you want the boost to occur in. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FSiFOSfbSUf0LHigK7Aye%252Fimage.png%3Falt%3Dmedia%26token%3D930140a5-03b9-41a5-ae94-1c468bb4f4d9&width=768&dpr=3&quality=100&sign=cd37a5e&sv=2) #### [](https://documentation.botghost.com/community-engagement/leveling#enable-in-threads) Enable in Threads If this toggle is enabled then the boost will also apply to the threads in the channel that the boost is occurring in. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FdEIE5G7OIL8YorjGPKGc%252Fimage.png%3Falt%3Dmedia%26token%3Dc8cf4ab4-8e94-40f7-a365-a58b9fb11d9a&width=768&dpr=3&quality=100&sign=44bcd66f&sv=2) This type of boost will affect users with a certain role. #### [](https://documentation.botghost.com/community-engagement/leveling#boosted-role) Boosted Role In this selection you can choose the role that the boost is affecting. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FDCJQ42r8AToKLaA7CkH9%252Fimage.png%3Falt%3Dmedia%26token%3Db70ba8fa-556c-47ce-97aa-9b81d62ea27b&width=768&dpr=3&quality=100&sign=b199aed4&sv=2) To save the boost's settings, you need to click "Add" in the bottom-right corner of the settings. This will reset the fields so you can set up another boost. ### [](https://documentation.botghost.com/community-engagement/leveling#your-boosts) Your Boosts In this section is where the added boosts can be edited / deleted. There is a maximum of 100 boosts. To save the edits you made on the boost's settings, you need to click "Edit" in the bottom-right corner of the settings. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FUzcPqSrBltICEXdG726O%252Fimage.png%3Falt%3Dmedia%26token%3D609b54b1-781e-480a-8fdb-8bd83e1afde2&width=768&dpr=3&quality=100&sign=6d423851&sv=2) * * * [](https://documentation.botghost.com/community-engagement/leveling#variables) Variables --------------------------------------------------------------------------------------------- The leveling module collects leveling data and sorts out levels for each user and their XP. These variables below can be used to reference that data in this module. These Variables can only be used in this module. Variable Details `{level}` Displays the user's current level `{xp}` Displays the user's experience `{required_xp}` Displays the required experience to reach the next level `{rank}` Displays the rank of the user * * * [](https://documentation.botghost.com/community-engagement/leveling#commands) Commands ------------------------------------------------------------------------------------------- The leveling module has a wide range of commands, you can find these below. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F97pBsSmDQ1EVe0aGiBBS%252Fimage.png%3Falt%3Dmedia%26token%3Dbe9ed0a8-fae6-4d55-a904-107510556f31&width=768&dpr=3&quality=100&sign=9dd6141e&sv=2) /rank[](https://documentation.botghost.com/community-engagement/leveling#rank) This command will allow users to display their current XP progress as well as others. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FbZv2mA1hAb0xxWI2B6JU%252Fimage.png%3Falt%3Dmedia%26token%3D835b1f82-c255-4f79-b679-0a09302e29eb&width=300&dpr=3&quality=100&sign=9d33ec12&sv=2) /level leaderboard[](https://documentation.botghost.com/community-engagement/leveling#level-leaderboard) This command will display the server's level leaderboard when triggered. Use the buttons below to navigate through the leaderboard. The button in the middle allows you to go to a specific position in the leaderboard. Change the value of the users-per-page option to show a different amount of users per page (defaults to 10). ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FkKAgGnJBbHeeinor9VyO%252Fimage.png%3Falt%3Dmedia%26token%3D5e0e2554-edb4-467c-b89f-c4526fe1c769&width=300&dpr=3&quality=100&sign=a4c9692f&sv=2) /level edit-xp[](https://documentation.botghost.com/community-engagement/leveling#level-edit-xp) This is one of the admin commands for the module, users with the defined admin roles will be able to use this command to edit a user's XP points. You can add / set / remove a custom amount of levels / XP. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252Fc2jpi2d4vF9M3oL2aXdq%252Fimage.png%3Falt%3Dmedia%26token%3Df4df63dc-8992-4cb4-8a75-cb78ffbf57b4&width=300&dpr=3&quality=100&sign=e0317a3b&sv=2) /level reset-leaderboard[](https://documentation.botghost.com/community-engagement/leveling#level-reset-leaderboard) This is one of the admin commands for the module, users with the defined admin roles will be able to use this command to reset the servers level leaderboard. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252FNX3iTDbaRyZTC2cMO7mY%252Fimage.png%3Falt%3Dmedia%26token%3D4dc3260c-e0c0-4429-b5e8-732e65413477&width=300&dpr=3&quality=100&sign=c50ab23c&sv=2) [](https://documentation.botghost.com/community-engagement/leveling#events) Events --------------------------------------------------------------------------------------- The leveling module has a wide range of events, you can find these below. ![](https://documentation.botghost.com/~gitbook/image?url=https%3A%2F%2F1937909199-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-Lm_hW5MApY3J0lRhi0M%252Fuploads%252F0FZsGSzw0lEB44RGIH19%252Fimage.png%3Falt%3Dmedia%26token%3Df97a169b-b734-4eff-b531-9fd36160d27c&width=768&dpr=3&quality=100&sign=cc2623de&sv=2) Level Up[](https://documentation.botghost.com/community-engagement/leveling#level-up) This event will track when a user levels up and send the level up message to the appropriate destination. Message Experience[](https://documentation.botghost.com/community-engagement/leveling#message-experience) This event will track user messages and add XP points to a users total for each message, following the defined settings in the module. Voice Experience - Join[](https://documentation.botghost.com/community-engagement/leveling#voice-experience-join) This event will track when a user joins a voice channel and start giving them XP points if you have the [Voice XP Settings](https://documentation.botghost.com/community-engagement/leveling#voice-xp-settings) function enabled. Voice Experience - Leave[](https://documentation.botghost.com/community-engagement/leveling#voice-experience-leave) This event will track when a user leaves a voice channel and stop giving the user XP points, the voice events will only work if you have enabled the [Voice XP Settings](https://documentation.botghost.com/community-engagement/leveling#voice-xp-settings) function above. Clear on Leave[](https://documentation.botghost.com/community-engagement/leveling#clear-on-leave) If you have the clear on Leave option enabled, this event will trigger when a user leaves the server and clear their Leveling data, this includes XP, Levels, etc. * * * It's advised that you do not edit the commands and events unless you have a good understanding of BotGhost and its Command Builder. If you encounter any issues, you might want to reset the module for it to work again as intented. Additionally, a copy of the edited commands / events will be created if you update the module. Last updated 6 months ago Was this helpful? * [Watch the Tutorial](https://documentation.botghost.com/community-engagement/leveling#watch-the-tutorial) * [Settings](https://documentation.botghost.com/community-engagement/leveling#settings) * [General Settings](https://documentation.botghost.com/community-engagement/leveling#general-settings) * [Level Card Settings](https://documentation.botghost.com/community-engagement/leveling#level-card-settings) * [Message XP Settings](https://documentation.botghost.com/community-engagement/leveling#message-xp-settings) * [Voice XP Settings](https://documentation.botghost.com/community-engagement/leveling#voice-xp-settings) * [Channels & Roles](https://documentation.botghost.com/community-engagement/leveling#channels-and-roles) * [Role Rewards](https://documentation.botghost.com/community-engagement/leveling#role-rewards) * [Your Role Rewards](https://documentation.botghost.com/community-engagement/leveling#your-role-rewards) * [XP Boosters](https://documentation.botghost.com/community-engagement/leveling#xp-boosters) * [Your Boosts](https://documentation.botghost.com/community-engagement/leveling#your-boosts) * [Variables](https://documentation.botghost.com/community-engagement/leveling#variables) * [Commands](https://documentation.botghost.com/community-engagement/leveling#commands) * [Events](https://documentation.botghost.com/community-engagement/leveling#events) Was this helpful? ---