Maintenance
This commit is contained in:
parent
b34700fd85
commit
636aa130a0
27
README.md
27
README.md
@ -1,21 +1,32 @@
|
||||
# NodBot
|
||||
A simple Discord bot created by @voidf1sh#0420 for retreiving gifs, saving copypastas, and more coming soon.
|
||||
|
||||
## Dependancies
|
||||
NodBot depends on `fs`, `discord.js`, `dotenv`, and `giphy-api`.
|
||||
## Dependencies
|
||||
NodBot depends on `fs`, `discord.js`, `dotenv`, `giphy-api`, and `axios`.
|
||||
|
||||
## Features
|
||||
Dynamic Help Message
|
||||
Ability to save favorite gifs and copypastas
|
||||
|
||||
## Usage
|
||||
Search for any gif with `search query here.gif`
|
||||
Save a favorite gif with `/save-gif <gif_name> <gif link>`
|
||||
Recall a saved gif with `gif_name.gif`
|
||||
All commands are provided as "file extensions" instead of prefixes to the message.
|
||||
|
||||
Save a favorite copypasta with `/save-pasta <pasta_name> <pasta text>`
|
||||
Recall a saved copypasta with `pasta_name.pasta`
|
||||
```
|
||||
foo.gif -- Will return the first GIF for 'foo'
|
||||
foo.savegif -- Will send the first GIF result for 'foo', with Reactions to browse the results and save the GIF
|
||||
bar foo.savepasta -- Saves a copypasta text ('bar') as 'foo.pasta'
|
||||
foo.pasta -- If a copypasta by the name of 'foo' is saved, the bot will send it
|
||||
foo.weather -- Returns the current weather in 'foo', where 'foo' is a city or ZIP code
|
||||
foobar.spongebob - Returns 'FoObAr' aka SpongeBob text
|
||||
.joint -- Puff, Puff, Pass.
|
||||
```
|
||||
|
||||
## To Do
|
||||
Clean up text input for copypastas, line breaks and apostrophes break the bot.
|
||||
Add ability to reload commands, gifs, pastas, etc without rebooting the bot manually.
|
||||
Add ability to reload commands, gifs, pastas, etc without rebooting the bot manually.
|
||||
Change `savepasta` to use a collector and ask for the name or the pasta.
|
||||
Add Stock quotes from Yahoo Finance API
|
||||
Add self-delete if wrongbad'd
|
||||
Move most string literals to config.json or strings.json for ease of editing.
|
||||
Make construction of the `data` element easier for the createEmbeds functions.
|
||||
Find a Cannabis API for strain information lookup.
|
@ -1,10 +1,5 @@
|
||||
# Release Notes
|
||||
|
||||
## To Do
|
||||
Move most string literals to config.json or strings.json for ease of editing.
|
||||
Make construction of the `data` element easier for the createEmbeds functions.
|
||||
Find a Cannabis API for strain information lookup.
|
||||
|
||||
## v2.1
|
||||
Changing the method to search for and save GIFs for later reuse. Previously the bot simply sent a message containing the link to a GIF which Discord would display in the chat. However the new code uses Embeds to make the messages look prettier. These Embeds require a *direct* link to the GIF, which isn't very user friendly. Now you can search for a GIF and NodBot will DM you with results for you to browse before choosing the GIF you'd like to save, then name it.
|
||||
Generic bug squashing, sanitizing of inputs, setting up some configs for deployment on Heroku.
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "nodbot",
|
||||
"version": "2.1.0",
|
||||
"version": "2.1",
|
||||
"description": "Nods and Nod Accessories.",
|
||||
"main": "index.js",
|
||||
"dependencies": {
|
||||
|
Loading…
Reference in New Issue
Block a user