From 1f5f33fc2f2c8f5d2239d5506ba53438a090d52d Mon Sep 17 00:00:00 2001
From: ilotterytea <iltsu@alright.party>
Date: Sat, 12 Apr 2025 17:01:48 +0500
Subject: feat: command descriptions

---
 luamods/chatters.lua | 8 ++++++++
 luamods/ping.lua     | 2 ++
 2 files changed, 10 insertions(+)

(limited to 'luamods')

diff --git a/luamods/chatters.lua b/luamods/chatters.lua
index a3c3820..cf71bcc 100644
--- a/luamods/chatters.lua
+++ b/luamods/chatters.lua
@@ -15,6 +15,14 @@ local lines = {
 
 return {
 	name = "chatters",
+	description = [[
+> To use the `!chatters` command, you must assign moderator to the bot.
+> Following the [Twitch API docs](https://dev.twitch.tv/docs/api/reference/#get-chatters), only moderators have access to full chatter list.
+
+The `!chatters` command allows you to get a list of chatters as plain text.
+After collecting the list of chatters, the bot returns a link to the paste from
+[the Pastebin-like service](https://paste.alright.party).
+]],
 	delay_sec = 30,
 	options = {},
 	subcommands = {},
diff --git a/luamods/ping.lua b/luamods/ping.lua
index 8e1578e..d6ac40d 100644
--- a/luamods/ping.lua
+++ b/luamods/ping.lua
@@ -1,5 +1,7 @@
 return {
     name = "ping",
+    description =
+    "The `!ping` command checks to see if it's alive and gives a bunch of other data like memory usage, compiler version, etc.",
     delay_sec = 5,
     options = {},
     subcommands = {},
-- 
cgit v1.2.3