align readme and discord command docs

rfresh2 · rfresh2 · commit 8893e44f9f56 · 2025-08-17T21:26:32.000-07:00
diff --git a/README.md b/README.md
@@ -24,5 +24,5 @@ Invite link: [bot.2b2t.vc](https://bot.2b2t.vc)
 * `/priodata` -> Dumps a JSON list of all players who currently have priority queue (probably)
 * `/stats` -> Prints a player's stats on 2b2t
 * `/wordcount` -> Counts how many times a word has been seen in chat
-* `/watch` -> DM Notifications on player joins, leaves, deaths, or kills
-* `/watch-guild` -> Discord server channel notifications on player joins, leaves, deaths, or kills
+* `/watch` -> DM Notifications on player joins, leaves, deaths, kills, and chats
+* `/watch-guild` -> Discord server channel notifications on player joins, leaves, deaths, kills, and chats
diff --git a/src/main/resources/commands/chats.json b/src/main/resources/commands/chats.json
@@ -1,16 +1,16 @@
 {
   "name": "chats",
-  "description": "Gets a player's chat history",
+  "description": "Searches chats by player, word, and date",
   "options": [
     {
       "name": "player",
-      "description": "The player to get the chat history of",
+      "description": "Player",
       "type": 3,
       "required": false
     },
     {
       "name": "word",
-      "description": "The word to search",
+      "description": "Word",
       "type": 3,
       "required": false
     },
diff --git a/src/main/resources/commands/commands.json b/src/main/resources/commands/commands.json
@@ -1,4 +1,4 @@
 {
   "name": "commands",
-  "description": "Lists commands the bot supports"
+  "description": "Lists all commands and their description"
 }
diff --git a/src/main/resources/commands/connections.json b/src/main/resources/commands/connections.json
@@ -1,10 +1,10 @@
 {
   "name": "connections",
-  "description": "Gets a player's join and leave events on 2b2t",
+  "description": "Prints a player's join/leave history",
   "options": [
     {
       "name": "player",
-      "description": "The player to get the join and leave events for",
+      "description": "Player",
       "type": 3,
       "required": true
     },
diff --git a/src/main/resources/commands/data.json b/src/main/resources/commands/data.json
@@ -1,10 +1,10 @@
 {
   "name": "data",
-  "description": "Gets a dump of all a player's data on 2b2t",
+  "description": "Dumps all data on a player as a CSV file",
   "options": [
     {
       "name": "player",
-      "description": "The player to get the data for",
+      "description": "Player",
       "type": 3,
       "required": true
     }
diff --git a/src/main/resources/commands/deaths.json b/src/main/resources/commands/deaths.json
@@ -1,10 +1,10 @@
 {
   "name": "deaths",
-  "description": "Gets a player's deaths",
+  "description": "Prints a player's death history",
   "options": [
     {
       "name": "player",
-      "description": "The player to get deaths for",
+      "description": "Player",
       "type": 3,
       "required": true
     },
diff --git a/src/main/resources/commands/deaths_top_month.json b/src/main/resources/commands/deaths_top_month.json
@@ -1,4 +1,4 @@
 {
   "name": "deathsmonth",
-  "description": "Top deaths counts in the last 30 days"
+  "description": "Leaderboard for top deaths in the last 30 days"
 }
diff --git a/src/main/resources/commands/kills.json b/src/main/resources/commands/kills.json
@@ -1,10 +1,10 @@
 {
   "name": "kills",
-  "description": "Gets kills by a player",
+  "description": "Prints a player's kill history",
   "options": [
     {
       "name": "player",
-      "description": "The player to get kills for",
+      "description": "Player",
       "type": 3,
       "required": true
     },
diff --git a/src/main/resources/commands/kills_top_month.json b/src/main/resources/commands/kills_top_month.json
@@ -1,4 +1,4 @@
 {
   "name": "killsmonth",
-  "description": "Top kills counts in the last 30 days"
+  "description": "Leaderboard for top kills in the last 30 days"
 }
diff --git a/src/main/resources/commands/livechat.json b/src/main/resources/commands/livechat.json
@@ -1,6 +1,6 @@
 {
   "name": "livechat",
-  "description": "Configures the live chat feature",
+  "description": "Configures a live chat feed channel in your server",
   "options": [
     {
       "name": "enable",
diff --git a/src/main/resources/commands/liveconnections.json b/src/main/resources/commands/liveconnections.json
@@ -1,6 +1,6 @@
 {
   "name": "liveconnections",
-  "description": "Configures the live connections feature",
+  "description": "Configures a live join/leave feed channel in your server",
   "options": [
     {
       "name": "enable",
diff --git a/src/main/resources/commands/playtime.json b/src/main/resources/commands/playtime.json
@@ -1,10 +1,10 @@
 {
   "name": "playtime",
-  "description": "2b2t playtime",
+  "description": "Gets a player's total playtime",
   "options": [
     {
       "name": "player",
-      "description": "The player to lookup",
+      "description": "Player",
       "type": 3,
       "required": true
     }
diff --git a/src/main/resources/commands/priodata.json b/src/main/resources/commands/priodata.json
@@ -1,4 +1,4 @@
 {
   "name": "priodata",
-  "description": "Dump all players who probably have priority queue"
+  "description": "Dumps a JSON list of all players who currently have priority queue (probably)"
 }
diff --git a/src/main/resources/commands/pt_top.json b/src/main/resources/commands/pt_top.json
@@ -1,4 +1,4 @@
 {
   "name": "playtimetop",
-  "description": "Top playtime over all time"
+  "description": "Leaderboard for all time top playtime on 2b2t"
 }
diff --git a/src/main/resources/commands/pt_top_month.json b/src/main/resources/commands/pt_top_month.json
@@ -1,4 +1,4 @@
 {
   "name": "playtimemonth",
-  "description": "Top playtime in the last 30 days"
+  "description": "Leaderboard for top playtime in the last 30 days"
 }
diff --git a/src/main/resources/commands/queue.json b/src/main/resources/commands/queue.json
@@ -1,4 +1,4 @@
 {
   "name": "queue",
-  "description": "Gets 2b2t queue status"
+  "description": "Shows 2b2t's current queue lengths and ETA"
 }
diff --git a/src/main/resources/commands/seen.json b/src/main/resources/commands/seen.json
@@ -1,10 +1,10 @@
 {
   "name": "seen",
-  "description": "Get when a player was last and first seen on 2b2t",
+  "description": "When a player was last and first seen on 2b2t",
   "options": [
     {
       "name": "player",
-      "description": "The player to lookup",
+      "description": "Player",
       "type": 3,
       "required": true
     }
diff --git a/src/main/resources/commands/stats.json b/src/main/resources/commands/stats.json
@@ -1,10 +1,10 @@
 {
   "name": "stats",
-  "description": "Gets a player's 2b2t stats",
+  "description": "Prints a player's stats on 2b2t",
   "options": [
     {
       "name": "player",
-      "description": "The player to get stats of",
+      "description": "Player",
       "type": 3,
       "required": true
     }
diff --git a/src/main/resources/commands/tablist.json b/src/main/resources/commands/tablist.json
@@ -1,4 +1,4 @@
 {
   "name": "tablist",
-  "description": "Gets the current 2b2t tablist"
+  "description": "Prints all online players right now on 2b2t"
 }
diff --git a/src/main/resources/commands/watch.json b/src/main/resources/commands/watch.json
@@ -1,124 +1,124 @@
 {
   "name": "watch",
-  "description": "DM notifications on player events",
+  "description": "DM Notifications on player joins, leaves, deaths, or kills",
   "options": [
     {
       "name": "player",
-      "description": "Watch for events about a specific player",
+      "description": "Player watch",
       "type": 2,
       "options": [
         {
           "name": "add",
-          "description": "Add a watch",
+          "description": "Add player watch",
           "type": 1,
           "options": [
             {
               "name": "player",
-              "description": "Player Name",
+              "description": "Player",
               "type": 3,
               "required": true
             },
             {
               "name": "joins",
-              "description": "On player join",
+              "description": "Joins",
               "type": 5,
               "required": false
             },
             {
               "name": "leaves",
-              "description": "On player disconnects",
+              "description": "Leaves",
               "type": 5,
               "required": false
             },
             {
               "name": "chats",
-              "description": "On player chats",
+              "description": "Chats",
               "type": 5,
               "required": false
             },
             {
               "name": "deaths",
-              "description": "On player deaths",
+              "description": "Deaths",
               "type": 5,
               "required": false
             },
             {
               "name": "kills",
-              "description": "On player kills",
+              "description": "Kills",
               "type": 5,
               "required": false
             }
           ]
         },
         {
           "name": "delete",
-          "description": "Remove a watch",
+          "description": "Remove player watch",
           "type": 1,
           "options": [
             {
               "name": "player",
-              "description": "Player Name",
+              "description": "Player",
               "type": 3,
               "required": true
             }
           ]
         },
         {
           "name": "list",
-          "description": "List all watches",
+          "description": "List all player watches",
           "type": 1
         },
         {
           "name": "clear",
-          "description": "Remove all watches",
+          "description": "Remove all player watches",
           "type": 1
         }
       ]
     },
     {
       "name": "chat",
-      "description": "Watch for chats containing a keyword",
+      "description": "Watch chats containing a keyword",
       "type": 2,
       "options": [
         {
           "name": "add",
-          "description": "Add a watch",
+          "description": "Add a chat watch",
           "type": 1,
           "options": [
             {
               "name": "keyword",
-              "description": "Set a keyword",
+              "description": "Keyword",
               "type": 3,
               "required": true
             },
             {
               "name": "case-sensitive",
-              "description": "Set whether keyword matches regardless of upper/lowercase letters",
+              "description": "Whether keyword matches regardless of upper/lowercase letters",
               "type": 5
             }
           ]
         },
         {
           "name": "delete",
-          "description": "Remove a watch",
+          "description": "Remove a chat watch",
           "type": 1,
           "options": [
             {
               "name": "keyword",
-              "description": "Keyword to remove",
+              "description": "Keyword",
               "type": 3,
               "required": true
             }
           ]
         },
         {
           "name": "list",
-          "description": "List all watches",
+          "description": "List all chat watches",
           "type": 1
         },
         {
           "name": "clear",
-          "description": "Remove all watches",
+          "description": "Remove all chat watches",
           "type": 1
         }
       ]
diff --git a/src/main/resources/commands/watch_guild.json b/src/main/resources/commands/watch_guild.json
diff --git a/src/main/resources/commands/word_count.json b/src/main/resources/commands/word_count.json

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "commands",`
`3`		`- "description": "Lists commands the bot supports"`
	`3`	`+ "description": "Lists all commands and their description"`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,10 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "connections",`
`3`		`- "description": "Gets a player's join and leave events on 2b2t",`
	`3`	`+ "description": "Prints a player's join/leave history",`
`4`	`4`	`"options": [`
`5`	`5`	`{`
`6`	`6`	`"name": "player",`
`7`		`- "description": "The player to get the join and leave events for",`
	`7`	`+ "description": "Player",`
`8`	`8`	`"type": 3,`
`9`	`9`	`"required": true`
`10`	`10`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,10 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "data",`
`3`		`- "description": "Gets a dump of all a player's data on 2b2t",`
	`3`	`+ "description": "Dumps all data on a player as a CSV file",`
`4`	`4`	`"options": [`
`5`	`5`	`{`
`6`	`6`	`"name": "player",`
`7`		`- "description": "The player to get the data for",`
	`7`	`+ "description": "Player",`
`8`	`8`	`"type": 3,`
`9`	`9`	`"required": true`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,10 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "deaths",`
`3`		`- "description": "Gets a player's deaths",`
	`3`	`+ "description": "Prints a player's death history",`
`4`	`4`	`"options": [`
`5`	`5`	`{`
`6`	`6`	`"name": "player",`
`7`		`- "description": "The player to get deaths for",`
	`7`	`+ "description": "Player",`
`8`	`8`	`"type": 3,`
`9`	`9`	`"required": true`
`10`	`10`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "deathsmonth",`
`3`		`- "description": "Top deaths counts in the last 30 days"`
	`3`	`+ "description": "Leaderboard for top deaths in the last 30 days"`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,10 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "kills",`
`3`		`- "description": "Gets kills by a player",`
	`3`	`+ "description": "Prints a player's kill history",`
`4`	`4`	`"options": [`
`5`	`5`	`{`
`6`	`6`	`"name": "player",`
`7`		`- "description": "The player to get kills for",`
	`7`	`+ "description": "Player",`
`8`	`8`	`"type": 3,`
`9`	`9`	`"required": true`
`10`	`10`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "killsmonth",`
`3`		`- "description": "Top kills counts in the last 30 days"`
	`3`	`+ "description": "Leaderboard for top kills in the last 30 days"`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "livechat",`
`3`		`- "description": "Configures the live chat feature",`
	`3`	`+ "description": "Configures a live chat feed channel in your server",`
`4`	`4`	`"options": [`
`5`	`5`	`{`
`6`	`6`	`"name": "enable",`