-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fun: migrate fun documentation (#27)
* fun: migrate fun documentation Signed-off-by: SoggySaussages <[email protected]> * fun: correct weight Signed-off-by: SoggySaussages <[email protected]> --------- Signed-off-by: SoggySaussages <[email protected]> Signed-off-by: Luca Zeuch <[email protected]>
- Loading branch information
1 parent
6c44759
commit f4953d2
Showing
5 changed files
with
147 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
+++ | ||
archetype = "chapter" | ||
title = "Fun" | ||
weight = 7 | ||
+++ | ||
|
||
Fun commands and systems provide engaging ways to enrich your server environment. | ||
|
||
This chapter documents the fun systems which offer additional configuration via the control panel. To see all fun | ||
commands, [click here](/commands/all-commands#fun) | ||
|
||
{{%children containerstyle="div" style="h2" description="true" %}} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
+++ | ||
title = 'Reputation' | ||
weight = 1 | ||
+++ | ||
|
||
The reputation system tracks each user's reputation score, and allows users to add or remove reputation points from | ||
other users. | ||
|
||
<!--more--> | ||
|
||
## Setup | ||
|
||
![Overview of the Reputation System](overview_reputation.png) | ||
|
||
Reputation is not enabled by default. To enable it, please go to the [control panel](https://yagpdb.xyz/manage) and | ||
check _Reputation enabled._ | ||
|
||
### Enable giving rep when someone says "thanks @user"? | ||
|
||
This is an alternative way of `-giverep`. | ||
|
||
### Name for reputation points | ||
|
||
This will be displayed in the `-rep` command. By default, it is _Rep_. | ||
|
||
### Rep cooldown in seconds | ||
|
||
This is the cooldown for the `-giverep` and `-takerep` commands. It does not affect the `-setrep` command. No one can | ||
bypass this cooldown, including admins. | ||
|
||
###  Maximum amount of rep that can be given/taken away in one command | ||
|
||
This affects the `-giverep` and `-takrep` commands which users can choose to specify the number of points to be | ||
given/taken away. | ||
|
||
### Admin role | ||
|
||
Users with this role have access to the `-setrep` command and can freely change anyone's points to any number. | ||
|
||
### Required role to give/remove points | ||
|
||
Users with this role have access to the `-giverep` and `-takerep` commands which is affected by the _Rep cool down in | ||
seconds_ and the _Maximum amount of rep that can be given/taken away in one command_. If set to none, everyone will be | ||
able to use these commands. | ||
|
||
### Required role to receive/being taken away points from | ||
|
||
Users with this role participates in the point system which they can be given/taken away points from. If set to none, | ||
everyone will be participating. | ||
|
||
### Blacklisted role for giving/taking away points | ||
|
||
Users with this role cannot use the `-giverep` and `-takerep` commands. This also overrides the _Required role to | ||
give/remove points._ | ||
|
||
### Blacklisted role for receiving/being taken away points from | ||
|
||
Users with this role cannot participate in the point system which they can be given/taken away points from. This also | ||
overrides the _Required role to receive/being taken away points from_. | ||
|
||
## Reputation logs | ||
|
||
Besides using the command `-replog` , you can also check the logs from the control panel. Specify a user ID to check the | ||
logs affecting the points of the user. | ||
|
||
## Reset all user's reputation | ||
|
||
This command is irreversible, and will reset everyone's reputation point to 0. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
+++ | ||
title = 'Soundboard' | ||
weight = 2 | ||
+++ | ||
|
||
The soundboard system allows the bot to join a voice channel, and play sounds triggered by soundboard commands. | ||
|
||
<!--more--> | ||
|
||
## Uploading New Sounds | ||
|
||
### Name | ||
|
||
Give the sound a name. This name will be shown in the list to play later on. Avoid giving duplicated names for easier | ||
reference. | ||
|
||
### Required role | ||
|
||
Choose to require users to have a role in order to play this sound. | ||
|
||
### Upload file | ||
|
||
{{% notice style="tip" %}} | ||
|
||
Do **not** fill in the URL if you are going uploaded from local files, and vice versa. | ||
|
||
{{% /notice %}} | ||
|
||
You have two options to upload sounds: | ||
|
||
* Upload with local files | ||
* Specify a URL | ||
|
||
#### Upload with local files | ||
|
||
Click on _Choose file_ and __ select an audio file to upload. All types of sound files, including videos with sound | ||
tracks, are supported. | ||
|
||
#### Specify a URL | ||
|
||
You can also specify a sound URL instead of uploading one.  | ||
|
||
{{% notice style="tip" %}} | ||
|
||
This has to be the direct link to the media file, and not a YouTube link. A direct link should end with`.mp3`(or other | ||
relevant audio/video type), such as | ||
[http://soundboard.panictank.net/AIRHORN.mp3](http://soundboard.panictank.net/AIRHORN.mp3).  | ||
|
||
{{% /notice %}} | ||
|
||
### Finish | ||
|
||
Click on _Upload/Download_ after you are done with the previous steps. You should see a _Success_ notification when the | ||
upload is completed. Check the status of the sound under _Existing sounds_. __ Wait for several minutes, and press | ||
_Save_ again if the status does not show _Ready_. | ||
|
||
![An example of a successfully uploaded sound](example_soundboard.png) | ||
|
||
## Playing sounds | ||
|
||
You can check for an available list of sounds with the `-soundboard` command. Then, play it with the `-sb <sound name>` | ||
command. Make sure that YAGPDB has the right permissions (i.e. connect to and speak in the voice channel). | ||
|
||
## Deleting sounds | ||
|
||
You can delete sounds from the control panel. Look for the desired sound name under _Existing sounds_ and press _Delete_ | ||
to remove it from the list. |