From 7863802cc833bee5214e981d8ae8aaa069706c6d Mon Sep 17 00:00:00 2001
From: mfaltys <mfaltys@gmail.com>
Date: Fri, 14 Jul 2023 15:12:52 -0500
Subject: [PATCH] Add data struct documentation

---
 lorebot/lorebot.go | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/lorebot/lorebot.go b/lorebot/lorebot.go
index 0f5455e..89276b8 100644
--- a/lorebot/lorebot.go
+++ b/lorebot/lorebot.go
@@ -301,6 +301,17 @@ func rngHandler(s *discordgo.Session, m *discordgo.MessageCreate, redisClient *r
 }
 
 func shopHandler(s *discordgo.Session, m *discordgo.MessageCreate, redisClient *redis.Client) {
+	// data format
+	// redis set for the following indexes:
+	//   index:dnd:common
+	//   index:dnd:uncommon
+	//   index:dnd:rare
+	//   index:dnd:very_rare
+	//   index:dnd:legendary
+	//
+	// redis hash with the following data
+	//   dnd:abracadabrus name x rarity x price x type x
+
 	// item settings
 	minCommon := 4
 	maxCommon := 6