Skip to content

buckley-w-david/anibot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

anibot

Search for anime and manga without leaving the comfort of your discord server!

What does it do?

anibot listens for two kinds of messages in any discord server it is added to:

Inline Requests

An inline request is any bit of text between a set of braces ({}) for anime or a set of inequality signs (<>) for manga.

Examples:

Have you guys heard of {Hunter x Hunter}?

or

<Berserk> is way better than the anime would lead you to believe.

Bot commands

A bot command is a message prefixed with !anibot . With bot commands you can get more specific than with the inline requests, looking up media based on title, ID (from anilist, where all the data is pulled from), studio, or staff.

TODO: Section on bot commands

Response

The bot will respond with something that looks like... Example

What's with the reactions?

I'm so glad you asked!

Since discord is a little behind the times when it comes to methods of interacting with a bot, those of us interested in a more user friendly experience have had to do some improvising. Those reactions are ways to request additional information about the preview that was just sent.

In the above demonstration, reacting to the message with "👉" will result in the bot pulling additional pieces of media that the Director has worked on, while "👈" will request the same for the Original Creator.

The buttons labeled "1️⃣", "2️⃣", ..., "🔟" are the equivalent of "👉" and "👈" but for the studios that have worked on the media.

To prevent spam, each button will only work once. After is has been pressed, and the info put into chat, using that reaction again won't do anything. Similarly 24 hours after the message was posted the buttons will expire.

Note: As of now, if the bot goes offline, all previously existing buttons will unfortunatly stop functioning, even after the bot is brought back up. In practice this isn't a huge deal as the bot isn't expected to go down very often (if ever), and old buttons would have expired anyway.

How do I use it?

  1. Setup a discord application through the Discord Developer Portal.
  2. Create a bot user for that application.
  3. Copy the bot token.
  4. Clone this repository.
  5. run make build inside the cloned directory (This will require you have go installed on your system).
  6. run bin/bot -t "<Your Bot Token from Step 3>"

The bot should now be running, add it to a server to see it go.

To add the bot to your server, go to https://discordapp.com/oauth2/authorize?&client_id=<Your application client ID>&scope=bot&permissions=19456.
You'll need the client ID from the application you setup in step 1

Why would I want this?

¯\_(ツ)_/¯

About

Discord bot for easy access to anime and manga information

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published