(update): Better Documentation (betterdocs) (#90)

* (update): description of roleplay/action commands * (update): description + examples of anime commands * (update): description + examples of bot commands * (update): description + examples of core commands * (update): examples of fun commands * (update): examples of moderation commands * (update): examples of owner commands * (update): examples of setup commands * (update): examples of social commands * (update): examples of utility commands + removal of time command * (update): command database
BearTS · Jan 15, 2021 · 360b801 · 360b801
1 parent 9927d79
commit 360b801
Show file tree

Hide file tree

Showing 146 changed files with 1,077 additions and 592 deletions.
diff --git a/assets/json/command-database.json b/assets/json/command-database.json
diff --git a/commands/action/baka.js b/commands/action/baka.js
@@ -9,7 +9,7 @@ module.exports = {
     'ADD_REACTIONS'
   ],
   group: 'action',
-  description: 'It\'s not like I want you to use my command.. ~Baka!',
+  description: 'Sends a roleplay gif `baka` to the chat, directed towards the mentioned user, if there is any. Usually interpreted as 「 The user whom this command is directed to is an idiot (in a kawaii-context) 」.',
   examples: [ 'baka @user' ],
   parameters: [ 'User Mention' ],
   run: async ( client, message, args ) => {

diff --git a/commands/action/cry.js b/commands/action/cry.js
@@ -9,10 +9,10 @@ module.exports = {
     'ADD_REACTIONS'
   ],
   group: 'action',
-  description: 'UWAA~!',
+  description: 'Sends a roleplay gif `cry` to the chat. Usually interpreted as 「 The user who used this commnd is crying 」. Use to indicate that you are currently crying. May be used in a similar context to the emoji 😢.',
   examples: [ 'cry' ],
   parameters: [],
-  run: async ( client, message, args ) => {
+  run: async ( client, message ) => {
 
     return message.channel.send(
       new MessageEmbed()

diff --git a/commands/action/dance.js b/commands/action/dance.js
@@ -8,10 +8,10 @@ module.exports = {
     'ADD_REACTIONS'
   ],
   group: 'action',
-  description: 'UWAA~!',
+  description: 'Sends a roleplay gif `dance` to the chat. Usually interpreted as 「 The user who used this commnd is dancing (in joy) 」. Use to indicate that you are currently dancing (context may vary).',
   examples: [ 'dance' ],
   parameters: [],
-  run: async ( client, message, args ) => {
+  run: async ( client, message ) => {
     return message.channel.send(
       new MessageEmbed()
       .setColor('GREY')

diff --git a/commands/action/disgust.js b/commands/action/disgust.js
@@ -9,9 +9,9 @@ module.exports = {
     'ADD_REACTIONS'
   ],
   group: 'action',
-  description: 'Mazui! Kimoi!',
-  examples: [ 'User Mention' ],
-  parameters: [],
+  description: 'Sends a roleplay gif `disgust` to the chat, directed towards the mentioned user, if there is any. Usually interpreted as 「 The user whom this command is directed to is digusting (Mazui!!, Kimoi!!) 」. Use to indicate that you are disgusted by their (ideas on their) previous chats. May be used in a similar context to the emoji 🤮.',
+  examples: [ 'disgust @user' ],
+  parameters: [ 'User Mention' ],
   run: async ( client, message, args ) => {
 
     // Filter out args so that args are only user-mention formats.

diff --git a/commands/action/feed.js b/commands/action/feed.js
@@ -9,7 +9,7 @@ module.exports = {
     'ADD_REACTIONS'
   ],
   group: 'action',
-  description: 'Yummy!',
+  description: 'Sends a roleplay gif `feed` to the chat, directed towards the mentioned user, if there is any. Usually interpreted as 「 The user whom this command is directed to has been fed 」. Use to indicate that you are / wanted to feed the user.',
   examples: [ 'feed @user' ],
   parameters: [ 'User Mention' ],
   run: async ( client, message, args ) => {

diff --git a/commands/action/happy.js b/commands/action/happy.js
@@ -9,10 +9,10 @@ module.exports = {
     'ADD_REACTIONS'
   ],
   group: 'action',
-  description: 'Happy!',
+  description: 'Sends a roleplay gif `happy` to the chat. Usually interpreted as 「 The user who used this command is happy (shiawase da!!) 」. Use to indicate that you are currently happy (context may vary). May be used in a similar context to the emoji 😃.',
   examples: [ 'happy' ],
   parameters: [],
-  run: async ( client, message, args ) => {
+  run: async ( client, message ) => {
 
     return message.channel.send(
       new MessageEmbed()

diff --git a/commands/action/hug.js b/commands/action/hug.js
@@ -9,7 +9,7 @@ module.exports = {
     'ADD_REACTIONS'
   ],
   group: 'action',
-  description: 'Hug someone special.',
+  description: 'Sends a roleplay gif `hug` to the chat, directed towards the mentioned user, if there is any. Usually interpreted as 「 The user whom this command is directed to has been hugged 」. Use to indicate that you are / wanted to hug the mentioned user (context may vary). May be used in a similar context to the emoji 🤗.',
   examples: [ 'hug @user' ],
   parameters: [ 'User Mention' ],
   run: async ( client, message, args ) => {

diff --git a/commands/action/kill.js b/commands/action/kill.js
@@ -4,12 +4,13 @@ module.exports = {
   name: 'kill',
   aliases: [],
   guildOnly: true,
+  nsfw: true,
   clientPermissions: [
     'EMBED_LINKS',
     'ADD_REACTIONS'
   ],
   group: 'action',
-  description: 'Kill someone.',
+  description: 'Sends a roleplay gif `kill` to the chat, directed towards the mentioned user, if there is any. Usually interpreted as 「 The user who used this command wants to kill the mentioned user 」. Use to indicate that you are / wanted to kill the mentioned user (context may vary). This is a roleplay command and is meant to be used as a joke, however, this will be limited to a nsfw channel due to sensitive nature of this command. Context should not include real crimes.',
   examples: [ 'kill @user' ],
   parameters: [ 'User Mention' ],
   run: async ( client, message, args ) => {

diff --git a/commands/action/kiss.js b/commands/action/kiss.js
@@ -9,7 +9,7 @@ module.exports = {
     'ADD_REACTIONS'
   ],
   group: 'action',
-  description: 'Show your love to someone special! Not me lol',
+  description: 'Sends a roleplay gif `kiss` to the chat, directed towards the mentioned user, if there is any. Usually interpreted as 「 The user whom this command is directed to has been kissed 」. Use to indicate that you are / wanted to kiss the mentioned user (context may vary). May be used in a similar context to the emoji 😘.',
   examples: [ 'kiss @user' ],
   parameters: [ 'User Mention' ],
   run: async ( client, message, args ) => {

diff --git a/commands/action/lick.js b/commands/action/lick.js
@@ -9,7 +9,7 @@ module.exports = {
     'ADD_REACTIONS'
   ],
   group: 'action',
-  description: 'Lick Lick Lick Lick Lick Lick Lick.',
+  description: 'Sends a roleplay gif `lick` to the chat, directed towards the mentioned user, if there is any. Usually interpreted as 「 The user whom this command is directed to has been licked (lero lero lero lero lero) 」. Use to indicate that you are / wanted to lick the mentioned user (context may vary).',
   examples: [ 'lick @user' ],
   parameters: [ 'User Mention' ],
   run: async ( client, message, args ) => {

diff --git a/commands/action/midfing.js b/commands/action/midfing.js
@@ -10,9 +10,9 @@ module.exports = {
   ],
   group: 'action',
   nsfw: true,
-  description: 'Use this to throw someone off. No seriously, it\'s a joke!',
-  examples: [ '' ],
-  parameters: [],
+  description: 'Sends a roleplay gif `midfing` to the chat, directed towards the mentioned user, if there is any. Usually interpreted as 「 The user who used this command wants the mentioned user to **** off 」. Use to indicate that you are annoyed by the user (context may vary). This is a roleplay command and is meant to be used as a joke, however, this will be limited to a nsfw channel due to sensitive nature of this command.',
+  examples: [ 'midfing @user' ],
+  parameters: [ 'User Mention' ],
   run: async ( client, message, args ) => {
 
     args = args.filter(x => /<@!?\d{17,19}>/.test(x))

diff --git a/commands/action/pat.js b/commands/action/pat.js
@@ -9,7 +9,7 @@ module.exports = {
     'ADD_REACTIONS'
   ],
   group: 'action',
-  description: 'It\'s not like I want you to use my command.. ~Baka!',
+  description: 'Sends a roleplay gif `pat` to the chat, directed towards the mentioned user, if there is any. Usually interpreted as 「 The user gave a headpat to the mentioned user 」. Use to indicate that you are / wanted to headpat the mentioned user (context may vary).',
   examples: [ 'pat @user' ],
   parameters: [ 'User Mention' ],
   run: async ( client, message, args ) => {

diff --git a/commands/action/poke.js b/commands/action/poke.js
@@ -9,7 +9,7 @@ module.exports = {
     'ADD_REACTIONS'
   ],
   group: 'action',
-  description: 'Poke your friends!',
+  description: 'Sends a roleplay gif `poke` to the chat, directed towards the mentioned user, if there is any. Usually interpreted as 「 The mentioned user ignores you, so you poke them 」. Use to indicate that you are in need of attention from the mentioned user (context may vary).',
   examples: [ 'poke @user' ],
   parameters: [ 'User Mention' ],
   run: async ( client, message, args ) => {

diff --git a/commands/action/slap.js b/commands/action/slap.js
@@ -9,7 +9,7 @@ module.exports = {
     'ADD_REACTIONS'
   ],
   group: 'action',
-  description: 'Slap them friends!~',
+  description: 'Sends a roleplay gif `slap` to the chat, directed towards the mentioned user, if there is any. Usually interpreted as 「 The user whom this command is directed to has been slapped 」. Use to indicate that you are / wanted to slap the mentioned user (context may vary).',
   examples: [ 'slap @user' ],
   parameters: [ 'User Mention' ],
   run: async ( client, message, args ) => {

diff --git a/commands/action/smug.js b/commands/action/smug.js
@@ -9,7 +9,7 @@ module.exports = {
     'ADD_REACTIONS'
   ],
   group: 'action',
-  description: 'The epitome of arguments: smug anime girls',
+  description: 'Sends a roleplay gif `smug` to the chat. Usually interpreted as 「 The user who used this command smugs at the previous chat 」. Use to indicate that you sense the ulterior motive the previous user sent in chat.',
   examples: [ 'smug' ],
   parameters: [],
   run: async ( client, message, args ) => {

diff --git a/commands/action/suicide.js b/commands/action/suicide.js
@@ -4,16 +4,16 @@ module.exports = {
   name: 'suicide',
   aliases: ['kms'],
   guildOnly: true,
+  nsfw: true,
   clientPermissions: [
     'EMBED_LINKS',
     'ADD_REACTIONS'
   ],
   group: 'action',
-  nsfw: true,
-  description: 'KYSL - KillYourSelfLol',
+  description: 'Sends a roleplay gif `suicide` to the chat. Usually interpreted as 「 The user who used this command wants to commit suicide (in a jokingly manner) 」. Use to indicate that you are stunned by the previous user\'s chats that it makes you want to kys. This is a roleplay command and is meant to be used as a joke, however, this will be limited to a nsfw channel due to sensitive nature of this command. Context should not include real crimes.',
   examples: [ 'suicide', 'kms' ],
   parameters: [],
-  run: async ( client, message, args ) => {
+  run: async ( client, message) => {
 
     return message.channel.send(
       new MessageEmbed()

diff --git a/commands/action/tickle.js b/commands/action/tickle.js
@@ -9,7 +9,7 @@ module.exports = {
     'ADD_REACTIONS'
   ],
   group: 'action',
-  description: 'Tickle your friends!',
+  description: 'Sends a roleplay gif `tickle` to the chat, directed towards the mentioned user, if there is any. Usually interpreted as 「 The user whom this command is directed to has been tickled 」. Use to indicate that you tickled the mentioned user (context may vary).',
   examples: [ 'tickle @user' ],
   parameters: ['User Mention'],
   run: async ( client, message, args ) => {

diff --git a/commands/anime/alprofile.js b/commands/anime/alprofile.js
@@ -10,9 +10,15 @@ module.exports = {
   cooldown: { time: 10000 },
   clientPermissions: [ 'EMBED_LINKS' ],
   group: 'anime',
-  description: 'Finds user profile on Anilist based on the provided query',
-  parameters: [ 'User' ],
-  get examples(){ return [this.name, ...this.aliases].map(x => `${x} <mal username>`)},
+  description: 'Finds user profile on [Anilist](https://anilist.co) based on the provided query.',
+  parameters: [ 'Anilist Username' ],
+  examples: [
+    'alprofile',
+    'al-of sakurajimai',
+    'alof sakurajimai',
+    'alstat sakurajimai',
+    'aluser sakurajimai'
+  ],
   run: async function ( client, message, args ) {
 
     const query = args.join(' ');

diff --git a/commands/anime/anime.js b/commands/anime/anime.js
@@ -10,16 +10,17 @@ module.exports = {
   cooldown: {
     time: 10000,
     message: 'You are going too fast. Please slow down to avoid getting rate-limited!'
-  }, clientPermissions: [ 'EMBED_LINKS' ],
-  group: 'anime',
-  description: 'Searches for a specific anime in <:mal:767062339177676800> [MyAnimeList](https://myanimelist.net "Homepage")',
-  parameters: ['Search Query'],
-  get examples(){
-    return [this.name, ...this.aliases.map((x,i) => {
-      const queries = [ 'aobuta' , 'seishun buta yarou' , 'bunnygirl senpai' ];
-      return x + ' ' + queries[i];
-    })];
   },
+  clientPermissions: [ 'EMBED_LINKS' ],
+  group: 'anime',
+  description: 'Searches for a specific anime in <:mal:767062339177676800> [MyAnimeList](https://myanimelist.net "Homepage"), or shows Mai\'s anime series information if no query is provided.',
+  parameters: [ 'Search Query' ],
+  examples: [
+    'anime',
+    'as seishun buta yarou',
+    'ani aobuta',
+    'anisearch bunnygirl senpai'
+  ],
   run: async ( client, message, args ) => {
 
     const query = args.join(' ') || 'Seishun Buta Yarou';
@@ -51,7 +52,7 @@ module.exports = {
     };
 
     message.channel.stopTyping();
-    
+
     return message.channel.send(
       new MessageEmbed()
       .setColor('GREY')

diff --git a/commands/anime/animeme.js b/commands/anime/animeme.js
@@ -9,13 +9,14 @@ module.exports = {
   group: 'anime',
   clientPermissions: [ 'EMBED_LINKS' ],
   description: 'Generate an anime meme fetched from selected <:reddit:767062345422864394> [Subreddits](https://reddit.com "Homepage"). Include `reload` parameter to reload meme cache. Memes generated are in order by default, add `r`, `random`, or `randomize` to randomize meme.',
-  parameters: ['Reload tag','Randomization tag'],
-  get examples(){
-    return [this.name, ...this.aliases.map((x,i) => {
-      const queries = ['reload', 'random', '', 'reload', 'random'];
-      return x + ' ' + queries[i];
-    })];
-  },
+  parameters: [ 'Reload tag', 'Randomization tag' ],
+  examples: [
+    'animeme',
+    'ameme reload',
+    'animeme random',
+    'animemes reload',
+    'amemes'
+  ],
   run: async ( client, message, [parameter]) => {
 
     if (!client.collections.getFrom('memes', message.guild.id)) {

diff --git a/commands/anime/aniquote.js b/commands/anime/aniquote.js
@@ -7,9 +7,9 @@ module.exports = {
   aliases: [ 'aq', 'animequote' ],
   group: 'anime',
   clientPermissions: [ 'EMBED_LINKS' ],
-  description: 'Generate a random anime quote',
+  description: 'Generate a random anime quote.',
   parameters: [],
-  get examples(){ return [this.name, ...this.aliases]; },
+  examples: [ 'aniquote', 'aq', 'animequote' ],
   run: async ( client, message) => {
 
     const { quote, anime, id, name } = randomQuote();

diff --git a/commands/anime/anirandom.js b/commands/anime/anirandom.js
@@ -15,6 +15,11 @@ module.exports = {
   description: 'Generates a random anime recommendation. Recommends a Hentai if used on a nsfw channel.',
   clientPermissions: [ 'EMBED_LINKS' ],
   parameter: [],
+  examples: [
+    'anirandom',
+    'anirand',
+    'anirecommend'
+  ],
   get examples(){ return [this.name, ...this.aliases]; },
   run: async ( client, message ) => {
 

diff --git a/commands/anime/character.js b/commands/anime/character.js
@@ -13,14 +13,15 @@ module.exports = {
   },
   clientPermissions: [ 'EMBED_LINKS' ],
   group: 'anime',
-  description: 'Searches for a character in <:mal:767062339177676800> [MyAnimeList](https://myanimelist.net "Homepage")',
+  description: 'Searches for a character in <:mal:767062339177676800> [MyAnimeList](https://myanimelist.net "Homepage"), or Mai\'s character information if no query is provided.',
   parameters: [ 'Search Query' ],
-  get examples(){
-    return [this.name, ...this.aliases.map((x, i) => {
-      const queries = ['Mai Sakurajima', 'Mai-san', 'mai'];
-      return x + ' ' + [queries][i];
-    })];
-  },
+  examples: [
+    'character',
+    'anichar Mai',
+    'anichar Sakuta Azusagawa',
+    'char Rio Futaba',
+    'c Kaede Azusagawa'
+  ],
   run: async (client, message, args) => {
 
     const query = args.join(' ') || 'Mai Sakurajima';

diff --git a/commands/anime/discover.js b/commands/anime/discover.js
@@ -11,10 +11,13 @@ module.exports = {
   aliases: [],
   guildOnly: true,
   group: 'anime',
-  description: 'Generate a set of handpicked <Anime/Manga> recommendations for a user',
+  description: 'Generate a set of handpicked <Anime/Manga> recommendations for a user.',
   clientPermissions: [ 'EMBED_LINKS', 'USE_EXTERNAL_EMOJIS', 'ADD_REACTIONS' ],
   parameter: [ 'Manga', 'Anime' ],
-  get examples(){ return this.parameter.map(x => this.name + ' ' + x); },
+  examples: [
+    'discover anime',
+    'discover manga'
+  ],
   run: async ( client, message, [category = '']) => {
 
     category = category.toLowerCase();

diff --git a/commands/anime/hanime.js b/commands/anime/hanime.js
@@ -19,9 +19,12 @@ module.exports = {
   nsfw: true,
   description: 'Queries hanime.tv for a specific hentai. Returns a maximum of 10 results',
   parameters: [ 'Search Query' ],
-  get examples(){ return [this.name, ...this.aliases].map((x,i) => {
-    return `${x} Saimin Seishidou ${i+1}`
-  })},
+  examples: [
+    'hanime saimin seishidou',
+    'searchhentai mankitsu happening',
+    'hanisearch dropout',
+    'hs tamashii insert'
+  ],
   run: async function (client, message, args){
 
     const query = args.join(' ');

diff --git a/commands/anime/malprofile.js b/commands/anime/malprofile.js
@@ -9,9 +9,15 @@ module.exports = {
   cooldown: { time: 10000 },
   clientPermissions: [ 'EMBED_LINKS' ],
   group: 'anime',
-  description: 'Finds user profile on myanimelist based on the provided query',
-  parameters: [ 'User' ],
-  get examples(){ return [this.name, ...this.aliases].map(x => `${x} <mal username>`)},
+  description: 'Finds user profile on myanimelist based on the provided query.',
+  parameters: [ 'Myanimelist Username' ],
+  examples: [
+    'malprofile sakurajimai-san',
+    'mal-of sakurajimai-san',
+    'malof sakurajimai-san',
+    'malstat sakurajimai-san',
+    'maluser sakurajimai-san'
+  ],
   run: async function (client, message, args ){
 
     const query = args.join(' ');

diff --git a/commands/anime/manga.js b/commands/anime/manga.js
@@ -14,14 +14,14 @@ module.exports = {
   },
   clientPermissions: [ 'EMBED_LINKS', 'USE_EXTERNAL_EMOJIS', 'ADD_REACTIONS'],
   group: 'anime',
-  description: 'Searches for a Manga / Manhwa / Manhua in <:mal:767062339177676800> [MyAnimeList](https://myanimelist.net.co "Homepage").',
+  description: 'Searches for a Manga / Manhwa / Manhua in <:mal:767062339177676800> [MyAnimeList](https://myanimelist.net.co "Homepage"), or shows Seishun Buta Yarou if no query is provided.',
   parameters: [ 'Search Query' ],
-  get examples(){
-    return [ this.name, ...this.aliases.map((x,i) => {
-      const queries = [ 'aobuta', 'solo leveling', 'king\'s avatar' ];
-      return x + ' ' + queries[i];
-    }) ];
-  },
+  examples: [
+    'manga',
+    'comic rascal does not dream',
+    'manhwa solo leveling',
+    'manhua king\'s avatar'
+  ],
   run: async (client, message, args) => {
 
     const query = args.join(' ') || 'Seishun Buta Yarou';

diff --git a/commands/anime/mangarandom.js b/commands/anime/mangarandom.js
@@ -15,7 +15,10 @@ module.exports = {
   description: 'Generates a random manga recommendation. Recommends a Hentai if used on a nsfw channel.',
   clientPermissions: [ 'EMBED_LINKS' ],
   parameter: [],
-  get examples(){ return [ this.name, ...this.aliases ]; },
+  examples: [
+    'mangarandom',
+    'mangarand'
+  ],
   run: async ( client, message ) => {
 
     message.channel.startTyping()