diff --git a/README.md b/README.md index ce59efa..05eadda 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,14 @@ This is the source code for the [FBTHeaven discord bot](https://fbtsecurity.fbth [FBT Links](https://linktr.ee/FBT_Heaven) -## about +## About -I am the developer for version 2.0, it has been a stale unmaintained project for months but I didn't want my source to just wither untouched so I removed the API keys and added a handful of `// TODO:`s to the code for you to find what discord IDs you need to change and what other keys you need to provide. +I am the developer for version 2.0, it has been a stale unmaintained project for months but I didn't want my source to just wither untouched -- so I removed the API keys and added a handful of `// TODO:`s to the code for you to find what discord IDs you need to change and what other keys you need to provide. You will need a [Redis DB](https://redis.io/) for a bunch of features, no guide on setting one up atm (or possibly ever, we'll see how I feel later) You can also update a [Meilisearch DB](https://www.meilisearch.com/) with the same data, that one command is easy to comment out if you don't want to use that too -## redis layout +## Redis layout The db is split into 8 "folders". Redis is a key:value DB meaning you have just the name of the DB entry and then its value, an example of this is the entry `user:0000000000000000000` which is an entry in the user "folder". @@ -21,8 +21,8 @@ here are the "folders" and their descriptions: - `authed-server-users:` - This is a Redis [SET](https://redis.io/docs/latest/develop/data-types/sets/) of discord user IDs who are authenticated in the server in the DB entry - `cleared-suer:` - - this is a [JSON](https://redis.io/docs/latest/develop/data-types/json/) entry of users who are cleared as okay in the DB after being flagged - - Json format: + - This is a [JSON](https://redis.io/docs/latest/develop/data-types/json/) entry of users who are cleared as okay in the DB after being flagged + - JSON format: ```JSON { @@ -36,7 +36,7 @@ here are the "folders" and their descriptions: - `feedback:--` - This is just a [String](https://redis.io/docs/latest/develop/data-types/strings/) containing whatever feedback they put in the feedback command - `guild-settings:` - - This is a [JSON](https://redis.io/docs/latest/develop/data-types/json/) entry containing if the server has auto kick enabled or not as well as the channel id for bot announcements + - This is a [JSON](https://redis.io/docs/latest/develop/data-types/json/) entry containing if the server has auto kick enabled or not as well as the channel ID for bot announcements ```json { @@ -46,7 +46,7 @@ here are the "folders" and their descriptions: } ``` -- `monitroted-guild:` +- `monitored-guild:` - This is a [JSON](https://redis.io/docs/latest/develop/data-types/json/) entry containing info about tracked servers. this is only inside of the `_deprecated.rs` as it was a holdover from the old Python version's SQLite DB. More info about this one will come with the Python source code later™️ ```json @@ -60,7 +60,7 @@ here are the "folders" and their descriptions: ``` - `status:commands-executed` - - this is a simple [String](https://redis.io/docs/latest/develop/data-types/strings/) entry to track how many commands have run since the feature was implemented, it appears at the bottom of the `/about` command + - This is a simple [String](https://redis.io/docs/latest/develop/data-types/strings/) entry to track how many commands have run since the feature was implemented, it appears at the bottom of the `/about` command - `user:` - This is the largest list of entries in the DB. - These are [JSON](https://redis.io/docs/latest/develop/data-types/json/) entries for users who are uploaded via scrapped discords, more info on that in the next section @@ -84,7 +84,7 @@ here are the "folders" and their descriptions: - `kick-whitelist` - This is a [SET](https://redis.io/docs/latest/develop/data-types/sets/) that I didn't put in a folder for some reason. It holds a list of DiscordUserIDs that should be ignored when running the `/excel` command. -# scrape discords +# Scrape Discords So the main use of this bot originally was as follows: @@ -102,12 +102,12 @@ I might clean this up further or add a branch for the old Python version in the good luck to whoever may look upon my first large Rust project -# mirrors +# Mirrors - [GitHub](https://github.com/BuyMyMojo/open-fbt) - [Codeberg](https://codeberg.org/BuyMyMojo/open-fbt) - [Personal Gitea](https://git.buymymojo.net/BuyMyMojo/open-fbt)

-There is no database files or user entries here, look somewhere else <3 +There are no database files or user entries here, look somewhere else <3