+
+ );
+};
+
+export default Arg;
diff --git a/components/badge.tsx b/components/badge.tsx
new file mode 100644
index 00000000..9d8f0107
--- /dev/null
+++ b/components/badge.tsx
@@ -0,0 +1,41 @@
+import type { ReactNode } from 'react';
+
+type BadgeType = 'tip' | 'info' | 'warning' | 'danger';
+
+const styles: Record
+
+
+ {isRequired ? (
+ "Required Argument"
+ ) : (
+ <>
+ Optional Argument
+ {isCode ? (
+
+
+
+ Default:
+ ) : (
+ {defaultValue}
+ Default: {defaultValue}
+ )}
+
+ )}
+ {name}
+ + +This function is commonly used to programmatically access the bot's ID within custom commands or other bot logic. + +Here's an example of how it works in practice: + +
+ +Here's an example of how to use the `$ping` command in Discord: + +
+ +**Example:** + +```cc +!!exec $ram MB +``` + +**Bot Response:** + +``` +2143.55 MB +``` + +This indicates that the bot is currently using approximately 2143.55 MB of RAM. + +**Function Difficulty:**
+**Example:** +
+ +Here's an example of how it works: + +
+ +**Example:** + +
+
+ +**Example:** + +```cc +!!exec $channelExists[889102524727058463] +``` + +``` +true +``` + +
+ +**Example:** + +```cc +!!exec $channelID +``` + +``` +839090554205241394 +``` + +**Explanation:** The bot returns the channel ID where the `!!exec` command was used. + +
+ +**Example with channel name:** + +Let's say you have a channel named `#general`. You can get its ID like this: + +```cc +!!exec $channelID[general] +``` + +If a channel named `general` exists, the output will be its ID. + +
+ +**Example:** + +
+ +**Example:** + +
+ +**Example:** + +This example demonstrates how to send a message informing the user about the ticket closure, wait for a short period, and then close the ticket. + +```cc +$sendmessage[This ticket will be closed in 5 seconds.] +$wait[5s] +$closeTicket +``` + +**Explanation:** + +* `$sendmessage[This ticket will be closed in 5 seconds.]`: Sends a message to the ticket channel informing the user that the ticket will be closed shortly. +* `$wait[5s]`: Pauses the script execution for 5 seconds, giving the user a chance to read the message. +* `$closeTicket`: Closes the ticket channel. + +**Difficulty:**
+ +
+You're not on cooldown! +
+You're not on cooldown! +
+$clearCooldown
+No cooldown +
+$clearCooldown
+No cooldown 2nd try +
+You're not on cooldown! +
+You're not on cooldown! +
+$getCooldownTime[5m;channel;$channelID] +
+You're not on cooldown! +
+You're not on cooldown! +
+ +**Example:** + +
+ +
+ +
+ +
+
+ +
+ +
+ +**Example:** + +This example demonstrates converting 1000 milliseconds to a time duration. + +
+ +
+ +**Example:** + +
$imageBorderRad[50]
$imageFill[red;100;100;100;100]
$image[$imageOutput]
+
$imageFill[red]
$image[$imageOutput]
+
$imageLoadFromURL[avatar;$replaceText[$authorAvatar;webp;png]]
$imageCrop[avatar;0;0;100;100] // crop the image from position (0, 0) with size 100
$imageDraw[avatar]
$image[$imageOutput]
+
$imageLoadFromURL[avatar;$replaceText[$authorAvatar;webp;png]] // Load Avatar as "avatar"
$imageDraw[avatar;0;0;300;300] // Draw "avatar" at (0,0) with width 300 and height 300
$image[$imageOutput]
+
$imageLoadFromURL[avatar;$replaceText[$authorAvatar;webp;png]]
$imageFill[gray]
$imageFill[transparent;100;100;100;100]
$imageDrawBack[avatar;50;50;200;200]
$image[$imageOutput]
+
$imageFill[gray]
$image[$imageOutput]
+
$imageFill[gray]
$imageFill[red;100;100;50;50]
$image[$imageOutput]
+
$imageLoadEmoji[mycheese;:cheese:]
$imageBorderRad[100]
$imageFill[gray;50;50;200;200]
$imageDraw[mycheese;100;100;100;100]
$image[$imageOutput]
+
$imageLoadEmoji[seed;<:seed:1149808771888062605>]
$imageLoadEmoji[cheese;:cheese:]
$imageBorderRad[100]
$imageFill[gray;50;200;200;200]
$imageFill[gray;350;200;200;200]
$imageDraw[cheese;100;250;100;100]
$imageDraw[seed;400;250;100;100]
$image[$imageOutput]
+
+$imageLoadFromURL[avatar;$replaceText[$authorAvatar;webp;png]] // Load the author's avatar
+$imageDraw[avatar;0;0;300;300] // Draw the avatar onto the image frame
+$image[$imageOutput] // Output the resulting image
+
$imagePositionBase[centerleft]
$imageFill[white;center;center;100;100]
$imagePositionBase[centerright]
$imageFill[red;center;center;100;100]
$image[$imageOutput]
+
$imageCreate[300;300]
$imageLoadFromURL[avatar;$avatar]
$imageDraw[avatar;100;10;100;100]
$imageSetOpacity[50]
$imageDraw[avatar;100;190;100;100]
$image[$imageOutput]
+
$imagePositionBase[center]
$imageStrokeWidth[10]
$imageStroke[red;center;center;50;50]
$image[$imageOutput]
+
$imagePositionBase[center]
$imageStrokeWidth[10]
$imageStroke[red;center;center;50;50]
$image[$imageOutput]
+
+
$imageTextSize[30]
$imageTextAlign[center]
$imageTextFill[CC is Awesome;150;150;#4461b3]
$image[$imageOutput]
+
+ $imageTextSize[30] +
+ $imageTextAlign[center] +
+ $imageTextStroke[CC is Awesome;150;150;#4461b3] +
+ $image[$imageOutput] +
+
+
$imageUseFont[Roboto]
$imageTextColor[white]
$imageTextSize[30]
$imageTextFill[Hello World;20;50]
$stop[\{image:$imageOutput}] +
+ +**Explanation:** + +This function allows you to remove an interaction reply. If you don't specify a message ID, it will delete the most recent interaction reply sent within the command. + +**Parameters:** + +* `message ID` (Optional): The ID of the message you want to delete. If left blank, it defaults to deleting the last interaction reply sent by the bot in that command execution. + +**Example:** + +To delete the previous interaction reply: + +```cc +$interactionDelete +``` + +To delete a specific interaction reply by its ID: + +```cc +$interactionDelete[123456789012345678] +``` + +**Function difficulty:**
+ +
+ +
+ +##### **type** + +Specifies the input type for the input. + +* **`short` (Default):** A single-line text input field. +* **`long`:** A multi-line text area for longer responses. +* **`menu/user/role/mention/channel`:** A dropdown selection menu instead of a text field. +* **`attachment/attach`:** A file upload input field. +* **`radio`:** A multiple choice list where only **one** item can be selected (Min 2 options, Max 10). +* **`checkbox`:** A multiple choice list where **several** items can be checked (Min 1 option, Max 10). + +#### Max Amount of Inputs + +You can include multiple input fields, up to a maximum of 5 total (for example: 2 text inputs, 1 attachment input, and 2 radio/checkbox fields). + +### Example +#### Code + + +#### Output + + +### Example With Menu +#### Code + + +#### Output + + +
+
+
+Message +
+To have all members cached, you will need Tier 5 Bot. + +
+
+
+
+
+
+
Mido joined the server at: $memberJoinedDate[$user_id]
+
+To have all members cached, you will need Tier 5 Bot. + +
+Other user: $mention[123456789123456789] +
+Other user:
+ +Returns the status of a user. Can be `online`, `offline`, `idle` or `dnd`. + +## Usage + +```cc +$status[userID] +``` +1. **userID** - (Optional) default value: `$authorID`. The ID of user to return the status from. + +## Example + +#### Using $status + +How to use $status + +
+
+
++
+
++To have all members cached, you will need Tier 5 Bot. + +
+To have all members cached, you will need Tier 5 Bot. + +
+To have all members cached, you will need Tier 5 Bot. + +
]
++To have all members cached, you will need Tier 5 Bot. + +
+To have all members cached, you will need Tier 5 Bot. + +
+To have all members cached, you will need Tier 5 Bot. + +
+To have all members cached, you will need Tier 5 Bot. + +
+To have all members cached, you will need Tier 5 Bot. + +
+To have all members cached, you will need Tier 5 Bot. + +
+ +
+ +
+ +This function allows you to add multiple reactions to the message the bot just sent. Simply list the emojis you want to use, separated by semicolons. + +
+
+ +
+
+ +**Difficulty:**
+ +**Example:** + +**Command Input:** +```cc +!!exec $dm[$authorID] This is a fantastic message! +``` + +
+ +**Function difficulty:**
+ +
+ +#### Example: + +This example demonstrates how `$messageAttachment` can be used. + +
+ +**Example:** + +Let's say you want to check if a message with the ID `123456789012345678` exists in the channel with the ID `987654321098765432`. + +
+ +Here's a simple example demonstrating how to use `$messageFlags`: + +
+ +**Example:** + +Let's say the message sent is: `!!exec a b c d e` + +
+ +**Another Example:** + +Using the same message: `!!exec a b c d e` + +
+ +**Example:** + +Here's how `$messageType` might be used in a custom command: + +
+ +
+ +
+ +**Function Difficulty:**
+
+ +
Total votes: $poll[$channelID;$messageID;votes]
Total answers: $poll[$channelID;$messageID;answers]
1st answer name: $poll[$channelID;$messageID;answer 1 name]
2nd answer name: $poll[$channelID;$messageID;answer 2 name]
1st answer votes: $poll[$channelID;$messageID;answer 1 votes]
+
+ +**Example 1: Sending a DM to the message author multiple times.** + +
+ +
+ +**Example:** + +```cc +!!exec $sendMessage[This is a fantastic message!;no] +``` + +
\{description: This is a fantastic message! \}
\{color:GREEN\}
] +
+ +
+ +**Example:** + +```cc +!!exec $random[1;6] +``` + +This command will return a random integer between 1 and 6 (inclusive). Possible outputs: 1, 2, 3, 4, 5, or 6. + +
+ +**Example:** + +```cc +!!exec $randomChannelID +``` + +**Result:** + +```cc +37907890789087988 +``` + +This will output a random channel ID from the server where the command is executed. The actual ID returned will, of course, be different each time. + +**Function Difficulty:**
+ +**Example:** + +This example shows how to use `$randomMention` to mention a random user in a command. + +
+ +**Example:** + +Here's how you can use `$randomRoleID` in a custom command: + +
+ +#### Example: + +This example demonstrates how to use `$randomString` to generate a 6-character random string. + +
+ +**Example:** + +```cc +$randomText[Hello;Hi;Hey] +``` + +This example will randomly return either "Hello", "Hi", or "Hey". + +
+ +
+
+
+
+ +
Another Picked Number: $random[1;6]
$resetRandom
Picked Number After Reset: $random[1;6] +
Another Picked Number: 5
Picked Number After Reset: 3 +
Response is $response
Response Status is $httpRequestStatus
+
Response Status is 200
+
+Content-Type Header: $httpRequestHeader[content-type] +
+Content-Type Header: application/json +
+Code: $httpRequestStatus +
+Code: 200 +
+ +**Example:** + +Let's say you have a command `!ban` and you want to prevent users with a specific role from using it. + +```cc +$blackListRoleIds[9872xx..;You are not authorized to use this command!] +$ban[$mentioned[1]] +Successfully banned user. +``` + +**Explanation:** + +* `$blackListRoleIds[9872xx..;You are not authorized to use this command!]`: This line checks if the user executing the command has the role with the ID `9872xx..`. If they do, the bot will reply with "You are not authorized to use this command!". +* `$ban[$mentioned[1]]`: This line executes the ban command, banning the mentioned user. It only executes if the user does *not* have a blacklisted role. +* `Successfully banned user.`: This line sends a confirmation message after a successful ban. + +
+
+
+ +**Example:** + +Let's say you want to get the color of the role with the ID `123456789012345678`. You would use: + +```cc +$getRoleColor[123456789012345678] +``` + +This would return the hex color code of the role, such as `#FF0000` (red). + +
+ +**Function Difficulty:**
+ +**Example:** + +This example grants the "Muted" role to the command executor. + +
+ +**Example:** + +This example shows how to retrieve the IDs of all roles in the guild. + +
+ +**Example:** + +Checks if the message author has the role with the ID `99871..xx`. + +
+ +**Function Difficulty:**
+ +**Example:** + +This example shows how to use `$highestRole` with `$roleName` to output the role's name. + +```cc +!!exec $roleName[$highestRole] +``` + +**Result:** + +(Assuming the user's highest role is "Admin") + +```cc +Admin +``` + +
+ +**Difficulty:**
+ +**Example:** + +This example retrieves the role ID of the user's lowest role and displays it. + +```cc +!!exec $roleName[$lowestRole] +``` + +**Explanation:** + +* `!!exec` is used to execute a custom command. +* `$lowestRole` retrieves the lowest role of the command executor. +* `$roleName` retrieves the ID of the role obtained from `$lowestRole`. + +**Discord Output:** + +```cc +Member +``` + +(The bot will output the role ID of the user's lowest role. This example only provides a placeholder "Member".) + +**Function Difficulty:**
+ +#### Example: + +
+ +**Example:** + +Let's create a custom command that announces the total number of roles in the server. + +
+ +**Example:** +
+ +**Example:** + +Let's say you have a role named "muted" in your server. The following example demonstrates how to retrieve its ID. + +
+ +#### Example: + +This example shows how to use the `$roleName` function to find the name of the role with the ID `869243918787686439`. + +
+ +**Example:** + +
+ +**Example Scenario:** + +Let's say you have a custom command that checks the position of the "Muted" role. + +
+ +**Example:** + +Sets the command executor's roles to only the "Muted" role. + +```cc +!!exec $setRoles[$authorID;$roleID[Muted]] +``` + +
+ +**Explanation:** + +* `!!exec`: Executes the command. Replace with your bot's command prefix. +* `$setRoles`: The function being used. +* `$authorID`: Gets the ID of the user who executed the command (using the `$authorID` function). +* `$roleID[Muted]`: Gets the ID of the role named "Muted" (using the `$roleID` function). + +
+ +
+ +
+ +**Example:** + +
+
+
+ +#### Example: + +
+
+
+
+
+
+ +
+ +
+
+ +
+ +
+ +
+
+
+
+
Before=$arrayJoin[, ]
$arrayClear
After=$arrayJoin[, ]
+
After= +
$arrayConcat[Azz/Finkz;/]
$arrayJoin[, ]
+
+
$arrayCount
+
1 is $arrayGet[1]
2 is $arrayGet[2]
3 is $arrayGet[3]
+
2 is Rake
3 is Azz +
Rake repeated $arrayElementCount[Rake] times
Mido repeated $arrayElementCount[Mido] times
Azz repeated $arrayElementCount[Azz] times
Faj repeated $arrayElementCount[Faj] times
+
Mido repeated 2 times
Azz repeated 1 times
Faj repeated 1 times +
For example, if your loop contains `$sendMessage[Hello world!]`, it will literally display as "$sendMessage[Hello world!]" because `$sendMessage` is not a zero-cooldown function. + +If you are looking to loop over non-zero cooldown functions, you should use `$forEach` instead. + +
$arrayFilter[value]\{
$if[$value==Hello]\{
false
}
}
$arrayJoin[/] +
First is $arrayGet[1]
Second is $arrayGet[2]
Third is $arrayGet[3]
+
Second is Rake
Third is Azz +
$arrayInclude[Rake]
+
$arrayJoin[, ]
+
$arrayLength
+
For example, if your loop contains `$sendMessage[Hello world!]`, it will literally display as "$sendMessage[Hello world!]" because `$sendMessage` is not a zero-cooldown function. + +If you are looking to loop over non-zero cooldown functions, you should use `$forEach` instead. + +
$arrayLoop[age]\{
age is $age
} +
age is 18
age is 21 +
For example, if your loop contains `$sendMessage[Hello world!]`, it will literally display as "$sendMessage[Hello world!]" because `$sendMessage` is not a zero-cooldown function. + +If you are looking to loop over non-zero cooldown functions, you should use `$forEach` instead. + +
$arrayMap[age]\{
age is $age
}
$arrayJoin[, ]
+
last one is $arrayPop
before it is $arrayPop
before it is $arrayPop
+
before it is Rake
before it is Mido +
$arrayPush[Rake]
$arrayPush[Azz]
$arrayJoin[/]
+
$arrayRemove[1;2;3]
$arrayGet[1]
+
$arrayReverse
$arrayJoin[/]
+
Mido is in position: $arraySearch[Mido]
Azz is in position: $arraySearch[Azz]
InvalidName is in position: $arraySearch[justsomeweirdrandom]
+
Azz is in position: 3
InvalidName is in position: -1 +
Before: $arrayGet[3]
$arraySet[3;Finkz]
After: $arrayGet[3]
+
After: Finkz +
first one is $arrayShift
after it is $arrayShift
after it is $arrayShift
+
after it is Rake
after it is Azz +
$arrayShuffle
$arrayJoin[/]
+
$arraySlice[2;3]
$arrayJoin[ ]
+
1.Azz
2.Rake
2.Rake
3.Mido
3.Mido
4.Finkz;
]
$arraySort[no;frequent]
+
3.Mido
2.Rake
4.Finkz
1.Azz
+
3.Mido
2.Rake
4.Finkz;
]
$arraySort[yes;num]
The sorted list is
$arrayJoin[
]
+
1. Azz
2.Rake
3.Mido
4.Finkz
+
1.Azz
2.Rake
4.Finkz;
]
$arraySort[yes;alpha]
The sorted list is
$arrayJoin[
]
+
1. Azz
4.Finkz
3.Mido
2.Rake +
$arrayUnique[, ]
+
$arrayUnshift[Rake]
$arrayUnshift[Azz]
$arrayJoin[/]
+
+ +## Example +(Add a simple button) + +(Add in new row) + +(Add disabled) + + +
+ +### Timeout +The maximum time the bot waits for a user to click a button.\ +Accepts time in the format `10s` for example.\ +The max time is `60 x (bot tier + 1)` seconds, for example for tier 3 it would be `240` seconds. + +
\{title: Test}
\{menu:
\{id=test}
\{placeholder=Select}
\{min=1}
\{max=1}
\{option=Mido}
\{desc=A guy}
\{value=mido}
\{option=Rake}
\{desc=Another guy}
\{value=rake}
}
;$authorID;;test]
+
If there's no button, return `undefined`. + +## Usage + +```cc +$buttonIsDisabled +``` + diff --git a/content/docs/(functions)/Text/Components/buttonLabel.mdx b/content/docs/(functions)/Text/Components/buttonLabel.mdx new file mode 100644 index 00000000..6673cfb8 --- /dev/null +++ b/content/docs/(functions)/Text/Components/buttonLabel.mdx @@ -0,0 +1,12 @@ +--- +title: "$buttonLabel" +--- + +Return the clicked button's label in the Button trigger. If the button doesn't have a label, return `undefined`. + +## Usage + +```cc +$buttonLabel +``` + diff --git a/content/docs/(functions)/Text/Components/buttonStyle.mdx b/content/docs/(functions)/Text/Components/buttonStyle.mdx new file mode 100644 index 00000000..89ee7783 --- /dev/null +++ b/content/docs/(functions)/Text/Components/buttonStyle.mdx @@ -0,0 +1,12 @@ +--- +title: "$buttonStyle" +--- + +Return the clicked button's style, e.g. `blurple`/`red`/`url` in the Button trigger. If none, `undefined` is returned. + +## Usage + +```cc +$buttonStyle +``` + diff --git a/content/docs/(functions)/Text/Components/buttonURL.mdx b/content/docs/(functions)/Text/Components/buttonURL.mdx new file mode 100644 index 00000000..1744f7a9 --- /dev/null +++ b/content/docs/(functions)/Text/Components/buttonURL.mdx @@ -0,0 +1,12 @@ +--- +title: "$buttonURL" +--- + +Return the clicked button's URL in Button trigger if it exists. Else, returns `undefined` if not found. + +## Usage + +```cc +$buttonURL +``` + diff --git a/content/docs/(functions)/Text/Components/disableButton.mdx b/content/docs/(functions)/Text/Components/disableButton.mdx new file mode 100644 index 00000000..4ebd87e2 --- /dev/null +++ b/content/docs/(functions)/Text/Components/disableButton.mdx @@ -0,0 +1,28 @@ +--- +title: "$disableButton" +--- + +Disables a button using its `(ID/label/Emoji/URL)`. + +## Usage +```cc +$disableButton[Message ID;Label/Emoji/URL/ID (optional, default: disables the last button); Channel ID (optional, default $channelID)] +``` + +##### Example +(Disable button by emoji) + +(Disable button by URL) + +(Disable button by ID) + +(Disable button by label) + +(Disable the last button ) + + +
+ +**Function difficulty:**
+ +
+ + + +**Function difficulty:**
+
+
+
+
+
+
+Oh, you are Tom!
+$endIf +
+
+Oh, you are Tom!
+$else
+You are not Tom!
+$endIf +
+
+Oh, you are Tom!
+$elseif[$username==Lisa]
+You are Lisa!
+$endelseIf
+$else
+I don't know you :C
+$endIf +
+
+Oh, you are Tom!
+$elseif[$username==Lisa]
+1.You are Lisa!
+$endelseIf
+$elseif[$username==Lisa]
+2.You are Lisa!
+$endelseIf
+$else
+I don't know you :C
+$endIf +
`||` is for OR +
`&&` is for AND + +Example: +```cc +$username==Mido&&$country==Egypt +``` +Condition 1: `$username==Mido` +Condition 2: `$country==Egypt` +But this expression will only be true only if both condition 1 **AND** (because of &&) condition 2 is `true` + +The Example below will execute since $username==Tom is false but the second expression is true .It wouldn't work with && +
+
+You are Tom or Lisa
+$endIf +
+You are Lisa with tag 9999
+$endIf
+
+
+$addField[title2;value2]
+$addField[title3;value3]
+$addField[title4;value4]
+
+
+
+
+
\{desc:You are awesome}
\{color:#0099ff}
] +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Your name is $objectGet[name]
Your age is $objectGet[age]
+
Your age is 110 +
+
+"Owner": "Rake",
+"Manager": "Mika",
+"Dev": "Mido",
+"Contributor": "Wiki"
+} +
+
+
$objectIncrease[Rake;5]
$objectGet
+
+
$objectIncrease[Mido;x*2]
$objectGet
+
$objectSet[user1;id;1234]
$objectSet[user1;weapon;Sword]
$objectSet[user2;name;Rake]
$objectSet[user2;id;5678]
$objectSet[user2;weapon;Feather]
$objectKeys[/]
+
+
$objectSet[user1;id;1234]
$objectSet[user1;weapon;Sword]
$objectSet[user2;name;Rake]
$objectSet[user2;id;5678]
$objectSet[user2;weapon;Feather]
$objectKeys[/;user1]
+
For example, if your loop contains `$sendMessage[Hello world!]`, it will literally display as "$sendMessage[Hello world!]" because `$sendMessage` is not a zero-cooldown function. + +If you are looking to loop over non-zero cooldown functions, you should use `$forEach` instead. + +
$objectSet[Rake;Staff]
$objectLoop[name;weapon;index]\{
$index. $name has $weapon
}
+
2. Rake has Staff +
$objectMerge[\{"country":"EG"}]
$objectGet
+
+
$objectSet[user;country;EG]
Before: $objectGet
$objectMerge[user;\{"name":"Rake","country":"DE"}]
After: $objectGet
+
After: \{"user":\{"name":"Rake","country":"DE"}} +
+$objectSet[Country;EG]
+Before: $getObject
+$objectRemove[Name]
+After: $getObject +
+After: \{"Country":"EG"} +
Before: $objectGet
$objectRenameKey[name;nick]
After: $objectGet
+
After: \{"nick":"Mido"}
+
Before: $objectGet
$objectRenameKey[user;name;nick]
After: $objectGet
+
After: \{"user":\{"nick":"Mido"}} +
+
$objectSet[age;300]
$objectValues
+
+
$objectSet[user;id;1234]
$objectSet[user;weapon;Sword]
$objectValues[/;user]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
All mentions are: $mentioned[all]
+
All mentions are: 788361834360864808, 840526017260945468 +
+
+
+
+
+
+
+
$padLeft[13;2;0]
+
13 +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
$concatTextSplit[Wiki,Mika;,]
$arrayJoin[ ] +
+
$editTextSplitElement[1;Mido]
$arrayJoin[ ] +
+
$findTextSplitIndex[Wiki] +
+
+$getTextSplitLength +
+
+$joinSplitText[-] +
+ +
+
+
+$splitText[2] +
+
+
+
+
+
+
+
+
My name is $void[$get[name]]
+
+
+
+
+Hello $name 👋 +
+$endFunction +$callFunction[printhello;Mika] +
+
+Hello $name 👋 +
+$endFunction +$printhello[Mika] +
+
+$get[member], is one of our Staff Members! +
+$endForEach +
+Mido, is one of our Staff Members! +
+Azz, is one of our Staff Members! +
+Mika, is one of our Staff Members! +
+Felix, is one of our Staff Members! +
+Flinkz, is one of our Staff Members! +
+Wiki, is one of our Staff Members! +
+Ddk, is one of our Staff Members! +
+
+
+
+
+
+
+
+
+
+$stop[This funtion will cause the interpetender to stop the code] +
+$sendMesssage[This message won't be send;no] +
+
+
+
+
+
+$wait[10s] +
+$sendMessage[This part after the 10s] +
+
+
+
+
$get[orange] or $orange +
+
+
+
$increaseChannelVar[messages;x*2]
After: $getChannelVar[messages]
+
After: 10 +
$increaseServerVar[ticket numbers;x*2]
After: $getServerVar[ticket numbers]
+
After: 10 +
$increaseUserVar[money;x*2]
After: $getUserVar[money]
+
After: 2000 +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\{desc:You are awesome}
\{color:Aqua}
] +
$color[#0099ff] +
...` to format command examples.
+* **`link`:** An array of links to relevant resources, documentation, or examples.
+* **`custommd`:** (Optional) A string containing custom markdown to further describe or provide instructions for the command.
+
+#### Metadata Example
+
+Here's an example of metadata for a `!balance` command:
+
+```
+/* Metadata :
+{{{
+ "version": "1",
+ "tags": ["economy", "balance", "money"],
+ "author": "User-0000",
+ "usecase": "checks the balance of the user",
+ "category": "economy",
+ "preview": "https://media.discordapp.net/attachments/845279377733320745/928401183809364008/unknown.png",
+ "description": ["Run !bal to show your balance"] ,
+ "link": ["https://media.discordapp.net/attachments/845279377733320745/928401183809364008/unknown.png"],
+ "custommd": ""
+}}}
+*/
+The !bal command code
+```
+
+**Note:** In this example, the `link` and `preview` are the same, as it's a simple command.
+
+## `$onTemplate` Function
+
+The `$onTemplate` function creates a user interface (UI) for interacting with commands. This UI allows users to input values and customize the command before execution. It is especially useful for commands that require user-specific information.
+
+**Important:** A UI is only generated if the command has associated metadata.
+
+### Usage
+
+```cc
+$onTemplate[type;field;title;help;default value]
+```
+
+**Parameters:**
+
+* **`type`:** The type of input field to create.
+* **`field`:** The style/appearance of the input field.
+* **`title`:** The title displayed above the input field in the UI.
+* **`help`:** A helpful description displayed below the input field.
+* **`default value`:** The default value for the input field.
+
+**Valid Types:**
+
+* `category`: Creates a dropdown list of categories from the server. `dropdownarray` or `dropdown` should be used for the `field` parameter.
+* `number`: Creates a number input field.
+* `channel`: Creates a dropdown list of channels from the server. `dropdownarray` or `dropdown` should be used for the `field` parameter.
+* `role`: Creates a dropdown list of roles from the server. `dropdownarray` or `dropdown` should be used for the `field` parameter.
+* `text`: Creates a single-line text input field.
+* `boolean`: Creates a checkbox.
+* `id`: Creates a text input field, typically used for IDs.
+* `runonlyin`: This modifies the cloned command run only in to the selected channel(s)
+
+**Valid Fields:**
+
+* `input`: Creates a standard text input field.
+* `inputarray`: Creates a text input field with the placeholder "Split by ,". The input will be treated as an array, split by commas.
+* `dropdown`: Creates a dropdown list with values from the specified `type`. If the type is `text` or `number`, the values are taken from the `default value` parameter, separated by commas.
+* `dropdownarray`: Creates a dropdown list where multiple options can be selected. Values are determined as with the standard `dropdown` field.
+* `checkbox`: Creates a checkbox.
+
+**Title & Help:**
+
+* **`title`:** The label for the input field.
+* **`help`:** A descriptive text providing guidance on what to enter in the input field.
+
+**Default Value:**
+
+* **`default value`:** The value that's pre-filled or pre-selected in the input field.
+
+ ] [ ] [ ] [ ] [ ]
++// User's age
+$let[age;$math[$year-$userYear]] // $userYear is year the user was born in
+// Send a message with age
+Your age is: $age
+// TODO: Save into user variable +
+userYear -> Year the user was born in
+age -> User's age
+*/
+$let[userYear;2000]
+$let[age;$math[$year /* current year - born year */ - $userYear]]
+Your age is: $age /* \<- The variable */ +
+$let[name;$displayName[$uid]]
+Random User's name: $name +
+First item: $arrayGet[1]
+Last item: $arrayGet[$arrayLength]
+All items: $arrayJoin[/] +
+Last item: Kiwi
+All items: Apple/Banana/Kiwi +
+$description[What is 2^11?
+Click to reveal: ||$math[2^11]||] +
+Click to reveal:
2048
++Trigger: `/!(bal|balance)/gi`
+Min. Perms: `None`
+Ignored Roles: `None`
+Run Only In: `None`
+Channel Used: `None`
+ +## Token: +Clone by using this command in your own server: `!!clone vFHnD` + +**Tags:**
+Trigger: `/!(rob|robbery)/gi`
+Min. Perms: `None`
+Ignored Roles: `None`
+Run Only In: `None`
+Channel Used: `None`
+ +## Token: +Clone by using this command in your own server: `!!clone XC5sK` + +**Tags:**
+Trigger: `!ban`
+Min. Perms: `None`
+Ignored Roles: `None`
+Run Only In: `None`
+Channel Used: `None`
+ +## Clone: +Clone by using this command in your own server: `!!clone VyCfP` + +
+Trigger: `add`
+Min. Perms: `None`
+Ignored Roles: `None`
+Run Only In: `None`
+Channel Used: `YOUR STAFF CHAT`
+ +## Clone: +Clone by using this command in your own server: `!!clone 5Tr2e` + +**Tags:**
+Trigger: `/!(mute|shut)/gi`
+Min. Perms: `None`
+Ignored Roles: `None`
+Run Only In: `None`
+Channel Used: `None`
+ +## Clone: +Clone by using this command in your own server: `!!clone Otk6C` + +
+Trigger: `/!(warn|warning)/gi`
+Min. Perms: `None`
+Ignored Roles: `None`
+Run Only In: `None`
+Channel Used: `None`
+ +## Clone: +Clone by using this command in your own server: `!!clone lpDsX` + +
-
-
-
-
-
-
\ No newline at end of file
diff --git a/guide/.vuepress/config.js b/guide/.vuepress/config.js
deleted file mode 100644
index d37dd3ca..00000000
--- a/guide/.vuepress/config.js
+++ /dev/null
@@ -1,123 +0,0 @@
-import { viteBundler } from "@vuepress/bundler-vite";
-import { defaultTheme } from "@vuepress/theme-default";
-import { searchPlugin } from "@vuepress/plugin-search";
-import { removeHtmlExtensionPlugin } from "vuepress-plugin-remove-html-extension";
-
-import { getDirname, path } from "vuepress/utils";
-import fs from "fs";
-
-import sidebar from "./sidebar.js";
-import parseTag from "./parseTags.js";
-import replacements from "./replacements.js";
-
-const replacePageContent = (content, replacements) => {
- let output = content;
- for (const [placeholder, replacement] of Object.entries(replacements)) {
- const regex = new RegExp(`${placeholder}`, "g");
- output = output.replace(regex, replacement);
- }
- return output;
-};
-
-
-
-module.exports = {
- lang: "en-US",
- title: "Custom Command",
- description: "Custom Command Bot's Documentation",
- bundler: viteBundler(),
-
- theme: defaultTheme({
- docsDir: "guide",
- navbar: [
- {
- text: "Dashboard",
- link: "https://ccommandbot.com/dashboard",
- },
- {
- text: "Discord",
- link: "https://discord.gg/ZFQNZA4Ekz",
- },
- ],
- repo: "raspdevpy/ccdoc",
- contributors: false,
- logo: "/favicon.ico",
- editLink: true,
- editLinkText: "Improve This Page!",
- lastUpdated: true,
- ...sidebar,
- }),
-
- head: [
- [
- "link",
- {
- rel: "icon",
- href: "https://doc.ccommandbot.com/bot-profile.png",
- },
- ],
- [
- "meta",
- {
- name: "twitter:image",
- content: "https://doc.ccommandbot.com/bot-profile.png",
- },
- ],
- [
- "meta",
- {
- property: "og:image",
- content: "https://doc.ccommandbot.com/bot-profile.png",
- },
- ],
- ["meta", { name: "theme-color", content: "#74b0f7" }],
- [
- "meta",
- {
- property: "og:description",
- content: "Custom Command Bot's Documentation",
- },
- ],
- [
- "meta",
- {
- name: "twitter:description",
- content: "Custom Command Bot's Documentation",
- },
- ],
- ],
-
- plugins: [
- {
- name: "replace-content-plugin",
- extendsMarkdown: (md) => {
- const render = md.render;
- md.render = (...args) => {
- args[0] = replacements(args.slice(1), args[0]);
- const html = render.call(md, ...args);
- return html;
- };
- },
- },
- {
- name: "dynamic-meta-plugin",
- extendsPage: (page) => {
- const title = page.title || null;
- const newTitle = title
- ? `${title} | Custom Command`
- : "Custom Command Documentation";
-
- page.frontmatter.head = [
- ["meta", { property: "og:title", content: newTitle }],
- ["meta", { name: "twitter:title", content: newTitle }],
- ];
- },
- },
-
- searchPlugin({
- maxSuggestions: 15,
- getExtraFields: (page) => parseTag(page),
- }),
- removeHtmlExtensionPlugin(),
- ],
-};
diff --git a/guide/.vuepress/parseTags.js b/guide/.vuepress/parseTags.js
deleted file mode 100644
index 61e5b9e3..00000000
--- a/guide/.vuepress/parseTags.js
+++ /dev/null
@@ -1,46 +0,0 @@
-const cheerio = require("cheerio");
-const fs = require("fs");
-let jsonObj = [];
-const dataFile = "./guide/.vuepress/public/docs-pages.json";
-
-let delayed;
-function write(immediate = false) {
- if (!delayed) return (delayed = setTimeout(write, 1000, true));
- if (!immediate) {
- clearTimeout(delayed);
- return (delayed = setTimeout(write, 1000, true));
- }
- fs.writeFile(dataFile, JSON.stringify(jsonObj, null, 2), function (err) {
- if (err) {
- return console.log(err);
- }
- console.log("The file was saved!");
- });
-}
-module.exports = (page) => {
- let tags = [];
- const $ = cheerio.load(page.contentRendered);
- $("Badge").each(function (i, elem) {
- let txt = $(this).attr("text");
- if (txt.match(/Easy|Difficult|Read Below|Medium|Bugged/gi)) return;
- if (txt.length > 1) tags.push(txt);
- });
- if (page.title.startsWith("$")) tags.push(page.title.slice(1));
- let data = {
- title: page.title,
- path: page.path,
- content: page.contentRendered,
- tags: tags,
- };
-
- const index = jsonObj.findIndex((item) => item.path === page.path);
- if (index !== -1) {
- jsonObj[index] = data;
- } else {
- jsonObj.push(data);
- }
-
- write();
-
- return tags;
-};
diff --git a/guide/.vuepress/public/images/guide/creating-cc/2.png b/guide/.vuepress/public/images/guide/creating-cc/2.png
deleted file mode 100644
index 845c7900..00000000
Binary files a/guide/.vuepress/public/images/guide/creating-cc/2.png and /dev/null differ
diff --git a/guide/.vuepress/public/images/guide/templates/0.png b/guide/.vuepress/public/images/guide/templates/0.png
deleted file mode 100644
index 93b53680..00000000
Binary files a/guide/.vuepress/public/images/guide/templates/0.png and /dev/null differ
diff --git a/guide/.vuepress/public/images/guide/templates/1.png b/guide/.vuepress/public/images/guide/templates/1.png
deleted file mode 100644
index dd7dc506..00000000
Binary files a/guide/.vuepress/public/images/guide/templates/1.png and /dev/null differ
diff --git a/guide/.vuepress/replacements.js b/guide/.vuepress/replacements.js
deleted file mode 100644
index aa89c5c0..00000000
--- a/guide/.vuepress/replacements.js
+++ /dev/null
@@ -1,15 +0,0 @@
-const cooldownAddition = require("./replacements/cooldownAddition");
-const functionLinkReference = require("./replacements/functionLinkReference");
-const imageReplacement = require("./replacements/imageReplacement");
-
-module.exports = (page, content) => {
- for (let handler of [
- imageReplacement,
- cooldownAddition,
- functionLinkReference,
- ]) {
- if (!content) continue;
- content = handler(page, content);
- }
- return content;
-};
diff --git a/guide/.vuepress/replacements/cooldownAddition.js b/guide/.vuepress/replacements/cooldownAddition.js
deleted file mode 100644
index d0eb7324..00000000
--- a/guide/.vuepress/replacements/cooldownAddition.js
+++ /dev/null
@@ -1,68 +0,0 @@
-const cooldowns = require("../cooldowns.json");
-function getTitle(content) {
- const match = content.match(/^#\s*(\$[a-zA-Z]+)(\s|$)/);
- return match ? match[1].trim() : null;
-}
-function formatDuration(ms) {
- if (ms < 1) {
- return `${(ms * 1000).toFixed(ms >= 0.1 ? 0 : 1)} μs`;
- }
-
- if (ms < 1000) {
- return `${ms} ms`;
- }
-
- const units = [
- ["day", 86400000],
- ["hour", 3600000],
- ["minute", 60000],
- ["second", 1000],
- ];
-
- const parts = [];
-
- for (const [name, value] of units) {
- const amount = Math.floor(ms / value);
- if (!amount) continue;
-
- parts.push(`${amount} ${name}${amount !== 1 ? "s" : ""}`);
- ms %= value;
-
- if (parts.length === 2) break; // e.g. "2 minutes 5 seconds"
- }
-
- return parts.join(" ");
-}
-module.exports = (page, content) => {
- if(!page[0]?.filePathRelative)
- return content;
- const functionName = "$" + page[0].filePathRelative
- .split("/")
- .pop()
- .replace(/\.md$/, "");
-
- const cooldown = cooldowns[functionName.toLowerCase()];
- // let title = getTitle(content);
- // if (!title) return content;
- // const cooldown = cooldowns[title.toLowerCase()];
- if (!cooldown) return content;
- let isHardCooldown = cooldown.hardCooldown;
- content += `
-
-## Function Cooldown
-
-This function has built-in cooldown. Why? Read more about cooldowns [here](/Other/ratelimits.md).
-
-- **Cooldown:** ${formatDuration(cooldown.time)}
-- **Tracked By:** ${cooldown.per}
-- **Type:** \`${cooldown.scope}\`
-
-Functions with the same type share cooldowns based on the same \`Tracked By\` value.`;
- if (isHardCooldown) {
- content += `
-::: warning Warning
-This cooldown cannot be bypassed by Tier 3+ bots.
-:::`;
- }
- return content;
-};
diff --git a/guide/.vuepress/replacements/functionLinkReference.js b/guide/.vuepress/replacements/functionLinkReference.js
deleted file mode 100644
index 0a07052c..00000000
--- a/guide/.vuepress/replacements/functionLinkReference.js
+++ /dev/null
@@ -1,39 +0,0 @@
-const fs = require("fs");
-const path = require("path");
-
-const GUIDE_DIR = path.join(__dirname, "../../");
-
-const functionMap = new Map();
-
-function scan(dir) {
- for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
- const full = path.join(dir, entry.name);
-
- if (entry.isDirectory()) {
- scan(full);
- } else if (entry.name.endsWith(".md")) {
- const name = path.basename(entry.name, ".md").toLowerCase();
- functionMap.set(name, full);
- }
- }
-}
-
-scan(GUIDE_DIR);
-
-module.exports = (page, content) => {
- const currentFile = page[0].filePath;
-
- return content.replace(/`\$([A-Za-z]+)`/g, (match, fn) => {
- const targetFile = functionMap.get(fn.toLowerCase()+"_ai")??functionMap.get(fn.toLowerCase());
- if (!targetFile) return match;
-
- let relative = path.relative(
- path.dirname(currentFile),
- targetFile
- );
-
- relative = relative.replace(/\\/g, "/");
-
- return `[\`${match}\`](${relative})`;
- });
-};
\ No newline at end of file
diff --git a/guide/.vuepress/replacements/imageReplacement.js b/guide/.vuepress/replacements/imageReplacement.js
deleted file mode 100644
index 867b19af..00000000
--- a/guide/.vuepress/replacements/imageReplacement.js
+++ /dev/null
@@ -1,20 +0,0 @@
-var fs = require('fs');
-var path = require('path');
-const crypto = require('crypto');
-
-function shaUrl(url) {
- const ext = path.extname(url);
- const hash = crypto.createHash('sha256').update(url).digest('hex');
- return hash + ext;
-}
-
-module.exports=(page,content)=>{
- content=content.replace(/\((http.*?)\)/g,(...v)=>{
- let url=v[1];
- let name=shaUrl(url)
- const filename = `guide/.vuepress/public/images/${name}`;
- if (fs.existsSync(filename)) return `(/images/${name})`;
- return v[0]
- })
- return content;
-}
\ No newline at end of file
diff --git a/guide/.vuepress/sidebar.js b/guide/.vuepress/sidebar.js
deleted file mode 100644
index aa6808ad..00000000
--- a/guide/.vuepress/sidebar.js
+++ /dev/null
@@ -1,158 +0,0 @@
-const fs = require("fs");
-const path = require("path");
-const matter = require("gray-matter");
-
-function getSideBar(folder, title, options = {}) {
- const children = getChildren(folder);
- return { text: title, children, collapsible: false, ...options };
-}
-
-function getChildren(folder) {
- if (!fs.existsSync(path.join(`${__dirname}/../${folder}`))) return [];
-
- const files = fs
- // get all files in $folder
- .readdirSync(path.join(`${__dirname}/../${folder}`), {
- withFileTypes: true,
- })
- .filter((dirent) => dirent.isFile())
- // read frontmatter and append a weight to each file
- .map((item) => {
- const fileContent = fs.readFileSync(
- `${item.parentPath}/${item.name}`,
- "utf8",
- );
- const { data } = matter(fileContent);
- return {
- name: item.name,
- path: `/${folder}/${item.name}`,
- weight: data.weight ?? -1,
- hidden: data.hidden ?? false,
- };
- })
- // remove non .md files, and filter out files that are hidden
- .filter(
- (item) =>
- item.path.endsWith(".md") &&
- !item.hidden &&
- item.name.toLowerCase() != "readme.md",
- )
- // sort files based on weight
- .sort((a, b) => {
- if (a.weight === -1 && b.weight === -1) return 0;
- if (a.weight === -1) return 1;
- if (b.weight === -1) return -1;
- return a.weight - b.weight;
- })
- // convert back to array of paths
- .map((file) => file.path);
-
- return files;
-}
-
-module.exports = {
- sidebarDepth: 1,
- sidebar: {
- "/": [
- {
- text: "Guide",
- children: ["/", ...getChildren("Guide")],
- },
- getSideBar("Trigger", "Trigger Types", { collapsible: true }),
- getSideBar("Tutorials", "Tutorials & Examples", {
- collapsible: true,
- }),
- getSideBar("Other", "Other Information"),
- getSideBar("Changelogs", "Changelogs", { collapsible: true }),
- // getSideBar('Templates','Templates'),
- {
- text: "Functions",
- collapsible: true,
- children: [
- getSideBar("Member", "Member Functions", {
- collapsible: true,
- }),
- getSideBar("Channel", "Channel Functions", {
- collapsible: true,
- }),
- getSideBar("Message", "Message Functions", {
- collapsible: true,
- }),
- getSideBar("Interaction", "Interaction Functions", {
- collapsible: true,
- }),
- getSideBar("Threads", "Threads Functions", {
- collapsible: true,
- }),
- getSideBar("Role", "Role Functions", { collapsible: true }),
- getSideBar("Server", "Server Functions", {
- collapsible: true,
- }),
- getSideBar("Random", "Random Functions", {
- collapsible: true,
- }),
- getSideBar("Text", "Text Functions", { collapsible: true }),
- getSideBar("Text/Condition", "Condition Functions", {
- collapsible: true,
- }),
- getSideBar("Stickers", "Sticker Functions", {
- collapsible: true,
- }),
- getSideBar("Events", "Event Functions", {
- collapsible: true,
- }),
- getSideBar("Timeout", "User Timeout Functions", {
- collapsible: true,
- }),
- getSideBar("Text/Embed", "Embed functions", {
- collapsible: true,
- }),
- getSideBar("Text/Components", "Button Functions", {
- collapsible: true,
- }),
- getSideBar("Text/Math", "Math Functions", {
- collapsible: true,
- }),
- getSideBar("Text/textSplit", "Text Split Functions", {
- collapsible: true,
- }),
- getSideBar("Text/Array", "Array Functions", {
- collapsible: true,
- }),
- getSideBar("Text/Object", "Object Functions", {
- collapsible: true,
- }),
- getSideBar("Text/isandhas", "Is and Has Functions", {
- collapsible: true,
- }),
- getSideBar("Text/only", "Only Functions", {
- collapsible: true,
- }),
- getSideBar("Text/Regex", "Regex Functions", {
- collapsible: true,
- }),
- getSideBar("Date", "Date Functions", { collapsible: true }),
- getSideBar("Variables", "Variables Functions", {
- collapsible: true,
- }),
- getSideBar("Bot", "Bot Functions", { collapsible: true }),
- getSideBar("Useful", "Useful Functions", {
- collapsible: true,
- }),
- getSideBar("Cooldown", "Cooldown functions", {
- collapsible: true,
- }),
- getSideBar("Request", "Http Requests functions", {
- collapsible: true,
- }),
- getSideBar("Image", "Image Builder functions", {
- collapsible: true,
- }),
- // getSideBar('Unclassified','Unclassfied Functions',{collapsible:true})
- ],
- },
- getSideBar("Contribution_Info", "Contribute", { collapsible: true }),
- getSideBar("Legal", "Legal"),
- ],
- },
-};
diff --git a/guide/.vuepress/styles/index.scss b/guide/.vuepress/styles/index.scss
deleted file mode 100644
index 858553ca..00000000
--- a/guide/.vuepress/styles/index.scss
+++ /dev/null
@@ -1,65 +0,0 @@
-@import "https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&display=swap";
-
-html[data-theme="dark"] .discord-messages, html[data-theme="dark"] div[class*="language-"] {
- background-color: #202024 !important;
- border: 1px solid rgba(255, 255, 255, 0.1) !important;
-}
-
-html[data-theme="light"] .discord-messages, html[data-theme="light"] div[class*="language-"] {
- background-color: #e5e7eb !important;
- border: 1px solid rgba(0, 0, 0, 0.1) !important;
-}
-
-html[data-theme="dark"] .discord-message {
- color: #dcddde !important;
-}
-
-html[data-theme="light"] .discord-message {
- color: #202024 !important;
-}
-
-.discord-message:hover {
- background-color: rgba(128, 128, 128, 0.2) !important;
-}
-
-.discord-messages {
- border-radius: 8px;
- font-family: Inter, Roboto, sans-serif;
-}
-
-html[data-theme="light"] .discord-embed-container, html[data-theme="light"] .discord-embed-title {
- background-color: white;
- color: black !important;
-}
-
-.discord-message .discord-author-info .discord-author-username {
- font-size: 0.95rem !important;
- letter-spacing: 0px !important;
- display: inline-flex !important;
-}
-.discord-message .discord-message-body {
- font-size: 15px !important;
-}
-.discord-message .discord-message-content .discord-message-timestamp {
- display: inline-flex !important;
- font-size: 11px !important;
- margin-left: 5px !important;
-}
-
-@media screen and (max-width: 719px) {
- .hint-container {
- margin-inline: 0 !important;
- }
-}
-
-:root {
- --code-border-radius: 8px !important;
- --tab-border-radius: 8px !important;
-}
-
-@media (max-width: 419px) {
- #content {
- --code-border-radius: 8px !important;
- --tab-border-radius: 8px !important;
- }
-}
diff --git a/guide/.vuepress/styles/prism-coldark-dark.css b/guide/.vuepress/styles/prism-coldark-dark.css
deleted file mode 100644
index 71cea4ed..00000000
--- a/guide/.vuepress/styles/prism-coldark-dark.css
+++ /dev/null
@@ -1,447 +0,0 @@
-/**
- * Coldark Theme for Prism.js
- * Theme variation: Dark
- * Tested with HTML, CSS, JS, JSON, PHP, YAML, Bash script
- * @author Armand Philippot
-
-
-
- Required Argument
-
-
- Optional Argument
-
-
- Default:
- {{ props.default }}Default: {{ props.default }}
-
- {{ props.name }}
- - -This function is commonly used to programmatically access the bot's ID within custom commands or other bot logic. - -Here's an example of how it works in practice: - -
- -Here's an example of how to use the `$ping` command in Discord: - -
- -**Example:** - -``` -!!exec $ram MB -``` - -**Bot Response:** - -``` -2143.55 MB -``` - -This indicates that the bot is currently using approximately 2143.55 MB of RAM. - -##### Function Difficulty:
-**Example:** -
- -Here's an example of how it works: - -
- -**Example:** - -
-
- -**Example:** - -``` -!!exec $channelExists[889102524727058463] -``` - -``` -true -``` - -::: tip Example Breakdown -This example checks if a channel with the ID `889102524727058463` exists. Since a channel with that ID exists, the function returns `true`. -::: - -::: tip Useful Tip -You can use the `$channelID` function to retrieve the ID of a channel based on its name. This is helpful if you don't already know the channel's ID. -::: - -::: tip Related Functions -* `$findChannel`: Finds a channel by its name. -::: - -##### Function Difficulty:
- -**Example:** - -``` -!!exec $channelID -``` - -``` -839090554205241394 -``` - -**Explanation:** The bot returns the channel ID where the `!!exec` command was used. - -
- -**Example with channel name:** - -Let's say you have a channel named `#general`. You can get its ID like this: - -``` -!!exec $channelID[general] -``` - -If a channel named `general` exists, the output will be its ID. - -::: warning -This function will **not** work with the voice channel join/leave trigger. Use `$voiceChannelID` instead. - -This function will **not** work with the channel creation/deletion trigger. Use `$eventChannelID` instead. -::: - -##### Function Difficulty:
- -**Example:** - -
- -**Example:** - -
- -**Example:** - -This example demonstrates how to send a message informing the user about the ticket closure, wait for a short period, and then close the ticket. - -```sh -$sendmessage[This ticket will be closed in 5 seconds.] -$wait[5s] -$closeTicket -``` - -**Explanation:** - -* `$sendmessage[This ticket will be closed in 5 seconds.]`: Sends a message to the ticket channel informing the user that the ticket will be closed shortly. -* `$wait[5s]`: Pauses the script execution for 5 seconds, giving the user a chance to read the message. -* `$closeTicket`: Closes the ticket channel. - -##### Difficulty:
- -
{desc:You are awesome}
{color:Aqua}
] -
$color[#0099ff] -
...` to format command examples.
-* **`link`:** An array of links to relevant resources, documentation, or examples.
-* **`custommd`:** (Optional) A string containing custom markdown to further describe or provide instructions for the command.
-
-#### Metadata Example
-
-Here's an example of metadata for a `!balance` command:
-
-```
-/* Metadata :
-{{{
- "version": "1",
- "tags": ["economy", "balance", "money"],
- "author": "User-0000",
- "usecase": "checks the balance of the user",
- "category": "economy",
- "preview": "https://media.discordapp.net/attachments/845279377733320745/928401183809364008/unknown.png",
- "description": ["Run !bal to show your balance"] ,
- "link": ["https://media.discordapp.net/attachments/845279377733320745/928401183809364008/unknown.png"],
- "custommd": ""
-}}}
-*/
-The !bal command code
-```
-
-**Note:** In this example, the `link` and `preview` are the same, as it's a simple command.
-
-## `$onTemplate` Function
-
-The `$onTemplate` function creates a user interface (UI) for interacting with commands. This UI allows users to input values and customize the command before execution. It is especially useful for commands that require user-specific information.
-
-**Important:** A UI is only generated if the command has associated metadata.
-
-### Usage
-
-```php
-$onTemplate[type;field;title;help;default value]
-```
-
-**Parameters:**
-
-* **`type`:** The type of input field to create.
-* **`field`:** The style/appearance of the input field.
-* **`title`:** The title displayed above the input field in the UI.
-* **`help`:** A helpful description displayed below the input field.
-* **`default value`:** The default value for the input field.
-
-**Valid Types:**
-
-* `category`: Creates a dropdown list of categories from the server. `dropdownarray` or `dropdown` should be used for the `field` parameter.
-* `number`: Creates a number input field.
-* `channel`: Creates a dropdown list of channels from the server. `dropdownarray` or `dropdown` should be used for the `field` parameter.
-* `role`: Creates a dropdown list of roles from the server. `dropdownarray` or `dropdown` should be used for the `field` parameter.
-* `text`: Creates a single-line text input field.
-* `boolean`: Creates a checkbox.
-* `id`: Creates a text input field, typically used for IDs.
-* `runonlyin`: This modifies the cloned command run only in to the selected channel(s)
-
-**Valid Fields:**
-
-* `input`: Creates a standard text input field.
-* `inputarray`: Creates a text input field with the placeholder "Split by ,". The input will be treated as an array, split by commas.
-* `dropdown`: Creates a dropdown list with values from the specified `type`. If the type is `text` or `number`, the values are taken from the `default value` parameter, separated by commas.
-* `dropdownarray`: Creates a dropdown list where multiple options can be selected. Values are determined as with the standard `dropdown` field.
-* `checkbox`: Creates a checkbox.
-
-**Title & Help:**
-
-* **`title`:** The label for the input field.
-* **`help`:** A descriptive text providing guidance on what to enter in the input field.
-
-**Default Value:**
-
-* **`default value`:** The value that's pre-filled or pre-selected in the input field.
-
-:::warning Escaping Special Characters
-You **cannot** use the characters `[` `]` and `;` directly within the `$onTemplate` function. They are unsupported by the parser.
-
-Use the following escape sequences instead:
-
-* `#RIGHT#` for `]`
-* `#LEFT#` for `[`
-* `#SEMI#` for `;`
-:::
-
-#### Example Ticket System
-
-**Ticket Code:**
-
-```php
-$let[categoryID;$onTemplate[category;dropdown;Ticket Category;Choose the category where the ticket should be created;$channelCategoryID]] // Put the category ID Here
-$if[$buttonID==openTicket]
- $cooldown[1m;<@$authorID> Please Wait %time% to create a new ticket]
- $newTicket[$userTag;
- {title:🎫 Ticket}
- {url:https://raspdevpy.gitbook.io}
- {description:You can change this message to yours}
- {footer:Press the blue link for the docs}
- {button:Close The ticket:red:❌:closeTicket}
- {color:RANDOM}
- ;$get[categoryID];no;Could not Create Ticket]
-$elseIf[$buttonID==closeTicket]
- $sendMessage[{title: This ticket will be closed in 10s} {color: #ff4a4a};no]
- $disableButton[$messageID;closeTicket]
- $wait[10s]
- $closeTicket[This channel is not a ticket!]
-$endelse
-```
-
-**Template Asking for Input:**
-
-
-
-**After Cloning:** `$let[categoryID;866251414232498197]`
-
-## Special Cases: Arrays
-
-`dropdownarray` and `inputarray` fields split their input by commas (`,`). To use these arrays in your custom commands, you need to *spread* them.
-
-**How to Spread Arrays:**
-
-```php
-$let[input;input,from,template]
-$giveRoles[$authorID;$spread[,;$input]]
-```
diff --git a/guide/Contribution_Info/function_template.md b/guide/Contribution_Info/function_template.md
deleted file mode 100644
index 72f5dc2a..00000000
--- a/guide/Contribution_Info/function_template.md
+++ /dev/null
@@ -1,20 +0,0 @@
-# Function Template
-
-```md
-# $FUNCTION
-
-
-#### Usage: `$FUNCTION NAME + PARAMETERS`
--
- You're not on cooldown! -
- You're not on cooldown! -
- $clearCooldown
- No cooldown -
- $clearCooldown
- No cooldown 2nd try -
- You're not on cooldown! -
- You're not on cooldown! -
- $getCooldownTime[5m;channel;$channelID] -
- You're not on cooldown! -
- You're not on cooldown! -
- -**Example:** - -
- -
- -
- -
-
- -```html -
- -```html -
- -**Example:** - -This example demonstrates converting 1000 milliseconds to a time duration. - -
- -
- -**Example:** - -
] [ ] [ ] [ ] [ ]
- - // User's age
- $let[age;$math[$year-$userYear]] // $userYear is year the user was born in
- // Send a message with age
- Your age is: $age
- // TODO: Save into user variable -
- userYear -> Year the user was born in
- age -> User's age
- */
- $let[userYear;2000]
- $let[age;$math[$year /* current year - born year */ - $userYear]]
- Your age is: $age /* <- The variable */ -
- $let[name;$displayName[$uid]]
- Random User's name: $name -
- First item: $arrayGet[1]
- Last item: $arrayGet[$arrayLength]
- All items: $arrayJoin[/] -
- Last item: Kiwi
- All items: Apple/Banana/Kiwi -
- $description[What is 2^11?
- Click to reveal: ||$math[2^11]||] -
- Click to reveal:
2048
- $imageBorderRad[50]
$imageFill[red;100;100;100;100]
$image[$imageOutput]
-
$imageFill[red]
$image[$imageOutput]
-
$imageLoadFromURL[avatar;$replaceText[$authorAvatar;webp;png]]
$imageCrop[avatar;0;0;100;100] // crop the image from position (0, 0) with size 100
$imageDraw[avatar]
$image[$imageOutput]
-
$imageLoadFromURL[avatar;$replaceText[$authorAvatar;webp;png]] // Load Avatar as "avatar"
$imageDraw[avatar;0;0;300;300] // Draw "avatar" at (0,0) with width 300 and height 300
$image[$imageOutput]
-
$imageLoadFromURL[avatar;$replaceText[$authorAvatar;webp;png]]
$imageFill[gray]
$imageFill[transparent;100;100;100;100]
$imageDrawBack[avatar;50;50;200;200]
$image[$imageOutput]
-
$imageFill[gray]
$image[$imageOutput]
-
$imageFill[gray]
$imageFill[red;100;100;50;50]
$image[$imageOutput]
-
$imageLoadEmoji[mycheese;:cheese:]
$imageBorderRad[100]
$imageFill[gray;50;50;200;200]
$imageDraw[mycheese;100;100;100;100]
$image[$imageOutput]
-
$imageLoadEmoji[seed;<:seed:1149808771888062605>]
$imageLoadEmoji[cheese;:cheese:]
$imageBorderRad[100]
$imageFill[gray;50;200;200;200]
$imageFill[gray;350;200;200;200]
$imageDraw[cheese;100;250;100;100]
$imageDraw[seed;400;250;100;100]
$image[$imageOutput]
-
- $imageLoadFromURL[avatar;$replaceText[$authorAvatar;webp;png]] // Load the author's avatar
- $imageDraw[avatar;0;0;300;300] // Draw the avatar onto the image frame
- $image[$imageOutput] // Output the resulting image
-
$imagePositionBase[centerleft]
$imageFill[white;center;center;100;100]
$imagePositionBase[centerright]
$imageFill[red;center;center;100;100]
$image[$imageOutput]
-
$imageCreate[300;300]
$imageLoadFromURL[avatar;$avatar]
$imageDraw[avatar;100;10;100;100]
$imageSetOpacity[50]
$imageDraw[avatar;100;190;100;100]
$image[$imageOutput]
-
$imagePositionBase[center]
$imageStrokeWidth[10]
$imageStroke[red;center;center;50;50]
$image[$imageOutput]
-
$imagePositionBase[center]
$imageStrokeWidth[10]
$imageStroke[red;center;center;50;50]
$image[$imageOutput]
-
$imageTextSize[30]
$imageTextAlign[center]
$imageTextFill[CC is Awesome;150;150;#4461b3]
$image[$imageOutput]
-
$imageTextSize[30]
$imageTextAlign[center]
$imageTextStroke[CC is Awesome;150;150;#4461b3]
$image[$imageOutput]
-
$imageUseFont[Roboto]
$imageTextColor[white]
$imageTextSize[30]
$imageTextFill[Hello World;20;50]
$stop[{image:$imageOutput}] -
- -**Explanation:** - -This function allows you to remove an interaction reply. If you don't specify a message ID, it will delete the most recent interaction reply sent within the command. - -**Parameters:** - -* `message ID` (Optional): The ID of the message you want to delete. If left blank, it defaults to deleting the last interaction reply sent by the bot in that command execution. - -**Example:** - -To delete the previous interaction reply: - -```php -$interactionDelete -``` - -To delete a specific interaction reply by its ID: - -```php -$interactionDelete[123456789012345678] -``` - -##### Function difficulty:
- -::: warning Important -This function only works within interaction-based triggers (e.g., slash commands, button clicks). Do not use it in `exec` or other trigger types. -::: - -
- -::: details Example -```php -$interactionreply[Hello world!;yes] -$wait[2s] -$interactionedit[Bye World!] -``` - -This example first sends an interaction reply ("Hello world!"). After a 2-second delay, it edits that same message to "Bye World!". - - -::: - -::: tip Note -You can send embeds using the [Message Curl Format](../CodeReferences/ref.message_curl_format.md). This allows for rich message formatting including titles, descriptions, fields, and more! -::: - -##### Function difficulty:
- -##### **type** - -Specifies the input type for the input. - -* **`short` (Default):** A single-line text input field. -* **`long`:** A multi-line text area for longer responses. -* **`menu/user/role/mention/channel`:** A dropdown selection menu instead of a text field. -* **`attachment/attach`:** A file upload input field. -* **`radio`:** A multiple choice list where only **one** item can be selected (Min 2 options, Max 10). -* **`checkbox`:** A multiple choice list where **several** items can be checked (Min 1 option, Max 10). - -#### Max Amount of Inputs - -You can include multiple input fields, up to a maximum of 5 total (for example: 2 text inputs, 1 attachment input, and 2 radio/checkbox fields). - -### Example -#### Code - - -#### Output - - -### Example With Menu -#### Code - - -#### Output - - -::: tip -This can only be used inside the [modal trigger](../Trigger/modal.md) -::: - -::: tip -Read more about the menu structure in [selectMenu](../Text/Components/selectMenu.md) -::: - -##### Function difficulty:
-
-
- Message -
-To have all members cached, you will need Tier 5 Bot. -::: - -##### Related functions: `$userID` `$authorID` - -##### Function difficulty:
-
-
-
-
-
-
Mido joined the server at: $memberJoinedDate[$user_id]
-
-To have all members cached, you will need Tier 5 Bot. -::: - -##### Related functions: `$status` - -##### Function difficulty:
- Other user: $mention[123456789123456789] -
- Other user:
- -Returns the status of a user. Can be `online`, `offline`, `idle` or `dnd`. - -## Usage - -```bash -$status[userID] -``` -1. **userID** - (Optional) default value: `$authorID`. The ID of user to return the status from. - -## Example - -#### Using $status - -How to use $status - -
-
-
- -
-
- -To have all members cached, you will need Tier 5 Bot. -::: - -##### Related functions: `$findMember` - -##### Function Difficulty:
-To have all members cached, you will need Tier 5 Bot. -::: - -##### Related functions: `$authorID` `$findMember` - -##### Function Difficulty:
-To have all members cached, you will need Tier 5 Bot. -::: - -##### Related functions: `$rolePerms` `$hasPerms` - -##### Function Difficulty:
]
- -To have all members cached, you will need Tier 5 Bot. -::: - -##### Related functions: `$getMessageReactions` `$getReactionCount` - -##### Function difficulty:
-To have all members cached, you will need Tier 5 Bot. -::: - -##### Related functions: `$userRoles` - -##### Difficulty:
-To have all members cached, you will need Tier 5 Bot. -::: - -##### Related functions: `$hasRoles` - -##### Function difficulty:
-To have all members cached, you will need Tier 5 Bot. -::: - -##### Related functions: `$nickname` - -##### Function difficulty:
-To have all members cached, you will need Tier 5 Bot. -::: - -##### Related functions: `$usersWithRole` - -##### Function difficulty:
-To have all members cached, you will need Tier 5 Bot. -::: - -##### Related functions: `$userRoles` - -##### Function difficulty:
- -**Example:** - -**Command Input:** -``` -!!exec $DM[$authorID] This is a fantastic message! -``` - -
- -::: tip Example - -This example adds a checkmark and a cross emoji as reactions to the user's command message. - -```php -$addCmdReactions[✅;❌] -``` - - - -::: - -##### Function difficulty:
- -::: tip Example - -This example demonstrates adding multiple reactions to a message using its ID. - - - -You can use the function format `{reactions}` (formatted as `curl`) to use inside functions like `$sendMessage` to easily apply reactions. - -::: - -##### Function Difficulty:
- -This function allows you to add multiple reactions to the message the bot just sent. Simply list the emojis you want to use, separated by semicolons. - -::: tip Examples - -This example shows how to react to a message with specific emojis. - - - -::: - -##### Function Difficulty:
-
- -::: tip Example - -This example shows how to remove a specific user's reaction from a message. - - -::: - -##### Difficulty:
-
- -##### Difficulty:
- -##### Function difficulty:
- -::: tip Example - -**Scenario:** You want to get a list of users who reacted with the 👍 emoji on a specific message and mention them. - -**Code:** - -```php -$getReactions[832894131844128888;940739445487988807;👍;mention] -``` - -::: tip Visual Examples - - - -Counting how many users reacted - -::: - -##### Function Difficulty:
- -#### Example: - -This example demonstrates how `$messageAttachment` can be used. - -
- -**Example:** - -Let's say you want to check if a message with the ID `123456789012345678` exists in the channel with the ID `987654321098765432`. - -
- -Here's a simple example demonstrating how to use `$messageFlags`: - -
- -**Example:** - -Let's say the message sent is: `!!exec a b c d e` - -```html -
- -**Another Example:** - -Using the same message: `!!exec a b c d e` - -```html -
- -**Example:** - -Here's how `$messageType` might be used in a custom command: - -
- -
- -::: tip Example - -Here's an example of how to use this function: - - -::: - -
- -**Function Difficulty:**
-
- -
Total votes: $poll[$channelID;$messageID;votes]
Total answers: $poll[$channelID;$messageID;answers]
1st answer name: $poll[$channelID;$messageID;answer 1 name]
2nd answer name: $poll[$channelID;$messageID;answer 2 name]
1st answer votes: $poll[$channelID;$messageID;answer 1 votes]
-
- -**Example 1: Sending a DM to the message author multiple times.** - -
- -
- -**Example:** - -```discord -!!exec $sendMessage[This is a fantastic message!;no] -``` - -
- -
- $description[What is 2^11?
- Click to reveal: ||$math[2^11]||] -
- Click to reveal:
2048
- - -**Example:** - -```discord -!!exec $random[1;6] -``` - -This command will return a random integer between 1 and 6 (inclusive). Possible outputs: 1, 2, 3, 4, 5, or 6. - -
- -**Example:** - -```discord -!!exec $randomChannelID -``` - -**Result:** - -```discord -37907890789087988 -``` - -This will output a random channel ID from the server where the command is executed. The actual ID returned will, of course, be different each time. - -##### Function Difficulty:
- -**Example:** - -This example shows how to use `$randomMention` to mention a random user in a command. - -
- -**Example:** - -Here's how you can use `$randomRoleID` in a custom command: - -
- -#### Example: - -This example demonstrates how to use `$randomString` to generate a 6-character random string. - -
- -**Example:** - -```php -$randomText[Hello;Hi;Hey] -``` - -This example will randomly return either "Hello", "Hi", or "Hey". - -
- -
-
-
-
- -
Response is $response
Response Status is $httpRequestStatus
-
Response Status is 200
-
- Content-Type Header: $httpRequestHeader[content-type] -
- Content-Type Header: application/json -
- Code: $httpRequestStatus -
- Code: 200 -
- -**Example:** - -Let's say you have a command `!ban` and you want to prevent users with a specific role from using it. - -```bash -$blackListRoleIds[9872xx..;You are not authorized to use this command!] -$ban[$mentioned[1]] -Successfully banned user. -``` - -**Explanation:** - -* `$blackListRoleIds[9872xx..;You are not authorized to use this command!]`: This line checks if the user executing the command has the role with the ID `9872xx..`. If they do, the bot will reply with "You are not authorized to use this command!". -* `$ban[$mentioned[1]]`: This line executes the ban command, banning the mentioned user. It only executes if the user does *not* have a blacklisted role. -* `Successfully banned user.`: This line sends a confirmation message after a successful ban. - -
-
-
- -**Example:** - -Let's say you want to get the color of the role with the ID `123456789012345678`. You would use: - -```php -$getRoleColor[123456789012345678] -``` - -This would return the hex color code of the role, such as `#FF0000` (red). - -
- -**Function Difficulty:**
- -**Example:** - -This example grants the "Muted" role to the command executor. - -
- -**Example:** - -This example shows how to retrieve the IDs of all roles in the guild. - -
- -**Example:** - -Checks if the message author has the role with the ID `99871..xx`. - -
- -##### Function Difficulty:
- -**Example:** - -This example shows how to use `$highestRole` with `$roleName` to output the role's name. - -```discord -!!exec $roleName[$highestRole] -``` - -**Result:** - -(Assuming the user's highest role is "Admin") - -```discord -Admin -``` - -
- -##### Difficulty:
- -**Example:** - -This example retrieves the role ID of the user's lowest role and displays it. - -```discord -!!exec $roleName[$lowestRole] -``` - -**Explanation:** - -* `!!exec` is used to execute a custom command. -* `$lowestRole` retrieves the lowest role of the command executor. -* `$roleName` retrieves the ID of the role obtained from `$lowestRole`. - -**Discord Output:** - -```discord -Member -``` - -(The bot will output the role ID of the user's lowest role. This example only provides a placeholder "Member".) - -##### Function Difficulty:
- -#### Example: - -
- -**Example:** - -Let's create a custom command that announces the total number of roles in the server. - -
- -**Example:** - -```discord -
- -**Example:** - -Let's say you have a role named "muted" in your server. The following example demonstrates how to retrieve its ID. - -
- -#### Example: - -This example shows how to use the `$roleName` function to find the name of the role with the ID `869243918787686439`. - -
- -**Example:** - -
- -**Example Scenario:** - -Let's say you have a custom command that checks the position of the "Muted" role. - -
- -**Example:** - -Sets the command executor's roles to only the "Muted" role. - -```discord -!!exec $setRoles[$authorID;$roleID[Muted]] -``` - -
- -**Explanation:** - -* `!!exec`: Executes the command. Replace with your bot's command prefix. -* `$setRoles`: The function being used. -* `$authorID`: Gets the ID of the user who executed the command (using the `$authorID` function). -* `$roleID[Muted]`: Gets the ID of the role named "Muted" (using the `$roleID` function). - -::: tip Important Notes - -* The bot needs the **Manage Roles** permission to use this function. -* The bot can only manage roles that are below its highest role in the server's role hierarchy. -* Invalid role IDs or user IDs will cause the function to fail. - -::: - -::: tip Used Functions - -* `$roleID[roleName]`: Returns the ID of a role, given its name. [See RoleID Documentation](../Role/roleID.md) -* `$authorID`: Returns the ID of the command executor. [See AuthorID Documentation](../Member/authorID.md) - -::: - -::: tip Related Functions - -* `$giveRoles[userID;roleID 1;roleID 2;...]`: Gives roles to a user without removing existing roles. [See GiveRoles Documentation](../Role/giveRoles.md) -* `$takeRoles[userID;roleID 1;roleID 2;...]`: Removes roles from a user. [See TakeRoles Documentation](../Role/takeRoles.md) -* `$toggleRoles[userID;roleID 1;roleID 2;...]`: Toggles the specified roles on a user. [See ToggleRoles Documentation](../Role/toggleRoles.md) - -::: - -##### Function difficulty:
- -
- -
- -**Example:** - -
-
-
- -#### Example: - -
-
-
-
-
-
- -
- -
-
- -
- -
- -
-
-
-
-
-Trigger: `/!(bal|balance)/gi`
-Min. Perms: `None`
-Ignored Roles: `None`
-Run Only In: `None`
-Channel Used: `None`
- -## Token: -Clone by using this command in your own server: `!!clone vFHnD` - -###### Tags:
-Trigger: `/!(rob|robbery)/gi`
-Min. Perms: `None`
-Ignored Roles: `None`
-Run Only In: `None`
-Channel Used: `None`
- -## Token: -Clone by using this command in your own server: `!!clone XC5sK` - -###### Tags:
-Trigger: `!ban`
-Min. Perms: `None`
-Ignored Roles: `None`
-Run Only In: `None`
-Channel Used: `None`
- -## Clone: -Clone by using this command in your own server: `!!clone VyCfP` - -::: danger -Please be aware, that this code doesn't includes permissions checks!! Everyone can execute this command, which might ends in horrible disasters -::: - - -###### Tags:
-Trigger: `add`
-Min. Perms: `None`
-Ignored Roles: `None`
-Run Only In: `None`
-Channel Used: `YOUR STAFF CHAT`
- -## Clone: -Clone by using this command in your own server: `!!clone 5Tr2e` - -###### Tags:
-Trigger: `/!(mute|shut)/gi`
-Min. Perms: `None`
-Ignored Roles: `None`
-Run Only In: `None`
-Channel Used: `None`
- -## Clone: -Clone by using this command in your own server: `!!clone Otk6C` - -::: danger -Please be aware, that this code doesn't includes permissions checks!! Everyone can execute this command, which might ends in horrible disasters -::: - -###### Tags:
-Trigger: `/!(warn|warning)/gi`
-Min. Perms: `None`
-Ignored Roles: `None`
-Run Only In: `None`
-Channel Used: `None`
- -## Clone: -Clone by using this command in your own server: `!!clone lpDsX` - -::: danger -Please be aware, that this code doesn't includes permissions checks!! Everyone can execute this command, which might ends in horrible disasters -::: - -###### Tags:
Before=$arrayJoin[, ]
$arrayClear
After=$arrayJoin[, ]
-
After= -
$arrayConcat[Azz/Finkz;/]
$arrayJoin[, ]
-
-
$arrayCount
-
1 is $arrayGet[1]
2 is $arrayGet[2]
3 is $arrayGet[3]
-
2 is Rake
3 is Azz -
Rake repeated $arrayElementCount[Rake] times
Mido repeated $arrayElementCount[Mido] times
Azz repeated $arrayElementCount[Azz] times
Faj repeated $arrayElementCount[Faj] times
-
Mido repeated 2 times
Azz repeated 1 times
Faj repeated 1 times -
For example, if your loop contains `$sendMessage[Hello world!]`, it will literally display as "$sendMessage[Hello world!]" because `$sendMessage` is not a zero-cooldown function. - -If you are looking to loop over non-zero cooldown functions, you should use `$forEach` instead. -::: - -## Usage -```bash -$arrayFilter[Element Value;Element Index;array name]{ -CODE... -} -``` -## Loop Limits -Array loops are limited to a certain number of cycles. These limits vary between different tiers of premium. -| Tier | Limit | -| :------- | :--- | -| 0 (Free) | 50 | -| 3 (Freemium) | 50 | -| 4 (Pro) | 100 | -| 5 (Ultra) | 150 | - -### Example (Remove Hello): -
$arrayFilter[value]{
$if[$value==Hello]{
false
}
}
$arrayJoin[/] -
First is $arrayGet[1]
Second is $arrayGet[2]
Third is $arrayGet[3]
-
Second is Rake
Third is Azz -
$arrayInclude[Rake]
-
$arrayJoin[, ]
-
$arrayLength
-
For example, if your loop contains `$sendMessage[Hello world!]`, it will literally display as "$sendMessage[Hello world!]" because `$sendMessage` is not a zero-cooldown function. - -If you are looking to loop over non-zero cooldown functions, you should use `$forEach` instead. -::: - -## Usage -```bash -$arrayLoop[varName;index;array name (optional)]{ -CODE... -} -``` -## Loop Limits -Array loops are limited to a certain number of cycles. These limits vary between different tiers of premium. -| Tier | Limit | -| :------- | :--- | -| 0 (Free) | 50 | -| 3 (Freemium) | 50 | -| 4 (Pro) | 100 | -| 5 (Ultra) | 150 | - -## Example: -
$arrayLoop[age]{
age is $age
} -
age is 18
age is 21 -
For example, if your loop contains `$sendMessage[Hello world!]`, it will literally display as "$sendMessage[Hello world!]" because `$sendMessage` is not a zero-cooldown function. - -If you are looking to loop over non-zero cooldown functions, you should use `$forEach` instead. -::: - -## Usage -```bash -$arrayMap[Element Value;Element Index;array name (optional)]{ -CODE -} -``` -## Loop Limits -Array loops are limited to a certain number of cycles. These limits vary between different tiers of premium. -| Tier | Limit | -| :------- | :--- | -| 0 (Free) | 50 | -| 3 (Freemium) | 50 | -| 4 (Pro) | 100 | -| 5 (Ultra) | 150 | - -### Example: -
$arrayMap[age]{
age is $age
}
$arrayJoin[, ]
-
last one is $arrayPop
before it is $arrayPop
before it is $arrayPop
-
before it is Rake
before it is Mido -
$arrayPush[Rake]
$arrayPush[Azz]
$arrayJoin[/]
-
$arrayRemove[1;2;3]
$arrayGet[1]
-
$arrayReverse
$arrayJoin[/]
-
Mido is in position: $arraySearch[Mido]
Azz is in position: $arraySearch[Azz]
InvalidName is in position: $arraySearch[justsomeweirdrandom]
-
Azz is in position: 3
InvalidName is in position: -1 -
Before: $arrayGet[3]
$arraySet[3;Finkz]
After: $arrayGet[3]
-
After: Finkz -
first one is $arrayShift
after it is $arrayShift
after it is $arrayShift
-
after it is Rake
after it is Azz -
$arrayShuffle
$arrayJoin[/]
-
$arraySlice[2;3]
$arrayJoin[ ]
-
1.Azz
2.Rake
2.Rake
3.Mido
3.Mido
4.Finkz;
]
$arraySort[no;frequent]
-
3.Mido
2.Rake
4.Finkz
1.Azz
-
3.Mido
2.Rake
4.Finkz;
]
$arraySort[yes;num]
The sorted list is
$arrayJoin[
]
-
1. Azz
2.Rake
3.Mido
4.Finkz
-
1.Azz
2.Rake
4.Finkz;
]
$arraySort[yes;alpha]
The sorted list is
$arrayJoin[
]
-
1. Azz
4.Finkz
3.Mido
2.Rake -
$arrayUnique[, ]
-
$arrayUnshift[Rake]
$arrayUnshift[Azz]
$arrayJoin[/]
-
- -## Example -(Add a simple button) - -(Add in new row) - -(Add disabled) - - -:::tip Available colors -`red, green, blurple, grey, url` -\ -**URL buttons are grey by default.** - -* You can use normal unicode emojis, custom emojis with their ID, or you can use `$customEmoji`. -::: - -##### Function difficulty:
- -### Timeout -The maximum time the bot waits for a user to click a button.\ -Accepts time in the format `10s` for example.\ -The max time is `60 x (bot tier + 1)` seconds, for example for tier 3 it would be `240` seconds. - -::: details Examples - -:::details Examples -(Simple response) - - - -(Usage example) -```php -$let[pressedButton;$awaitButton[Which color is my favorite? -{button:Green:GREEN::green} -{button:Blue:BLUE::blue} -{button:Red:RED::red};$authorID;15s;red;blue;green]] -/* Saves the pressed button id in a temporary var, so you can retrieve later */ - -$if[$pressedButton!=red] -Wrong! -$else -Correct! -$endif -/* If the button id is different from red, which is the right answer, then incorrect. Else, correct. */ -``` -Choosing something other them red, or nothing. - - -Choosing red. - - -::: - -:::tip Note -You can send an embed using the [Message Curl Format](/CodeReferences/ref.message_curl_format.md). -::: - -##### Function difficulty:
{title: Test}
{menu:
{id=test}
{placeholder=Select}
{min=1}
{max=1}
{option=Mido}
{desc=A guy}
{value=mido}
{option=Rake}
{desc=Another guy}
{value=rake}
}
;$authorID;;test]
-
If there's no button, return `undefined`. - -## Usage - -```bash -$buttonIsDisabled -``` - diff --git a/guide/Text/Components/buttonLabel.md b/guide/Text/Components/buttonLabel.md deleted file mode 100644 index 38a8b007..00000000 --- a/guide/Text/Components/buttonLabel.md +++ /dev/null @@ -1,10 +0,0 @@ -# $buttonLabel - -Return the clicked button's label in the Button trigger. If the button doesn't have a label, return `undefined`. - -## Usage - -```bash -$buttonLabel -``` - diff --git a/guide/Text/Components/buttonStyle.md b/guide/Text/Components/buttonStyle.md deleted file mode 100644 index eff3f2d3..00000000 --- a/guide/Text/Components/buttonStyle.md +++ /dev/null @@ -1,10 +0,0 @@ -# $buttonStyle - -Return the clicked button's style, e.g. `blurple`/`red`/`url` in the Button trigger. If none, `undefined` is returned. - -## Usage - -```bash -$buttonStyle -``` - diff --git a/guide/Text/Components/buttonURL.md b/guide/Text/Components/buttonURL.md deleted file mode 100644 index 9bd3aa34..00000000 --- a/guide/Text/Components/buttonURL.md +++ /dev/null @@ -1,10 +0,0 @@ -# $buttonURL - -Return the clicked button's URL in Button trigger if it exists. Else, returns `undefined` if not found. - -## Usage - -```bash -$buttonURL -``` - diff --git a/guide/Text/Components/disableButton.md b/guide/Text/Components/disableButton.md deleted file mode 100644 index 30ef45e2..00000000 --- a/guide/Text/Components/disableButton.md +++ /dev/null @@ -1,21 +0,0 @@ -# $disableButton -Disables a button using its `(ID/label/Emoji/URL)`. - -#### Usage: `$disableButton[Message ID;Label/Emoji/URL/ID (optional, default: disables the last button); Channel ID (optional, default $channelID)]` - -##### Example -(Disable button by emoji) - -(Disable button by URL) - -(Disable button by ID) - -(Disable button by label) - -(Disable the last button ) - - -
- -##### Function difficulty:
- -:::details Examples -(Remove Button using its label) -```php -$removeButton[863xxxxxxxxxx21130;Visit example.com] -``` - -(Remove the Last button) -```php -$removeButton[863xxxxxxxxxx21130] -``` -::: - -##### Function difficulty:
- - - -##### Function difficulty:
-
-
-
-
-
-
- Oh, you are Tom!
- $endIf -
-
- Oh, you are Tom!
- $else
- You are not Tom!
- $endIf -
-
- Oh, you are Tom!
- $elseif[$username==Lisa]
- You are Lisa!
- $endelseIf
- $else
- I don't know you :C
- $endIf -
-
- Oh, you are Tom!
- $elseif[$username==Lisa]
- 1.You are Lisa!
- $endelseIf
- $elseif[$username==Lisa]
- 2.You are Lisa!
- $endelseIf
- $else
- I don't know you :C
- $endIf -
`||` is for OR -
`&&` is for AND - -Example: -```php -$username==Mido&&$country==Egypt -``` -Condition 1: `$username==Mido` -Condition 2: `$country==Egypt` -But this expression will only be true only if both condition 1 **AND** (because of &&) condition 2 is `true` - -The Example below will execute since $username==Tom is false but the second expression is true .It wouldn't work with && -
-
- You are Tom or Lisa
- $endIf -
- You are Lisa with tag 9999
- $endIf
-
-
- $addField[title2;value2]
- $addField[title3;value3]
- $addField[title4;value4]
-
-
-
-
-
{desc:You are awesome}
{color:#0099ff}
] -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
$objectIncrease[Rake;5]
$objectGet
-
-
$objectIncrease[Mido;x*2]
$objectGet
-
$objectSet[user1;id;1234]
$objectSet[user1;weapon;Sword]
$objectSet[user2;name;Rake]
$objectSet[user2;id;5678]
$objectSet[user2;weapon;Feather]
$ObjectKeys[/]
-
-
$objectSet[user1;id;1234]
$objectSet[user1;weapon;Sword]
$objectSet[user2;name;Rake]
$objectSet[user2;id;5678]
$objectSet[user2;weapon;Feather]
$ObjectKeys[/;user1]
-
For example, if your loop contains `$sendMessage[Hello world!]`, it will literally display as "$sendMessage[Hello world!]" because `$sendMessage` is not a zero-cooldown function. - -If you are looking to loop over non-zero cooldown functions, you should use `$forEach` instead. -::: -## Usage - -```bash -$ObjectLoop[key name;value name;index name;Nested Prroperty 1;Nested Property 2;...]{ -CODE... -} -``` -## Loop Limits -Array loops are limited to a certain number of cycles. These limits vary between different tiers of premium. -| Tier | Limit | -| :------- | :--- | -| 0 (Free) | 50 | -| 3 (Freemium) | 50 | -| 4 (Pro) | 100 | -| 5 (Ultra) | 150 | - -### Example: -
$objectSet[Rake;Staff]
$objectLoop[name;weapon;index]{
$index. $name has $weapon
}
-
2. Rake has Staff -
$objectMerge[{"country":"EG"}]
$objectGet
-
-
$objectSet[user;country;EG]
Before: $objectGet
$objectMerge[user;{"name":"Rake","country":"DE"}]
After: $objectGet
-
After: {"user":{"name":"Rake","country":"DE"}} -
-$objectSet[Country;EG]
-Before: $getObject
-$objectRemove[Name]
-After: $getObject -
-After: {"Country":"EG"}
Before: $objectGet
$objectRenameKey[name;nick]
After: $objectGet
-
After: {"nick":"Mido"}
-
Before: $objectGet
$objectRenameKey[user;name;nick]
After: $objectGet
-
After: {"user":{"nick":"Mido"}} -
-
$objectSet[age;300]
$ObjectValues
-
-
$objectSet[user;id;1234]
$objectSet[user;weapon;Sword]
$ObjectValues[/;user]
-
Your name is $objectGet[name]
Your age is $objectGet[age]
-
Your age is 110 -
-
- "Owner": "Rake",
- "Manager": "Mika",
- "Dev": "Mido",
- "Contributor": "Wiki"
-} -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
All mentions are: $mentioned[all]
-
All mentions are: 788361834360864808, 840526017260945468 -
-
-
-
-
-
-
-
$padLeft[13;2;0]
-
13 -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- -::: danger -This function got deprecated, use `$arrayRemove` instead -::: - -##### Function difficulty
-
-
-
-
-
-
-
-
-
-
My name is $void[$get[name]]
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
$get[orange] or $orange -
-
-
-
-
$increaseChannelVar[messages;x*2]
After: $getChannelVar[messages]
-
After: 10 -
$increaseServerVar[ticket numbers;x*2]
After: $getServerVar[ticket numbers]
-
After: 10 -
$increaseUserVar[money;x*2]
After: $getUserVar[money]
-
After: 2000 -
-
-
-
-
-
-
-
- !!exec $userLeaderboard[money;asc;{top}.- {username} - {value}] -
-
-
-
-
-
-
-
-