Giter Club home page Giter Club logo

azuri's Introduction

Azuri Logo

Azuri: A Discord bot for AzuraCast

Invite Image Apache 2.0 License Ethical Open Source DeepScan grade

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.

Discord Invite Link

Invite Image

If you have any problems just make an issue

Commands & Usage

Use ~help to view available commands adding the bot to your server.

To setup the api you need this:

https://yourazuradomain.com/api/nowplaying_static/STATIONNAME.json

Hosted or Self-Hosted?

Azuri has both! We have it hosted, allowing anyone to invite the bot using this invite into their server and experience Azuri to its full potential. Want to go the extra mile and make it self-host it for the custom experience? Follow the steps below.

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:

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:

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!

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.

azuri's People

Contributors

twixgamer00 avatar ninjalabs-dev avatar finnie2006 avatar busterneece avatar ckhawks avatar jrp596 avatar

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.