README.md

^{Unlimited access to a growing collection of over 90,000 anime, manga, music, games, and more!}

Kurozora Discord Bot (KuroBot)

Kurozora is your one-stop shop for everything anime! With KuroBot, you can easily search for anime, manga, games, music, characters, people, and studios from the biggest anime library in the world—Kurozora.

The data is presented in nice embeds which include titles, synopsis, poster/banner images, status, type, source, TV/age rating, genres, themes, broadcast/publication dates, seasons/volumes/editions, episodes/chapters, duration, ratings, and more!

But that’s not all. Kurozora is multipurpose and, among many stuff, allows you to quickly share anime GIFs, and search for anime music on YouTube, Spotify and Apple Music at the same time!

Full feature-list:

• Search
  • anime
  • manga
  • game
  • music
    • YouTube, Spotify and Apple Music results combined
  • characters
  • people
  • studios
• GIFs
  • Anime
  • Neko (Cat)
  • Inu (Dog)
  • Kitsu (Fox)
• Play anime music:
  • Queue
  • List queue
  • Play/pause/clear
  • Shuffle
  • Loop
  • Volume up/down
• Create stream links
• Create anime polls
• Clear URLs from tracking parameters ¹

Screenshots

Anime GIFs	Music Search	VC Queue	Character Search

Character Details	Anime Search	Anime Details

Getting Started

You can invite Kurozora Bot to your server from the App Directory. However, if you wish to run a local instance on your server, you can do so as well.

Prerequisite

1. NodeJS 20.x
2. Python 3.x
3. PM2 (optional)

Installation

Installing KuroBot is straightforward:

1. Clone the repository

   $ git clone https://github.com/Kurozora/kurozora-discord-bot.git

2. Navigate to the project directory

   $ cd kurozora-discord-bot

3. Install NPM and Python dependencies

   $ ./install

This last step in particular will install the dependencies necessary for KuroBot to work. It will also create a .env file where you need to specify secrets necessary for certain features to work.

Setup

Although the app can run now, some functionality will not work without some setup.

Discord Bot Account

For KuroBot to connect to your server, you will need to register it with Discord. Creating a bot account is done through the Discord Developers dashboard.

1. Log in on to the developer dashboard
2. Navigate to the application page
3. Click on the New Application button
4. Give the application a name and click Create

App Token

1. Navigate to the Bot tab to configure it
2. Copy the token using the Copy button
3. Open the .env file
4. Paste the copied token as the TOKEN key's value

App ID

1. Navigate to the General Information tab
2. Copy the application ID using the Copy button
3. Open the .env file
4. Paste the copied ID as the APP_ID key's value

Guild ID

1. Navigate to the Discord website or app
2. Right-click on your server
3. Select Copy Server ID
4. Open the .env file
5. Paste the copied ID as the GUILD_ID key's value

Apple Music

When using the /music search command, Kurozora uses the Apple Music API to find songs on Apple Music. To get the necessary secrets for this feature to work, you need to be registered as an Apple Developer.

After that, you need to generate a developer token. You can follow the steps on the Apple Music documentation page to do so. Alternatively you can use tools such as apple-music-token-generator to make life easier.

Once the developer token is generated:

1. Open the .env file
2. Paste the copied token as the AM_DEVELOPER_TOKEN key's value
3. Add your team ID as the AM_TEAM_ID key's value
4. Add your key ID as the AM_KEY_ID key's value

Spotify

Similar to Apple Music, the Spotify API is used for finding songs on Spotify. To get this to work, you need to be registered as a Spotify Developer.

After that you need to create an app to get the required ID and secret. You can follow the steps on the Spotify documentation page.

Once the credentials are generated:

1. Open the .env file
2. Paste the copied client ID as the SPOTIFY_CLIENT_ID key's value
3. Paste the copied client secret as the SPOTIFY_CLIENT_SECRET key's value

Run

Use the following command to run KuroBot:

$ node index.js

While this is fine for testing purposes, quitting the process or closing the terminal will also terminate KuroBot. To keep KuroBot always running, you can use PM2 or other process managers.

1. Install PM2 as a global dependency

   $ npm install pm2 -g

2. Run KuroBot using PM2

   $ pm2 start index.js --update-env --name kuro-bot

3. Generate a startup script and follow the instructions in the terminal

   $ pm2 startup

4. Save the app list

   $ pm2 save

With this, PM2 should start KuroBot automatically on system (re)boot. PM2 will also restart the KuroBot process in case of crashes and other failures. You can learn more on the PM2 documentation page.

Contributing

Read our Contributing Guide to learn about reporting issues, contributing code, and more ways to contribute.

Security

Read our Security Policy to learn about reporting security issues.

Getting in Touch

If you have any questions or just want to say hi, join the Kurozora Discord and drop a message on the #development channel.

Code of Conduct

This project has a Code of Conduct. By interacting with this repository, or community you agree to abide by its terms.

More by Kurozora

• Kurozora Android App — Android client app
• Kurozora iOS App — iOS/iPadOS/MacOS client app
• KurozoraKit — Simple to use framework for interacting with the Kurozora API
• Kurozora Linux App — Linux client app
• Kurozora Web — Home to the Kurozora website and API
• Kurozora Web Extension — Anime, Manga and Game search engine for FireFox and Chrome

License

KuroBot is an Open Source project covered by the GNU General Public License v3.0.

Footnotes

1. works only on the Kurozora server. Support can be extended if there's interest. ↩