diff --git a/.DS_Store b/.DS_Store index 18a8805..f61bb65 100644 Binary files a/.DS_Store and b/.DS_Store differ diff --git a/.gitignore b/.gitignore index 06fecb3..923ffd7 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,7 @@ package-lock.json .VSCodeCounter/ env.dev env.prod +.DS_Store # Custom folders # gifs/* diff --git a/README.md b/README.md index 6bd4303..12ad72f 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,47 @@ -#Grow A Tree Analyzer +# Grow A Tree Analyzer This bot works with Grow A Tree Bot by Limbo Labs. This project is not affiliated with Limbo Labs in any way. This bot allows easy comparison between a server's tree and other trees displayed on the leaderboard. -##Usage +## Usage Add the bot to your server and make sure it has the proper permissions (`Send Messages` and `Send Messages in Threads` if applicable), then run `/setup` in the channel(s) that contain your server's tree and leaderboard messages. -##Commands +## Commands * `/setup` - Attempts automatic detection of your server's tree and leaderboard messages. * `/setupinfo` - Displays your server's current configuration. * `/reset` - Resets your server's configuration, run `/setup` again if needed. + + +## Database Structure + +### Table: guildinfo +``` ++-----------------+-------------+------+-----+---------+----------------+ +| Field | Type | Null | Key | Default | Extra | ++-----------------+-------------+------+-----+---------+----------------+ +| id | int(10) | NO | PRI | NULL | auto_increment | +| guild_id | varchar(50) | NO | | NULL | | +| tree_message_id | varchar(50) | NO | | NULL | | +| tree_channel_id | varchar(50) | NO | | NULL | | +| rank_message_id | varchar(50) | NO | | NULL | | +| rank_channel_id | varchar(50) | NO | | NULL | | +| tree_height | varchar(10) | NO | | NULL | | ++-----------------+-------------+------+-----+---------+----------------+ +``` +### Table: treeinfo +``` ++-----------+--------------+------+-----+---------+----------------+ +| Field | Type | Null | Key | Default | Extra | ++-----------+--------------+------+-----+---------+----------------+ +| id | int(10) | NO | PRI | NULL | auto_increment | +| treename | varchar(100) | NO | | NULL | | +| treerank | int(10) | NO | | NULL | | +| timestamp | varchar(50) | NO | | NULL | | ++-----------+--------------+------+-----+---------+----------------+ +``` + +## Changes to Implement + +* Move around some of the functions. +* Migrate storage to SQLite. \ No newline at end of file