A Discord bot that streams audio to voice channels and features many other useful commands and utilities.
A lightweight aggregator, currently deployed and hosted on Heroku. Even when hosted locally, Rosé is low-impact on system resources and still features quick response times.
For any questions, concerns, or assistance in getting this bot into your server - contact:
(e-mail) johnnie.tan27@gmail.com
(Discord) j o n#4444
-
Play music
-
Skip songs
-
Pause and Resume playback
-
Seeking and Looping
-
Dynamic playlists
-
YouTube queryable searches
-
Lyrics by Genius-API
-
Search up song, album, artist information using Spotify-API
-
Scrobble audio, get listening trends, and history using LastFM-API
-
(NEW!) Search up public instagram accounts and hash tags
write-access methods for logged in Instagram accounts
-
Weekly/Daily server reminders
- Spotify-API
- LastFM-API
- Genius-API
- [Google-translate-web-API]
- Instagram-API
- Cron
First, make sure you have all the required modules and dependencies then continue with the following steps!
# Clone the respository
git clone https://github.com/jcheonsa/rose-music-bot
# Enter into the directory
cd rose-music-bot/
# Install the dependencies
See the requirements above!- open 'config.json' in Rosé's root directory
- configure your desired command prefix, place all of your API keys and Rosé/guild/channel IDs in the corresponding areas
After cloning the project and installing all of the dependencies, you're going to need to add your Discord API token in the config.json file as well.
https://discord.com/developers/applications to create your own Rosé clone and get your token!
NOTE: Most, if not all of the information being read from the different APIs are presented to users using Discord's embed UI. In other words, they're kind of limited by their API. Reaction buttons and typing are used to directly interact with Rosé and the interfaces.
At the moment version 4 of Rosé handles lastFM, Spotify, YouTube, Google Translate, Genius, and Instagram APIs (the list will continue to grow!) for basic information visualization and querying.
This example show how to authenticate with the Spotify API. Authentication is only required to make signed method calls or use write methods.
// ** BEGIN EDIT HERE **************************************************
var API_KEY = ''; // YOUR API KEY HERE
var API_SECRET = ''; // YOUR API SECRET HERE
var DEMO_PORT = 1337;
var DEMO_URL = 'http://localhost:' + DEMO_PORT;
// ** END EDIT HERE ****************************************************
if ( !API_KEY || !API_SECRET ) {
console.log('Please edit `API_KEY` and `API_SECRET` before running this example.');
process.exit(1);
}
const spotifyAPI = new SpotifyWebAPI({
clientID: API_KEY,
clientSecret: API_SECRET,
REDIRECT_URL: DEMO_URL + DEMO_PORT + `/callback`
})
// define the methods (documentation available at https://developer.spotify.com/documentation/web-api/)
const scopes = [];
// attempt to connect to Spotify with the previously defined signed access methods
app.get('/login', (req, res) => {
res.redirect(spotifyApi.createAuthorizeURL(scopes));
});
app.get('/callback', (req, res) => {
const error = req.query.error;
const code = req.query.code;
const state = req.query.state;
if (error) {
console.error('Callback Error:', error);
res.send(`Callback Error: ${error}`);
return;
}
// generate authorization token for all queries to/from Rosé
spotifyApi
.authorizationCodeGrant(code)
.then(data => {
const access_token = data.body['access_token'];
const refresh_token = data.body['refresh_token'];
const expires_in = data.body['expires_in'];
spotifyApi.setAccessToken(access_token);
spotifyApi.setRefreshToken(refresh_token);
// make access_token callable for all methods
module.exports = access_token;
// refresh the token at a set interval
setInterval(async () => {
const data = await spotifyApi.refreshAccessToken();
const access_token = data.body['access_token'];
spotifyApi.setAccessToken(access_token);
}, expires_in / 2 * 1000);
})
});This authentication example is interchangeable for all lastFM, Spotify, and Instagram APIs. After authentication, the token will remain valid for 1 hour, after which it would need to be refreshed. Currently Rosé does not have a method for automatically refreshing this token. (WIP)
All Spotify API methods require authentication. Rosé is currently written with an automatically refreshing access token and cookie script when running her read-access methods (writing is a wip).
// Look up artists, albums, songs on Spotify
`${prefix}sysearch`The lastFM API key allows read-access to basic information available on the lastFM site. You'll need to bind the bot to an account for writing and scrobbling.
// Bind a lastFM account to user for read-access to lastFM account information
`${prefix}lfmreg`
// After binding the bot to a lastFM account, users can begin querying for playback history and trends.
`${prefix}lfmhistory` Song name, duration, and artists are auto-corrected when scrobbling!
Rosé currently uses Instagram's Basic Display API, where most read-access methods do not require authentication.
// If you want to write, then you can either login to an account:
const Instagram = require('instagram-web-api')
var insta_user = ``;
var insta_pw = ``;
// or use the above access token scriptPlease note that I highly discourage using the bot in this way, as this gives all users on the server (yes, ALL of them) read/write access on the logged account. You can edit the permissions in Rosé's command-handler to get around this.
- adding instructional gifs
- fix seeking
- reconstruct main playbick, searching, and queueing scripts for improved accessibility
- write-access to spotify
- write-access to instagram
- write-access to lastFM
- fix translation api
- modular dependencies
- Kaiba-bot
Johnnie Tan