aria/open-fbt
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source 
Fixed the fixes
This commit is contained in:
Austin 2024-06-29 02:42:13 -07:00 • committed by GitHub
parent 7e9d15b05e
commit aab98e3e7e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -4,14 +4,14 @@ This is the source code for the [FBTHeaven discord bot](https://fbtsecurity.fbth
[FBT Links](https://linktr.ee/FBT_Heaven) [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 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 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". 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". 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:<DiscordServerID>` - `authed-server-users:<DiscordServerID>`
- 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 - 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:<DiscordUserID>` - `cleared-suer:<DiscordUserID>`
- 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 - 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 format:
```JSON ```JSON
{ {
@ -36,7 +36,7 @@ here are the "folders" and their descriptions:
- `feedback:<timestamp>-<DiscordUserID>-<DiscordUserName>` - `feedback:<timestamp>-<DiscordUserID>-<DiscordUserName>`
- This is just a [String](https://redis.io/docs/latest/develop/data-types/strings/) containing whatever feedback they put in the feedback command - 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:<DiscordGuildID>` - `guild-settings:<DiscordGuildID>`
- 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 ```json
{ {
@ -46,7 +46,7 @@ here are the "folders" and their descriptions:
} }
``` ```
- `monitroted-guild:<DiscordGuildID>` - `monitored-guild:<DiscordGuildID>`
- 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™️ - 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 ```json
@ -60,7 +60,7 @@ here are the "folders" and their descriptions:
``` ```
- `status:commands-executed` - `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:<DiscordUserID>` - `user:<DiscordUserID>`
- This is the largest list of entries in the DB. - 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 - 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` - `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. - 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: 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 good luck to whoever may look upon my first large Rust project
# mirrors # Mirrors
- [GitHub](https://github.com/BuyMyMojo/open-fbt) - [GitHub](https://github.com/BuyMyMojo/open-fbt)
- [Codeberg](https://codeberg.org/BuyMyMojo/open-fbt) - [Codeberg](https://codeberg.org/BuyMyMojo/open-fbt)
- [Personal Gitea](https://git.buymymojo.net/BuyMyMojo/open-fbt) - [Personal Gitea](https://git.buymymojo.net/BuyMyMojo/open-fbt)
<p style="color: rgba(0, 0, 0, 0)"> <p style="color: rgba(0, 0, 0, 0)">
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
</p> </p>