This is the Rust version of the discord bot created for FBT Heaven
Update README.md
Fixed spelling errors in the README
+10
-10
+10
-10
README.md
+10
-10
README.md
···
6
6
7
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 hand full 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
-
You will need a [Redis DB](https://redis.io/) for a bunch of features, no guide on setting one up atm (or possibly every, we'll see how I feel later)
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
14
## redis layout
15
15
16
16
The db is split into 8 "folders".
17
-
Redis is a key:value DB meaning you have just the name of the DB entry and then it's value, an example of this is the entry `user:0000000000000000000` which is an entry in the user "folder".
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".
18
18
19
19
here are the "folders" and their descriptions:
20
20
···
47
47
```
48
48
49
49
- `monitroted-guild:<DiscordGuildID>`
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 hold over from the old Python verion's SQLite DB. more info about this one will come with the Python source code later™️
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
53
53
{
···
86
86
87
87
# scrape discords
88
88
89
-
So the main use of this bot origionally was as follows:
89
+
So the main use of this bot originally was as follows:
90
90
91
91
- scrape discord using [DiscordChatExporter](https://github.com/Tyrrrz/DiscordChatExporter)
92
-
- run resulting .csv files though [my old parser](https://github.com/BuyMyMojo/discord-chat-parser)
92
+
- run resulting .csv files through [my old parser](https://github.com/BuyMyMojo/discord-chat-parser)
93
93
- resulting file to the bot using the `/excel` command
94
94
95
95
This was to be used to scrape servers of bad actors such as VRC model rippers and leakers, it would add every user found inside the server into the DB with a description of the server that they are found in.
96
96
97
-
Once in the DB whenever the user joined a server with the FBT bot active the server owner/mods would get notified of a bad actor joining or optionally it would auto kick these accounts.
97
+
Once in the DB whenever the user joined a server with the FBT bot active the server owner/mods would get notified of a bad actor joining or optionally it would auto-kick these accounts.
98
98
99
-
# that's all folks
99
+
# That's all folks
100
100
101
-
I might clean this up further or add a branch for the old python version in the future.
101
+
I might clean this up further or add a branch for the old Python version in the future.
102
102
103
-
good luck whoever may look upon my first large Rust project
103
+
good luck to whoever may look upon my first large Rust project
104
104
105
105
# mirrors
106
106