diff --git a/external/CHANGELOG.json b/external/CHANGELOG.json index bfcacdf17be..b1e1dddeefc 100644 --- a/external/CHANGELOG.json +++ b/external/CHANGELOG.json @@ -25,6 +25,37 @@ ] }, "2025": { + "december": [ + "Added \"Sign out other sessions\" button", + "Smoother animations in the app", + "Redesigned Premium Points shop", + "A lot of app bug fixes", + "HTTP Timeout Limit: 5s > 35s", + "Fixed `$ceil[]`", + "Fixed `$floor[]`", + "Fixed `$getLeaderboardPosition[]`", + "AI Quota: 5000 > 10000", + "Log Quota: 1500 > 3000", + "Updated BDFD App icon for Android" + ], + "november": [ + "Major improvements to hosting infrastructure", + "Reworked bot status preview", + "HTTP Timeout Limit: 15s > 5s" + ], + "october": [ + "Added setting to disable code highlighting in the command editor" + ], + "september": [ + "Updated BDFD App icon for iOS 26", + "Reworked bot list" + ], + "july": [ + "BDScript bug fixes" + ], + "february": [ + "Fixed app crashing during premium points purchases" + ], "january": [ "Added `$afkChannelID`", "Added `$afkTimeout[]`", diff --git a/external/entityTransferPolicy.txt b/external/entityTransferPolicy.txt new file mode 100644 index 00000000000..b2be4af11fb --- /dev/null +++ b/external/entityTransferPolicy.txt @@ -0,0 +1,41 @@ +CONTEXT + +-  Bot Designer for Discord is a service provided by NilPointer Software. +-  "Our service" refers to "Bot Designer for Discord". +-  "Bot" refers to data held by BDFD describing the behaviour of a Discord Bot¹ on our service. +-  "Hosting time" refers to the time duration left of a singular bot during which it will be hosted by our service. +-  "Premium point" refers to BDFD premium in-app currency, granting users the ability for bots to have extended functionality for a limited time. +-  "Premium time" refers to the time duration left for a singular bot during which it can access the extended functionality. + Premium time is related, but not strictly linked, with hosting time. Premium time might end before hosting time, but not vice-versa. +-  "Promocode" or "promo code" refers to a randomly generated string of characters used to gain hosting or premium time. +-  "BDFD entity" or "entity" refers to any piece of data that is being held by BDFD, that ownership of it or itself can be transferred. + In this policy, "entity" mainly refers to bots, hosting and premium time, and premium points. +-  "Transfer request" refers to a request made by a user to BDFD developers for an entity transfer. + These requests can be made through a ticket on our official Discord server². + + +POLICY + +-  Entities that can be transferred can only be transferred through a transfer request by the user that holds ownership of that entity. +-  Requesting users must provide proof of ownership of the entities in question for the request to be granted. +-  BDFD Accounts can not be transferred in any way. + +-  Bots can only be transferred between BDFD accounts owned by a single user. +-  Bot after its transfer retains any hosting or premium time the bot in question had left. +-  A bot previously not assigned to any BDFD account can be transferred to an account of the user that holds ownership over the bot in question. + +-  Premium points can be transferred between BDFD accounts owned by a single user. +-  Premium points can be donated for a giveaway promotion on our official Discord server². + +-  Hosting and Premium time can only be transferred between bots owned by a single user. +-  Hosting and Premium time can not be transferred to a promocode. +-  Only premium time can be donated for a giveaway promotion on our official Discord server². + + +LINKS + +¹ https://discord.com/developers/docs +² https://discord.gg/botdesigner + + +Effective Date: 28 January, 2026. diff --git a/src/CHANGELOG.md b/src/CHANGELOG.md index 2a3adca2fd0..6725f8c4e0b 100644 --- a/src/CHANGELOG.md +++ b/src/CHANGELOG.md @@ -16,7 +16,6 @@ Added Components V2 functions: - Added `$addSection[]` - Added `$addThumbnail[]` - Added `$addMediaGallery[]` -- Added `$addMediaGallery[]` - Added `$addMediaGalleryItem[]` - Added `$addActionRow[]` - Added `$addButtonCV2[]` diff --git a/src/FLOWCHART_CHANGELOG.md b/src/FLOWCHART_CHANGELOG.md index 4b974dce4cc..5ccd56b9b81 100644 --- a/src/FLOWCHART_CHANGELOG.md +++ b/src/FLOWCHART_CHANGELOG.md @@ -1,7 +1,5 @@ # Flowchart Changelog - -

2024

diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 0aee19c9171..cacfcbe2170 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -4,7 +4,7 @@ [Settings](./settings.md) [Changelog](./CHANGELOG.md) [Flowchart Changelog](./FLOWCHART_CHANGELOG.md) -[Entity Transfer Policy](./entityTransferPolicy.md) +[Terms & Privacy](./termsAndPrivacy.md) --- @@ -58,15 +58,17 @@ - [Functions]() - [Introduction](./bdscript/introduction.md) - - [Components]() + - [Component]() - [$addButton](./bdscript/addButton.md) - [$addSelectMenuOption](./bdscript/addSelectMenuOption.md) - [$addSeparator](./bdscript/addSeparator.md) - [$addTextDisplay](./bdscript/addTextDisplay.md) - [$addTextInput](./bdscript/addTextInput.md) + - [$defer](./bdscript/defer.md) - [$editButton](./bdscript/editButton.md) - [$editSelectMenu](./bdscript/editSelectMenu.md) - [$editSelectMenuOption](./bdscript/editSelectMenuOption.md) + - [$input](./bdscript/input.md) - [$newModal](./bdscript/newModal.md) - [$newSelectMenu](./bdscript/newSelectMenu.md) - [$removeAllComponents](./bdscript/removeAllComponents.md) @@ -74,11 +76,11 @@ - [$removeButtons](./bdscript/removeButtons.md) - [$removeButtons[]](./bdscript/removeButtonsComplex.md) - [$removeComponent](./bdscript/removeComponent.md) - - [$defer](./bdscript/defer.md) - - [$input](./bdscript/input.md) - - [Embeds]() + - [Embed]() - [$addContainer](./bdscript/addContainer.md) - [$addField](./bdscript/addField.md) + - [$addMediaGallery](./bdscript/addMediaGallery.md) + - [$addMediaGalleryItem](./bdscript/addMediaGalleryItem.md) - [$addSection](./bdscript/addSection.md) - [$addThumbnail](./bdscript/addThumbnail.md) - [$addTimestamp](./bdscript/addTimestamp.md) @@ -102,8 +104,9 @@ - [$discriminator](./bdscript/discriminator.md) - [$displayName](./bdscript/displayName.md) - [$displayName[]](./bdscript/displayNameComplex.md) - - [$getUserStatus](./bdscript/getUserStatus.md) - [$getCustomStatus](./bdscript/getCustomStatus.md) + - [$getUserStatus](./bdscript/getUserStatus.md) + - [$hypesquad](./bdscript/hypesquad.md) - [$isAdmin](./bdscript/isAdmin.md) - [$isBooster](./bdscript/isBooster.md) - [$isBot](./bdscript/isBot.md) @@ -123,14 +126,14 @@ - [$username[]](./bdscript/usernameComplex.md) - [$userPerms](./bdscript/userPerms.md) - [$userServerAvatar](./bdscript/userServerAvatar.md) - - [$changeUsername](./bdscript/changeUsername.md) - - [$changeUsernameWithID](./bdscript/changeUsernameWithID.md) - [$findUser](./bdscript/findUser.md) - [Moderation]() - [$ban](./bdscript/ban.md) - [$ban[]](./bdscript/banComplex.md) - [$banID](./bdscript/banID.md) - [$banID[]](./bdscript/banIDComplex.md) + - [$changeUsername](./bdscript/changeUsername.md) + - [$changeUsernameWithID](./bdscript/changeUsernameWithID.md) - [$clear](./bdscript/clear.md) - [$clear[]](./bdscript/clearComplex.md) - [$getBanReason](./bdscript/getBanReason.md) @@ -146,7 +149,7 @@ - [$unbanID[]](./bdscript/unbanIDComplex.md) - [$unmute](./bdscript/unmute.md) - [$untimeout](./bdscript/untimeout.md) - - [Channels]() + - [Channel]() - [$afkChannelID](./bdscript/afkChannelID.md) - [$categoryChannels](./bdscript/categoryChannels.md) - [$categoryCount](./bdscript/categoryCount.md) @@ -164,6 +167,7 @@ - [$channelTopic](./bdscript/channelTopic.md) - [$channelTopic[]](./bdscript/channelTopicComplex.md) - [$channelType](./bdscript/channelType.md) + - [$closeTicket](./bdscript/closeTicket.md) - [$createChannel](./bdscript/createChannel.md) - [$deleteChannels](./bdscript/deleteChannels.md) - [$deleteChannelsByName](./bdscript/deleteChannelsByName.md) @@ -172,13 +176,12 @@ - [$findChannel](./bdscript/findChannel.md) - [$getSlowmode](./bdscript/getSlowmode.md) - [$isNSFW](./bdscript/isNSFW.md) - - [$closeTicket](./bdscript/closeTicket.md) - [$isTicket](./bdscript/isTicket.md) - - [$newTicket](./bdscript/newTicket.md) - [$lastMessageID](./bdscript/lastMessageID.md) - [$lastPinTimestamp](./bdscript/lastPinTimestamp.md) - [$modifyChannel](./bdscript/modifyChannel.md) - [$modifyChannelPerms](./bdscript/modifyChannelPerms.md) + - [$newTicket](./bdscript/newTicket.md) - [$parentID](./bdscript/parentID.md) - [$parentID[]](./bdscript/parentIDComplex.md) - [$rulesChannelID](./bdscript/rulesChannelID.md) @@ -186,7 +189,7 @@ - [$slowmode](./bdscript/slowmode.md) - [$systemChannelID](./bdscript/systemChannelID.md) - [$voiceUserLimit](./bdscript/voiceUserLimit.md) - - [Roles]() + - [Role]() - [$allowRoleMentions](./bdscript/allowRoleMentions.md) - [$colorRole](./bdscript/colorRole.md) - [$createRole](./bdscript/createRole.md) @@ -220,7 +223,6 @@ - [$userRoles](./bdscript/userRoles.md) - [Bot]() - [$allMembersCount](./bdscript/allMembersCount.md) - - [$awaitFunc](./bdscript/awaitFunc.md) - [$botCommands](./bdscript/botCommands.md) - [$botID](./bdscript/botID.md) - [$botLeave](./bdscript/botLeave.md) @@ -230,46 +232,52 @@ - [$botNode](./bdscript/botNode.md) - [$botOwnerID](./bdscript/botOwnerID.md) - [$botTyping](./bdscript/botTyping.md) + - [$getBotInvite](./bdscript/getBotInvite.md) + - [$hostingExpireTime](./bdscript/hostingExpireTime.md) + - [$hostingExpireTime[]](./bdscript/hostingExpireTimeComplex.md) + - [$nodeVersion](./bdscript/nodeVersion.md) + - [$nodeVersion[]](./bdscript/nodeVersionComplex.md) + - [$ping](./bdscript/ping.md) + - [$premiumExpireTime](./bdscript/premiumExpireTime.md) + - [$serverCount](./bdscript/serverCount.md) + - [$serverNames](./bdscript/serverNames.md) + - [$serverNames[]](./bdscript/serverNamesComplex.md) + - [$shardID](./bdscript/shardID.md) + - [$shardID[]](./bdscript/shardIDComplex.md) + - [$slashCommandsCount](./bdscript/slashCommandsCount.md) + - [$uptime](./bdscript/uptime.md) + - [Command]() + - [$alternativeParsing](./bdscript/alternativeParsing.md) + - [$awaitFunc](./bdscript/awaitFunc.md) + - [$c](./bdscript/c.md) - [$commandFolder](./bdscript/commandFolder.md) - [$commandName](./bdscript/commandName.md) - [$commandTrigger](./bdscript/commandTrigger.md) - [$commandsCount](./bdscript/commandsCount.md) - [$customID](./bdscript/customID.md) - - [$deletecommand](./bdscript/deletecommand.md) - - [$enabled](./bdscript/enabled.md) - - [$getBotInvite](./bdscript/getBotInvite.md) - - [$nodeVersion](./bdscript/nodeVersion.md) - - [$nodeVersion[]](./bdscript/nodeVersionComplex.md) - - [$ping](./bdscript/ping.md) + - [$eval](./bdscript/eval.md) + - [$executionTime](./bdscript/executionTime.md) + - [$isSlash](./bdscript/isSlash.md) + - [$nomention](./bdscript/nomention.md) - [$registerGuildCommands](./bdscript/registerGuildCommands.md) - [$registerGuildCommands[]](./bdscript/registerGuildCommandsComplex.md) - [$scriptLanguage](./bdscript/scriptLanguage.md) - - [$shardID](./bdscript/shardID.md) - - [$shardID[]](./bdscript/shardIDComplex.md) - - [$slashCommandsCount](./bdscript/slashCommandsCount.md) - [$slashID](./bdscript/slashID.md) - [$slashID[]](./bdscript/slashIDComplex.md) - - [$serverCount](./bdscript/serverCount.md) - - [$serverNames](./bdscript/serverNames.md) - - [$serverNames[]](./bdscript/serverNamesComplex.md) - - [$executionTime](./bdscript/executionTime.md) - [$unregisterGuildCommands](./bdscript/unregisterGuildCommands.md) - [$unregisterGuildCommands[]](./bdscript/unregisterGuildCommandsComplex.md) - - [$uptime](./bdscript/uptime.md) - - [$eval](./bdscript/eval.md) - [Server]() - [$afkTimeout](./bdscript/afkTimeout.md) - [$boostCount](./bdscript/boostCount.md) - [$boostCount[]](./bdscript/boostCountComplex.md) - [$boostLevel](./bdscript/boostLevel.md) + - [$getInviteInfo](./bdscript/getInviteInfo.md) - [$getServerInvite](./bdscript/getServerInvite.md) - [$getServerInvite[]](./bdscript/getServerInviteComplex.md) - - [$getInviteInfo](./bdscript/getInviteInfo.md) - [$guildBanner](./bdscript/guildBanner.md) - [$guildExists](./bdscript/guildExists.md) - [$guildID](./bdscript/guildID.md) - [$guildID[]](./bdscript/guildIDComplex.md) - - [$hypesquad](./bdscript/hypesquad.md) - [$membersCount](./bdscript/membersCount.md) - [$membersCount[]](./bdscript/membersCountComplex.md) - [$serverDescription](./bdscript/serverDescription.md) @@ -290,11 +298,9 @@ - [$blackListServers](./bdscript/blackListServers.md) - [$blackListUsers](./bdscript/blackListUsers.md) - [Arguments & Conditions]() - - [$argCount](./bdscript/argCount.md) - - [$argsCheck](./bdscript/argsCheck.md) - [$and](./bdscript/and.md) + - [$argsCheck](./bdscript/argsCheck.md) - [$checkCondition](./bdscript/checkCondition.md) - - [$checkContains](./bdscript/checkContains.md) - [$else](./bdscript/else.md) - [$elseif](./bdscript/elseif.md) - [$endif](./bdscript/endif.md) @@ -302,13 +308,11 @@ - [$isBoolean](./bdscript/isBoolean.md) - [$isInteger](./bdscript/isInteger.md) - [$isNumber](./bdscript/isNumber.md) - - [$isSlash](./bdscript/isSlash.md) - [$isValidHex](./bdscript/isValidHex.md) - [$or](./bdscript/or.md) - [Text]() - - [$alternativeParsing](./bdscript/alternativeParsing.md) + - [$argCount](./bdscript/argCount.md) - [$byteCount](./bdscript/byteCount.md) - - [$c](./bdscript/c.md) - [$charCount](./bdscript/charCount.md) - [$cropText](./bdscript/cropText.md) - [$disableInnerSpaceRemoval](./bdscript/disableInnerSpaceRemoval.md) @@ -317,10 +321,8 @@ - [$getTextSplitIndex](./bdscript/getTextSplitIndex.md) - [$getTextSplitLength](./bdscript/getTextSplitLength.md) - [$joinSplitText](./bdscript/joinSplitText.md) - - [$mentionedChannels](./bdscript/mentionedChannels.md) - [$linesCount](./bdscript/linesCount.md) - [$numberSeparator](./bdscript/numberSeparator.md) - - [$removeContains](./bdscript/removeContains.md) - [$removeSplitTextElement](./bdscript/removeSplitTextElement.md) - [$repeatMessage](./bdscript/repeatMessage.md) - [$replaceText](./bdscript/replaceText.md) @@ -336,6 +338,7 @@ - [$calculate](./bdscript/calculate.md) - [$ceil](./bdscript/ceil.md) - [$divide](./bdscript/divide.md) + - [$enableDecimals](./bdscript/enableDecimals.md) - [$floor](./bdscript/floor.md) - [$max](./bdscript/max.md) - [$min](./bdscript/min.md) @@ -346,7 +349,6 @@ - [$sqrt](./bdscript/sqrt.md) - [$sub](./bdscript/sub.md) - [$sum](./bdscript/sum.md) - - [$enableDecimals](./bdscript/enableDecimals.md) - [Random]() - [$optOff](./bdscript/optOff.md) - [$random](./bdscript/random.md) @@ -366,16 +368,12 @@ - [$getTimestamp](./bdscript/getTimestamp.md) - [$getTimestamp[]](./bdscript/getTimestampComplex.md) - [$hour](./bdscript/hour.md) - - [$hostingExpireTime](./bdscript/hostingExpireTime.md) - - [$hostingExpireTime[]](./bdscript/hostingExpireTimeComplex.md) - - [$messageEditedTimestamp](./bdscript/messageEditedTimestamp.md) - [$minute](./bdscript/minute.md) - [$month](./bdscript/month.md) - - [$premiumExpireTime](./bdscript/premiumExpireTime.md) - [$second](./bdscript/second.md) - [$time](./bdscript/time.md) - [$year](./bdscript/year.md) - - [Cooldowns]() + - [Cooldown]() - [$changeCooldownTime](./bdscript/changeCooldownTime.md) - [$cooldown](./bdscript/cooldown.md) - [$getCooldown](./bdscript/getCooldown.md) @@ -387,42 +385,46 @@ - [$channelSendMessage](./bdscript/channelSendMessage.md) - [$deleteIn](./bdscript/deleteIn.md) - [$deleteMessage](./bdscript/deleteMessage.md) + - [$deletecommand](./bdscript/deletecommand.md) - [$dm](./bdscript/dm.md) - [$dm[]](./bdscript/dmComplex.md) - [$editEmbedIn](./bdscript/editEmbedIn.md) - [$editIn](./bdscript/editIn.md) - [$editMessage](./bdscript/editMessage.md) - [$ephemeral](./bdscript/ephemeral.md) - - [$isMentioned](./bdscript/isMentioned.md) - - [$mentioned](./bdscript/mentioned.md) - - [$nomention](./bdscript/nomention.md) - [$getAttachments](./bdscript/getAttachments.md) - [$getEmbedData](./bdscript/getEmbedData.md) - [$getMessage](./bdscript/getMessage.md) - - [$isMessageEdited](./bdscript/isMessageEdited.md) - [$ignoreLinks](./bdscript/ignoreLinks.md) + - [$isMentioned](./bdscript/isMentioned.md) + - [$isMessageEdited](./bdscript/isMessageEdited.md) + - [$mentioned](./bdscript/mentioned.md) + - [$mentionedChannels](./bdscript/mentionedChannels.md) - [$message](./bdscript/message.md) - [$message[]](./bdscript/messageComplex.md) + - [$messageEditedTimestamp](./bdscript/messageEditedTimestamp.md) - [$messageID](./bdscript/messageID.md) + - [$noMentionMessage](./bdscript/noMentionMessage.md) + - [$noMentionMessage[]](./bdscript/noMentionMessageComplex.md) - [$pinMessage](./bdscript/pinMessage.md) - [$pinMessage[]](./bdscript/pinMessageComplex.md) - [$publishMessage](./bdscript/publishMessage.md) + - [$removeContains](./bdscript/removeContains.md) + - [$removeLinks](./bdscript/removeLinks.md) + - [$removeLinks[]](./bdscript/removeLinksComplex.md) + - [$repliedMessageID](./bdscript/repliedMessageID.md) + - [$repliedMessageID[]](./bdscript/repliedMessageIDComplex.md) - [$reply](./bdscript/reply.md) - [$reply[]](./bdscript/replyComplex.md) - [$replyIn](./bdscript/replyIn.md) - - [$repliedMessageID](./bdscript/repliedMessageID.md) - - [$repliedMessageID[]](./bdscript/repliedMessageIDComplex.md) - - [$removeLinks](./bdscript/removeLinks.md) - - [$removeLinks[]](./bdscript/removeLinksComplex.md) - - [$noMentionMessage](./bdscript/noMentionMessage.md) - - [$noMentionMessage[]](./bdscript/noMentionMessageComplex.md) - [$sendEmbedMessage](./bdscript/sendEmbedMessage.md) - [$sendMessage](./bdscript/sendMessage.md) - - [$unpinMessage](./bdscript/unpinMessage.md) - - [$useChannel](./bdscript/useChannel.md) - [$tts](./bdscript/tts.md) + - [$unpinMessage](./bdscript/unpinMessage.md) - [$url](./bdscript/url.md) - - [Variables]() + - [$useChannel](./bdscript/useChannel.md) + - [Variable]() + - [$enabled](./bdscript/enabled.md) - [$getChannelVar](./bdscript/getChannelVar.md) - [$getLeaderboardPosition](./bdscript/getLeaderboardPosition.md) - [$getLeaderboardValue](./bdscript/getLeaderboardValue.md) @@ -430,7 +432,6 @@ - [$getUserVar](./bdscript/getUserVar.md) - [$getVar](./bdscript/getVar.md) - [$globalUserLeaderboard](./bdscript/globalUserLeaderboard.md) - - [$listVar](./bdscript/listVar.md) - [$resetChannelVar](./bdscript/resetChannelVar.md) - [$resetServerVar](./bdscript/resetServerVar.md) - [$resetUserVar](./bdscript/resetUserVar.md) @@ -453,21 +454,22 @@ - [$threadUserCount](./bdscript/threadUserCount.md) - [Emojis & Reactions]() - [$addCmdReactions](./bdscript/addCmdReactions.md) + - [$addEmoji](./bdscript/addEmoji.md) - [$addMessageReactions](./bdscript/addMessageReactions.md) - [$addReactions](./bdscript/addReactions.md) - [$clearReactions](./bdscript/clearReactions.md) - - [$getReactions](./bdscript/getReactions.md) - - [$userReacted](./bdscript/userReacted.md) - - [$addEmoji](./bdscript/addEmoji.md) - [$customEmoji](./bdscript/customEmoji.md) - [$emoteCount](./bdscript/emoteCount.md) - [$emojiExists](./bdscript/emojiExists.md) - [$emojiName](./bdscript/emojiName.md) + - [$getReactions](./bdscript/getReactions.md) - [$isEmojiAnimated](./bdscript/isEmojiAnimated.md) - [$removeEmoji](./bdscript/removeEmoji.md) + - [$userReacted](./bdscript/userReacted.md) - [Webhooks]() - [$webhookAvatarURL](./bdscript/webhookAvatarURL.md) - [$webhookColor](./bdscript/webhookColor.md) + - [$webhookContent](./bdscript/webhookContent.md) - [$webhookCreate](./bdscript/webhookCreate.md) - [$webhookDelete](./bdscript/webhookDelete.md) - [$webhookDescription](./bdscript/webhookDescription.md) @@ -475,16 +477,15 @@ - [$webhookSend](./bdscript/webhookSend.md) - [$webhookTitle](./bdscript/webhookTitle.md) - [$webhookUsername](./bdscript/webhookUsername.md) - - [$webhookContent](./bdscript/webhookContent.md) - [Error Handling]() - [$catch](./bdscript/catch.md) + - [$embedSuppressErrors](./bdscript/embedSuppressErrors.md) - [$endtry](./bdscript/endtry.md) - [$error](./bdscript/error.md) + - [$stop](./bdscript/stop.md) - [$suppressErrors](./bdscript/suppressErrors.md) - [$suppressErrors[]](./bdscript/suppressErrorsComplex.md) - [$try](./bdscript/try.md) - - [$stop](./bdscript/stop.md) - - [$embedSuppressErrors](./bdscript/embedSuppressErrors.md) - [Permissions]() - [$checkUserPerms](./bdscript/checkUserPerms.md) - [$ignoreChannels](./bdscript/ignoreChannels.md) @@ -529,10 +530,6 @@ - [$reaction](./premium/reaction.md) - [Functions]() - [$ai](./premium/ai.md) - - [$aiDecide](./premium/aiDecide.md) - - [$aiWithCtx](./premium/aiWithCtx.md) - - [$aiDecideWithCtx](./premium/aiDecideWithCtx.md) - - [$aiAgent](./premium/aiAgent.md) - [$aiQuota](./premium/aiQuota.md) - [$awaitReactions](./premium/awaitReactions.md) - [$customImage](./premium/customImage.md) diff --git a/src/bdscript/addContainer.md b/src/bdscript/addContainer.md index a822dcf1313..0733de922f0 100644 --- a/src/bdscript/addContainer.md +++ b/src/bdscript/addContainer.md @@ -31,6 +31,7 @@ You can't have multiple containers and [sections](./addSection.md) **with the sa ## Container Components - [`$addTextDisplay[]`](./addTextDisplay.md) - [`$addSeparator[]`](./addSeparator.md) +- [`$addMediaGallery[]`](./addMediaGallery.md) ## Example ``` diff --git a/src/bdscript/addMediaGallery.md b/src/bdscript/addMediaGallery.md new file mode 100644 index 00000000000..12765657ca7 --- /dev/null +++ b/src/bdscript/addMediaGallery.md @@ -0,0 +1,26 @@ +# $addMediaGallery +
+ Components v2 +
+ +Adds a media gallery to the message. + +## Syntax +``` +$addMediaGallery[Gallery name;(Container name)] +``` + +### Parameters +- `Gallery name` `(Type: String || Flag: Required)`: Name for attaching pictures to the gallery. +- `Container name` `(Type: String || Flag: Optional)`: To which [container body](./addContainer.md) should the gallery be attached. + +## Example +``` +$nomention +$addMediaGallery[pictures] +$addMediaGalleryItem[$authorAvatar;;;pictures] +``` + +```admonish question title="What is this?" +How [`$addMediaGalleryItem[]`](./addMediaGalleryItem.md) and [`$authorAvatar`](./authorAvatar.md) works? +``` \ No newline at end of file diff --git a/src/bdscript/addMediaGalleryItem.md b/src/bdscript/addMediaGalleryItem.md new file mode 100644 index 00000000000..549a8d0db8f --- /dev/null +++ b/src/bdscript/addMediaGalleryItem.md @@ -0,0 +1,32 @@ +# $addMediaGalleryItem +
+ Components v2 +
+ +Adds a media to the gallery. + +## Syntax +``` +$addMediaGalleryItem[Media URL;Description;Spoiler?;Gallery name] +``` + +```admonish warning title="Limit" +You can add up to 10 media items to a gallery. +``` + +### Parameters +- `Media URL` `(Type: URL || Flag: Required)`: URL of the media (image or video). +- `Description` `(Type: String || Flag: Emptiable)`: Alt text for the media item. +- `Spoiler?` `(Type: Bool || Flag: Emptiable)`: Will the media have a spoiler effect? +- `Gallery name` `(Type: String || Flag: Required)`: Name of the media gallery to add item to. + +## Example +``` +$nomention +$addMediaGallery[pictures] +$addMediaGalleryItem[$authorAvatar;;;pictures] +``` + +```admonish question title="What is this?" +How [`$addMediaGallery[]`](./addMediaGallery.md) and [`$authorAvatar`](./authorAvatar.md) works? +``` \ No newline at end of file diff --git a/src/bdscript/alternativeParsing.md b/src/bdscript/alternativeParsing.md index eb9dd2bd664..683ff2a8a60 100644 --- a/src/bdscript/alternativeParsing.md +++ b/src/bdscript/alternativeParsing.md @@ -16,11 +16,11 @@ Changes the way how triggers are read. ## Syntax ``` $alternativeParsing -``` - +``` + ```admonish fail This function was added at the end of 2019 as an experiment, and it can be unstable and break your commands. You should not use `$alternativeParsing` when making your bot. -``` +``` ## Example 1. Create two commands and set the trigger `hello` for one command and `helloworld` for the other. @@ -39,61 +39,61 @@ This function was added at the end of 2019 as an experiment, and it can be unsta ``` 3. Execute commands. ``` discord yaml -- user_id: 729343563401265193 - username: Nicky - color: "#EE7908" +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" content: | hello -- user_id: 566613317972394004 - username: Wiki Bot - color: "#748BD4" +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" bot: true verified: true content: embed: description: "\"hello\"" -- user_id: 729343563401265193 - username: Nicky - color: "#EE7908" +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" content: | helloworld -- user_id: 566613317972394004 - username: Wiki Bot - color: "#748BD4" +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" bot: true verified: true content: embed: description: "\"helloworld\"" -``` - -~~~admonish example +``` + +~~~admonish example - Without `$alternativeParsing`: ``` discord yaml -- user_id: 729343563401265193 - username: Nicky - color: "#EE7908" +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" content: | hello -- user_id: 566613317972394004 - username: Wiki Bot - color: "#748BD4" +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" bot: true verified: true content: embed: description: "\"hello\"" -- user_id: 729343563401265193 - username: Nicky - color: "#EE7908" +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" content: | helloworld -- user_id: 566613317972394004 - username: Wiki Bot - color: "#748BD4" +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" bot: true verified: true content: @@ -101,5 +101,5 @@ This function was added at the end of 2019 as an experiment, and it can be unsta - description: "\"helloworld\"" - description: "\"hello\"" ``` - + ~~~ \ No newline at end of file diff --git a/src/bdscript/awaitFunc.md b/src/bdscript/awaitFunc.md index 694ca7c7f67..b93034b13a0 100644 --- a/src/bdscript/awaitFunc.md +++ b/src/bdscript/awaitFunc.md @@ -19,14 +19,14 @@ $awaitFunc[say] ``` ``` discord yaml -- user_id: 729343563401265193 - username: Nicky - color: "#EE7908" +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" content: | - !example -- user_id: 566613317972394004 - username: Wiki Bot - color: "#748BD4" + !example 566363823137882154 +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" bot: true verified: true content: | @@ -34,5 +34,5 @@ $awaitFunc[say] ``` ```admonish info title="Read more" -For more information, read the [Awaited Commands Guide](../guides/general/awaitedCommands.md). +For more information, read the [Awaited Commands Guide](../guides/general/awaitedCommands.md). ``` diff --git a/src/bdscript/boostCount.md b/src/bdscript/boostCount.md index 69ac345847a..0229d930376 100644 --- a/src/bdscript/boostCount.md +++ b/src/bdscript/boostCount.md @@ -13,6 +13,18 @@ This server currently has $boostCount boost(s). ``` ```discord yaml +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" + bot: true + verified: true + content: | + This server currently has 11 boost(s). - type: boost content: | RainbowKey just boosted the server! diff --git a/src/bdscript/boostCountComplex.md b/src/bdscript/boostCountComplex.md index 1c2fb5fa848..a0909985a6e 100644 --- a/src/bdscript/boostCountComplex.md +++ b/src/bdscript/boostCountComplex.md @@ -12,13 +12,10 @@ $boostCount[Guild ID] ## Example ``` $nomention -This server currently has $boostCount[$message] boost(s). +Boosts: $boostCount[$message] ``` ```discord yaml -- type: boost - content: | - RainbowKey just boosted the server! - user_id: 803569638084313098 username: RainbowKey color: "#E67E22" @@ -30,5 +27,9 @@ This server currently has $boostCount[$message] boost(s). bot: true verified: true content: | - This server currently has 38 boost(s). + Boosts: 38 +``` + +```admonish question title="What is this?" +How [`$message`](./message.md) works? ``` diff --git a/src/bdscript/botID.md b/src/bdscript/botID.md index 5a8055edde3..886a744e962 100644 --- a/src/bdscript/botID.md +++ b/src/bdscript/botID.md @@ -9,7 +9,7 @@ $botID ## Example ``` $nomention -My ID is: $botID +My ID: $botID ``` ```discord yaml diff --git a/src/bdscript/botOwnerID.md b/src/bdscript/botOwnerID.md index 7e4b0f3ea66..c70ceee235c 100644 --- a/src/bdscript/botOwnerID.md +++ b/src/bdscript/botOwnerID.md @@ -1,9 +1,9 @@ # $botOwnerID Returns the bot owner's ID. - -```admonish warning -Only works if you logged into the app via your Discord account. Otherwise, if you log in via your Google/Apple account or other methods, it will return ``. -``` + +```admonish warning +Only works if you logged into the app via your Discord account. Otherwise, if you log in via your Google/Apple account or other methods, it will return ``. +``` ## Syntax ``` @@ -17,16 +17,16 @@ My owner's ID: $botOwnerID ``` ``` discord yaml -- user_id: 729343563401265193 - username: Nicky - color: "#EE7908" +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" content: | - !example -- user_id: 566613317972394004 - username: Wiki Bot - color: "#748BD4" + !example 566363823137882154 +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" bot: true verified: true content: | - My owner's ID: 729343563401265193 + My owner's ID: 803569638084313098 ``` diff --git a/src/bdscript/c.md b/src/bdscript/c.md index faa4600763b..33a4076b692 100644 --- a/src/bdscript/c.md +++ b/src/bdscript/c.md @@ -17,20 +17,20 @@ $c[This is a say command. You are reading a comment!] ``` ``` discord yaml -- user_id: 729343563401265193 - username: Nicky - color: "#EE7908" +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" content: | !example As you can see, the comment doesn't appear! Pretty cool; right? -- user_id: 566613317972394004 - username: Wiki Bot - color: "#748BD4" +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" bot: true verified: true content: | As you can see, the comment doesn't appear! Pretty cool; right? -``` - -```admonish question title="What is this?" -How [`$message`](./message.md) works? +``` + +```admonish question title="What is this?" +How [`$message`](./message.md) works? ``` diff --git a/src/bdscript/channelIDFromName.md b/src/bdscript/channelIDFromName.md index c2c75a1fbb4..312adac398c 100644 --- a/src/bdscript/channelIDFromName.md +++ b/src/bdscript/channelIDFromName.md @@ -3,10 +3,10 @@ Deprecated
-> This function is deprecated, instead better use [`$channelID[]`](./channelIDComplex.md). - Returns a channel's ID from its name. +> This function is deprecated, instead better use [`$channelID[]`](./channelIDComplex.md). + ## Syntax ``` $channelIDFromName[Channel name] diff --git a/src/bdscript/clearReactions.md b/src/bdscript/clearReactions.md index c144367b89a..a86fac3e6a5 100644 --- a/src/bdscript/clearReactions.md +++ b/src/bdscript/clearReactions.md @@ -47,3 +47,7 @@ $clearReactions[$channelID;$message;✅] content: | !example 1216863258708021248 ``` + +```admonish question title="What is this?" +How [`$channelID`](./channelID.md) and [`$message`](./message.md) works? +``` \ No newline at end of file diff --git a/src/bdscript/commandFolder.md b/src/bdscript/commandFolder.md index bbf14f36a8e..9c3138d47f3 100644 --- a/src/bdscript/commandFolder.md +++ b/src/bdscript/commandFolder.md @@ -17,7 +17,7 @@ Commmand folder: $commandFolder username: RainbowKey color: "#E67E22" content: | - !example Hello world! + !example - username: BDFD Support user_id: 1009018156494368798 color: "#378afa" diff --git a/src/bdscript/commandName.md b/src/bdscript/commandName.md index 0ea23ca099d..2ad247f1942 100644 --- a/src/bdscript/commandName.md +++ b/src/bdscript/commandName.md @@ -17,12 +17,12 @@ Commmand name: $commandName username: RainbowKey color: "#E67E22" content: | - !example Hello world! + !example - username: BDFD Support user_id: 1009018156494368798 color: "#378afa" bot: true verified: true content: | - Commmand name: !example + Commmand name: Examples ``` diff --git a/src/bdscript/commandTrigger.md b/src/bdscript/commandTrigger.md index 8e9628c1e8a..bc004eca886 100644 --- a/src/bdscript/commandTrigger.md +++ b/src/bdscript/commandTrigger.md @@ -21,7 +21,7 @@ Commmand trigger: $commandTrigger username: RainbowKey color: "#E67E22" content: | - !example Hello world! + !example - username: BDFD Support user_id: 1009018156494368798 color: "#378afa" diff --git a/src/bdscript/commandsCount.md b/src/bdscript/commandsCount.md index 79a7d1a8d4f..dc110678cf9 100644 --- a/src/bdscript/commandsCount.md +++ b/src/bdscript/commandsCount.md @@ -17,9 +17,9 @@ I have $commandsCount commands! username: RainbowKey color: "#E67E22" content: | - !example -- username: BDFD Support - user_id: 1009018156494368798 + !example 566363823137882154 +- user_id: 1009018156494368798 + username: BDFD Support color: "#378afa" bot: true verified: true diff --git a/src/bdscript/customEmoji.md b/src/bdscript/customEmoji.md index 49c31c241dc..1d45942485f 100644 --- a/src/bdscript/customEmoji.md +++ b/src/bdscript/customEmoji.md @@ -1,7 +1,7 @@ # $customEmoji -Returns a custom emoji. +Returns a custom emoji on the current server. -```admonish danger title="Important" +```admonish warning title="Important" We recommend emoji IDs instead of `$customEmoji[]` **for public** bots. ``` @@ -16,7 +16,20 @@ $customEmoji[Emoji name] ## Example ``` $nomention -Hello there! $customEmoji[Wave] +Hello bdfd! $customEmoji[BDFD] ``` -![Example](https://user-images.githubusercontent.com/69215413/122825469-fa934f80-d2af-11eb-9563-67552204beb5.png) +``` discord yaml +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" + bot: true + verified: true + content: | + Hello bdfd! +``` \ No newline at end of file diff --git a/src/bdscript/deletecommand.md b/src/bdscript/deletecommand.md index 8eb1f6cae02..47028064373 100644 --- a/src/bdscript/deletecommand.md +++ b/src/bdscript/deletecommand.md @@ -1,14 +1,18 @@ # $deletecommand Deletes the author's command message. -> The bot must have the `manage_messages` permission. +```admonish warning +The bot must have the `manage_messages` permission. +``` ## Syntax ``` $deletecommand ``` -> Sometimes a message may be deleted, but you will still see it. This is a discord bug. +```admonish note +Sometimes a message may be deleted, but you will still see it. This is a Discord bug. +``` ## Example ``` diff --git a/src/bdscript/editSplitText.md b/src/bdscript/editSplitText.md index c9d0a9fd39c..eb342027818 100644 --- a/src/bdscript/editSplitText.md +++ b/src/bdscript/editSplitText.md @@ -1,5 +1,5 @@ # $editSplitText -Edits a splitted text element using its index. +This function replaces the element at the specified index with a new element instead of the previous one. ## Syntax ``` @@ -13,23 +13,30 @@ $editSplitText[Index;Value] ## Example ``` $nomention +$textSplit[Hello-world-!;-] +$editSplitText[2;bdfd] +> $joinSplitText[-] +``` -$textSplit[$message; ] - -$var[Index;$splitText[$sub[$getTextSplitLength;1]]] -$var[Value;$splitText[$getTextSplitLength]] - -$removeSplitTextElement[$getTextSplitLength] -$removeSplitTextElement[$getTextSplitLength] - -$var[Text;$joinSplitText[ ]] - -$textSplit[$var[Text];] -$editSplitText[$var[Index];$var[Value]] +``` discord yaml +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" + bot: true + verified: true + content: | + Hello-bdfd-! +``` -Original Text: $var[Text] -New Text: $joinSplitText[] +```admonish question title="What is this?" +How [`$textSplit[]`](./textSplit.md) and [`$joinSplitText[]`](./joinSplitText.md) works? ``` -![example](https://user-images.githubusercontent.com/95774950/202880969-9ce5041a-cc6c-4bd2-a275-76e9d80be5b5.png) -> For more info, see the [Text Splitting Guide](../guides/general/textSplitting.md). +```admonish info title="Read more" +For more information, read the [Text Splitting Guide](../guides/general/textSplitting.md). +``` diff --git a/src/bdscript/editThread.md b/src/bdscript/editThread.md index bf55d40dcfa..05aa063d25b 100644 --- a/src/bdscript/editThread.md +++ b/src/bdscript/editThread.md @@ -3,21 +3,44 @@ Modifies an existing thread. ## Syntax ``` -$editThread[Thread ID;(Name;Archived;Archive duration;Locked;Slowmode)] +$editThread[Thread ID;(Thread name;Archived?;Archive duration;Locked?;Slowmode)] ``` ### Parameters - `Thread ID` `(Type: Snowflake || Flag: Required)`: The thread channel to edit. -- `Name` `(Type: String || Flag: Optional)`: The new name of the thread. -- `Archived` `(Type: Bool || Flag: Optional)`: Whether to archive this thread or not. -- `Archive duration` `(Type: Integer || Flag: Optional)`: The archive duration of this thread in minutes. Only 60, 1440,4320, 10080 can be used. Note that for the 4320 archive duration option, the server needs to be level 1 boosted, and for 10080 the server needs level 2. -- `Locked` `(Type: Bool || Flag: Optional)`: Whether to lock this thread or not. Note that archived threads can't be locked. +- `Thread name` `(Type: String || Flag: Optional)`: The new name of the thread. +- `Archived?` `(Type: Bool || Flag: Optional)`: Whether to archive this thread or not. +- `Archive duration` `(Type: Integer || Flag: Optional)`: The [archive duration](#archive-duration) after which the thread will be auto-archived due to inactivity. Defaults to `60`. +- `Locked?` `(Type: Bool || Flag: Optional)`: Whether to lock this thread or not. Note that archived threads can't be locked. - `Slowmode` `(Type: Integer || Flag: Optional)`: The slowmode of this channel, expressed in seconds. -> You can use `!unchanged` as an parameter for the option to remain in its current state. +```admonish tip +Use `!unchanged` as an argument for the option to remain in its current state. +``` + +### Archive Duration +`60` - 1 Hour\ +`1440` - 1 Day\ +`4320` - 3 Days (Only for servers with level 1 boosted)\ +`10080` - 7 Days (Only for servers with level 2 boosted) ## Example ``` $nomention $editThread[1098166444111433819;Cool Thread 😎;no;!unchanged;!unchanged;5] ``` + +``` discord yaml +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example +- type: edit + content: | + BDFD Support changed the channel name: Cool Thread 😎 +``` + +```admonish info title="Read more" +For more information, read the [Threads Guide](../guides/general/threads.md). +``` diff --git a/src/bdscript/else.md b/src/bdscript/else.md index 1378cd20102..c834d8148ee 100644 --- a/src/bdscript/else.md +++ b/src/bdscript/else.md @@ -22,7 +22,8 @@ $endif color: "#E67E22" content: | !example -- username: BDFD Support +- user_id: 1009018156494368798 + username: BDFD Support color: "#378afa" bot: true verified: true @@ -33,7 +34,8 @@ $endif color: "#FF0000" content: | !example -- username: BDFD Support +- user_id: 1009018156494368798 + username: BDFD Support color: "#378afa" bot: true verified: true @@ -42,5 +44,5 @@ $endif ``` ```admonish info title="Read more" -For more information, read the [If Statements Guide](../guides/ifStatements.md). +For more information, read the [If Statements Guide](../guides/ifStatements.md). ``` diff --git a/src/bdscript/emoteCount.md b/src/bdscript/emoteCount.md index d67f32074da..b483d60add3 100644 --- a/src/bdscript/emoteCount.md +++ b/src/bdscript/emoteCount.md @@ -9,7 +9,7 @@ $emoteCount ## Example ``` $nomention -There are $emoteCount emojis in $serverName[$guildID]! +There are $emoteCount emojis in this server! ``` ```discord yaml @@ -24,9 +24,5 @@ There are $emoteCount emojis in $serverName[$guildID]! bot: true verified: true content: | - There are 149 emojis in Bot Designer for Discord Official Server! -``` - -```admonish question title="What is this?" -How [`$serverName[]`](./serverName.md) and [`$guildID`](./guildID.md) works? + There are 149 emojis in this server! ``` diff --git a/src/bdscript/endif.md b/src/bdscript/endif.md index 946fc24dc04..63269e7dfce 100644 --- a/src/bdscript/endif.md +++ b/src/bdscript/endif.md @@ -20,7 +20,8 @@ $endif color: "#E67E22" content: | !example BDFD -- username: BDFD Support +- user_id: 1009018156494368798 + username: BDFD Support color: "#378afa" bot: true verified: true @@ -28,6 +29,8 @@ $endif I love BDFD! ``` +~~~admonish example + - Without `$endif`: ``` discord yaml @@ -36,7 +39,8 @@ $endif color: "#E67E22" content: | !example BDFD -- username: BDFD Support +- user_id: 1009018156494368798 + username: BDFD Support color: "#378afa" bot: true verified: true @@ -44,7 +48,8 @@ $endif $if not closed with $endif ``` +~~~ ```admonish info title="Read more" -For more information, read the [If Statements Guide](../guides/ifStatements.md). +For more information, read the [If Statements Guide](../guides/ifStatements.md). ``` diff --git a/src/bdscript/endtry.md b/src/bdscript/endtry.md index e6ae4c85ed4..1b64556f501 100644 --- a/src/bdscript/endtry.md +++ b/src/bdscript/endtry.md @@ -18,7 +18,6 @@ $try $endtry ``` -- With `$endtry`: ```discord yaml - user_id: 803569638084313098 username: RainbowKey @@ -34,6 +33,8 @@ $endtry 7 ``` +~~~admonish example + - Without `$endtry`: ```discord yaml - user_id: 803569638084313098 @@ -50,6 +51,8 @@ $endtry $try not closed with $endtry or invalid use of $sum ``` +~~~ + ```admonish question title="What is this?" How [`$calculate[]`](./calculate.md), [`$message`](./message.md) and [`$try`](./try.md) works? ``` diff --git a/src/bdscript/getServerInviteComplex.md b/src/bdscript/getServerInviteComplex.md index 4d16f35a357..56208a38860 100644 --- a/src/bdscript/getServerInviteComplex.md +++ b/src/bdscript/getServerInviteComplex.md @@ -1,13 +1,13 @@ # $getServerInvite[] Returns the provided server's invite URL. - + ```admonish warning The bot must be present in the provided server (`Guild ID` parameter) for it to create an invite. -``` - -```admonish danger -You should not use this function to join a user's server **unsolicited**. This means that you aren't allowed to join a user's server without their consent, otherwise it may be considered as API abuse and result in a report against you and your bot. -``` +``` + +```admonish danger +You should not use this function to join a user's server **unsolicited**. This means that you aren't allowed to join a user's server without their consent, otherwise it may be considered as API abuse and result in a report against you and your bot. +``` ## Syntax ``` @@ -27,3 +27,7 @@ $nomention $getServerInvite[$message] ``` ![example](https://user-images.githubusercontent.com/111157596/232099171-ab1a4cea-836a-45e7-9a93-2012ac4012e5.png) + +```admonish question title="What is this?" +How [`$message`](./message.md) works? +``` diff --git a/src/bdscript/getTextSplitIndex.md b/src/bdscript/getTextSplitIndex.md index 5ab34bbde3f..0606cf01ee5 100644 --- a/src/bdscript/getTextSplitIndex.md +++ b/src/bdscript/getTextSplitIndex.md @@ -43,4 +43,10 @@ $textSplit[hello_world_!;_] -1 ``` -> For more info, see the [Text Splitting Guide](../guides/general/textSplitting.md). +```admonish question title="What is this?" +How [`$textSplit[]`](./textSplit.md) works? +``` + +```admonish info title="Read more" +For more information, read the [Text Splitting Guide](../guides/general/textSplitting.md). +``` \ No newline at end of file diff --git a/src/bdscript/getTextSplitLength.md b/src/bdscript/getTextSplitLength.md index 2c3fd6513cd..1d62398670d 100644 --- a/src/bdscript/getTextSplitLength.md +++ b/src/bdscript/getTextSplitLength.md @@ -28,4 +28,10 @@ $textSplit[hello%world%!;%] 3 ``` -> For more info, see the [Text Splitting Guide](../guides/general/textSplitting.md). +```admonish question title="What is this?" +How [`$textSplit[]`](./textSplit.md) works? +``` + +```admonish info title="Read more" +For more information, read the [Text Splitting Guide](../guides/general/textSplitting.md). +``` \ No newline at end of file diff --git a/src/bdscript/giveRole.md b/src/bdscript/giveRole.md index 8bf55e08ce0..d5a6bdf836c 100644 --- a/src/bdscript/giveRole.md +++ b/src/bdscript/giveRole.md @@ -3,10 +3,10 @@ Deprecated
-> This function is deprecated, instead better to use [`$roleGrant[]`](./roleGrant.md). - Adds a role to the provided user. +> This function is deprecated, instead better to use [`$roleGrant[]`](./roleGrant.md). + ## Syntax ``` $giveRole[User/Role ID;(Role ID)] diff --git a/src/bdscript/guildBanner.md b/src/bdscript/guildBanner.md index 96387db0047..c823b50a0a6 100644 --- a/src/bdscript/guildBanner.md +++ b/src/bdscript/guildBanner.md @@ -16,17 +16,21 @@ $guildBanner[$guildID] ``` ``` discord yaml -- username: Ivaylo - user_id: 1251981607468798089 +- user_id: 803569638084313098 + username: RainbowKey color: "#E67E22" content: | - !example -- username: BDFD Support - user_id: 1009018156494368798 + !example 566363823137882154 +- user_id: 1009018156494368798 + username: BDFD Support color: "#378afa" bot: true verified: true - content: " " + content: attachments: - url: https://cdn.discordapp.com/banners/566363823137882154/a8cd6ed3d5c665e1443e5fe8fa2ab8c8.jpg ``` + +```admonish question title="What is this?" +How [`$guildID`](./guildID.md) works? +``` \ No newline at end of file diff --git a/src/bdscript/guildExists.md b/src/bdscript/guildExists.md index 5a91677a4c1..657768d455a 100644 --- a/src/bdscript/guildExists.md +++ b/src/bdscript/guildExists.md @@ -25,12 +25,25 @@ $guildExists[$message] color: "#E67E22" content: | !example 566363823137882154 -- username: BDFD Support +- user_id: 1009018156494368798 + username: BDFD Support color: "#378afa" bot: true verified: true content: | true +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example hdiroxkxjjwos6729394 +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" + bot: true + verified: true + content: | + false ``` ```admonish question title="What is this?" diff --git a/src/bdscript/guildID.md b/src/bdscript/guildID.md index d738a2258eb..51646e25289 100644 --- a/src/bdscript/guildID.md +++ b/src/bdscript/guildID.md @@ -9,7 +9,7 @@ $guildID ## Example ``` $nomention -Server's ID: $guildID +ID: $guildID ``` ```discord yaml @@ -24,5 +24,5 @@ Server's ID: $guildID bot: true verified: true content: | - Server's ID: 566363823137882154 + ID: 566363823137882154 ``` diff --git a/src/bdscript/guildIDComplex.md b/src/bdscript/guildIDComplex.md index 03e28569a39..a2a2dbab45c 100644 --- a/src/bdscript/guildIDComplex.md +++ b/src/bdscript/guildIDComplex.md @@ -12,6 +12,36 @@ $guildID[Server name] ## Example ``` $nomention -$noMentionMessage ID is : $guildID[$noMentionMessage] +ID: $guildID[$message] +``` + +```discord yaml +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example Bot Designer For Discord Official Server +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" + bot: true + verified: true + content: | + ID: 566363823137882154 +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example B. Support +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" + bot: true + verified: true + content: | + ID: 1009018669982031912 +``` + +```admonish question title="What is this?" +How [`$message`](./message.md) works? ``` -![example](https://user-images.githubusercontent.com/70468667/219971506-204ba3e1-0909-448c-bf3f-63361ffdc62e.jpg) diff --git a/src/bdscript/isEmojiAnimated.md b/src/bdscript/isEmojiAnimated.md index 41bd20c0cd4..94157c068e4 100644 --- a/src/bdscript/isEmojiAnimated.md +++ b/src/bdscript/isEmojiAnimated.md @@ -16,8 +16,8 @@ Is emoji animated?: $isEmojiAnimated[$message] ``` ``` discord yaml -- user_id: 1262009115689881702 - username: GettingBeatenByKito +- user_id: 803569638084313098 + username: RainbowKey color: "#E67E22" content: | !example 760463263879135242 diff --git a/src/bdscript/joinSplitText.md b/src/bdscript/joinSplitText.md index 23908d9663d..cb168cc657d 100644 --- a/src/bdscript/joinSplitText.md +++ b/src/bdscript/joinSplitText.md @@ -23,17 +23,19 @@ $joinSplitText[+] color: "#E67E22" content: | !example hello-world-! -- user_id: 1009018156494368798 - username: BDFD Support - color: "#378afa" - bot: true +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" + bot: true verified: true content: | hello+world+! ``` - -```admonish question title="What is this?" -How [`$textSplit[]`](./textSplit.md) and [`$message`](./message.md) works? -``` -> For more info, see the [Text Splitting Guide](../guides/general/textSplitting.md). +```admonish question title="What is this?" +How [`$textSplit[]`](./textSplit.md) and [`$message`](./message.md) works? +``` + +```admonish info title="Read more" +For more information, read the [Text Splitting Guide](../guides/general/textSplitting.md). +``` diff --git a/src/bdscript/linesCount.md b/src/bdscript/linesCount.md index efa5956ee6d..3553cfb8bc4 100644 --- a/src/bdscript/linesCount.md +++ b/src/bdscript/linesCount.md @@ -16,8 +16,8 @@ $linesCount[$message] ``` ``` discord yaml -- username: Ivaylo - user_id: 1251981607468798089 +- user_id: 803569638084313098 + username: RainbowKey color: "#E67E22" content: | !example Hello World! diff --git a/src/bdscript/membersCount.md b/src/bdscript/membersCount.md index 011d233b00c..a45041b9801 100644 --- a/src/bdscript/membersCount.md +++ b/src/bdscript/membersCount.md @@ -9,13 +9,28 @@ $membersCount ## Example ``` $nomention -This server has $membersCount members +This server has $membersCount members! ``` -![example1](https://user-images.githubusercontent.com/70468667/219971581-9eca0e8e-0b85-4ee3-b5e1-42b4fae2178a.jpg) +``` discord yaml +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example +- username: BDFD Support + user_id: 1009018156494368798 + color: "#378afa" + bot: true + verified: true + content: | + This server has 5281 members! +``` +```admonish example -## Note You can use `$membersCount` in the bot status to display how many users are in all servers of the bot. -![example2](https://user-images.githubusercontent.com/70468667/219971617-d3cd270f-792a-415b-b9de-2651fc9d7f08.jpg) +![example](https://user-images.githubusercontent.com/70468667/219971617-d3cd270f-792a-415b-b9de-2651fc9d7f08.jpg) + +``` \ No newline at end of file diff --git a/src/bdscript/membersCountComplex.md b/src/bdscript/membersCountComplex.md index e50689874e5..9bf398205fc 100644 --- a/src/bdscript/membersCountComplex.md +++ b/src/bdscript/membersCountComplex.md @@ -21,6 +21,20 @@ This function requires the following privileged intents: ## Example ``` $nomention -there are $membersCount[online] online users in this server +There are $membersCount[online] online users in this server! ``` -![example](https://user-images.githubusercontent.com/70468667/219971665-9185a0b7-52e8-44eb-8d43-e5e2455bcbe3.jpg) + +``` discord yaml +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example +- username: BDFD Support + user_id: 1009018156494368798 + color: "#378afa" + bot: true + verified: true + content: | + There are 67 online users in this server! +``` \ No newline at end of file diff --git a/src/bdscript/mentionedChannels.md b/src/bdscript/mentionedChannels.md index 9b3688d1d23..56dab961e35 100644 --- a/src/bdscript/mentionedChannels.md +++ b/src/bdscript/mentionedChannels.md @@ -17,7 +17,20 @@ $mentionedChannels[Mention number;(Return current?)] ## Example ``` $nomention -$mentionedChannels[1] +Channel: $mentionedChannels[1] ``` -![example](https://user-images.githubusercontent.com/69215413/126917253-33db5d96-fdb3-43a3-b614-1ac061701fb1.png) +``` discord yaml +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example <#main-chat> +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" + bot: true + verified: true + content: | + Channel: 566370477967147018 +``` diff --git a/src/bdscript/modifyChannelPerms.md b/src/bdscript/modifyChannelPerms.md index 6330fbeae43..15bee83cb3d 100644 --- a/src/bdscript/modifyChannelPerms.md +++ b/src/bdscript/modifyChannelPerms.md @@ -3,11 +3,12 @@ Deprecated -```admonish warning -This function has been deprecated in favor of [`$editChannelPerms[]`](./editChannelPerms.md). -``` Modifies a channel's permissions. +```admonish warning +This function has been deprecated in favor of [`$editChannelPerms[]`](./editChannelPerms.md). +``` + ## Syntax ``` $modifyChannelPerms[Channel ID;Permissions;User/Role ID] diff --git a/src/bdscript/mute.md b/src/bdscript/mute.md index 5578fa2f580..3935eec7eeb 100644 --- a/src/bdscript/mute.md +++ b/src/bdscript/mute.md @@ -3,12 +3,12 @@ Deprecated -```admonish warning -As of December 2021, this function has been deprecated in favor of [`$timeout[]`](./timeout.md). -``` - Mutes the mentioned user. +```admonish warning +As of December 2021, this function has been deprecated in favor of [`$timeout[]`](./timeout.md). +``` + ## Syntax ``` $mute[Muted Role Name] diff --git a/src/bdscript/random.md b/src/bdscript/random.md index cc88f14930e..42f83b8bb76 100644 --- a/src/bdscript/random.md +++ b/src/bdscript/random.md @@ -18,11 +18,37 @@ The random number is **$random** color: "#E67E22" content: | !example -- username: BDFD Support - user_id: 1009018156494368798 - color: "#378afa" - bot: true +- username: BDFD Support + user_id: 1009018156494368798 + color: "#378afa" + bot: true verified: true content: | The random number is 4 ``` + +~~~admonish example +You can use [`$enableDecimals[]`](./enableDecimals.md) to disable or enable decimals: + +``` +$nomention +$enableDecimals[yes] +The random number is **$random** +``` + +``` discord yaml +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example +- username: BDFD Support + user_id: 1009018156494368798 + color: "#378afa" + bot: true + verified: true + content: | + The random number is 2.3 +``` + +~~~ \ No newline at end of file diff --git a/src/bdscript/randomComplex.md b/src/bdscript/randomComplex.md index df0efe59844..88785748daf 100644 --- a/src/bdscript/randomComplex.md +++ b/src/bdscript/randomComplex.md @@ -15,7 +15,7 @@ $random[Min;Max] - `Max` `(Type: Integer, Float || Flag: Required)`: The maximum value. ```admonish failure -The `Max` value cannot be greater than or equal to the `Min` value. +The `Min` value cannot be greater than or equal to the `Max` value. - ❌ `Max` <= `Min` - ✅ `Max` > `Min` ``` @@ -40,3 +40,29 @@ The random number is **$random[1;21]** content: | The random number is 16 ``` + +~~~admonish example +You can use [`$enableDecimals[]`](./enableDecimals.md) to disable or enable decimals: + +``` +$nomention +$enableDecimals[yes] +The random number is **$random[1;21]** +``` + +``` discord yaml +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example +- username: BDFD Support + user_id: 1009018156494368798 + color: "#378afa" + bot: true + verified: true + content: | + The random number is 13.1 +``` + +~~~ diff --git a/src/bdscript/removeSplitTextElement.md b/src/bdscript/removeSplitTextElement.md index a77410aa9e1..47f6c067c5a 100644 --- a/src/bdscript/removeSplitTextElement.md +++ b/src/bdscript/removeSplitTextElement.md @@ -1,7 +1,5 @@ # $removeSplitTextElement -Removes a certain element from the [`$textSplit[]`](./textSplit.md) values. - -> This function is unneeded, if `$textSplit[]` isn't present in the code. +This function removes an element from the separated text by the specified index. ## Syntax ``` @@ -11,4 +9,29 @@ $removeSplitTextElement[Index] ### Parameters - `Index` `(Type: Integer || Flag: Required)`: The index of the `$textSplit[]` value to remove. -> For more info, see the [Text Splitting Guide](../guides/general/textSplitting.md). +## Example +``` +$nomention +$textSplit[hello-world-!;-] +$removeSplitTextElement[3] +> $joinSplitText[-] +``` + +``` discord yaml +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" + bot: true + verified: true + content: | + hello-world +``` + +```admonish info title="Read more" +For more information, read the [Text Splitting Guide](../guides/general/textSplitting.md). +``` diff --git a/src/bdscript/repeatMessage.md b/src/bdscript/repeatMessage.md index 73eef757718..6ff4af1d7ec 100644 --- a/src/bdscript/repeatMessage.md +++ b/src/bdscript/repeatMessage.md @@ -3,12 +3,12 @@ Repeats the provided text a certain amount of times. ## Syntax ``` -$repeatMessage[Amount;Message] +$repeatMessage[Amount;Text] ``` ### Parameters - `Amount` `(Type: Integer || Flag: Required)`: The number of times to repeat the given text (max `10` times). -- `Message` `(Type: String || Flag: Emptiable)`: The text to repeat. +- `Text` `(Type: String || Flag: Emptiable)`: The text to repeat. ## Example ``` @@ -31,6 +31,28 @@ $repeatMessage[5;Hello World!] Hello World!Hello World!Hello World!Hello World!Hello World! ``` -```admonish info -You can use a space at the end of "text" in the `Message` parameter, so there are spaces in-between repeats. +~~~admonish example + +You can use a space at the end of "text" in the `Text` parameter, so there are spaces in-between repeats: + ``` +$nomention +$repeatMessage[5;Hello World! ] +``` + +``` discord yaml +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example +- username: BDFD Support + user_id: 1009018156494368798 + color: "#378afa" + bot: true + verified: true + content: | + Hello World! Hello World! Hello World! Hello World! Hello World! +``` + +~~~ diff --git a/src/bdscript/replaceText.md b/src/bdscript/replaceText.md index 904df9f7000..7275b5bc7b0 100644 --- a/src/bdscript/replaceText.md +++ b/src/bdscript/replaceText.md @@ -10,7 +10,7 @@ $replaceText[Text;Sample;New;(Amount)] - `Text` `(Type: String || Flag: Emptiable)`: The text where the bot is searching for the 'Sample'. - `Sample` `(Type: String || Flag: Emptiable)`: The text to replace with 'New'. - `New` `(Type: String || Flag: Emptiable)`: The text to replace 'Sample' with. -- `Amount` `(Type: Integer || Flag: Optional)`: The number of times, at most, the bot should replace the sample. Use `-1` to replace all 'Sample' in 'Text' with 'New'. Default is `1`. +- `Amount` `(Type: Integer || Flag: Optional)`: The number of times, at most, the bot should replace the sample. Use `-1` to replace all 'Sample' in 'Text' with 'New'. Default is `-1`. ## Example ``` diff --git a/src/bdscript/serverCount.md b/src/bdscript/serverCount.md index 460ce2166f1..765b6d99915 100644 --- a/src/bdscript/serverCount.md +++ b/src/bdscript/serverCount.md @@ -27,4 +27,6 @@ I'm currently in $serverCount servers! I'm currently in 203 servers! ``` -> Can be used in bot status +```admonish note +Can be used in bot status. +``` diff --git a/src/bdscript/serverDescriptionComplex.md b/src/bdscript/serverDescriptionComplex.md index 70e712eaf62..f292b4b34e0 100644 --- a/src/bdscript/serverDescriptionComplex.md +++ b/src/bdscript/serverDescriptionComplex.md @@ -29,3 +29,7 @@ Server description: $serverDescription[$message] content: | Server description: Welcome to the BDFD Support server! Enjoy stay with us! ``` + +```admonish question title="What is this?" +How [`$message`](./message.md) works? +``` diff --git a/src/bdscript/serverName.md b/src/bdscript/serverName.md index 5cf7d8661a7..c1516a62223 100644 --- a/src/bdscript/serverName.md +++ b/src/bdscript/serverName.md @@ -9,7 +9,9 @@ $serverName[Guild ID] ### Parameters - `Guild ID` `(Type: Snowflake || Flag: Required)`: The server to get the name of. Use [`$guildID`](./guildID.md) for the current server. -> The bot must be present in the server to return its name. +```admonish warning +The bot must be present in the server to return its name. +``` ## Example ``` @@ -17,13 +19,14 @@ $nomention Server Name: $serverName[$guildID] ``` -``` discord yaml +```discord yaml - user_id: 803569638084313098 username: RainbowKey color: "#E67E22" content: | !example - username: BDFD Support + user_id: 1009018156494368798 color: "#378afa" bot: true verified: true diff --git a/src/bdscript/serverOwner.md b/src/bdscript/serverOwner.md index 56bf4ecbd32..5b9b060a1b0 100644 --- a/src/bdscript/serverOwner.md +++ b/src/bdscript/serverOwner.md @@ -23,7 +23,6 @@ This server is owned by <@$serverOwner>! color: "#378afa" bot: true verified: true - highlight: true content: | - This server is owned by <@RainbowKey>! + This server is owned by <@Kuba>! ``` diff --git a/src/bdscript/serverOwnerComplex.md b/src/bdscript/serverOwnerComplex.md index 6e0b7cb841e..eff28efd543 100644 --- a/src/bdscript/serverOwnerComplex.md +++ b/src/bdscript/serverOwnerComplex.md @@ -9,7 +9,9 @@ $serverOwner[Guild ID] ### Parameters - `Guild ID` `(Type: Snowflake || Flag: Required)`: The server to get the owner ID for. -> The bot must be present in the server in order to get the server owner ID. +```admonish warning +The bot must be present in the server in order to get the server owner ID. +``` ## Example ``` @@ -29,8 +31,7 @@ This server is owned by <@$serverOwner[$guildID]>! bot: true verified: true content: | - This server is owned by <@RainbowKey>! - highlight: true + This server is owned by <@Kuba>! ``` ```admonish question title="What is this?" diff --git a/src/bdscript/serverRegion.md b/src/bdscript/serverRegion.md index dd83280957c..e45e8797770 100644 --- a/src/bdscript/serverRegion.md +++ b/src/bdscript/serverRegion.md @@ -3,10 +3,10 @@ Deprecated -> This function is deprecated, because Discord removed the server region setting. For more information, [click here](https://support.discord.com/hc/en-us/articles/360060570993). - Returns the server's region. +> This function is deprecated, because Discord removed the server region setting. For more information, [click here](https://support.discord.com/hc/en-us/articles/360060570993). + ## Syntax ``` $serverRegion diff --git a/src/bdscript/serverVerificationLvl.md b/src/bdscript/serverVerificationLvl.md index 4dc0dae1432..baf3c3bb53b 100644 --- a/src/bdscript/serverVerificationLvl.md +++ b/src/bdscript/serverVerificationLvl.md @@ -18,7 +18,8 @@ This server's verification level is $serverVerificationLvl color: "#E67E22" content: | !example -- username: BDFD Support +- user_id: 1009018156494368798 + username: BDFD Support color: "#378afa" bot: true verified: true diff --git a/src/bdscript/splitText.md b/src/bdscript/splitText.md index be9218aff2e..8e4ed847734 100644 --- a/src/bdscript/splitText.md +++ b/src/bdscript/splitText.md @@ -38,4 +38,8 @@ $textSplit[hello world !; ] ```admonish question title="What is this?" How [`$textSplit[]`](./textSplit.md) works? -``` \ No newline at end of file +``` + +```admonish info title="Read more" +For more information, read the [Text Splitting Guide](../guides/general/textSplitting.md). +``` diff --git a/src/bdscript/startThread.md b/src/bdscript/startThread.md index adbdb3a29c1..09027d6b537 100644 --- a/src/bdscript/startThread.md +++ b/src/bdscript/startThread.md @@ -3,23 +3,51 @@ Creates a new thread in the provided channel. ## Syntax ``` -$startThread[Name;Channel ID;Message ID;(Archive duration;Return thread/channel ID?)] +$startThread[Thread name;Channel ID;Message ID;(Archive duration;Return thread ID?)] +``` + +```admonish info +Required permissions that the bot must have for this function to work properly: +- `createpublicthreads` ``` ### Parameters -- `Name` `(Type: String || Flag: Required)`: The name of the newly created thread. +- `Thread name` `(Type: String || Flag: Required)`: The name of the newly created thread. - `Channel ID` `(Type: Snowflake || Flag: Required)`: The channel where the thread will be created. - `Message ID` `(Type: Snowflake || Flag: Emptiable)`: The message from which the thread will be created. Can be left empty. -- `Archive duration` `(Type: Integer || Flag: Optional)`: The duration after which the thread will be auto-archived due to inactivity. Accepts `60` (1 hour), `1440` (1 day), `4320` (3 days), or `10080` (7 days) as input. Defaults to `60`. -- `Return thread/channel ID?` `(Type: Bool || Flag: Optional)`: Whether to return the thread channel ID or not. Defaults to `no`. +- `Archive duration` `(Type: Integer || Flag: Optional)`: The [archive duration](#archive-duration) after which the thread will be auto-archived due to inactivity. Defaults to `60`. +- `Return thread ID?` `(Type: Bool || Flag: Optional)`: Whether to return the thread channel ID or not. Defaults to `no`. -### Permissions -Required permissions that the bot must have for this function to work properly: -- `createpublicthreads` +### Archive Duration +`60` - 1 Hour\ +`1440` - 1 Day\ +`4320` - 3 Days (Only for servers with level 1 boosted)\ +`10080` - 7 Days (Only for servers with level 2 boosted) ## Example ``` $nomention I created a new thread! <#$startThread[Cool Thread;$channelID;;1440;yes]> ``` -![example](https://user-images.githubusercontent.com/69215413/128615731-c61c95c1-d1ec-42cf-9964-e8722df30dfe.png) + +``` discord yaml +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example +- type: thread + content: | + BDFD Support Started a thread: Cool Thread. See all threads. +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" + bot: true + verified: true + content: | + I created a new thread! <#Cool Thread> +``` + +```admonish info title="Read more" +For more information, read the [Threads Guide](../guides/general/threads.md). +``` diff --git a/src/bdscript/takeRole.md b/src/bdscript/takeRole.md index 32296a5ed6c..96bb9862d04 100644 --- a/src/bdscript/takeRole.md +++ b/src/bdscript/takeRole.md @@ -3,12 +3,12 @@ Deprecated +Removes a role from the provided/mentioned user. + > As of December 2021, this function has been deprecated in favor of [`$roleGrant[]`](./roleGrant.md). > In order to remove a role from a user, the bot must have the `manageroles` permission. -Removes a role from the provided/mentioned user. - ## Syntax ``` $takeRole[User/Role ID;(Role ID)] diff --git a/src/bdscript/textSplit.md b/src/bdscript/textSplit.md index 5a6201f9293..0257eadc181 100644 --- a/src/bdscript/textSplit.md +++ b/src/bdscript/textSplit.md @@ -1,8 +1,6 @@ # $textSplit Splits the provided text by a given separator and saves the value temporarily. -> 📌 To retrieve the split values, use [`$splitText`](./splitText.md). - ## Syntax ``` $textSplit[Text;Separator] @@ -12,20 +10,32 @@ $textSplit[Text;Separator] - `Text` `(Type: String || Flag: Emptiable)`: The text to split. - `Separator` `(Type: String || Flag: Emptiable)`: The separator to split the text with. If this parameter is empty, it separates the text by each character. -### Example +## Example ``` $nomention -$textSplit[Coffee, Tea, Milk;,] -$splitText[1] +$textSplit[Hello-world-!;-] +> $splitText[2] +``` + +``` discord yaml +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" + bot: true + verified: true + content: | + world ``` -![Screenshot_20221029_203537](https://user-images.githubusercontent.com/95774950/198839569-338c0892-80ef-4e7a-bbb7-dd696c6ab15b.png) -###### _In the above example, [`$textSplit`](#textsplit) splits the provided text using a comma (`,`) as the separator. After that, [`$splitText`](./splitText.md) is used to retrieve the first split value._ +```admonish question title="What is this?" +How [`$splitText[]`](./splitText.md) works? +``` -## Related Resources -- [Text Splitting Guide](../guides/general/textSplitting.md) -- [$getTextSplitIndex](./getTextSplitIndex.md) -- [$getTextSplitLength](./getTextSplitLength.md) -- [$joinSplitText](./joinSplitText.md) -- [$removeSplitTextElement](./removeSplitTextElement.md) -- [$splitText](./splitText.md) +```admonish info title="Read more" +For more information, read the [Text Splitting Guide](../guides/general/textSplitting.md). +``` \ No newline at end of file diff --git a/src/bdscript/threadAddMember.md b/src/bdscript/threadAddMember.md index ceedb6649ef..7fc83bcc60a 100644 --- a/src/bdscript/threadAddMember.md +++ b/src/bdscript/threadAddMember.md @@ -13,14 +13,24 @@ $threadAddMember[Thread ID;User ID] ## Example ``` $nomention -$var[thread;$startThread[Cool Thread;$channelID;;60;yes]] -$threadAddMember[$var[thread];$authorID] +$threadAddMember[1021054508975009793;$authorID] ``` -![example1](https://user-images.githubusercontent.com/69215413/130260166-768cb59f-2377-49e3-9588-6425028484d9.png)\ -![example2](https://user-images.githubusercontent.com/69215413/130260148-0c6b54ec-96ea-4f94-9aee-8a583667d80d.png) -## Related Resources -- [Threads Guide](../guides/threads.md) -- [$editThread](./editThread.md) -- [$startThread](./startThread.md) -- [$threadRemoveMember](./threadRemoveMember.md) +``` discord yaml +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example +``` +- In the thread: + +``` discord yaml +- type: join + content: | + BDFD Support added RainbowKey to the thread. +``` + +```admonish info title="Read more" +For more information, read the [Threads Guide](../guides/general/threads.md). +``` diff --git a/src/bdscript/threadMessageCount.md b/src/bdscript/threadMessageCount.md index 597eefe233e..3077d007713 100644 --- a/src/bdscript/threadMessageCount.md +++ b/src/bdscript/threadMessageCount.md @@ -41,3 +41,7 @@ This thread has a total of $threadMessageCount messages sent! content: | Nice! ``` + +```admonish info title="Read more" +For more information, read the [Threads Guide](../guides/general/threads.md). +``` diff --git a/src/bdscript/threadRemoveMember.md b/src/bdscript/threadRemoveMember.md index 4b2f405dd91..75c4d0caa31 100644 --- a/src/bdscript/threadRemoveMember.md +++ b/src/bdscript/threadRemoveMember.md @@ -11,14 +11,21 @@ $threadRemoveMember[Thread ID;User ID] - `User ID` `(Type: Snowflake || Flag: Required)`: The user to remove from the thread. ## Example +``` discord yaml +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example ``` -$nomention -$threadRemoveMember[878305123707785218;$authorID] +- In the thread: + +``` discord yaml +- type: leave + content: | + BDFD Support removed RainbowKey from the thread. ``` -![example](https://user-images.githubusercontent.com/69215413/130261147-1d44af9b-a951-4286-88a3-1908702d3fe0.png) -## Related Resources -- [Threads Guide](../guides/threads.md) -- [$editThread](./editThread.md) -- [$startThread](./startThread.md) -- [$threadAddMember](./threadAddMember.md) +```admonish info title="Read more" +For more information, read the [Threads Guide](../guides/general/threads.md). +``` diff --git a/src/bdscript/threadUserCount.md b/src/bdscript/threadUserCount.md index b31fd1279da..e1c8305aa9e 100644 --- a/src/bdscript/threadUserCount.md +++ b/src/bdscript/threadUserCount.md @@ -26,3 +26,7 @@ This thread has $threadUserCount users! content: | This thread has 29 users! ``` + +```admonish info title="Read more" +For more information, read the [Threads Guide](../guides/general/threads.md). +``` diff --git a/src/bdscript/unmute.md b/src/bdscript/unmute.md index 40af230eb27..06c66ccff34 100644 --- a/src/bdscript/unmute.md +++ b/src/bdscript/unmute.md @@ -2,13 +2,13 @@
Deprecated
- -```admonish warning -As of December 2021, this function has been deprecated in favor of [`$untimeout[]`](./untimeout.md). -``` Unmutes the mentioned user. +```admonish warning +As of December 2021, this function has been deprecated in favor of [`$untimeout[]`](./untimeout.md). +``` + ## Syntax ``` $unmute[Muted Role Name] diff --git a/src/bdscript/userJoinedDiscord.md b/src/bdscript/userJoinedDiscord.md index 91fb39a3c6e..ea9bfb839bc 100644 --- a/src/bdscript/userJoinedDiscord.md +++ b/src/bdscript/userJoinedDiscord.md @@ -2,25 +2,25 @@
Deprecated
- -```admonish warning -As of November 2022, this function has been deprecated in favor of [`$creationDate[]`](./creationDate.md). -``` Returns the account creation date of a given user. +```admonish warning +As of November 2022, this function has been deprecated in favor of [`$creationDate[]`](./creationDate.md). +``` + ## Syntax ``` $userJoinedDiscord[ID;(Format)] ``` - -```admonish info -Uses GoLang date format. -``` - -```admonish tip -Besides user IDs, `$userJoinedDiscord[]` can also return the creation date of any valid Discord Snowflake ID. -``` + +```admonish info +Uses GoLang date format. +``` + +```admonish tip +Besides user IDs, `$userJoinedDiscord[]` can also return the creation date of any valid Discord Snowflake ID. +``` ### Parameters - `ID` `(Type: Snowflake || Flag: Required)`: The user/channel/role/guild/message id whose creation date will be returned. @@ -46,10 +46,10 @@ $userJoinedDiscord[$authorID] content: | 2021-01-26 ``` - -~~~admonish example -Example with custom format: +~~~admonish example + +Example with custom format: ``` $nomention @@ -70,8 +70,8 @@ $userJoinedDiscord[$authorID;January 2, 2006 at 3:04 PM (MST -07:00)] content: | January 26, 2021 at 10:18 AM (UTC +00:00) ``` - -~~~ + +~~~ ```admonish question title="What is this?" How [`$authorID`](./authorID.md) works? diff --git a/src/bdscript/var.md b/src/bdscript/var.md index 49bd048b3bf..46b07dd5a3c 100644 --- a/src/bdscript/var.md +++ b/src/bdscript/var.md @@ -1,8 +1,8 @@ # $var Creates a temporary variable. -Unlike it's counterpart variables (i.e [`$setVar`](./setVar.md), [`$setUserVar`](./setUserVar.md) etc.) which needs you to create a variable in the app, [`$var[]`](./var.md) doesn't require you to do that. -Instead, it creates the variable automatically during it's runtime and gets deleted once the command execution terminates. +Unlike its counterpart variables (e.g. [`$setVar`](./setVar.md), [`$setUserVar`](./setUserVar.md), etc.) which require you to create a variable in the app, [`$var[]`](./var.md) doesn't require that. +Instead, it creates the variable automatically during its runtime and deletes it once the command execution terminates. The data stored in the temporary variable can only be retrieved during its execution period and is removed once it's finished. @@ -17,7 +17,7 @@ $var[Name;(Value)] ### Parameters - `Name` `(Type: String || Flag: Required)`: The name of the temporary variable. -- `Value` `(Type: String || Flag: Vacantable)`: The data to store. +- `Value` `(Type: String || Flag: Vacantable)`: The data to store. ```admonish info To retrieve the temporary stored value, type `$var[Name]`, where *"Name"* is the temporary variable name. @@ -33,4 +33,4 @@ $addButton[no;interactionID;Example;secondary;;;$var[ID]] ```admonish info title="Read more" For more information, read the [Variables Guide](../guides/introduction/variables.md). -``` +``` \ No newline at end of file diff --git a/src/entityTransferPolicy.md b/src/entityTransferPolicy.md deleted file mode 100644 index 7e9131e4acf..00000000000 --- a/src/entityTransferPolicy.md +++ /dev/null @@ -1,41 +0,0 @@ - - -# Context - -- Bot Designer for Discord is a service provided by NilPointer Software. -- "Our service" refers to "Bot Designer for Discord". -- "Bot" refers to data held by BDFD describing the behaviour of a [Discord Bot](https://discord.com/developers/docs) on our service. -- "Hosting time" refers to the time duration left of a singular bot during which it will be hosted by our service. -- "Premium point" refers to BDFD premium in-app currency, granting users the ability for bots to have extended functionality for a limited time. -- "Premium time" refers to the time duration left for a singular bot during which it can access the extended functionality. - Premium time is related, but not strictly linked, with hosting time. Premium time might end before hosting time, but not vice-versa. -- "Promocode" or "promo code" refers to a randomly generated string of characters used to gain hosting or premium time. -- "BDFD entity" or "entity" refers to any piece of data that is being held by BDFD, that ownership of it or itself can be transferred. - In this policy, "entity" mainly refers to bots, hosting and premium time, and premium points. -- "Transfer request" refers to a request made by a user to BDFD developers for an entity transfer. - These requests can be made through a ticket on our [official Discord server](https://discord.gg/botdesigner). - -# Policy - -- Entities that can be transferred can only be transferred through a transfer request by the user that holds ownership of that entity. -- Requesting users must provide proof of ownership of the entities in question for the request to be granted. -- BDFD Accounts can not be transferred in any way. - -- Bots can only be transferred between BDFD accounts owned by a single user. -- Bot after its transfer retains any hosting or premium time the bot in question had left. -- A bot previously not assigned to any BDFD account can be transferred to an account of the user that holds ownership over the bot in question. - -- Premium points can be transferred between BDFD accounts owned by a single user. -- Premium points can be donated for a giveaway promotion on our [official Discord server](https://discord.gg/botdesigner). - -- Hosting and Premium time can only be transferred between bots owned by a single user. -- Hosting and Premium time can not be transferred to a promocode. -- Only premium time can be donated for a giveaway promotion on our [official Discord server](https://discord.gg/botdesigner). - ---- - -_Effective Date: 10 August, 2023._ diff --git a/src/guides/general/threads.md b/src/guides/general/threads.md index 6b52af8363b..b7e41071830 100644 --- a/src/guides/general/threads.md +++ b/src/guides/general/threads.md @@ -1,19 +1,21 @@ # Threads In this section, you'll learn how to integrate threads in your bot. - + ```admonish warning Make sure your bot has `SEND_MESSAGES_IN_THREADS` permission. -``` +``` ## Content -[**Functions Used**](#functions-used) > [**Archive Duration**](#archive-duration) > [**$startThread[]**](#startthread) > [**$editThread[]**](#editthread) > [**$threadAddMember[]**](#threadaddmember) > [**$threadRemoveMember[]**](#threadremovemember) > [**Simple Code**](#simple-code) +[**Functions Used**](#functions-used) > [**Archive Duration**](#archive-duration) > [**$startThread[]**](#startthread) > [**$editThread[]**](#editthread) > [**$threadAddMember[]**](#threadaddmember) > [**$threadRemoveMember[]**](#threadremovemember) > [**$threadUserCount[]**](#threadusercount) > [**$threadMessageCount[]**](#threadmessagecount) > [**Simple Code**](#simple-code) ## Functions Used - [`$startThread[]`](../../bdscript/startThread.md) - [`$editThread[]`](../../bdscript/editThread.md) - [`$threadAddMember`](../../bdscript/threadAddMember.md) - [`$threadRemoveMember[]`](../../bdscript/threadRemoveMember.md) +- [`$threadUserCount`](../../bdscript/threadUserCount.md) +- [`$threadMessageCount[]`](../../bdscript/threadMessageCount.md) ## Archive Duration `60` - 1 Hour\ @@ -28,11 +30,11 @@ Creates a new thread in the provided channel. ``` $startThread[Thread name;Channel ID;Message ID;(Archive duration;Return thread ID?)] ``` - + ```admonish info Required permissions that the bot must have for this function to work properly: - `createpublicthreads` -``` +``` ### Parameters - `Thread name` `(Type: String || Flag: Required)`: The name of the newly created thread. @@ -81,10 +83,10 @@ $editThread[Thread ID;(Thread name;Archived?;Archive duration;Locked?;Slowmode)] - `Archive duration` `(Type: Integer || Flag: Optional)`: The [archive duration](#archive-duration) after which the thread will be auto-archived due to inactivity. Defaults to `60`. - `Locked?` `(Type: Bool || Flag: Optional)`: Whether to lock this thread or not. Note that archived threads can't be locked. - `Slowmode` `(Type: Integer || Flag: Optional)`: The slowmode of this channel, expressed in seconds. - + ```admonish tip Use `!unchanged` as an argument for the option to remain in its current state. -``` +``` ## Example ``` @@ -165,6 +167,79 @@ $threadRemoveMember[Thread ID;User ID] ``` \ +# $threadUserCount +Returns the total number of users in the current thread. + +## Syntax +``` +$threadUserCount +``` + +## Example +``` +$nomention +This thread has $threadUserCount users! +``` + +```discord yaml +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" + bot: true + verified: true + content: | + This thread has 29 users! +``` + +# $threadMessageCount +Returns the total number of messages in the current thread. (**not including bot's response**) + +## Syntax +``` +$threadMessageCount +``` + +## Example +``` +$nomention +This thread has a total of $threadMessageCount messages sent! +``` + +```discord yaml +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + Hello guys! +- user_id: 390515191819010058 + username: kubastick + color: "#FF0000" + content: | + Hello RainbowKey! 👋 +- user_id: 803569638084313098 + username: RainbowKey + color: "#E67E22" + content: | + !example +- user_id: 1009018156494368798 + username: BDFD Support + color: "#378afa" + bot: true + verified: true + content: | + This thread has a total of 3 messages sent! +- user_id: 390515191819010058 + username: kubastick + color: "#FF0000" + content: | + Nice! +``` + # Simple Code ``` $nomention @@ -197,7 +272,8 @@ $threadAddMember[$var[id];$authorID] content: | BDFD Support added RainbowKey to the thread. ``` - -```admonish note + +```admonish note If you want to learn more about threads, read [Discord's support article](https://support.discord.com/hc/en-us/articles/4403205878423-Threads-FAQ). -``` + +``` diff --git a/src/premium/sendNotification.md b/src/premium/sendNotification.md index 6ac03a04a51..fb91d8f4edf 100644 --- a/src/premium/sendNotification.md +++ b/src/premium/sendNotification.md @@ -4,14 +4,10 @@ Sends a notification to your mobile phone. - -```admonish warning title="Limit" -Can be used every 20 minutes. -``` - -```admonish warning title="Limit" -Only for Android. Can't be used on iOS. -``` + +```admonish warning title="Limit" +Can be used every 20 minutes. +``` ## Syntax ``` @@ -28,8 +24,8 @@ $nomention $sendNotification[Hello world!;$authorAvatar] ``` -![example](https://i.imgur.com/yfSTLVY.png) - -```admonish question title="What is this?" -How [`$authorAvatar`](../bdscript/authorAvatar.md) works? +![example](https://i.imgur.com/yfSTLVY.png) + +```admonish question title="What is this?" +How [`$authorAvatar`](../bdscript/authorAvatar.md) works? ``` diff --git a/src/resources/api.md b/src/resources/api.md index 2993765867c..ed3c1250a87 100644 --- a/src/resources/api.md +++ b/src/resources/api.md @@ -5,7 +5,21 @@ Public Bot Designer for Discord API. summary { background: hsl(0deg 0% 100% / 5%) !important; } - + +.code-container { + background: transparent !important; +} + +.line-numbers { + display: none !important; + visibility: hidden !important; + border: none !important; +} + +.line-number { + display: none !important; +} + .mainAPI, .endpoint { background: var(--card-bg); border-radius: var(--border-radius); @@ -223,36 +237,36 @@ Read more about intents in the our "[Gateway Intents](../guides/introduction/gat ``` ## Data Structures -- `Can be empty` means the field can be set to a default value. -- `Can be omitted` means the field might not be included in the response. +- `Can be empty?` means the field can be set to a default value. +- `Can be omitted?` means the field might not be included in the response. ### Function -| Field name | Type | Description | Can be empty | Can be omitted | -|------------------|---------------------------------|--------------------------------------------------------|--------------|----------------| -| tag | String | Function name | False | False | -| shortDescription | String | Description for a function without arguments | True | False | -| longDescription | String | Description for a function with arguments | True | False | -| arguments | Array of [Arguments](#Argument) | Arguments needed by a function | True | False | -| intents | Integer | Discord intents needed by bot to execute this function | False | False | -| premium | Bool | function needs premium | False | False | -| deprecated | Bool | function is deprecated | False | True | -| deprecatedFor | String | Name of the function that should be used instead | False | True | +| Field name | Type | Description | Can be empty? | Can be omitted? | +|------------------|---------------------------------|--------------------------------------------------------|---------------|----------------| +| tag | String | Function name | False | False | +| shortDescription | String | Description for a function without parameters | True | False | +| longDescription | String | Description for a function with parameters | True | False | +| arguments | Array of [Parameters](#parameters) | Parameters needed by a function | True | False | +| intents | Integer | Discord intents needed by bot to execute this function | False | False | +| premium | Bool | Function needs premium | False | False | +| deprecated | Bool | Function is deprecated | False | True | +| deprecatedFor | String | Name of the function that should be used instead | False | True | -### Argument -| Field name | Type | Description | Can be omitted | +### Parameters +| Field name | Type | Description | Can be omitted? | |-------------|------------------------------------------|---------------------------------------------------------------------------------------------|----------------| -| name | String | Argument name | False | -| description | String | Description for a function's argument | True | -| type | String [Argument Types](#Argument-Types) | Argument type. `\|` is used for a compound type | False | -| required | bool | Argument is required | False | -| tupleTypes | Array of [Arguments](#Argument) | Array of arguments which can be repeated, i.e `channelID;messageID;channelID;messageID;...` | True | -| empty | Bool | Argument can be empty | True | -| ellipsis | Bool | Argument accepts more data, i.e `username1;username2;username3;...` | True | -| enumData | Array of Strings | Possible options accepted as argument, i.e `primary/secondary/or/etc` | True | +| name | String | Parameter name | False | +| description | String | Description for a function's parameter | True | +| type | String [Parameter Types](#parameter-types) | Parameter type. `\|` is used for a compound type | False | +| required | bool | Parameter is required | False | +| tupleTypes | Array of [Parameters](#parameters) | Array of parameters which can be repeated, i.e `Channel ID;Message ID;Channel ID;Message ID;...` | True | +| empty | Bool | Parameter can be empty | True | +| ellipsis | Bool | Parameter accepts more data, i.e `Username 1;Username 2;Username 3;...` | True | +| enumData | Array of Strings | Possible options accepted as parameter, i.e `primary/secondary/or/etc` | True | -### Argument Types +### Parameter Types Multiple types can be merged together with `|` *(OR)*. \ -Possible argument types: +Possible parameter types: - `String` - `Integer` - `Float` @@ -267,3 +281,6 @@ Possible argument types: - `Tuple` + + + diff --git a/src/resources/timeFormat.md b/src/resources/timeFormat.md index a5af41e10eb..ae336cdbf82 100644 --- a/src/resources/timeFormat.md +++ b/src/resources/timeFormat.md @@ -2,7 +2,7 @@ Custom time formatting values for [`$creationDate[]`](../bdscript/creationDate.md), [`$userJoinedDiscord[]`](../bdscript/userJoinedDiscord.md) and [`$userJoined[]`](../bdscript/userJoined.md) functions. ### Time Formats -List of supported time format values : +List of supported time format values: Value | Return Information --------------- | ---------------------------------------- @@ -35,5 +35,8 @@ MST | Timezone name -070000[^1] | Timezone offset (±hhmmss) -07:00:00[^1] | Timezone offset (±hh:mm:ss) -> All time format values are case insensitive (i.e both `MOH` and `Mon` will work). +```admonish info +All time format values are case insensitive (i.e both `MOH` and `Mon` will work). +``` + [^1]: Replacing the sign in the format with a Z character triggers the ISO 8601 behavior of printing Z instead of an offset for the UTC (+00:00) zone. diff --git a/src/settings.md b/src/settings.md index 3262721b381..8e557771e5b 100644 --- a/src/settings.md +++ b/src/settings.md @@ -1,13 +1,4 @@ -
- - - Experimental Feature! - If you encountered an error, please contact us on the official BDFD Support Server. - -
- # Settings - Let's customize your experience in our Bot Designer For Discord wiki world! diff --git a/src/termsAndPrivacy.md b/src/termsAndPrivacy.md new file mode 100644 index 00000000000..be76172f413 --- /dev/null +++ b/src/termsAndPrivacy.md @@ -0,0 +1,149 @@ +# Terms & Privacy +Review our Terms of Service and Privacy Policy. These legal documents outline the rules for using our service and how we collect, use, and protect your data. + + + + diff --git a/src/tools/json.md b/src/tools/json.md new file mode 100644 index 00000000000..481a97141a7 --- /dev/null +++ b/src/tools/json.md @@ -0,0 +1,8 @@ + + +

Redirecting to https://bdfd-tool.github.io/bdfd-wiki/nightly/tools/json.html

+ \ No newline at end of file