readme formatting & todo updates

master
BuildTools 4 years ago
parent fbed938766
commit eb5b192ea9
  1. 20
      README.md

@ -1,19 +1,27 @@
# modular-discord-bot-fw # 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 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 * client class has implementations for handling opcodes
* event response is up to the client (!!) * 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 * 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 * 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 * 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 * basic rate limiting
* ~~plugin manager & hook integration~~
* make sure broken sockets are properly addressed with a resume or reconnect * make sure broken sockets are properly addressed with a resume or reconnect
* ~~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 * initial presence in config
* take config as cli param * full REST api implementation
### plugins:
* save session config to file * 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~~
* ~~take config as cli param~~
Loading…
Cancel
Save