This is the Rust version of the discord bot created for FBT Heaven
Update README.md
Fixed the fixes
+11
-11
+11
-11
README.md
+11
-11
README.md
···
4
4
5
5
[FBT Links](https://linktr.ee/FBT_Heaven)
6
6
7
-
## about
7
+
## About
8
8
9
-
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.
9
+
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.
10
10
11
11
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)
12
12
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
13
13
14
-
## redis layout
14
+
## Redis layout
15
15
16
16
The db is split into 8 "folders".
17
17
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
21
- `authed-server-users:<DiscordServerID>`
22
22
- 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
23
23
- `cleared-suer:<DiscordUserID>`
24
-
- 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
25
-
- Json format:
24
+
- 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
25
+
- JSON format:
26
26
27
27
```JSON
28
28
{
···
36
36
- `feedback:<timestamp>-<DiscordUserID>-<DiscordUserName>`
37
37
- This is just a [String](https://redis.io/docs/latest/develop/data-types/strings/) containing whatever feedback they put in the feedback command
38
38
- `guild-settings:<DiscordGuildID>`
39
-
- 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
39
+
- 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
40
40
41
41
```json
42
42
{
···
46
46
}
47
47
```
48
48
49
-
- `monitroted-guild:<DiscordGuildID>`
49
+
- `monitored-guild:<DiscordGuildID>`
50
50
- 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™️
51
51
52
52
```json
···
60
60
```
61
61
62
62
- `status:commands-executed`
63
-
- 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
63
+
- 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
64
64
- `user:<DiscordUserID>`
65
65
- This is the largest list of entries in the DB.
66
66
- 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
84
- `kick-whitelist`
85
85
- 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.
86
86
87
-
# scrape discords
87
+
# Scrape Discords
88
88
89
89
So the main use of this bot originally was as follows:
90
90
···
102
102
103
103
good luck to whoever may look upon my first large Rust project
104
104
105
-
# mirrors
105
+
# Mirrors
106
106
107
107
- [GitHub](https://github.com/BuyMyMojo/open-fbt)
108
108
- [Codeberg](https://codeberg.org/BuyMyMojo/open-fbt)
109
109
- [Personal Gitea](https://git.buymymojo.net/BuyMyMojo/open-fbt)
110
110
111
111
<p style="color: rgba(0, 0, 0, 0)">
112
-
There is no database files or user entries here, look somewhere else <3
112
+
There are no database files or user entries here, look somewhere else <3
113
113
</p>