Coder Social home page Coder Social logo

anischedule's Introduction

AniSchedule

A Discord bot that uses the AniList API to retrieve the airing schedule for configured anime and sends a message when a new episode has aired.

Edit: This branch contains a few additional lines for Glitch functionality.

Example Announcement Example Announcement

Running Locally

Make sure you have Node.js installed.

Run these commands to get the project locally:

git clone https://github.com/L11K/AniSchedule.git # or clone your own fork
cd AniSchedule
npm install

Create a new .env file in the root directory of the project (the same directory as this README) with the following properties:

BOT_TOKEN=$TOKEN
COMMAND_PREFIX=$PREFIX
PERMISSION_TYPE=$PERMISSION

$TOKEN should be the bot token obtained from Discord's developer panel.

$PREFIX should be a string required before the command name. If unset, ! will be used.

$PERMISSION defines which users can add/remove watches. It should be one of the following:

  • ANY

    Anybody can modify

  • CHANNEL_MANAGER

    Users with the "Manage Channel" permission will be able to modify

  • SERVER_OWNER

    Only the server owner can modify

Finally, run npm start to start the bot.

Commands

Commands should be prefixed by the prefix set in the .env file.

eg: If your prefix is ?as, the command would be ?aswatch.

  • watch

    This command adds a new anime to watch for new episodes of. You can either provide the AniList entry link or the media ID of the anime which can be obtained from the series URL. Whatever channel this is used in is the channel the announcements will be made in. This follows the permission level set in the .env file.

    A ๐Ÿ‘ reaction indicates that adding this anime was successful. A ๐Ÿ‘Ž reaction indicates that it was unsuccessful. An unsuccessful reaction could mean that the channel is already watching that anime or that the ID was invalid.

    eg: In the URL https://anilist.co/anime/99263/Tate-no-Yuusha-no-Nariagari/, the ID is 99263.

  • unwatch

    This command removes an anime from the list. Just as with the watch command, it takes the AniList media entry link or the media ID. Must be used in the channel that the watch was added to. This follows the permission level set in the .env file.

    A ๐Ÿ‘ reaction indicates that removing this anime was successful. A ๐Ÿ‘Ž reaction indicates that it was unsuccessful. An unsuccessful reaction could mean that the channel was not watching that anime or that the ID was invalid.

  • next

    This command will display the next anime to air (in the next 7 days) that the current channel is watching.

    A ๐Ÿ‘Ž reaction indicates that it was unsuccessful. An unsuccessful reaction could mean that the channel is not watching any anime or that none of the watched anime have an episode airing in the next 7 days.

  • watching

    This command prints a list of all anime names being watched that are still currently airing. It can be used by anybody.

    A ๐Ÿ‘Ž reaction indicates that it was unsuccessful. An unsuccessful reaction means that this channel is not watching any anime.

  • help

    This command lists all available commands along with a short description.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.