You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-16Lines changed: 12 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,39 +2,35 @@
2
2
3
3
Experimental / proof of concept page to replace the current documentation which is built with GitBook.
4
4
5
-
This documentation is built with [Hugo](https://gohugo.io) in conjunction with the [Doks theme](https://getdoks.org/) as
6
-
an experiment to see if it is a viable alternative.
5
+
This documentation is built with [Hugo](https://gohugo.io) in conjunction with the [Doks theme](https://getdoks.org/) as an experiment to see if it is a viable alternative.
7
6
8
7
## Contributing / Building
9
8
10
-
Install [Node.js](https://nodejs.org/en), clone this repository, install the dependencies with `npm install`, and run
11
-
`npm run dev` to start a local server. The server will automatically rebuild the page when you make changes.
9
+
Install [Node.js](https://nodejs.org/en), clone this repository, install the dependencies with `npm install`, and run`npm run dev` to start a local server.
10
+
The server will automatically rebuild the page when you make changes.
12
11
13
-
To build the page in release mode, use `HUGO_BASEURL=... npm run build`, then serve the generated `public/` directory
14
-
with your webserver of choice.
12
+
To build the page in release mode, use `HUGO_BASEURL=... npm run build`, then serve the generated `public/` directory with your webserver of choice.
15
13
16
14
For more information, please view our [Contributing Guidelines](.github/CONTRIBUTING.md).
17
15
18
16
### Editor Setup
19
17
20
-
As this project uses the [EditorConfig](https://editorconfig.org/) standard, you will have to make sure that your
21
-
editor supports it. Most modern editors do, but if you are unsure, check the EditorConfig page.
18
+
As this project uses the [EditorConfig](https://editorconfig.org/) standard, you will have to make sure that your editor supports it.
19
+
Most modern editors do, but if you are unsure, check the EditorConfig page.
22
20
23
21
### Authoring Content
24
22
25
-
Pages are written in Markdown with additional shortcodes provided by the Doks theme; refer to [its
26
-
documentation](<(https://getdoks.org/docs/start-here/getting-started/)>) for a complete list of features.
23
+
Pages are written in Markdown with additional shortcodes provided by the Doks theme; refer to [its documentation](<(https://getdoks.org/docs/start-here/getting-started/)>) for a complete list of features.
27
24
28
-
If you are editing pages related to custom commands, note that codeblocks support a custom `yag` language for accurate
29
-
syntax highlighting—do not use `go`. However, this feature is only enabled in production builds for performance, so
30
-
`npm run dev` will _not_ highlight `yag` codeblocks. Use `npm run build` followed by `npm run preview` instead if you
31
-
need to verify that code is highlighted correctly.
25
+
If you are editing pages related to custom commands, note that codeblocks support a custom `yag` language for accurate syntax highlighting—do not use `go`.
26
+
However, this feature is only enabled in production builds for performance, so `npm run dev` will _not_ highlight `yag` codeblocks.
27
+
Use `npm run build` followed by `npm run preview` instead if you need to verify that code is highlighted correctly.
32
28
33
29
> [!TIP]
34
30
> If you use VSCode, this project provides custom workspace snippets to insert callouts, which you can activate in
35
31
> Markdown files by typing <kbd>Ctrl</kbd> + <kbd>Space</kbd> followed by `note`, `tip`, `warning`, or `danger`.
36
32
37
33
## License
38
34
39
-
This documentation's text is distributed under the terms of the Creative Commons Attribution ShareAlike 4.0 license
40
-
(SPDX-indentifer `CC-BY-SA`). Please view the [LICENSE](LICENSE) file for more information.
35
+
This documentation's text is distributed under the terms of the Creative Commons Attribution ShareAlike 4.0 license (SPDX-indentifer `CC-BY-SA`).
36
+
Please view the [LICENSE](LICENSE) file for more information.
Copy file name to clipboardExpand all lines: content/docs/core/command-settings.md
+41-39Lines changed: 41 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,28 +8,33 @@ Fine-grained control over all of YAGPDB's inbuild commands.
8
8
9
9
## Overview
10
10
11
-
Command overrides allow you to restrict access to YAGPDB's inbuilt commands and optionally configure intervals after
12
-
which the command trigger and response will be autodeleted. The key features of the page are as follows:
13
-
14
-

11
+
Command overrides allow you to restrict access to YAGPDB's inbuilt commands and optionally configure intervals after which the command trigger and response will be autodeleted.
The order above trickles down from least specific to most specific, prioritizing the most specific setting---an analogy
60
-
for developers would be CSS's cascading rules.
64
+
The order above trickles down from least specific to most specific, prioritizing the most specific setting---an analogy for developers would be CSS's cascading rules.
61
65
62
-
Though perhaps confusing at first, the priority order above is designed to make common configurations trivial. For
63
-
instance, to disable all but a specific command---say the `remindme` command---one can simply disable the _All
64
-
commands enabled_ option and then create a command override that enables only `remindme`. This is possible as command
65
-
overrides are applied after the _All commands enabled_ setting.
66
+
Though perhaps confusing at first, the priority order above is designed to make common configurations trivial.
67
+
For instance, to disable all but a specific command---say the `remindme` command---one can simply disable the _All commands enabled_ option and then create a command override that enables only `remindme`.
68
+
This is possible as command overrides are applied after the _All commands enabled_ setting.
66
69
67
70
## Options
68
71
69
72
### Common Options
70
73
71
-
These options are common across all three sub-settings: global settings, channel overrides, and individual command
72
-
overrides.
74
+
These options are common across all three sub-settings: global settings, channel overrides, and individual command overrides.
73
75
74
76
#### Required and Ignored Roles
75
77
76
-
Clicking on either of these options (**3**,**4**) opens a drop-down menu with all the roles present on your server.
77
-
Select as many as you wish. YAGPDB will then either require all members to have any of these roles in order to run
78
-
commands, or completely ignore members with any of the ignored roles, server admins and owners included.
78
+
Clicking on either of these options (**3**,**4**) opens a drop-down menu with all the roles present on your server.
79
+
Select as many as you wish.
80
+
YAGPDB will then either require all members to have any of these roles in order to run commands, or completely ignore members with any of the ignored roles, server admins and owners included.
79
81
80
82
{{< callout context="note" title="Note: Priority of Ignored vs. Required Roles" icon="outline/info-circle" >}}
81
83
82
-
YAGPDB was raised well and honors a "no" when told "no". In other words, ignored roles take precedence over required
83
-
roles.
84
+
YAGPDB was raised well and honors a "no" when told "no".
85
+
In other words, ignored roles take precedence over required roles.
84
86
85
87
{{< /callout >}}
86
88
87
89
#### Autodelete Trigger / Response Interval
88
90
89
-
This setting makes YAGPDB automatically delete the triggering message and/or its response after the configured duration
90
-
has passed. To activate it, make sure to click the checkbox next to the respective input field (**5**,**6**).
91
+
This setting makes YAGPDB automatically delete the triggering message and/or its response after the configured duration has passed.
92
+
To activate it, make sure to click the checkbox next to the respective input field (**5**,**6**).
91
93
92
94
If 10 seconds are not enough, or too long, feel free to adjust as you see fit; the intervals need not be equal.
93
95
94
96
#### Slash command response always ephemeral
95
97
96
-
Toggling this setting on will make YAGPDB always respond to slash commands with an ephemeral message. This means that
97
-
only the user who triggered the command will be able to see the response.
98
+
Toggling this setting on will make YAGPDB always respond to slash commands with an ephemeral message.
99
+
This means that only the user who triggered the command will be able to see the response.
98
100
99
101
### Channel Override Options
100
102
101
-
These options are only available for channel overrides (**8**). To add a new one, head to the _New channel override_
102
-
tab on the command settings page.
103
+
These options are only available for channel overrides (**8**).
104
+
To add a new one, head to the _New channel override_tab on the command settings page.
103
105
104
106
You must select at least one channel or category; otherwise, the settings of the override will not be applied.
105
107
106
108
#### Channels
107
109
108
-
With this setting, you can select individual channels to apply the override to. Select as many as you wish.
110
+
With this setting, you can select individual channels to apply the override to.
111
+
Select as many as you wish.
109
112
110
113
You find this setting in the top-left corner of any channel override.
111
114
@@ -117,17 +120,16 @@ You find this setting in the top-right corner of any channel override, adjacent
117
120
118
121
### Command Override Options
119
122
120
-
These options are only available for individual command overrides (**7**). To add a new one, go to either your
121
-
global settings or any channel override and click on _New command override_.
123
+
These options are only available for individual command overrides (**7**).
124
+
To add a new one, go to either your global settings or any channel override and click on _New command override_.
122
125
123
126
#### Commands
124
127
125
-
This setting allows you to select specific commands to apply the command override to. Select as many as you wish to
126
-
apply an override to. You cannot have two (or more) overrides for the same command in the same tab, i.e. global settings
127
-
or a specific channel override.
128
+
This setting allows you to select specific commands to apply the command override to.
129
+
Select as many as you wish to apply an override to.
130
+
You cannot have two (or more) overrides for the same command in the same tab, i.e. global settings or a specific channel override.
128
131
129
132
#### Enable Specified Commands
130
133
131
-
Toggling this option simply tells YAGPDB whether the commands you selected are enabled or disabled. This allows you to
132
-
disable some specific commands, which may be useful if -- for example -- you have created a custom command that
133
-
completely replaces an inbuilt one.
134
+
Toggling this option simply tells YAGPDB whether the commands you selected are enabled or disabled.
135
+
This allows you to disable some specific commands, which may be useful if -- for example -- you have created a custom command that completely replaces an inbuilt one.
Copy file name to clipboardExpand all lines: content/docs/core/control-panel-logs.md
+3-5Lines changed: 3 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,9 @@ weight = 220
4
4
description = "View a list of recent changes to your YAGPDB configuration."
5
5
+++
6
6
7
-
This page is the analogue of the audit log built in to Discord for YAGPDB settings and summarizes recent edits on the
8
-
control panel, listing the time, action, and responsible user for each. It is useful to audit who may be responsible if
9
-
things go haywire, but other than that this page is unlikely to be of use.
7
+
This page is the analogue of the audit log built in to Discord for YAGPDB settings and summarizes recent edits on the control panel, listing the time, action, and responsible user for each.
8
+
It is useful to audit who may be responsible if things go haywire, but other than that this page is unlikely to be of use.
10
9
11
-
Please do not be confused if you see changes from the user `destroy_0001` (ID `598900258579283976`), as that is the bot
12
-
developer and he may at times need to change certain settings to ensure proper operation.
10
+
Please do not be confused if you see changes from the user `destroy_0001` (ID `598900258579283976`), as that is the bot developer and he may at times need to change certain settings to ensure proper operation.
13
11
14
12

0 commit comments