A Cappella

A music bot for Discord!
Explore the docs » (Someday)

View Demo (Someday) · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

A music bot for Discord!

Built With

• Discord.js
• ytdl-core
• ytsr

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• node
• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/acpoppe/A-Cappella.git

2. Navigate to the app directory

   cd /PATH_TO_DIRECTORY/acappella

3. Install NPM packages

   npm install

4. Rename configTemplate.json to config.json

   mv configTemplate.json config.json

5. Put your own bot information from the Discord developer's portal in config.json where there are placeholders Find more information here
6. Run the app

   node acappella.js

Usage

For more examples, please refer to the Documentation (Documentation to come in the future)

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

Contact

Allison Poppe - @alliepoppe - [email protected]

Project Link: https://github.com/acpoppe/A-Cappella

Acknowledgements

• Yvonne Rieck