Browse Source

Better formatting for some of the docs.

tags/v2.0.0
Roxie Gibson 5 years ago
parent
commit
00d719f1fc
2 changed files with 133 additions and 130 deletions
  1. +113
    -112
      docs/commands.md
  2. +20
    -18
      mkdocs.yml

+ 113
- 112
docs/commands.md View File



## Cog Commands ## Cog Commands


### Admin
## Admin
The Admin cog adds admin commands to Roxbot which should make moderating a Discord server easier. The Admin cog adds admin commands to Roxbot which should make moderating a Discord server easier.


!!! warning !!! warning
This whole cog cannot be used in private messages. This whole cog cannot be used in private messages.


#### ;ban
### ;ban


!!! warning !!! warning
Command requires the user **and** Roxbot to have the `ban_users` permission. Command requires the user **and** Roxbot to have the `ban_users` permission.


#### ;kick
### ;kick


!!! warning !!! warning
Command requires the user **and** Roxbot to have the `kick_users` permission. Command requires the user **and** Roxbot to have the `kick_users` permission.




#### ;purge
### ;purge


!!! warning !!! warning
Command requires the user **and** Roxbot to have the `manage_messages` permission. Command requires the user **and** Roxbot to have the `manage_messages` permission.




#### ;slowmode
### ;slowmode


!!! warning !!! warning
Command requires the user **and** Roxbot to have the `manage_channels` permission. Command requires the user **and** Roxbot to have the `manage_channels` permission.


#### ;unban
### ;unban


!!! warning !!! warning
Command requires the user **and** Roxbot to have the `ban_users` permission. Command requires the user **and** Roxbot to have the `ban_users` permission.




#### ;warn
### ;warn


!!! warning !!! warning
Group requires the user to have the `kick_users` permission. <small>The logic here is that if a mod can kick a user, they can warn a user too as they are similar in function.</small> Group requires the user to have the `kick_users` permission. <small>The logic here is that if a mod can kick a user, they can warn a user too as they are similar in function.</small>


--- ---


### Custom Commands
## Custom Commands


#### ;custom
### ;custom


!!! warning !!! warning
This command group cannot be used in private messages. This command group cannot be used in private messages.


##### Subcommands

__;custom add__
#### ;custom add


!!! warning !!! warning
Command requires the user to have the `manage_messages` permission. Command requires the user to have the `manage_messages` permission.


__;custom edit__
#### ;custom edit


!!! warning !!! warning
Command requires the user to have the `manage_messages` permission. Command requires the user to have the `manage_messages` permission.


__;custom list__
#### ;custom list


__;custom remove__
#### ;custom remove


!!! warning !!! warning
Command requires the user to have the `manage_messages` permission. Command requires the user to have the `manage_messages` permission.


--- ---


### Fun
## Fun


#### ;aesthetics
### ;aesthetics


#### ;coinflip
### ;coinflip


#### ;frogtips
### ;frogtips


#### ;hug
### ;hug


#### ;numberfact
### ;numberfact


#### ;onthisday
### ;onthisday


#### ;pet
### ;pet


#### ;roll
### ;roll


Rolls a die using dice expression format. Spaces in the expression are ignored. Rolls a die using dice expression format. Spaces in the expression are ignored.




Credit: TBTerra#5677 Credit: TBTerra#5677


#### ;roxbotfact
### ;roxbotfact


#### ;spank
### ;spank


!!! warning !!! warning
This command will only work in channels marked NSFW or DMs. This command will only work in channels marked NSFW or DMs.


#### ;suck
### ;suck


!!! warning !!! warning
This command will only work in channels marked NSFW or DMs. This command will only work in channels marked NSFW or DMs.


#### ;waifurate
### ;waifurate


#### ;xkcd
### ;xkcd


Grabs the image & metadata of the given xkcd comic. The query can be a comic number, comic title, or latest to get the latest. If not given, Roxbot will return a random comic. Grabs the image & metadata of the given xkcd comic. The query can be a comic number, comic title, or latest to get the latest. If not given, Roxbot will return a random comic.


`;xkcd "Silent Hammer"` `;xkcd "Silent Hammer"`
`;xkcd latest` `;xkcd latest`


#### ;zalgo
### ;zalgo


--- ---


### ImageEditor
## ImageEditor


The ImageEditor cog is a cog with multiple commands to manipulate images provided by the user. The ImageEditor cog is a cog with multiple commands to manipulate images provided by the user.


#### ;deepfry
### ;deepfry


Deepfrys the given image Deepfrys the given image


4. Provide an image via upload, that image will be deepfried 4. Provide an image via upload, that image will be deepfried




#### ;pride
### ;pride


`;pride` is a command group for multiple pride flag filters. Avalible pride filters are: LGBT, Bisexual, Asexual, Pansexual, Transgender, Non Binary, Agender, Gender Queer, Gender Fluid. `;pride` is a command group for multiple pride flag filters. Avalible pride filters are: LGBT, Bisexual, Asexual, Pansexual, Transgender, Non Binary, Agender, Gender Queer, Gender Fluid.


!!! note !!! note
If you want there to be more pride flag filters or feel there are some missing, don't be afraid to [submit an issue to the Github repo!](https://github.com/Roxxers/roxbot/issues/new) If you want there to be more pride flag filters or feel there are some missing, don't be afraid to [submit an issue to the Github repo!](https://github.com/Roxxers/roxbot/issues/new)


##### Subcommands
Subcommands


__;pride agender__
#### ;pride agender




__;pride asexual__
#### ;pride asexual


**Aliases** **Aliases**


`ace` `ace`


__;pride bisexual__

#### ;pride bisexual


**Aliases** **Aliases**


`bi` `bi`


__;pride genderfluid__
#### ;pride genderfluid


**Aliases** **Aliases**


`gf` `gf`


__;pride genderqueer__

#### ;pride genderqueer


**Aliases** **Aliases**


`gq` `gq`


__;pride lgbt__
#### ;pride lgbt




__;pride nonbinary__
#### ;pride nonbinary




**Aliases** **Aliases**


`nb`, `enby` `nb`, `enby`


__;pride transgender__
#### ;pride transgender


**Aliases** **Aliases**




--- ---


### JoinLeave
## JoinLeave


JoinLeave is a cog that allows you to create custom welcome and goodbye messages for your Discord server. JoinLeave is a cog that allows you to create custom welcome and goodbye messages for your Discord server.


!!! warning !!! warning
This whole cog cannot be used in private messages. This whole cog cannot be used in private messages.


#### ;goodbyes
### ;goodbyes


Edits settings for the goodbye messages. Edits settings for the goodbye messages.


Command Structure:
`;goodbyes option [changes: optional]`
**Command Structure**


Options:
enable/disable: Enable/disables goodbye messages.
channel: Sets the channel for the message to be posted in. If no channel is provided, it will default to the channel the command is executed in.
`;goodbyes option [changes: optional]`


Example:
Enable goodbye messages, set the channel one called `#logs`
`;goodbyes enable`
`;goodbyes channel #logs`
**Options**


#### ;greets
```py
'enable/disable' # Enable/disables goodbye messages.
'channel' # Sets the channel for the message to be posted in. If no channel is provided, it will default to the channel the command is executed in.
```


Edits settings for the welcome messages
**Example**


Command Structure:
Enable goodbye messages, set the channel one called `#logs` using a channel mention.
```
;goodbyes enable
;goodbyes channel #logs
```


`;greets option [changes: optional]`
### ;greets


Options:
Edits settings for the welcome messages

**Command Structure**


`enable/disable`: Enable/disables greet messages.
`;greets option [changes: optional]`


`channel`: Sets the channel for the message to be posted in. If no channel is provided, it will default to the channel the command is executed in.
**Options**


`message`: Specifies a custom message for the greet messages.
```py
'enable/disable' # Enable/disables greet messages.
'channel' # Sets the channel for the message to be posted in. If no channel is provided, it will default to the channel the command is executed in.
'message' # Specifies a custom message for the greet messages.
```


Example:
**Example**


Enable greet messages, set the channel to the current one, and set a custom message to be appended. Enable greet messages, set the channel to the current one, and set a custom message to be appended.


```py ```py
;greets enable ;greets enable
;greets message "Be sure to read the rules and say hi! :wave:" ;greets message "Be sure to read the rules and say hi! :wave:"
;greets channel` # if no channel is provided, it will default to the channel the command is executed in.
;greets channel # if no channel is provided, it will default to the channel the command is executed in.
``` ```




--- ---


### NSFW
## NSFW


#### ;e621
### ;e621


!!! warning !!! warning
This command will only work in channels marked NSFW or DMs. This command will only work in channels marked NSFW or DMs.


#### ;gelbooru
### ;gelbooru


!!! warning !!! warning
This command will only work in channels marked NSFW or DMs. This command will only work in channels marked NSFW or DMs.


#### ;rule34
### ;rule34


!!! warning !!! warning
This command will only work in channels marked NSFW or DMs. This command will only work in channels marked NSFW or DMs.


--- ---


#### ;nsfw
### ;nsfw


!!! warning !!! warning
This command cannot be used in private messages. This command cannot be used in private messages.


--- ---


### Reddit
## Reddit


The Reddit cog is a cog that allows users to get images and videos from their favourite subreddits. The Reddit cog is a cog that allows users to get images and videos from their favourite subreddits.


#### ;subreddit
### ;subreddit


Grabs an image or video (jpg, png, gif, gifv, webm, mp4) from the subreddit inputted. Grabs an image or video (jpg, png, gif, gifv, webm, mp4) from the subreddit inputted.


!!! info !!! info
The following commands are alias-like commands that function like `;subreddit`, randomly selecting a subreddit in a collection of themed subreddits to get a post from. The following commands are alias-like commands that function like `;subreddit`, randomly selecting a subreddit in a collection of themed subreddits to get a post from.


#### ;aww
### ;aww


Gives you cute pics from reddit Gives you cute pics from reddit




`;aww` `;aww`


#### ;feedme
### ;feedme


Feeds you with food porn. Feeds you with food porn.




`;feedme` `;feedme`


#### ;feedmevegan
### ;feedmevegan


Feeds you with vegan food porn. Feeds you with vegan food porn.




`;feedmevegan` `;feedmevegan`


#### ;me_irl
### ;me_irl


The full (mostly) me_irl network of subs. The full (mostly) me_irl network of subs.




`meirl` `meirl`


#### ;traa
### ;traa


Gives you the best trans memes for daysssss Gives you the best trans memes for daysssss




--- ---


### SelfAssign
## SelfAssign


The SelfAssign cog allows guild's to mark roles as 'self assignable'. This allows users to give themselves these roles and to see all the roles marked as 'self assignable'. The SelfAssign cog allows guild's to mark roles as 'self assignable'. This allows users to give themselves these roles and to see all the roles marked as 'self assignable'.


!!! warning !!! warning
This whole cog cannot be used in private messages. This whole cog cannot be used in private messages.


#### ;iam
### ;iam


Self-assign yourself a role. Can only be done one role at a time. Self-assign yourself a role. Can only be done one role at a time.


`;iam OverwatchPing` `;iam OverwatchPing`




#### ;iamn
### ;iamn


Remove a self-assigned role. Can only be done one role at a time. Remove a self-assigned role. Can only be done one role at a time.


`;iamn OverwatchPing` `;iamn OverwatchPing`




#### ;listroles
### ;listroles


List's all roles that can be self-assigned on this server. List's all roles that can be self-assigned on this server.




--- ---


#### ;selfassign
### ;selfassign


!!! warning !!! warning
Command requires the user to have the `manage_roles` permission. Command requires the user to have the `manage_roles` permission.


--- ---


### Trivia
## Trivia


#### ;trivia
### ;trivia


!!! warning !!! warning
This command group cannot be used in private messages. This command group cannot be used in private messages.




##### Subcommands

__;trivia about__
#### ;trivia about


__;trivia join__
#### ;trivia join


__;trivia leave__
#### ;trivia leave


__;trivia start__
#### ;trivia start


__;trivia kick__
#### ;trivia kick


--- ---


### Util
## Util


#### ;avatar
### ;avatar


#### ;echo
### ;echo


#### ;emote
### ;emote


#### ;guild
### ;guild


!!! warning !!! warning
This command cannot be used in private messages. This command cannot be used in private messages.




#### ;info
### ;info


#### ;invite
### ;invite


#### ;role
### ;role


!!! warning !!! warning
This command cannot be used in private messages. This command cannot be used in private messages.


--- ---


### Voice
## Voice


!!! warning !!! warning
This whole cog cannot be used in private messages. This whole cog cannot be used in private messages.


#### ;join
### ;join


#### ;nowplaying
### ;nowplaying


#### ;pause
### ;pause


#### ;play
### ;play


#### ;queue
### ;queue


#### ;remove
### ;remove


#### ;resume
### ;resume


#### ;skip
### ;skip


#### ;stop
### ;stop


#### ;stream
### ;stream


#### ;volume
### ;volume


#### ;voice
### ;voice

+ 20
- 18
mkdocs.yml View File



# Layout # Layout
nav: nav:
- 'Introduction': 'index.md'
- 'Quick Start': 'quickstart.md'
- 'Configuring Roxbot': 'config.md'
- 'Command Documentation': 'commands.md'
- 'Creating Cogs For Roxbot': 'creating_cogs.md'
- 'Contributing': 'contributing.md'
- 'License': 'license.md'
- 'Command Docs': 'commands.md'
- User Guide:
- 'Quick Start': 'quickstart.md'
- 'Configuring Roxbot': 'config.md'
- 'Creating Cogs For Roxbot': 'creating_cogs.md'
- About:
- 'Contributing': 'contributing.md'
- 'License': 'license.md'




# Customisation # Customisation
theme:
name: 'readthedocs'
theme:
name: material
language: en language: en
# palette:
# primary: 'deep purple'
# accent: 'deep purple'
navigation-depth: 5
palette:
primary: 'deep purple'
accent: 'deep purple'
font: font:
text: 'Roboto' text: 'Roboto'
code: 'Roboto Mono' code: 'Roboto Mono'
# logo:
# icon: "\uE80C"
# feature:
# tabs: true
# static_templates:
# - 404.html
logo:
icon: "\uE80C"
feature:
tabs: false
static_templates:
- 404.html


extra: extra:
social: social:

Loading…
Cancel
Save