Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/remix-bot/revolt

An advanced music bot for Revolt that supports YouTube, Spotify, and SoundCloud - All the power just a click away! ;)
https://github.com/remix-bot/revolt

Last synced: 3 months ago
JSON representation

An advanced music bot for Revolt that supports YouTube, Spotify, and SoundCloud - All the power just a click away! ;)

Host: GitHub
URL: https://github.com/remix-bot/revolt
Owner: remix-bot
License: mit
Created: 2021-02-06T12:28:51.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-02-25T14:55:58.000Z (8 months ago)
Last Synced: 2024-06-22T04:37:41.010Z (4 months ago)
Language: JavaScript
Homepage: https://remix.fairuse.org
Size: 3.77 MB
Stars: 28
Watchers: 3
Forks: 7
Open Issues: 29
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

awesome-revolt - Remix - An advanced music bot that supports YouTube, Spotify, and Soundcloud - All the power just a click away ;). (🤖 Bots / Cobol)

README

        


    

      

    

    
Remix

    

    The best high quality Revolt music bot.

    


    Invite to your server

      ·

    Report bug

      ·

     Request Feature

  


## About The Project

Remix is a free and open source music bot for Revolt built on [revoice.js](https://github.com/ShadowLp174/revoice.js). All commands on Remix are free and will always be free to use.

[![Wakatime stats](https://wakatime.com/badge/user/810f765c-4ad8-49cc-8be6-0f07dff3733f/project/e79f62e3-4d15-41fc-b239-53d5a30302c7.svg?style=flat)](https://wakatime.com/badge/user/810f765c-4ad8-49cc-8be6-0f07dff3733f/project/e79f62e3-4d15-41fc-b239-53d5a30302c7)

## Commands  

Below is a table of all of Remix's commands.

|Name|Description|Format|Alias|

|---|---|---|---|

|clear|Remove all songs from the queue.|%clear|clear, c|

|join|Make the bot join a specific voice channel.|%join 'Channel ID: channel'|join|

|leave|Make the bot leave your current voice channel|%leave|leave, l|

|list|List the queue in your current voice channel.|%list|list, queue|

|loop|Toggle the looping of your queue/song.|%loop |loop|

|np|Request the name and url of the currently playing song.|%np|np, current, nowplaying|

|pause|Pause the playback in your voice channel|%pause|pause|

|play|Play a youtube video from url/query or a playlist by url.|%play 'query: text'|play, p|

|player|Create an emoji player control for your voice channel|%player|player|

|playnext|Play a youtube video from url/query or a playlist by url. The result will be added to the top of the queue.|%playnext 'query: text'|playnext, pn|

|remove|Remove a specific song from the queue.|%remove 'index: number'|remove|

|resume|Resume the playback in your voice channel|%resume|resume|

|search|Display the search results for a given query|%search 'query: text'|search|

|settings|Change/Get settings in the current server.|%settings |settings, s|

|shuffle|Re-orders the queue randomly.|%shuffle|shuffle|

|skip|Skip the current playing song.|%skip|skip|

|stats|Display stats about the bot like the uptime.|%stats|stats, info|

|test|A test command used for various purposes.|%test 'number: number'|test|

|thumbnail|Request the thumbnail of the currently playing song.|%thumbnail|thumbnail, thumb|

|volume|Change the current volume.|%volume 'volume: number'|volume, v|

## Getting Started

Firstly, you have to [invite Remix](https://app.revolt.chat/bot/01FVB28WQ9JHMWK8K7RD0F0VCW). Then use the `%help` command to get a list of commands that you can use through the bot.

## Hosting The Bot

If you're self-hosting Remix, please make it clear that it is **not the main instance** (or **change the name**) but give credit by **linking to this repo** (for example, in the bot's profile - something like `This bot  [Remix](https://github.com/remix-bot/revolt)` will suffice).

-   Clone this repo (`git clone https://github.com/remix-bot/revolt.git)`)

-   Install the dependencies (`npm install`)

-   Set up a `config.json` file

    - Rename the `config.example.json` file and fill out the missing values. You can generate spotify credentials [here](https://developer.spotify.com/)

-   Run the bot (`node index.js`)

## Connecting To A Self-Hosted Instance

If you don't want to connect to the official Revolt instance, you need to fill out the `revolt.js` and `revolt-api` configuration values in your config file.

Please refer to the [revolt.js docs](https://revolt.js.org/classes/Client.html#constructor) for `revolt.js` and to [oapi's docs](https://github.com/insertish/oapi#example) for `revolt-api`.

## Contact

If you have any questions or would like to talk with other Remix users you can join our Revolt server here.

---

© 2023 Remix. All Rights Reserved.