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

Updating docs

This commit is contained in:
Skylar Grant 2024-06-22 10:42:26 -04:00
parent ecb50148b9
commit 2f9d29d891
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,6 +1,9 @@
# 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.
# Status
This should be ready to merge into `main`, let it run a couple days with testing before creating a PR. METAR and D-ATIS are implemented. TAFs will come later as they're more complicated.
# Nodbot Help
Use the `/help` command to see the bot's help message.
@ -13,12 +16,13 @@ Use the `/help` command to see the bot's help message.
# Immediate To-Do
1. ~~Sanitize inputs for SQL queries.~~ Done.
1. ~~Sanitize inputs for SQL queries.~~
2. ~~Move environment variables so they don't get included in the image.~~
3. Implement error handling on all actions.
4. Ephemeral responses to some/most slash commands.
4. ~~Ephemeral responses to some/most slash commands.~~
5. Comment the code! Document!
6. Check for and create database tables if necessary. Handle errors.
7. Readjust keyword autoresponses to be more generic instead of hard coded
# Deploy NodBot Yourself
@ -31,6 +35,13 @@ Use the `/help` command to see the bot's help message.
6. Configure your environment variables as outlined below.
7. Fire it up with `node main.js`
# Recent Changes
* Added METAR via AviationWeather.gov API
* Added D-ATIS via datis.clowd.io API
* Updated how keyword autoresponses are handled
* Changed `.joint` to reduce duplication and repetition by implementing an Ashtray and Roaches
## Table Structure
```