diff --git a/README.md b/README.md index e69de29..0dc3eae 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,32 @@ +# Jacobs Bot + +This is a funny little Discord bot I wrote to represent a hyperbolized version of my Computer Networking & Cybersecurity class's instructor, since he was...a character. + +Don't judge my spelling errors that I'm sure are littered all over the source code, and note that I *did* redact `students.py`, which contained information that did map personal identities to Discord users, + +I might re-write this bot as some kind of framework, so that I could easily make a Discord bot with similar. +But I probably won't. +Since the OpenAI Assistants API is being sunset, I might update this. +But, if I did that I'd be rewriting it in Rust, because obviously + + +## Key Features +The bot is not exclusively AI: It has some features that are simply based on hardcoded values and rng, but messaging him *does* utilize AI. + +1. Periodically sends messages +2. Able to assign essays to server members +3. Can play rock paper scissors ESSAY!!! (suggested by the man, the myth, the legend, Mr. Jacobs himself!) +4. Able to get a lot of context: + - Adds the content of reply chains (up to 10 messages) + - Looks at the current channel for: + - Channel name + - Channel description + - Category + - Attached information based on users mentioned + - If the student has an essay (to yell at them to do it) +5. Responds to messages that: + - Are replies to messages the bot sent + - Mention the bot + +uhh yeah I think those are the key points. +I'm sure it does other things but that's all I remember working on