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

v3.3.3 Documentation

Browse Source
This commit is contained in:
Skylar Grant 2024-09-26 09:07:20 -04:00
parent d0528c3637
commit 4b75dfa885
3 changed files with 24 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
CHANGELOG.md Normal file
View File

@ -0,0 +1,23 @@
## v3.3.x
#### v3.3.3 (#20)
* Fixed content-list slash commands `/gifs`, `/pastas`, `/joints`, `/requests` (#19)
* Fixed the creation of duplicate commands properly (#18)
* Added a ton of aliases for `.gif` (`.wav`, `.mp3`, `.mp4`, `.wmv`, etc.)
#### v3.3.2 (#17)
* Fixed the `/help` command to not crash the bot (#15)
* Filtered out duplicate commands from the `/help` list, temporary fix (#18)
* Removed instances of `MessageEmbed.addField` due to deprecation (#16)
v3.3.1 - Polishing and bugfixing for new AvWx commands
v3.3.0 - Added `.metar`, `.atis`, and `.datis` AvWx commands
## v3.0.x
v3.0.1 - Migrate TenorJS API Endpoint
v3.0.2 - Add medical advice commands
v3.0.3 - Fix broken `/requests` command
v3.0.4 - Add ability to use multiple aliases
v3.0.5 - Add ability to save strains
v3.0.6 - Move `.strain` to `/strain` and add Autocomplete
v3.0.7 - Add `.spongebob` replies
v3.0.8 - Add ability to open requests by pages

33
README.md
View File

@ -1,9 +1,6 @@
# 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.
@ -14,16 +11,6 @@ Use the `/help` command to see the bot's help message.
## Push Docker Image
`docker push name/nodbot`
# Immediate To-Do
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.~~
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
1. Create an application at the [Discord Developer Portal](https://discord.com/developers/applications)
@ -35,13 +22,6 @@ 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
```
@ -108,15 +88,4 @@ tenorAPIKey=<Tenor API Key>
ownerId=<your Discord user ID>
statusChannelId=<Discord channel ID of channel used for status messages>
clientId=<Discord user ID of your bot>
```
## Changes
v3.0.1 - Migrate TenorJS API Endpoint
v3.0.2 - Add medical advice commands
v3.0.3 - Fix broken `/requests` command
v3.0.4 - Add ability to use multiple aliases
v3.0.5 - Add ability to save strains
v3.0.6 - Move `.strain` to `/strain` and add Autocomplete
v3.0.7 - Add `.spongebob` replies
v3.0.8 - Add ability to open requests by pages
```

14
Roadmap.md
View File

@ -1,14 +0,0 @@
# 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