voidf1sh
/
nodbot
1
0
Fork 0
Code Issues 2 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Documentation

This commit is contained in:
Skylar Grant 2022-06-03 10:07:24 -04:00
parent 68bdcad522
commit 9e39d3a9eb
3 changed files with 32 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md Normal file
View File

@ -0,0 +1,18 @@
# About Nodbot
Nodbot is a content saving and serving Discord bot. Nodbot is able to search Tenor for GIFs, save custom copypastas, and look up marijuana strain information. Nodbot is in semi-active development by voidf1sh. It's buggy as hell and very shoddily built. Don't use it.
# Nodbot Help
Use the `/help` command to see the bot's help message.
## Create Docker Image
`docker build --tag=name/nodbot .`
## Push Docker Image
`docker push name/nodbot`
# Immediate To-Do
1. ~~Sanitize inputs for SQL queries.~~ Done.
2. Move environment variables so they don't get included in the image.
3. Implement error handling on all actions.

14
Roadmap.md Normal file
View File

@ -0,0 +1,14 @@
# v3.1.0
* Name checking for saving content
* .jpg, .wav
* Audio/Video attachments for saved content.
* Pass The Joint
* Voting system for Super Adventure Club
# v4.0.0
* Scalability: modify the code to allow the bot to be used in multiple servers
* including saved content, saved commands, preferences, etc.
# v3.?.?
= Joke generator for Hallihan

29
TODO.md
View File

@ -1,29 +0,0 @@
[ v3.0.0 ]
*= Finish MySQL Migration
* = Import strain names to a collection
* = Implement fuzzy-search for strain lookup
* = Then pass confirmed-good strainName to fn.download.strain()
*= Test all functions
* = Write out the process used to test functionality to standardize it.
= Sanitize inputs
= Don't forget to test apostrophes and newlines.
= Emoji break strain lookup
= Find a way to filter out URLs that may have .extensions at the end
= Mentions in .strain crash
= Fix newline escaping in savepasta
= Check what inputs need to be sanitized
! Name checking for saving content !
[ v3.1.0 ]
= .jpg, .wav
= Audio/Video attachments for saved content.
= Pass The Joint
= Voting system for Super Adventure Club
[ v4.0.0 ]
= Scalability: modify the code to allow the bot to be used in multiple servers
= including saved content, saved commands, preferences, etc.
[ v?.?.? ]
= Joke generator for Hallihan