Skip to content

Commit 5a5a30e

Browse files
committed
all: fix what rumdl couldn't
Signed-off-by: Luca Zeuch <[email protected]>
1 parent 73abe60 commit 5a5a30e

File tree

13 files changed

+149
-81
lines changed

13 files changed

+149
-81
lines changed

content/docs/custom-commands/commands.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,21 @@ Editing a custom command (**3**) opens a separate page for configuration.
105105

106106
<center>
107107

108-
**1** ID **2** Name **3** Trigger Type **4** Trigger Text **5** Case Sensitivity Toggle **6** Message Edits Trigger Toggle **7** Response **8** Add Response **9** Custom Command Group **10** Channel and Role Restrictions **11** Execution Statistics **12** Error Output Toggle **13** Enable Command Toggle **14** Save Command **15** Delete command button
108+
**1** ID
109+
**2** Name
110+
**3** Trigger Type
111+
**4** Trigger Text
112+
**5** Case Sensitivity Toggle
113+
**6** Message Edits Trigger Toggle
114+
**7** Response
115+
**8** Add Response
116+
**9** Custom Command Group
117+
**10** Channel and Role Restrictions
118+
**11** Execution Statistics
119+
**12** Error Output Toggle
120+
**13** Enable Command Toggle
121+
**14** Save Command
122+
**15** Delete command button
109123

110124
</center>
111125

content/docs/custom-commands/database.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,18 @@ The database page displays all database entries created by custom commands, allo
1111

1212
<center>
1313

14-
**1** Entry ID **2** Created Timestamp **3** Updated Timestamp **4** Expiry Timestamp **5** User ID **6** Key **7** Value **8** Size of Value **9** Delete Entry **10** Page Navigation **11** Search Query **12** Search Bar
14+
**1** Entry ID
15+
**2** Created Timestamp
16+
**3** Updated Timestamp
17+
**4** Expiry Timestamp
18+
**5** User ID
19+
**6** Key
20+
**7** Value
21+
**8** Size of Value
22+
**9** Delete Entry
23+
**10** Page Navigation
24+
**11** Search Query
25+
**12** Search Bar
1526

1627
</center>
1728

content/docs/moderation/moderation-tools.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,20 @@ Everything in moderation, including moderation.
1010

1111
<center>
1212

13-
**1** Mod Log Channel **2** Report Channel **3** Moderation DM Error Channel **4** Clean Command **5** Report Command **6** Unban Logging **7** Giverole/Takerole commands **8** Give/Takerole Permitted Roles **9** Give/Takerole Logging **10** External Ban Logging **11** External Kick Logging **12** External Timeout Logging **13** Moderation Tabs **14** Bot Permissions Notice
13+
**1** Mod Log Channel
14+
**2** Report Channel
15+
**3** Moderation DM Error Channel
16+
**4** Clean Command
17+
**5** Report Command
18+
**6** Unban Logging
19+
**7** Giverole/Takerole commands
20+
**8** Give/Takerole Permitted Roles
21+
**9** Give/Takerole Logging
22+
**10** External Ban Logging
23+
**11** External Kick Logging
24+
**12** External Timeout Logging
25+
**13** Moderation Tabs
26+
**14** Bot Permissions Notice
1427

1528
</center>
1629

@@ -43,7 +56,8 @@ These commands are:
4356
When the `unban`/ `unmute` commands are used, YAGPDB will log their usage to the [mod log](#mod-channels) similarly to the other moderation commands.
4457

4558
When using the `ban` and `mute` commands with a duration, YAGPDB will automatically undo the punishment after the specified duration.
46-
For instance, if you execute `ban @user 1d`, YAGPDB will ban the user, and 1 day later YAGPDB will execute the `unban` command with reason "Timed ban expired." This action appears in the mod log as YAGPDB being the moderator.
59+
For instance, if you execute `ban @user 1d`, YAGPDB will ban the user, and 1 day later YAGPDB will execute the `unban` command with reason "Timed ban expired".
60+
This action appears in the mod log as YAGPDB being the moderator.
4761

4862
Toggling Unban Logging (**6**) allows you to enable or disable the logging of Unmute events.
4963

@@ -80,7 +94,9 @@ Each of the main moderation tools have individual configuration pages, accessibl
8094

8195
<center>
8296

83-
**1** Permitted Roles **2** Reason Optional Toggle **3** Moderation DM
97+
**1** Permitted Roles
98+
**2** Reason Optional Toggle
99+
**3** Moderation DM
84100

85101
</center>
86102

@@ -121,7 +137,8 @@ Additional template dot context data is available for Moderation Actions:
121137
{{< callout context="danger" title="Danger: Template Execution Errors" icon="outline/alert-octagon" >}}
122138

123139
Any errors which occur in the template execution will not be logged by default.
124-
The offending user will only receive a DM from your server saying **Failed executing template.** Setting a [Moderation DM Error channel](#mod-channels) allows for the more detailed errors to be captured.
140+
The offending user will only receive a DM from your server saying **Failed executing template**.
141+
Setting a [Moderation DM Error channel](#mod-channels) allows for the more detailed errors to be captured.
125142

126143
{{< /callout >}}
127144

content/docs/notifications/youtube.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The bot requires at least the "Read Messages" and "Send Messages" permissions in
1414

1515
## Adding a YouTube Feed
1616

17-
To add a new feed simply copy the channel URL from YouTube and paste it into the "Link" field under "Add New Feed" (you may need to scroll down a bit); then select a channel to post it to.
17+
To add a new feed simply copy the channel URL from YouTube and paste it into the "Link" field under "Add New Feed" (you may need to scroll down a bit), then select a channel to post it to.
1818
For a visual reference, please see the image below.
1919

2020
<center>
@@ -23,23 +23,28 @@ For a visual reference, please see the image below.
2323

2424
</center>
2525

26-
If you are unable to obtain a direct channel URL, similar to If you are unable to obtain a direct channel URL, similar to<br> *<https://youtube.com/channel/UCuAXFkgsw1L7xaCfnd5JJOw>*, we also support the following URLs:
26+
If you are unable to obtain a direct channel URL, similar to <https://youtube.com/channel/UCuAXFkgsw1L7xaCfnd5JJOw>, we also support the following URLs:
2727

2828
- Video links (<https://youtube.com/watch?v=dQw4w9WgXcQ>)
2929
- Shorts links (<https://youtube.com/shorts/pBZ_2pX_8mg>)
3030
- Share links (<https://youtu.be/dQw4w9WgXcQ>)
3131
- Live links (<https://youtube.com/live/jfKfPfyJRdk>)
3232
- Playlist links (<https://youtube.com/playlist?list=PLEamUZtdyTMxwDNQ97Y7im8EwqRyht12R>)
3333

34-
Although we make an attempt at extracting the channel from usernames (<https://youtube.com/user/MontyPython>), custom links (<https://youtube.com/c/Taskmaster>), and handles (<https://youtube.com/@TomScottGo>), these are not as reliable as the links listed above, as we use the first result of a YouTube search to determine the channel via these URLs.
34+
Less reliable, but also supported are
3535

36+
- usernames (<https://youtube.com/user/MontyPython>)
37+
- custom links (<https://youtube.com/c/Taskmaster>)
38+
- handles (<https://youtube.com/@TomScottGo>)
39+
40+
as we use the first result of a YouTube search to determine the channel via these URLs.
3641
If you find yourself having trouble adding a feed using these kinds of URLs, please try to use one of the links listed above before asking for help in the [support server](/discord).
3742

3843
{{< callout context="caution" title="Warning: Maximum Number of Feeds" icon="outline/info-circle" >}}
3944

4045
You cannot have more than 10 active YouTube feeds at a time (250 with [Premium](/docs/welcome/premium)).
4146
If you have that many feeds active, you cannot add more until you disable at least one of those.
42-
That disabled excess feed will be deleted once you add a new one.
47+
Disabled excess feeds will be deleted once you add a new one.
4348

4449
{{< /callout >}}
4550

content/docs/reference/components-v2.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ description = "Be fancier, use components!"
66

77
## componentBuilder
88

9-
`componentBuilder` is a helper for building Discord’s new Components V2 (sections, buttons, menus, galleries). It provides a simple template-based way to assemble complex message layouts without needing to write raw JSON.
9+
The `componentBuilder` is a helper for building Discord’s new Components V2 (sections, buttons, menus, galleries).
10+
It provides a simple template-based way to assemble complex message layouts without needing to write raw JSON.
1011
You describe components with key–value pairs and `componentBuilder` handles conversion and validation for you.
1112

1213
This makes it easier to:

content/docs/reference/custom-command-examples.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ Please visit our [support server](/discord) for newer solutions.
2525
YAGPDB has a built-in random response system for custom commands, but sometimes you may want to control the chances for certain responses to occur.
2626
You can do this by creating a singular response and creating a variable with randInt.
2727
Then use an if-else-if statement like this to print out your desired output.
28-
YAGPDB has a built-in random response system for custom commands, but sometimes you may want to control the chances for certain responses to occur. You can do this by creating a singular response and creating a variable with randInt. Then use an if-else-if statement like this to print out your desired output.&#x20;
28+
YAGPDB has a built-in random response system for custom commands, but sometimes you may want to control the chances for certain responses to occur.
29+
You can do this by creating a singular response and creating a variable with randInt.
30+
Then use an if-else-if statement like this to print out your desired output.
2931

3032
```yag
3133
{{$var := randInt 100}}
@@ -43,8 +45,7 @@ This has a 65% chance of being triggered
4345

4446
This command is to be placed in the welcome message.
4547
It filters out people with invites in their name.
46-
Make sure that the checkbox **Censor server invites in usernames?** and the ban command are enabled on your server. and the ban command are enabled on your server.&#x20;
47-
48+
Make sure that the checkbox **Censor server invites in usernames?** and the ban command are enabled on your server.
4849
You might not want the response for the executed command to show.
4950
You can suppress the response of a command like the following:
5051

@@ -81,11 +82,8 @@ Trigger type: `Command` Trigger: `range`
8182
{{- end }}
8283
```
8384

84-
`$k` is the index for arrays / cslices (starting at 0) or the key for maps and sdicts, while `$v` is the current word in your input that you are on. is the current word in your input that you are on.&#x20;
85-
86-
Range will work on any kind of slice/array. for example.
87-
If we wanted to look for all the entries in our database we can use range and index through them all in the following.
88-
Range will work on any kind of slice/array. for example. If we wanted to look for all the entries in our database we can use range and index through them all in the following.&#x20;
85+
`$k` is the index for arrays / cslices (starting at 0) or the key for maps and sdicts, while `$v` is the current word in your input that you are on.
86+
Range will work on any kind of slice/array, so if we wanted to look for all the entries in our database we can use range and index through them all in the following.
8987

9088
```yag
9189
{{$lb := dbTopEntries "%" 100 0}}
@@ -152,7 +150,8 @@ This custom command is very complex, uses very many advanced functions, all it d
152150
{{execCC REPLACE-WITH-NEXT-CC-ID nil 0 (sdict "MessageID" $mID "T" $t "Message" ($args.Get 1)) }}
153151
```
154152

155-
Second part of the custom commands, here we see, how `data`-part of exeCC was made in previous custom command as `sdict`and now we are calling those keys with `.ExecData` - for example `.ExecData.MessageID` sets new variable the same as stated in previous code.
153+
Second part of the custom commands, here we see, how `data`-part of exeCC was made in previous custom command as `sdict`and now we are calling those keys with `.ExecData`.
154+
For example `.ExecData.MessageID` sets new variable the same as stated in previous code.
156155

157156
```yag
158157
{{$timeLeft := .ExecData.T.Sub currentTime}}
@@ -261,11 +260,10 @@ You can either make them global cooldowns or a per user cooldown.
261260
262261
With YAGPDB's database system, I made a command to have users count from 0 and keep counting to the next number.
263262
Relatively simple command that involves database and type conversion.
264-
With YAGPDB's database system, I made a command to have users count from 0 and keep counting to the next number. Relatively simple command that involves database and type conversion.&#x20;
265263

266264
Trigger type: `Regex` Trigger: `\A`
267265

268-
`BE SURE TO RESTRICT THE COMMAND TO A SINGLE CHANNEL`&#x20;
266+
`BE SURE TO RESTRICT THE COMMAND TO A SINGLE CHANNEL`
269267

270268
```yag
271269
{{/* If you are not doing (no twice msg in a row) or (role assignment for latest user) you can remove counter_user and by extension everything to do with $lastUser*/}}
@@ -352,7 +350,7 @@ Trigger type: `Command` Trigger: `giveRoleName`
352350

353351
### Broadcast command
354352

355-
> By **GryTrean#8957** \
353+
> By **GryTrean#8957**
356354
> Updated by: **Timcampy#5636**
357355
358356
This command lets the bot send a message to another channel.
@@ -389,7 +387,6 @@ Trigger type: `Command` Trigger: `bc`
389387
This command does a good job at using a little bit of everything.
390388
Which include but is not limited to, `conditional statement`, `assigning values to variable`, `getting command arguments`, `using template code`, and `creating embeds`.
391389
If you are able to understand everything in this command, you are at a very good place in being able to make advanced custom commands.
392-
. If you are able to understand everything in this command, you are at a very good place in being able to make advanced custom commands.&#x20;
393390

394391
Trigger type: `Command` Trigger: `avatar`
395392

content/docs/reference/custom-embeds.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ YAGPDB accepts embeds in JSON or YAML following the rules of Discord's [Embed Ob
3838
```yaml
3939
title: This is my title
4040
footer:
41-
text: This is my footer text.
41+
text: This is my footer text.
4242
```
4343
4444
YAML input is formatted as a list of names with associated values for each part of the embed.
@@ -101,11 +101,11 @@ Creating embeds with a generator can be more difficult if you don't need any dif
101101
If you want your embed to be super shiny, you can use [an embed generator](https://leovoel.github.io/embed-visualizer/).
102102
The customembed command only sends an embed, so you'll need to remove everything around it:
103103

104-
````javascript
104+
```javascript
105105
{
106106
"content": "...",
107107
"embed":
108-
````
108+
```
109109

110110
and the last curly brace (`}`).
111111
After this you can copy and paste it after the `ce` command:

content/docs/reference/custom-interactions.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,6 @@ A text menu may not have more than 25 options.
125125
#### Default Value Structure
126126

127127
The user, role, and channel type allow for a slice of `default_values` to be specified.
128-
Below is their structure.
129128

130129
| Field | Description |
131130
| ----- | ------------------------------------------------------------------- |

content/docs/reference/templates/functions.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,8 @@ Returns a channel object on success.
7474
- `message`: either `nil` to create a channel thread, or a message ID to create a message thread.
7575
- `private`: whether the thread is private.
7676
Default `false`.
77-
- `auto_archive_duration`: how long the thread will show in the channel list after inactivity. : how long the thread will show in the channel list after inactivity.<br> Valid values are 60, 1440, 4320, and 10080 minutes.
77+
- `auto_archive_duration`: how long the thread will show in the channel list after inactivity.
78+
Valid values are 60, 1440, 4320, and 10080 minutes.
7879
Defaults to 10080 (7 days).
7980
- `invitable`: whether non-moderators can add other members to the thread. (true/false)
8081

@@ -400,7 +401,8 @@ Returns up to `amount` entries from the database, sorted in descending order by
400401
Numerical values are stored as floating-point numbers in the database; large numbers such as user IDs will lose precision.
401402
To avoid this, convert them to a string before writing to the database.
402403

403-
Numerical `dict` keys are retrieved as an `int64`, therefore you'd have to write , therefore you'd have to write<br> `{{ $dict.Get (toInt64 N)}}` to retrieve the value associated with the numerical key `N`.
404+
Because numerical `dict` keys are retrieved as an `int64`, you have to first convert to `int64` when retrieving such values.
405+
So, to retrieve the value associated with the numerical key `N`: `{{ $dict.Get (toInt64 N)}}`.
404406

405407
{{< /callout >}}
406408

@@ -501,7 +503,8 @@ Executes another custom command specified by `ccID`.
501503
- `delay`: the delay in seconds before executing the custom command.
502504
- `data`: some arbitrary data to pass to the executed custom command.
503505

504-
Calling `execCC` with 0 delay sets `.StackDepth` to the current recursion depth and limits it to 2. `execCC` is rate-limited strictly to a maximum of 10 delayed custom commands executed per channel per minute.
506+
Calling `execCC` with 0 delay sets `.StackDepth` to the current recursion depth and limits it to 2.
507+
`execCC` is rate-limited strictly to a maximum of 10 delayed custom commands executed per channel per minute.
505508
Executions beyond this number will be dropped.
506509

507510
##### Example

0 commit comments

Comments
 (0)