From 636aa130a0bcaee21e2b886d23c0d4b3a103f0ed Mon Sep 17 00:00:00 2001 From: = Date: Thu, 15 Jul 2021 21:53:21 -0400 Subject: [PATCH] Maintenance --- README.md | 27 +++++++++++++++++++-------- ReleaseNotes.md | 5 ----- package.json | 2 +- 3 files changed, 20 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index fd6d3a9..59d5c6d 100644 --- a/README.md +++ b/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 ` -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 ` -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. \ No newline at end of file +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. \ No newline at end of file diff --git a/ReleaseNotes.md b/ReleaseNotes.md index f50e430..308f6e2 100644 --- a/ReleaseNotes.md +++ b/ReleaseNotes.md @@ -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. \ No newline at end of file diff --git a/package.json b/package.json index 22a5a87..c4b6bec 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "nodbot", - "version": "2.1.0", + "version": "2.1", "description": "Nods and Nod Accessories.", "main": "index.js", "dependencies": {