/**
* @name DeezerRP
* @description Adds Deezer integration (just like Spotify) (Due to Deezer's API restrictions, it only shows your last played song, not your current one. :/)
* @author Stealth (imnotstealth)
* @version 1.0.0
* @source https://github.com/ImNotStealth/DeezerRP/blob/master/DeezerRP.plugin.js
*/
// My License
/*
MIT License
Copyright (c) 2024 Stealth
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
/*
Below are the licenses that I found from https://github.com/eritbh/LastFMRichPresence/blob/main/LastFMRichPresence.plugin.js
My plugin is heavily inspired (code-wise) by dimden's plugin. (I only changed it to work with Deezer and improved the settings panel)
This is also my first plugin so if I did anything wrong or there's something that can be improved, make a pull request and I'll happily take a look!
*/
/*
MIT License
Copyright (c) 2022 dimden
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
// Lot of code is taken from AutoStartRichPresence plugin, thank you friend
/*
MIT License
Copyright (c) 2018-2022 Mega-Mewthree
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
/*
* Copyright (c) 2022 Sofia Lima
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
const ClientID = "1208754831657934888";
const defaultSettings = {
disableWhenSpotify: true,
disableWhenActivity: true,
listeningTo: true,
artistActivityName: false,
listenAlongButton: true,
showAlbumCover: true,
userID: "",
accessToken: "",
appID: "",
redirectURI: "",
loginCode: "",
appSecret: ""
}
let currentTrack = {
title: "Unknown",
link: "https:\/\/www.deezer.com\/",
artist: "Unknown",
cover: "deezer_logo"
}
class DeezerRP {
constructor(meta) {
this.pluginStarted = false;
this.rpc = {};
this.rpc = BdApi.findModuleByProps("dispatch", "_subscriptions");
this.getLocalPresence = BdApi.findModuleByProps("getLocalPresence").getLocalPresence;
this.taskID = -1;
this.request = require("request");
let filter = BdApi.Webpack.Filters.byStrings("getAssetImage: size must === [number, number] for Twitch");
let assetManager = BdApi.Webpack.getModule(m => typeof m === "object" && Object.values(m).some(filter));
let getAsset;
for (const key in assetManager) {
const member = assetManager[key];
if (member.toString().includes("APPLICATION_ASSETS_FETCH")) {
getAsset = member;
break;
}
}
this.getAsset = async key => {
return (await getAsset(ClientID, [key, undefined]))[0];
};
}
start() {
this.settings = BdApi.loadData("DeezerRP", "settings") || {};
for (const setting of Object.keys(defaultSettings)) {
if (typeof this.settings[setting] === "undefined") {
this.settings[setting] = defaultSettings[setting];
}
this.saveSettings();
}
this.startPlaying = Date.now();
this.updateRichPresence();
this.taskID = setInterval(() => this.updateRichPresence(), 1000 * 30);
this.pluginStarted = true;
}
stop() {
clearInterval(this.taskID);
this.taskID = -1;
this.startPlaying = 0;
currentTrack = {};
this.setActivity({});
this.pluginStarted = false;
}
setActivity(activity) {
this.rpc.dispatch({
type: "LOCAL_ACTIVITY_UPDATE",
activity: activity
});
}
async updateRichPresence() {
if (!this.settings.userID || !this.settings.accessToken || !this.settings.appID || !this.settings.redirectURI || !this.settings.loginCode || !this.settings.appSecret)
{
this.showAlertBanner("Please set up DeezerRP in your Plugin Settings.");
return;
}
if (this.settings.disableWhenSpotify === true) {
const activities = this.getLocalPresence().activities;
if (activities.find(a => a.name === "Spotify")) {
if (activities.find(a => a.application_id === ClientID)) {
this.setActivity({});
}
return;
}
}
if (this.settings.disableWhenActivity === true) {
const activities = this.getLocalPresence().activities;
if (activities.filter(a => a.application_id !== ClientID).length) {
if (activities.find(a => a.application_id === ClientID)) {
this.setActivity({});
}
return;
}
}
currentTrack = await this.updateCurrentTrack();
let button_urls = [currentTrack.link], buttons = ["Listen along"];
let obj = {
application_id: ClientID,
name: this.settings.artistActivityName ? currentTrack.artist : "Deezer",
details: currentTrack.title,
state: "by " + currentTrack.artist,
timestamps: { start: this.startPlaying },
assets: {
large_image: this.settings.showAlbumCover ? await this.getAsset(currentTrack.cover) : await this.getAsset("deezer_logo")
},
type: this.settings.listeningTo ? 2 : 0
}
if (this.settings.listenAlongButton === true) {
obj.metadata = { button_urls };
obj.buttons = buttons;
obj.flags = 1;
}
if (this.settings.showAlbumCover === true) {
obj.assets.small_image = await this.getAsset("deezer_logo");
}
this.setActivity(obj);
}
updateCurrentTrack() {
return new Promise((resolve, reject) => {
this.request(`https://api.deezer.com/user/${this.settings.userID}/history?access_token=${this.settings.accessToken}&index=0&limit=1`, async (err, response, body) => {
if(err) {
console.log(err);
return reject("Deezer has returned an error.");
}
let json;
try {
json = JSON.parse(body);
} catch (e) {
return reject(e);
}
if (json.error) {
const errMsg = "DeezerRP has encountered an error: " + json.error.message;
this.showAlertBanner(errMsg);
return reject(errMsg);
}
let newTrack = {
title: json.data[0].title,
link: json.data[0].link,
artist: json.data[0].artist.name,
cover: json.data[0].album.cover_big
}
resolve(newTrack);
});
});
}
showAlertBanner(msg) {
const buttons = [
{
label: "Disable Plugin",
onClick: () => {BdApi.Plugins.disable("DeezerRP")}
}
];
BdApi.showNotice(msg, {type: "error", buttons, timeout: 5000});
}
saveSettings() {
BdApi.saveData("DeezerRP", "settings", this.settings);
}
getSettingsPanel() {
if (!this.pluginStarted) return;
let template = document.createElement("template");
template.innerHTML =
`
Configuration
If you want a visual guide, you can follow the tutorial on GitHub.
Deezer App ID Input your Deezer App ID. You can create an application here.
Redirect URI This should match exactly what you used in your Application settings.
App Secret Input your Deezer App Secret (Found in your Application settings)
Click here to login. Once logged in, copy everything after "?code=" from the URL into the text box below.
Login Code Input your Login Code
Click here to get your access token. Next, copy everything between "access_token=" and "&expires" from the result into the text box below.
Access Token Finally, input your Access Token (This is only used for seeing your track history and can't be used to retrieve your account or any personal info)
Deezer User ID Input your User ID (can be found on the Deezer Home Page by clicking on your Profile and checking the URL)