voidf1sh/silvanus
voidf1sh
/
silvanus
1
1
Fork 0
Code Issues 1 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Documentation

This commit is contained in:
Skylar Grant 2023-01-20 23:12:07 -05:00
parent ae544369aa
commit e678e696bd
3 changed files with 38 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
.DS_Store vendored
View File

Binary file not shown.

1
.gitignore vendored
View File

@ -4,6 +4,7 @@ package-lock.json
.VSCodeCounter/ .VSCodeCounter/
env.dev env.dev
env.prod env.prod
.DS_Store
# Custom folders # Custom folders
# gifs/* # gifs/*

34
README.md
View File

@ -11,3 +11,37 @@ Add the bot to your server and make sure it has the proper permissions (`Send Me
* `/setup` - Attempts automatic detection of your server's tree and leaderboard messages. * `/setup` - Attempts automatic detection of your server's tree and leaderboard messages.
* `/setupinfo` - Displays your server's current configuration. * `/setupinfo` - Displays your server's current configuration.
* `/reset` - Resets your server's configuration, run `/setup` again if needed. * `/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.