From eb5b192ea9a54b1108b6ffd330c84d1331402801 Mon Sep 17 00:00:00 2001 From: BuildTools Date: Sat, 15 Jan 2022 17:43:35 -0500 Subject: [PATCH] readme formatting & todo updates --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4b4d10f..15b2492 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,27 @@ # modular-discord-bot-fw framework for discord bots that uses contained files for individual feature plugins that can be modified and reloaded on the fly -basic structure: +### basic structure: * client class has implementations for handling opcodes * event response is up to the client (!!) * this lets us expose events for plugins to hook into, but keeps core API interaction defined in-class * any and all bot features should be useable via independent feature plugins * these are dynamically found and run, so they can be hotloaded, modified, etc. without disconnecting or restarting the whole bot session -todo before it's basically finished: +## todo board + +### core: * basic rate limiting -* ~~plugin manager & hook integration~~ * make sure broken sockets are properly addressed with a resume or reconnect +* initial presence in config +* full REST api implementation + +### plugins: +* save session config to file + * re: runtime modufication of authenticated users and such + +### done: +* ~~plugin manager & hook integration~~ * ~~default plugins so the bot does _something_ out of the box~~ * ~~plugin reloading, user (command) authentication, etc. will also probably be written in plugin form~~ -* initial presence in config -* take config as cli param -* save session config to file \ No newline at end of file +* ~~take config as cli param~~ \ No newline at end of file