Skip to content

Commit

Permalink
Merge pull request #22 from CriticalFlaw/dev
Browse files Browse the repository at this point in the history
Version 3.1
  • Loading branch information
CriticalFlaw authored Apr 18, 2021
2 parents 80b6c78 + 826ea61 commit 14d0eb7
Show file tree
Hide file tree
Showing 92 changed files with 1,925 additions and 1,841 deletions.
27 changes: 15 additions & 12 deletions docs/modules/bot.md → docs/cmd/bot.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,23 @@ This section is for common issues you may encounter and how to resolve them.

## Bot

Description: Basic commands for interacting with FlawBOT.
Aliases: flaw

### info

Description: Retrieve FlawBOT information.
Description: Retrieve information about FlawBOT.
Aliases: about
Parameters: None
Parameters: None.

```
.bot info
```

### leave

Description: Make FlawBOT leave the current server.
Aliases: None
Description: Make FlawBOT leave the server.
Aliases: None.
Parameters: None. Respond with yes when prompted to complete the action.

```
Expand All @@ -34,15 +37,15 @@ Parameters: None. Respond with yes when prompted to complete the action.

Description: Ping the FlawBOT client.
Aliases: pong
Parameters: None
Parameters: None.

```
.bot ping
```

### report

Description: Report a problem with FlawBOT to the developer. Please do not abuse.
Description: Report a problem with FlawBOT to the developer.
Aliases: issue
Parameters: Detailed description of the issue. Minimum 50 characters.

Expand All @@ -53,23 +56,23 @@ Parameters: Detailed description of the issue. Minimum 50 characters.
### uptime

Description: Retrieve the FlawBOT uptime.
Aliases: time
Parameters: None

Aliases: None.
Parameters: None.

```
.bot uptime
```

---

## Owner Only
## Owner-Only

### activity

Description: Set FlawBOT's activity.
Aliases: setactivity
Parameters: Name of the activity.

```
.bot activity Team Fortress 2
```
Expand All @@ -78,7 +81,7 @@ Parameters: Name of the activity.

Description: Set FlawBOT's avatar.
Aliases: setavatar, pfp, photo
Parameters: Image URL. Must be in jpg, png or img format.
Parameters: Image URL. Must be in JPG, PNG or IMG format.

```
.bot avatar [Image URL]
Expand All @@ -98,7 +101,7 @@ Parameters: Activity Status. Online, Idle, DND or Offline.

Description: Set FlawBOT's username.
Aliases: setusername, name, setname, nickname, nick
Parameters: New bot username.
Parameters: New nickname for FlawBOT.

```
.sudo setname FlowBOT
Expand Down
114 changes: 114 additions & 0 deletions docs/cmd/channel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
[issues-link]: https://github.com/CriticalFlaw/FlawBOT/issues
[discord-link]: https://discord.gg/hTdtK9vBhE

This section is for common issues you may encounter and how to resolve them.

* For error or issues not on this page, please [open a ticket on our issue tracker][issues-link].
* For questions not covered in this documentation, [post in our Discord server][discord-link].

---

## Channel

Description: Commands for controlling channels.
Aliases: chn, ch, c

### category

Description: Create a new channel category.
Aliases: createcategory, newcategory, ct
Parameters: New category name.

```
.channel category Welcome
```

### clean

Description: Remove channel messages.
Aliases: clear
Parameters: Number of messages to remove from the current channel.

```
.channel clean 10
```

### delete

Description: Delete a channel. If a channel isn't specified, the current one will be deleted.
Aliases: remove
Parameters: Channel to delete.

```
.channel delete #text
```

### info

Description: Print channel information. If a channel isn't specified, the current one will be used.
Aliases: i
Parameters: Channel to retrieve information from.

```
.channel info #text
```

### purge

Description: Remove server user's channel messages.
Aliases: None
Parameters: Server user whose messages will be purged. Number of messages to purge.

```
.channel purge @CriticalFlaw 10
```

### rename

Description: Rename a channel. If a channel isn't specified, the current one will be used.
Aliases: setname
Parameters: Channel to rename. New channel name.

```
.channel rename #text newtext
```

### text

Description: Create a new text channel.
Aliases: createtext, newtext
Parameters: New text channel name.

```
.channel text texts
```

### topic

Description: Set current channel's topic.
Aliases: settopic
Parameters: New channel topic.

```
.channel topic Watermelon picking
```

### voice

Description: Create a new voice channel.
Aliases: createvoice, newvoice
Parameters: New voice channel name.

```
.channel voice voices
```

### vote

Description: Run a Yay or Nay poll in the current channel.
Aliases: poll
Parameters: Question to be asked in the poll.

```
.channel poll Am I correct?
```
64 changes: 64 additions & 0 deletions docs/cmd/emoji.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
[issues-link]: https://github.com/CriticalFlaw/FlawBOT/issues
[discord-link]: https://discord.gg/hTdtK9vBhE

This section is for common issues you may encounter and how to resolve them.

* For error or issues not on this page, please [open a ticket on our issue tracker][issues-link].
* For questions not covered in this documentation, [post in our Discord server][discord-link].

---

## Emoji

Description: Commands for managing server emojis.
Aliases: emote

### add

Description: Add a new server emoji using a URL image.
Aliases: new, create
Parameters: Image URL. Name for the emoji.

```
.emoji add homer [Image URL]
```

### delete

Description: Remove a server emoji. Note: Bots can only delete emojis they created.
Aliases: remove
Parameters: Server emoji to delete.

```
.emoji delete :homer:
```

### rename

Description: Rename a server emoji.
Aliases: edit, modify
Parameters: Emoji to rename. New emoji name.

```
.emoji rename :homer: homey
```

### info

Description: Retrieve server emoji information.
Aliases: None.
Parameters: Server emoji.

```
.emoji info :homer:
```

### list

Description: Retrieve a list of server emojis.
Aliases: print, all
Parameters: None.

```
.emoji list
```
Loading

0 comments on commit 14d0eb7

Please sign in to comment.