From 80b6c78b8f7c161d8a47e17b1a4046a0ab4cf7de Mon Sep 17 00:00:00 2001 From: CriticalFlaw Date: Fri, 16 Apr 2021 20:50:23 -0400 Subject: [PATCH] Split Modules Documentation - Corrected errors on the main docs page and the README. - Splits the commands page into multiple pages. --- .github/README.md | 12 +- docs/commands.md | 1063 ---------------------------------------- docs/index.md | 26 +- docs/install.md | 4 +- docs/modules/bot.md | 105 ++++ docs/modules/media.md | 373 ++++++++++++++ docs/modules/misc.md | 149 ++++++ docs/modules/music.md | 88 ++++ docs/modules/server.md | 436 ++++++++++++++++ mkdocs.yml | 7 +- 10 files changed, 1177 insertions(+), 1086 deletions(-) delete mode 100644 docs/commands.md create mode 100644 docs/modules/bot.md create mode 100644 docs/modules/media.md create mode 100644 docs/modules/misc.md create mode 100644 docs/modules/music.md create mode 100644 docs/modules/server.md diff --git a/.github/README.md b/.github/README.md index 1faceda2..e13ab003 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,7 +1,7 @@ -[![banner][banner-image]] -[![version][version-badge]] -[![build][build-badge][build-link]] -[![quality][quality-badge][quality-link]] +![banner][banner-image] +![version][version-badge] +[![build][build-badge]][build-link] +[![quality][quality-badge]][quality-link] A Discord bot written in C# using the [DSharpPlus][dsharp-link] library. This bot is not being hosted online, however you're welcome to fork this repository and host it yourself or reuse the code for your own bot, as long as you credit it properly. @@ -12,14 +12,14 @@ A Discord bot written in C# using the [DSharpPlus][dsharp-link] library. This bo To run your own instance of FlawBOT, [clone this repository][clone-link] or [download the release package][release-link] and modify the provided **config.json** file, adding the API tokens. If you're cloning the repository, use [Visual Studio 2019][vs-link] to compile the project. ## Running FlawBOT -As of version 3.0, FlawBOT requires a [Lavalink][lava-link] node to be running in order to play music and not display lavalink-related errors in console. `lavalink.jar` and `application.yml` are included in the project directory, so all you have to do is open the command prompt and launch lavalink with the command `java -jar Lavalink.jar` (be sure to install [Java 13 or later][java-link]. +As of version 3.0, FlawBOT requires a [Lavalink][lava-link] node to be running in order to play music and not display lavalink-related errors in console. `lavalink.jar` and `application.yml` are included in the project directory, so all you have to do is open the command prompt and launch lavalink with the command `java -jar Lavalink.jar` (be sure to install [Java 13 or later][java-link]). ## Documentation For more information on the project, including the complete list of commands can be found [here][docs-link]. ## API Tokens * [Discord][api-discord] (*required*) -* [Steam]( +* [Steam][api-steam] * [Imgur][api-imgur] * [OMDB][api-omdb] * [Twitch][api-twitch] diff --git a/docs/commands.md b/docs/commands.md deleted file mode 100644 index 07e38aab..00000000 --- a/docs/commands.md +++ /dev/null @@ -1,1063 +0,0 @@ -[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]. - ---- - -## Amiibo - -### amiibo - -Description: Retrieve Amiibo figurine information -Aliases: amib -Parameters: Name of the Amiibo figurine - -``` -.amiibo luigi -``` - ---- - -## Bot - -### info - -Description: Retrieve FlawBOT information -Aliases: i, about -Parameters: None - -``` -.bot info -``` - -### leave - -Description: Make FlawBOT leave the current server -Aliases: None -Parameters: None. Respond with yes when prompted to complete the action. - -``` -.bot leave -``` - -### ping - -Description: Ping the FlawBOT client -Aliases: pong -Parameters: None - -``` -.bot ping -``` - -### report - -Description: Report a problem with FlawBOT to the developer. -Aliases: issue -Parameters: Detailed description of the problem. Minimum 50 characters. - -``` -.bot report [Description of the problem] -``` - -### say - -Description: Make FlawBOT repeat a message -Aliases: echo -Parameters: Message for the bot to repeat - -``` -.bot say Hello World -``` - -### tts - -Description: Make FlawBOT repeat a message in text-to-speech -Aliases: talk -Parameters: Message for the bot to convert to speech - -``` -.bot tts Hello World -``` - -### uptime - -Description: Retrieve the FlawBOT uptime -Aliases: time -Parameters: None - -``` -.bot uptime -``` - -### activity - -Description: Set FlawBOT's activity -Aliases: setactivity -Parameters: Name of the activity -Owner Only: YES - -``` -.bot activity Team Fortress 2 -``` - -### avatar - -Description: Set FlawBOT's avatar -Aliases: setavatar, pfp, photo -Parameters: Image URL. Must be in JPG, PNG or IMG format. -Owner Only: YES - -``` -.bot avatar [Image URL] -``` - -### status - -Description: Set FlawBOT's status -Aliases: setstatus, state -Parameters: Activity Status. Online, Idle, DND or Offline -Owner Only: YES - -``` -.bot status Idle -``` - -### update - -Description: Update FlawBOT libraries -Aliases: refresh -Parameters: None -Owner Only: YES - -``` -.sudo update -``` - -### username - -Description: Set FlawBOT's username -Aliases: setusername, name, setname, nickname, nick -Parameters: New bot username -Owner Only: YES - -``` -.sudo setname FlowBOT -``` - ---- - -## Channel - -### 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 message 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, ctc -Parameters: New text channel name - -``` -.channel text texts -``` - -### topic - -Description: Set current channel's topic -Aliases: settopic, st -Parameters: New channel topic - -``` -.channel topic Watermelon picking -``` - -### voice - -Description: Create a new voice channel -Aliases: createvoice, newvoice, cvc -Parameters: New voice channel name - -``` -.channel voice voices -``` - ---- - -## Dictionary - -### dictionary - -Description: Retrieve an Urban Dictionary definition of a word or phrase -Aliases: define, def, dic -Parameters: Query to pass to Urban Dictionary - -``` -.dictionary Discord -``` - ---- - -## Emoji - -### add - -Description: Add a new server emoji through URL or as an attachment -Aliases: addnew, create -Parameters: Name for the emoji, Image URL - -``` -.emoji add homer [Image URL] -``` - -### delete - -Description: Remove an existing server emoji. Note: Bots can only delete emojis they created. -Aliases: remove, rm, del -Parameters: Server emoji to delete - -``` -.emoji delete :homer: -``` - -### modify - -Description: Edit the name of an existing server emoji. -Aliases: e, edit, rename -Parameters: Emoji to rename, New name - -``` -.emoji rename :homer: homey -``` - -### info - -Description: Retrieve server emoji information -Aliases: i -Parameters: Server emoji information to retrieve - -``` -.emoji info :homer: -``` - -### list - -Description: Retrieve list of server emojis -Aliases: print, l, ls, all -Parameters: None - -``` -.emoji list -``` - ---- - -## Google - -### time - -Description: Retrieve the time for specified location -Aliases: clock -Parameters: Location to retrieve time data from - -``` -.time Moscow -``` - -### news - -Description: Retrieve the latest news articles from NewsAPI.org -Aliases: None -Parameters: Article topic to find on Google News - -``` -.news Nintendo -``` - -### weather - -Description: Retrieve the weather for specified location -Aliases: None -Parameters: Location to retrieve weather data from - -``` -.weather Ottawa -``` - ---- - -## Imgur - -### imgur - -Description: Retrieve an imager from Imgur -Aliases: image -Parameters: Search query to pass to Imgur - -``` -.imgur Cats -``` - ---- - -## Math - -### math - -Description: Perform a basic math operation -Aliases: calculate -Parameters: First operand. Operator. Second operand - -``` -.math 2 + 2 -``` - -### sum - -Description: Calculate the sum of all inputted values -Aliases: total -Parameters: Numbers to sum up. - -``` -.sum 2 5 3 -``` - ---- - -## Miscellaneous - -### ask - -Description: Ask an 8-ball a question -Aliases: 8b, 8ball, ball -Parameters: Question to ask the 8-ball - -``` -.ask Am I lucky? -``` - -### cat - -Description: Retrieve a random cat fact -Aliases: catfact -Parameters: None - -``` -.cat -``` - -### randomcat - -Description: Retrieve a random cat photo -Aliases: meow -Parameters: None - -``` -.randomcat -``` - -### coinflip - -Description: Flip a coin -Aliases: coin, flip -Parameters: None - -``` -.coinflip -``` - -### color - -Description: Retrieve color values for a given HEX code -Aliases: clr -Parameters: HEX color code to process - -``` -.color #F2A92B -``` - -### diceroll - -Description: Roll a six-sided die -Aliases: dice, roll, rolldice, die -Parameters: None - -``` -.diceroll -``` - -### randomdog - -Description: Retrieve a random dog photo -Aliases: dog, woof, bark -Parameters: None - -``` -.randomdog -``` - -### hello - -Description: Welcome another user to the server -Aliases: hi, howdy -Parameters: User to say hello to - -``` -.hello @CriticalFlaw -``` - -### ip - -Description: Retrieve IP address geolocation information -Aliases: ipstack, track -Parameters: IP Address - -``` -.ip 123.123.123.123 -``` - ---- - -## NASA - -### nasa - -Description: Retrieve NASA's Astronomy Picture of the Day -Aliases: apod -Parameters: None - -``` -.nasa -``` - ---- - -## OMDB - -### omdb - -Description: Retrieve a movie or TV show from IMDB -Aliases: imdb, movie -Parameters: Movie or TV show to find on IMDB - -``` -.imdb Lego Movie -``` - ---- - -## Pokemon - -### pokemon - -Description: Retrieve a Pokemon card -Aliases: poke, pk -Parameters: Name of the pokemon - -``` -.pokemon pikachu -``` - ---- - -## Poll - -### poll - -Description: Run a Yay or Nay poll in the current channel -Aliases: None -Parameters: Question to be polled. - -``` -.poll Am I correct? -``` - ---- - -## Reddit - -### hot - -Description: Get hottest posts for a subreddit. -Aliases: None -Parameters: Name of the subreddit. - -``` -.reddit hot tf2 -``` - -### new - -Description: Get newest posts for a subreddit. -Aliases: None -Parameters: Name of the subreddit. - -``` -.reddit new tf2 -``` - -### top - -Description: Get top posts for a subreddit. -Aliases: None -Parameters: Name of the subreddit. - -``` -.reddit top tf2 -``` - ---- - -## Role - -### color - -Description: Set the role color -Aliases: clr -Parameters: HEX color code to set for the role. Server role to recolor. - -``` -.roles color #F2A92B -``` - -### create - -Description: Create a server role -Aliases: new -Parameters: New role name - -``` -.roles create admin -``` - -### delete - -Description: Delete a server role -Aliases: remove -Parameters: Server role to delete - -``` -.roles delete admin -``` - -### info - -Description: Retrieve role information -Aliases: i -Parameters: Server role information to retrieve - -``` -.roles info admin -``` - -### inrole - -Description: Retrieve a list of users in a given role -Aliases: None -Parameters: Server role - -``` -.roles inrole admin -``` - -### mention - -Description: Toggle whether this role can be mentioned by others -Aliases: None -Parameters: Server role to toggle - -``` -.roles mentionadmin -``` - -### revoke - -Description: Remove a role from server user -Aliases: None -Parameters: Server user to get revoked. Server role to revoke from user - -``` -.roles revoke @CriticalFlaw admin -``` - -### revokeall - -Description: Remove all role from server user -Aliases: None -Parameters: Server user to get revoked - -``` -.roles revokeall @CriticalFlaw -``` - -### setrole - -Description: Assign a role to server user -Aliases: addrole, sr -Parameters: Server user to get role assigned. Server role to assign to the user - -``` -.roles setrole @CriticalFlaw admin -``` - -### show - -Description: Toggle whether this role is seen or not -Aliases: display, hide -Parameters: Server role to toggle - -``` -.roles show admin -``` - ---- - -## Server - -### avatar - -Description: Set server avatar -Aliases: setavatar -Parameters: Image URL. Must be in jpg, png or img format. -``` -.server avatar [Image URL] -``` - -### info - -Description: Retrieve server information -Aliases: i -Parameters: None - -``` -.server info -``` - -### invite - -Description: Retrieve an instant invite link to the server -Aliases: None -Parameters: None - -``` -.server invite -``` - -### prune - -Description: Prune inactive server members -Aliases: None -Parameters: Number of days the user had to be inactive to get pruned - -``` -.server prune 30 -``` - -### rename - -Description: Set server name -Aliases: setname -Parameters: New server name - -``` -.server rename Cool Discord Server -``` - -### warn - -Description: Direct message user with a warning -Aliases: scold -Parameters: Server user to warn. Warning message. - -``` -.server warn @CriticalFlaw stop spamming! -``` - ---- - -## Simpsons - -### simpsons - -Description: Retrieve a random Simpsons screenshot and episode -Aliases: caramba -Parameters: None - -``` -.simpsons -``` - -### simpsonsgif - -Description: Retrieve a random Simpsons gif -Aliases: doh -Parameters: Inputting anything will add episode information - -``` -.simpsonsgif oi -``` - -### futurama - -Description: Retrieve a random Futurama screenshot and episode -Aliases: bite -Parameters: None - -``` -.futurama -``` - -### futuramagif - -Description: Retrieve a random Futurama gif -Aliases: neat -Parameters: Inputting anything will add episode information - -``` -.futuramagif oi -``` - -### rick - -Description: Retrieve a random Rick and Morty screenshot and episode -Aliases: morty -Parameters: None - -``` -.rick -``` - -### rickgif - -Description: Retrieve a random Rick and Morty gif -Aliases: mortygif -Parameters: Inputting anything will add episode information - -``` -.rickgif oi -``` - ---- - -## Speedrun - -### speedrun - -Description: Retrieve a game from Speedrun.com -Aliases: game, run -Parameters: Game to search on Speedrun.com - -``` -.speedrun Super Mario 64 -``` - ---- - -## Steam - -### connect - -Description: Format TF2 connection information into a clickable link -Aliases: None -Parameters: Connection string - -``` -.tf2 connect 123.345.56.789:000; password hello -``` - -### game - -Description: Retrieve Steam game information -Aliases: None -Parameters: Game to find on Steam - -``` -.steam game Team Fortress 2 -``` - -### user - -Description: Retrieve Steam user information -Aliases: None -Parameters: User to find on Steam - -``` -.steam user criticalflaw -``` - ---- - -## Team Fortress 2 - -### item - -Description: Retrieve an item from the latest TF2 item schema -Aliases: schema -Parameters: Item to find in the TF2 schema - -``` -.tf2 item natasha -``` - -### map - -Description: Retrieve map information from teamwork.tf -Aliases: maps -Parameters: Normalized map name, like pl_upward - -``` -.tf2 map pl_upward -``` - -### news - -Description: Retrieve the latest news article from teamwork.tf -Aliases: None -Parameters: None - -``` -.tf2 news -``` - -### server - -Description: Retrieve a list of servers with given gamemode -Aliases: servers -Parameters: Name of the gamemode, like payload - -``` -.tf2 server payload -``` - ---- - -## Twitch - -### avatar - -Description: Retrieve server user's avatar -Aliases: getavatar -Parameters: Server user whose avatar to retrieve - -``` -.user avatar @CriticalFlaw -``` - -### ban - -Description: Ban server user -Aliases: None -Parameters: Server user to ban. Reason for the ban. (optional) - -``` -.user ban @CriticalFlaw Spammer -``` - -### deafen - -Description: Deafen server user -Aliases: None -Parameters: Server user to deafen. Reason for the deafen. (optional) - -``` -.user deafen @CriticalFlaw -``` - -### info - -Description: Retrieve user information -Aliases: i -Parameters: Server user whose information to retrieve - -``` -.user info @CriticalFlaw -``` - -### kick - -Description: Kick server user -Aliases: None -Parameters: Server user to kick. Reason for the kick. (optional) - -``` -.user kick @CriticalFlaw -``` - -### mute - -Description: Mute server user -Aliases: None -Parameters: Server user to mute. Reason for the mute. (optional) - -``` -.user mute @CriticalFlaw -``` - -### nickname - -Description: Set server user's nickname -Aliases: setnick -Parameters: Server user to nickname. The new nickname - -``` -.user nickname @CriticalFlaw critical -``` - -### perms - -Description: Retrieve server user's permissions -Aliases: prm -Parameters: Server user whose permissions to retrieve. Server channel - -``` -.user perms @CriticalFlaw #text -``` - -### unban - -Description: Unban server user -Aliases: None -Parameters: Discord user ID to unban from the server - -``` -.user unban 1234567 -``` - -### undeafen - -Description: Undeafen server user -Aliases: None -Parameters: Server user to undeafen - -``` -.user undeafen @CriticalFlaw -``` - -### unmute - -Description: Unmute server user -Aliases: None -Parameters: Server user to unmute - -``` -.user unmute @CriticalFlaw -``` - ---- - -## Wikipedia - -### wiki - -Description: Search Wikipedia for a given query -Aliases: wikipedia -Parameters: Query to search on Wikipedia - -``` -.wiki Steam -``` - ---- - -## YouTube - -### channel - -Description: Retrieve a list of YouTube channel given a query -Aliases: channels, chn -Parameters: Channels to find on YouTube - -``` -.youtube channel pewdiepie -``` - -### playlist - -Description: Retrieve a list of YouTube playlists given a query -Aliases: playlists, list -Parameters: Playlist to find on YouTube - -``` -.youtube playlist Let's Drown Out -``` - -### search - -Description: Retrieve the first YouTube search result given a query -Aliases: find -Parameters: First result video to find on YouTube - -``` -.youtube search Accursed Farms -``` - -### video - -Description: Retrieve a list of YouTube videos given a query -Aliases: videos, vid -Parameters: Video to find on YouTube - -``` -.youtube video Zero Punctuation -``` \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 4993fd1d..98db165e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,28 +11,19 @@

-[![banner][banner-image]] -[![version][version-badge]] -[![build][build-badge][build-link]] -[![quality][quality-badge][quality-link]] -A Discord bot written in C# using the [DSharpPlus][dsharp-link] library. This bot is not being hosted online, however you're welcome to fork this repository and host it yourself or reuse the code for your own bot, as long as you credit it properly. - -## Invite +### Invite [Click here to invite FlawBOT to your server][invite-link]. Please note that the bot will only be online periodically for testing purposes. -## Installation +### Installation To run your own instance of FlawBOT, [clone this repository][clone-link] or [download the release package][release-link] and modify the provided **config.json** file, adding the API tokens. If you're cloning the repository, use [Visual Studio 2019][vs-link] to compile the project. -## Running FlawBOT -As of version 3.0, FlawBOT requires a [Lavalink][lava-link] node to be running in order to play music and not display lavalink-related errors in console. `lavalink.jar` and `application.yml` are included in the project directory, so all you have to do is open the command prompt and launch lavalink with the command `java -jar Lavalink.jar` (be sure to install [Java 13 or later][java-link]. - -## Documentation -For more information on the project, including the complete list of commands can be found [here][docs-link]. +### Running FlawBOT +As of version 3.0, FlawBOT requires a [Lavalink][lava-link] node to be running in order to play music and not display lavalink-related errors in console. `lavalink.jar` and `application.yml` are included in the project directory, so all you have to do is open the command prompt and launch lavalink with the command `java -jar Lavalink.jar` (be sure to install [Java 13 or later][java-link]). -## API Tokens +### API Tokens * [Discord][api-discord] (*required*) -* [Steam]( +* [Steam][api-steam] * [Imgur][api-imgur] * [OMDB][api-omdb] * [Twitch][api-twitch] @@ -42,6 +33,11 @@ For more information on the project, including the complete list of commands can * [WeatherStack][api-weather] * [YouTube][api-youtube] + +![version][version-badge] +[![build][build-badge]][build-link] +[![quality][quality-badge]][quality-link] + [banner-image]: https://i.imgur.com/YlbST5I.jpg [version-badge]: https://img.shields.io/github/release/CriticalFlaw/FlawBOT.svg diff --git a/docs/install.md b/docs/install.md index fed75512..fd6e674b 100644 --- a/docs/install.md +++ b/docs/install.md @@ -4,9 +4,11 @@ Follow these steps to setup and run FlawBOT on your local machine. 2. Modify the included **config.json** file, adding your API tokens (see list below). 3. Open and compile the project solution using [Visual Studio 2019][vs-link]. +--- + ## API Tokens * [Discord][api-discord] (*required*) -* [Steam]( +* [Steam][api-steam] * [Imgur][api-imgur] * [OMDB][api-omdb] * [Twitch][api-twitch] diff --git a/docs/modules/bot.md b/docs/modules/bot.md new file mode 100644 index 00000000..b9e309ea --- /dev/null +++ b/docs/modules/bot.md @@ -0,0 +1,105 @@ +[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]. + +--- + +## Bot + +### info + +Description: Retrieve FlawBOT information. +Aliases: about +Parameters: None + +``` +.bot info +``` + +### leave + +Description: Make FlawBOT leave the current server. +Aliases: None +Parameters: None. Respond with yes when prompted to complete the action. + +``` +.bot leave +``` + +### ping + +Description: Ping the FlawBOT client. +Aliases: pong +Parameters: None + +``` +.bot ping +``` + +### report + +Description: Report a problem with FlawBOT to the developer. Please do not abuse. +Aliases: issue +Parameters: Detailed description of the issue. Minimum 50 characters. + +``` +.bot report [Description of the problem] +``` + +### uptime + +Description: Retrieve the FlawBOT uptime. +Aliases: time +Parameters: None + + +``` +.bot uptime +``` + +--- + +## Owner Only + +### activity + +Description: Set FlawBOT's activity. +Aliases: setactivity +Parameters: Name of the activity. +``` +.bot activity Team Fortress 2 +``` + +### avatar + +Description: Set FlawBOT's avatar. +Aliases: setavatar, pfp, photo +Parameters: Image URL. Must be in jpg, png or img format. + +``` +.bot avatar [Image URL] +``` + +### status + +Description: Set FlawBOT's status. +Aliases: setstatus, state +Parameters: Activity Status. Online, Idle, DND or Offline. + +``` +.bot status Idle +``` + +### username + +Description: Set FlawBOT's username. +Aliases: setusername, name, setname, nickname, nick +Parameters: New bot username. + +``` +.sudo setname FlowBOT +``` \ No newline at end of file diff --git a/docs/modules/media.md b/docs/modules/media.md new file mode 100644 index 00000000..f3b63339 --- /dev/null +++ b/docs/modules/media.md @@ -0,0 +1,373 @@ +[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]. + +--- + +## Amiibo + +### amiibo + +Description: Retrieve Amiibo figurine information +Aliases: amib +Parameters: Name of the Amiibo figurine + +``` +.amiibo luigi +``` + +--- + +## Dictionary + +### dictionary + +Description: Retrieve an Urban Dictionary definition of a word or phrase +Aliases: define, def, dic +Parameters: Query to pass to Urban Dictionary + +``` +.dictionary Discord +``` + +--- + +## Google + +### time + +Description: Retrieve the time for specified location +Aliases: clock +Parameters: Location to retrieve time data from + +``` +.time Moscow +``` + +### news + +Description: Retrieve the latest news articles from NewsAPI.org +Aliases: None +Parameters: Article topic to find on Google News + +``` +.news Nintendo +``` + +### weather + +Description: Retrieve the weather for specified location +Aliases: None +Parameters: Location to retrieve weather data from + +``` +.weather Ottawa +``` + +--- + +## Imgur + +### imgur + +Description: Retrieve an imager from Imgur +Aliases: image +Parameters: Search query to pass to Imgur + +``` +.imgur Cats +``` + +--- + +## NASA + +### nasa + +Description: Retrieve NASA's Astronomy Picture of the Day +Aliases: apod +Parameters: None + +``` +.nasa +``` + +--- + +## OMDB + +### omdb + +Description: Retrieve a movie or TV show from IMDB +Aliases: imdb, movie +Parameters: Movie or TV show to find on IMDB + +``` +.imdb Lego Movie +``` + +--- + +## Pokemon + +### pokemon + +Description: Retrieve a Pokemon card +Aliases: poke, pk +Parameters: Name of the pokemon + +``` +.pokemon pikachu +``` + +--- + +## Reddit + +### hot + +Description: Get hottest posts for a subreddit. +Aliases: None +Parameters: Name of the subreddit. + +``` +.reddit hot tf2 +``` + +### new + +Description: Get newest posts for a subreddit. +Aliases: None +Parameters: Name of the subreddit. + +``` +.reddit new tf2 +``` + +### top + +Description: Get top posts for a subreddit. +Aliases: None +Parameters: Name of the subreddit. + +``` +.reddit top tf2 +``` + +--- + +## Simpsons + +### simpsons + +Description: Retrieve a random Simpsons screenshot and episode +Aliases: caramba +Parameters: None + +``` +.simpsons +``` + +### simpsonsgif + +Description: Retrieve a random Simpsons gif +Aliases: doh +Parameters: Inputting anything will add episode information + +``` +.simpsonsgif oi +``` + +### futurama + +Description: Retrieve a random Futurama screenshot and episode +Aliases: bite +Parameters: None + +``` +.futurama +``` + +### futuramagif + +Description: Retrieve a random Futurama gif +Aliases: neat +Parameters: Inputting anything will add episode information + +``` +.futuramagif oi +``` + +### rick + +Description: Retrieve a random Rick and Morty screenshot and episode +Aliases: morty +Parameters: None + +``` +.rick +``` + +### rickgif + +Description: Retrieve a random Rick and Morty gif +Aliases: mortygif +Parameters: Inputting anything will add episode information + +``` +.rickgif oi +``` + +--- + +## Speedrun + +### speedrun + +Description: Retrieve a game from Speedrun.com +Aliases: game, run +Parameters: Game to search on Speedrun.com + +``` +.speedrun Super Mario 64 +``` + +--- + +## Steam + +### connect + +Description: Format TF2 connection information into a clickable link +Aliases: None +Parameters: Connection string + +``` +.tf2 connect 123.345.56.789:000; password hello +``` + +### game + +Description: Retrieve Steam game information +Aliases: None +Parameters: Game to find on Steam + +``` +.steam game Team Fortress 2 +``` + +### user + +Description: Retrieve Steam user information +Aliases: None +Parameters: User to find on Steam + +``` +.steam user criticalflaw +``` + +--- + +## Team Fortress 2 + +### item + +Description: Retrieve an item from the latest TF2 item schema +Aliases: schema +Parameters: Item to find in the TF2 schema + +``` +.tf2 item natasha +``` + +### map + +Description: Retrieve map information from teamwork.tf +Aliases: maps +Parameters: Normalized map name, like pl_upward + +``` +.tf2 map pl_upward +``` + +### news + +Description: Retrieve the latest news article from teamwork.tf +Aliases: None +Parameters: None + +``` +.tf2 news +``` + +### server + +Description: Retrieve a list of servers with given gamemode +Aliases: servers +Parameters: Name of the gamemode, like payload + +``` +.tf2 server payload +``` + +--- + +## Wikipedia + +### wiki + +Description: Search Wikipedia for a given query +Aliases: wikipedia +Parameters: Query to search on Wikipedia + +``` +.wiki Steam +``` + +--- + +## YouTube + +### channel + +Description: Retrieve a list of YouTube channel given a query +Aliases: channels, chn +Parameters: Channels to find on YouTube + +``` +.youtube channel pewdiepie +``` + +### playlist + +Description: Retrieve a list of YouTube playlists given a query +Aliases: playlists, list +Parameters: Playlist to find on YouTube + +``` +.youtube playlist Let's Drown Out +``` + +### search + +Description: Retrieve the first YouTube search result given a query +Aliases: find +Parameters: First result video to find on YouTube + +``` +.youtube search Accursed Farms +``` + +### video + +Description: Retrieve a list of YouTube videos given a query +Aliases: videos, vid +Parameters: Video to find on YouTube + +``` +.youtube video Zero Punctuation +``` \ No newline at end of file diff --git a/docs/modules/misc.md b/docs/modules/misc.md new file mode 100644 index 00000000..8d345177 --- /dev/null +++ b/docs/modules/misc.md @@ -0,0 +1,149 @@ +[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]. + +--- + +## Math + +### math + +Description: Perform a basic math operation +Aliases: calculate +Parameters: First operand. Operator. Second operand + +``` +.math 2 + 2 +``` + +### sum + +Description: Calculate the sum of all inputted values +Aliases: total +Parameters: Numbers to sum up. + +``` +.sum 2 5 3 +``` + +--- + +## Miscellaneous + +### ask + +Description: Ask an 8-ball a question +Aliases: 8b, 8ball, ball +Parameters: Question to ask the 8-ball + +``` +.ask Am I lucky? +``` + +### tts + +Description: Make FlawBOT repeat a message in text-to-speech +Aliases: talk +Parameters: Message for the bot to convert to speech + +``` +.bot tts Hello World +``` + +### cat + +Description: Retrieve a random cat fact +Aliases: catfact +Parameters: None + +``` +.cat +``` + +### randomcat + +Description: Retrieve a random cat photo +Aliases: meow +Parameters: None + +``` +.randomcat +``` + +### coinflip + +Description: Flip a coin +Aliases: coin, flip +Parameters: None + +``` +.coinflip +``` + +### color + +Description: Retrieve color values for a given HEX code +Aliases: clr +Parameters: HEX color code to process + +``` +.color #F2A92B +``` + +### diceroll + +Description: Roll a six-sided die +Aliases: dice, roll, rolldice, die +Parameters: None + +``` +.diceroll +``` + +### randomdog + +Description: Retrieve a random dog photo +Aliases: dog, woof, bark +Parameters: None + +``` +.randomdog +``` + +### hello + +Description: Welcome another user to the server +Aliases: hi, howdy +Parameters: User to say hello to + +``` +.hello @CriticalFlaw +``` + +### ip + +Description: Retrieve IP address geolocation information +Aliases: ipstack, track +Parameters: IP Address + +``` +.ip 123.123.123.123 +``` + +--- + +## Poll + +### poll + +Description: Run a Yay or Nay poll in the current channel +Aliases: None +Parameters: Question to be polled. + +``` +.poll Am I correct? +``` \ No newline at end of file diff --git a/docs/modules/music.md b/docs/modules/music.md new file mode 100644 index 00000000..2d1390ec --- /dev/null +++ b/docs/modules/music.md @@ -0,0 +1,88 @@ +[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]. + +--- + +## Music + +### play + +Description: Play audio from provided URL or search by specified query. +Aliases: None +Parameters: URL from which to play audio + + +``` +.play https://www.youtube.com/watch?v=4JkIs37a2JE +``` + +### pause + +Description: Pause audio playback. +Aliases: None +Parameters: None + + +``` +.pause +``` + +### resume + +Description: Resume audio playback. +Aliases: unpause +Parameters: None + + +``` +.resume +``` + +### stop + +Description: Stop audio playback and leave the voice channel. +Aliases: None +Parameters: None + + +``` +.stop +``` + +### volume + +Description: Set audio playback volume. +Aliases: None +Parameters: Audio volume. Can be set to 0-150 (default 100). + + +``` +.volume 50 +``` + +### restart + +Description: Restarts the playback of the current track. +Aliases: replay +Parameters: None + + +``` +.replay +``` + +### nowplaying + +Description: Displays information about currently-played track. +Aliases: np +Parameters: None + + +``` +.nowplaying +``` \ No newline at end of file diff --git a/docs/modules/server.md b/docs/modules/server.md new file mode 100644 index 00000000..c9807389 --- /dev/null +++ b/docs/modules/server.md @@ -0,0 +1,436 @@ +[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 + +### 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 message 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, ctc +Parameters: New text channel name + +``` +.channel text texts +``` + +### topic + +Description: Set current channel's topic +Aliases: settopic, st +Parameters: New channel topic + +``` +.channel topic Watermelon picking +``` + +### voice + +Description: Create a new voice channel +Aliases: createvoice, newvoice, cvc +Parameters: New voice channel name + +``` +.channel voice voices +``` + +--- + +## Emoji + +### add + +Description: Add a new server emoji through URL or as an attachment +Aliases: addnew, create +Parameters: Name for the emoji, Image URL + +``` +.emoji add homer [Image URL] +``` + +### delete + +Description: Remove an existing server emoji. Note: Bots can only delete emojis they created. +Aliases: remove, rm, del +Parameters: Server emoji to delete + +``` +.emoji delete :homer: +``` + +### modify + +Description: Edit the name of an existing server emoji. +Aliases: e, edit, rename +Parameters: Emoji to rename, New name + +``` +.emoji rename :homer: homey +``` + +### info + +Description: Retrieve server emoji information +Aliases: i +Parameters: Server emoji information to retrieve + +``` +.emoji info :homer: +``` + +### list + +Description: Retrieve list of server emojis +Aliases: print, l, ls, all +Parameters: None + +``` +.emoji list +``` + +--- + +## Role + +### color + +Description: Set the role color +Aliases: clr +Parameters: HEX color code to set for the role. Server role to recolor. + +``` +.roles color #F2A92B +``` + +### create + +Description: Create a server role +Aliases: new +Parameters: New role name + +``` +.roles create admin +``` + +### delete + +Description: Delete a server role +Aliases: remove +Parameters: Server role to delete + +``` +.roles delete admin +``` + +### info + +Description: Retrieve role information +Aliases: i +Parameters: Server role information to retrieve + +``` +.roles info admin +``` + +### inrole + +Description: Retrieve a list of users in a given role +Aliases: None +Parameters: Server role + +``` +.roles inrole admin +``` + +### mention + +Description: Toggle whether this role can be mentioned by others +Aliases: None +Parameters: Server role to toggle + +``` +.roles mentionadmin +``` + +### revoke + +Description: Remove a role from server user +Aliases: None +Parameters: Server user to get revoked. Server role to revoke from user + +``` +.roles revoke @CriticalFlaw admin +``` + +### revokeall + +Description: Remove all role from server user +Aliases: None +Parameters: Server user to get revoked + +``` +.roles revokeall @CriticalFlaw +``` + +### setrole + +Description: Assign a role to server user +Aliases: addrole, sr +Parameters: Server user to get role assigned. Server role to assign to the user + +``` +.roles setrole @CriticalFlaw admin +``` + +### show + +Description: Toggle whether this role is seen or not +Aliases: display, hide +Parameters: Server role to toggle + +``` +.roles show admin +``` + +--- + +## Server + +### avatar + +Description: Set server avatar +Aliases: setavatar +Parameters: Image URL. Must be in jpg, png or img format. +``` +.server avatar [Image URL] +``` + +### info + +Description: Retrieve server information +Aliases: i +Parameters: None + +``` +.server info +``` + +### invite + +Description: Retrieve an instant invite link to the server +Aliases: None +Parameters: None + +``` +.server invite +``` + +### prune + +Description: Prune inactive server members +Aliases: None +Parameters: Number of days the user had to be inactive to get pruned + +``` +.server prune 30 +``` + +### rename + +Description: Set server name +Aliases: setname +Parameters: New server name + +``` +.server rename Cool Discord Server +``` + +### warn + +Description: Direct message user with a warning +Aliases: scold +Parameters: Server user to warn. Warning message. + +``` +.server warn @CriticalFlaw stop spamming! +``` + +--- + +## User + +### avatar + +Description: Retrieve server user's avatar +Aliases: getavatar +Parameters: Server user whose avatar to retrieve + +``` +.user avatar @CriticalFlaw +``` + +### ban + +Description: Ban server user +Aliases: None +Parameters: Server user to ban. Reason for the ban. (optional) + +``` +.user ban @CriticalFlaw Spammer +``` + +### deafen + +Description: Deafen server user +Aliases: None +Parameters: Server user to deafen. Reason for the deafen. (optional) + +``` +.user deafen @CriticalFlaw +``` + +### info + +Description: Retrieve user information +Aliases: i +Parameters: Server user whose information to retrieve + +``` +.user info @CriticalFlaw +``` + +### kick + +Description: Kick server user +Aliases: None +Parameters: Server user to kick. Reason for the kick. (optional) + +``` +.user kick @CriticalFlaw +``` + +### mute + +Description: Mute server user +Aliases: None +Parameters: Server user to mute. Reason for the mute. (optional) + +``` +.user mute @CriticalFlaw +``` + +### nickname + +Description: Set server user's nickname +Aliases: setnick +Parameters: Server user to nickname. The new nickname + +``` +.user nickname @CriticalFlaw critical +``` + +### perms + +Description: Retrieve server user's permissions +Aliases: prm +Parameters: Server user whose permissions to retrieve. Server channel + +``` +.user perms @CriticalFlaw #text +``` + +### unban + +Description: Unban server user +Aliases: None +Parameters: Discord user ID to unban from the server + +``` +.user unban 1234567 +``` + +### undeafen + +Description: Undeafen server user +Aliases: None +Parameters: Server user to undeafen + +``` +.user undeafen @CriticalFlaw +``` + +### unmute + +Description: Unmute server user +Aliases: None +Parameters: Server user to unmute + +``` +.user unmute @CriticalFlaw +``` \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 74d7d173..f7922a51 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -16,7 +16,12 @@ nav: - Home: 'index.md' - Installation: 'install.md' - Deployment: 'deploy.md' - - Commands: 'commands.md' + - Modules: + - Main: 'modules/bot.md' + - Media: 'modules/media.md' + - Misc: 'modules/misc.md' + - Music: 'modules/music.md' + - Server: 'modules/server.md' markdown_extensions: - admonition - pymdownx.superfences