README.md

NOTE: This project is no longer officially maintained. For a community-maintained fork, see: https://github.com/TwixGamer00/azuri

Azuri: A Discord bot for AzuraCast

Azuri is a simple but powerful Discord bot to integrate the open-source web radio management suite AzuraCast into your Discord community.

Azuri is currently in active development with new features and bugs fixed on the daily and is not a final product by any means. Azuri was created to support new radios that use AzuraCast, and provide a platform to connect the radio and community.

Installing Self-Hosted Version

Azuri is open-source, so you can host your own! Perfect if you want to customize something yourself.

Via Docker (Recommended)

Requirements:

• Docker
• Docker Compose (included with Docker Desktop for Windows or Mac)
• Discord bot token
  • Read a how-to guide

Installation and Usage

1. Copy azuri.sample.env to azuri.env
2. Edit azuri.env with your Discord BOT_TOKEN
3. Run docker-compose up -d

Direct Installation

Requirements:

• NodeJS: >= 12.18.4
• NPM: >= 6.14.6

Installation

To install and run:

1. Copy azuri.sample.env to src/.env
2. Change into the src directory
3. Edit .env with your Discord BOT_TOKEN
4. Run npm ci
5. Run npm run azuri

Dependencies Used

We use multiple packages to make sure Azuri is easy to use and navigate for the end-user.

• Discord.JS with Opus offical NodeJS library
• Axios used for API calls
• dotenv used for .env files and enviroment variables
• ffmpeg used for audio streaming
• fs used for storing data in files

Developer Resources

• nodemon hot reloading for development
• eslint used for code functionaility and error checking

Bug Reporting

Found a bug? Report it!

* before reporting please check for existing issues

Feature Request

Thought of a great idea? Request it!

* before requesting please check for existing issues

Support

Azuri is provided free of charge — but if you find it useful, support us and AzuraCast!

Azuri

AzuraCast

Support AzuraCast here!

License

Azuri is licensed under the Apache License, version 2.0. This project is free and open-source software; pull requests are always welcome along with bug and feature reports/requests.