mirror of
https://github.com/th-ch/youtube-music.git
synced 2026-01-11 18:41:47 +00:00
Compare commits
26 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| e07cac2406 | |||
| fd97576611 | |||
| 6ab01056e0 | |||
| 4dcbd2e7f0 | |||
| b94d0d4e8b | |||
| 7b20b9339d | |||
| 4d4a1f038b | |||
| e5ec79e345 | |||
| f4fe5c2a58 | |||
| a5130c1d3f | |||
| 8ab2da0482 | |||
| 1b54b19f3f | |||
| be7e6e431f | |||
| 6e42b097f8 | |||
| ef9cd8cd24 | |||
| 8f3e165917 | |||
| 33a11efe9a | |||
| 9a97436cd8 | |||
| f7935c0024 | |||
| 2b33d4e857 | |||
| ed16c35a57 | |||
| ae5b85d8d7 | |||
| 47b4414eb3 | |||
| e329bb2201 | |||
| 155ef9e5f5 | |||
| 4bac3ace18 |
38
config/defaults.js
Normal file
38
config/defaults.js
Normal file
@ -0,0 +1,38 @@
|
|||||||
|
const defaultConfig = {
|
||||||
|
"window-size": {
|
||||||
|
width: 1100,
|
||||||
|
height: 550,
|
||||||
|
},
|
||||||
|
url: "https://music.youtube.com",
|
||||||
|
options: {
|
||||||
|
tray: false,
|
||||||
|
appVisible: true,
|
||||||
|
autoUpdates: true,
|
||||||
|
hideMenu: false,
|
||||||
|
startAtLogin: false,
|
||||||
|
disableHardwareAcceleration: false,
|
||||||
|
restartOnConfigChanges: false,
|
||||||
|
},
|
||||||
|
plugins: {
|
||||||
|
// Enabled plugins
|
||||||
|
navigation: {
|
||||||
|
enabled: true,
|
||||||
|
},
|
||||||
|
shortcuts: {
|
||||||
|
enabled: true,
|
||||||
|
},
|
||||||
|
adblocker: {
|
||||||
|
enabled: true,
|
||||||
|
cache: true,
|
||||||
|
additionalBlockLists: [], // Additional list of filters, e.g "https://raw.githubusercontent.com/uBlockOrigin/uAssets/master/filters/filters.txt"
|
||||||
|
},
|
||||||
|
// Disabled plugins
|
||||||
|
downloader: {
|
||||||
|
enabled: false,
|
||||||
|
ffmpegArgs: [], // e.g. ["-b:a", "192k"] for an audio bitrate of 192kb/s
|
||||||
|
downloadFolder: undefined, // Custom download folder (absolute path)
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
module.exports = defaultConfig;
|
||||||
21
config/index.js
Normal file
21
config/index.js
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
const plugins = require("./plugins");
|
||||||
|
const store = require("./store");
|
||||||
|
|
||||||
|
const set = (key, value) => {
|
||||||
|
store.set(key, value);
|
||||||
|
};
|
||||||
|
|
||||||
|
const get = (key) => {
|
||||||
|
return store.get(key);
|
||||||
|
};
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
get,
|
||||||
|
set,
|
||||||
|
edit: () => store.openInEditor(),
|
||||||
|
watch: (cb) => {
|
||||||
|
store.onDidChange("options", cb);
|
||||||
|
store.onDidChange("plugins", cb);
|
||||||
|
},
|
||||||
|
plugins,
|
||||||
|
};
|
||||||
41
config/plugins.js
Normal file
41
config/plugins.js
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
const store = require("./store");
|
||||||
|
|
||||||
|
function getEnabled() {
|
||||||
|
const plugins = store.get("plugins");
|
||||||
|
const enabledPlugins = Object.entries(plugins).filter(([plugin, options]) =>
|
||||||
|
isEnabled(plugin)
|
||||||
|
);
|
||||||
|
return enabledPlugins;
|
||||||
|
}
|
||||||
|
|
||||||
|
function isEnabled(plugin) {
|
||||||
|
const pluginConfig = store.get("plugins")[plugin];
|
||||||
|
return pluginConfig !== undefined && pluginConfig.enabled;
|
||||||
|
}
|
||||||
|
|
||||||
|
function setOptions(plugin, options) {
|
||||||
|
const plugins = store.get("plugins");
|
||||||
|
store.set("plugins", {
|
||||||
|
...plugins,
|
||||||
|
[plugin]: {
|
||||||
|
...plugins[plugin],
|
||||||
|
...options,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function enable(plugin) {
|
||||||
|
setOptions(plugin, { enabled: true });
|
||||||
|
}
|
||||||
|
|
||||||
|
function disable(plugin) {
|
||||||
|
setOptions(plugin, { enabled: false });
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
isEnabled,
|
||||||
|
getEnabled,
|
||||||
|
enable,
|
||||||
|
disable,
|
||||||
|
setOptions,
|
||||||
|
};
|
||||||
40
config/store.js
Normal file
40
config/store.js
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
const Store = require("electron-store");
|
||||||
|
|
||||||
|
const defaults = require("./defaults");
|
||||||
|
|
||||||
|
const migrations = {
|
||||||
|
">=1.7.0": (store) => {
|
||||||
|
const enabledPlugins = store.get("plugins");
|
||||||
|
if (!Array.isArray(enabledPlugins)) {
|
||||||
|
console.warn("Plugins are not in array format, cannot migrate");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Include custom options
|
||||||
|
const plugins = {
|
||||||
|
adblocker: {
|
||||||
|
enabled: true,
|
||||||
|
cache: true,
|
||||||
|
additionalBlockLists: [],
|
||||||
|
},
|
||||||
|
downloader: {
|
||||||
|
enabled: false,
|
||||||
|
ffmpegArgs: [], // e.g. ["-b:a", "192k"] for an audio bitrate of 192kb/s
|
||||||
|
downloadFolder: undefined, // Custom download folder (absolute path)
|
||||||
|
},
|
||||||
|
};
|
||||||
|
enabledPlugins.forEach((enabledPlugin) => {
|
||||||
|
plugins[enabledPlugin] = {
|
||||||
|
...plugins[enabledPlugin],
|
||||||
|
enabled: true,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
store.set("plugins", plugins);
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
module.exports = new Store({
|
||||||
|
defaults,
|
||||||
|
clearInvalidConfig: false,
|
||||||
|
migrations,
|
||||||
|
});
|
||||||
75
index.js
75
index.js
@ -5,15 +5,8 @@ const electron = require("electron");
|
|||||||
const is = require("electron-is");
|
const is = require("electron-is");
|
||||||
const { autoUpdater } = require("electron-updater");
|
const { autoUpdater } = require("electron-updater");
|
||||||
|
|
||||||
|
const config = require("./config");
|
||||||
const { setApplicationMenu } = require("./menu");
|
const { setApplicationMenu } = require("./menu");
|
||||||
const {
|
|
||||||
autoUpdate,
|
|
||||||
getEnabledPlugins,
|
|
||||||
isAppVisible,
|
|
||||||
isTrayEnabled,
|
|
||||||
store,
|
|
||||||
startAtLogin,
|
|
||||||
} = require("./store");
|
|
||||||
const { fileExists, injectCSS } = require("./plugins/utils");
|
const { fileExists, injectCSS } = require("./plugins/utils");
|
||||||
const { isTesting } = require("./utils/testing");
|
const { isTesting } = require("./utils/testing");
|
||||||
const { setUpTray } = require("./tray");
|
const { setUpTray } = require("./tray");
|
||||||
@ -25,6 +18,12 @@ app.commandLine.appendSwitch(
|
|||||||
"--experimental-wasm-threads --experimental-wasm-bulk-memory"
|
"--experimental-wasm-threads --experimental-wasm-bulk-memory"
|
||||||
);
|
);
|
||||||
app.allowRendererProcessReuse = true; // https://github.com/electron/electron/issues/18397
|
app.allowRendererProcessReuse = true; // https://github.com/electron/electron/issues/18397
|
||||||
|
if (config.get("options.disableHardwareAcceleration")) {
|
||||||
|
if (is.dev()) {
|
||||||
|
console.log("Disabling hardware acceleration");
|
||||||
|
}
|
||||||
|
app.disableHardwareAcceleration();
|
||||||
|
}
|
||||||
|
|
||||||
// Adds debug features like hotkeys for triggering dev tools and reload
|
// Adds debug features like hotkeys for triggering dev tools and reload
|
||||||
require("electron-debug")();
|
require("electron-debug")();
|
||||||
@ -55,19 +54,19 @@ function loadPlugins(win) {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
getEnabledPlugins().forEach((plugin) => {
|
config.plugins.getEnabled().forEach(([plugin, options]) => {
|
||||||
console.log("Loaded plugin - " + plugin);
|
console.log("Loaded plugin - " + plugin);
|
||||||
const pluginPath = path.join(__dirname, "plugins", plugin, "back.js");
|
const pluginPath = path.join(__dirname, "plugins", plugin, "back.js");
|
||||||
fileExists(pluginPath, () => {
|
fileExists(pluginPath, () => {
|
||||||
const handle = require(pluginPath);
|
const handle = require(pluginPath);
|
||||||
handle(win);
|
handle(win, options);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
function createMainWindow() {
|
function createMainWindow() {
|
||||||
const windowSize = store.get("window-size");
|
const windowSize = config.get("window-size");
|
||||||
const windowMaximized = store.get("window-maximized");
|
const windowMaximized = config.get("window-maximized");
|
||||||
|
|
||||||
const win = new electron.BrowserWindow({
|
const win = new electron.BrowserWindow({
|
||||||
icon: icon,
|
icon: icon,
|
||||||
@ -85,30 +84,34 @@ function createMainWindow() {
|
|||||||
},
|
},
|
||||||
frame: !is.macOS(),
|
frame: !is.macOS(),
|
||||||
titleBarStyle: is.macOS() ? "hiddenInset" : "default",
|
titleBarStyle: is.macOS() ? "hiddenInset" : "default",
|
||||||
|
autoHideMenuBar: config.get("options.hideMenu"),
|
||||||
});
|
});
|
||||||
if (windowMaximized) {
|
if (windowMaximized) {
|
||||||
win.maximize();
|
win.maximize();
|
||||||
}
|
}
|
||||||
|
|
||||||
win.webContents.loadURL(store.get("url"));
|
win.webContents.loadURL(config.get("url"));
|
||||||
win.on("closed", onClosed);
|
win.on("closed", onClosed);
|
||||||
|
|
||||||
win.on("move", () => {
|
win.on("move", () => {
|
||||||
let position = win.getPosition();
|
let position = win.getPosition();
|
||||||
store.set("window-position", { x: position[0], y: position[1] });
|
config.set("window-position", { x: position[0], y: position[1] });
|
||||||
});
|
});
|
||||||
|
|
||||||
win.on("resize", () => {
|
win.on("resize", () => {
|
||||||
const windowSize = win.getSize();
|
const windowSize = win.getSize();
|
||||||
|
|
||||||
store.set("window-maximized", win.isMaximized());
|
config.set("window-maximized", win.isMaximized());
|
||||||
if (!win.isMaximized()) {
|
if (!win.isMaximized()) {
|
||||||
store.set("window-size", { width: windowSize[0], height: windowSize[1] });
|
config.set("window-size", {
|
||||||
|
width: windowSize[0],
|
||||||
|
height: windowSize[1],
|
||||||
|
});
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
win.once("ready-to-show", () => {
|
win.once("ready-to-show", () => {
|
||||||
if (isAppVisible()) {
|
if (config.get("options.appVisible")) {
|
||||||
win.show();
|
win.show();
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@ -133,7 +136,7 @@ app.on("browser-window-created", (event, win) => {
|
|||||||
win.webContents.on("did-navigate-in-page", () => {
|
win.webContents.on("did-navigate-in-page", () => {
|
||||||
const url = win.webContents.getURL();
|
const url = win.webContents.getURL();
|
||||||
if (url.startsWith("https://music.youtube.com")) {
|
if (url.startsWith("https://music.youtube.com")) {
|
||||||
store.set("url", url);
|
config.set("url", url);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -186,31 +189,51 @@ app.on("activate", () => {
|
|||||||
app.on("ready", () => {
|
app.on("ready", () => {
|
||||||
mainWindow = createMainWindow();
|
mainWindow = createMainWindow();
|
||||||
setApplicationMenu(mainWindow);
|
setApplicationMenu(mainWindow);
|
||||||
|
if (config.get("options.restartOnConfigChanges")) {
|
||||||
|
config.watch(() => {
|
||||||
|
app.relaunch();
|
||||||
|
app.exit();
|
||||||
|
});
|
||||||
|
}
|
||||||
setUpTray(app, mainWindow);
|
setUpTray(app, mainWindow);
|
||||||
|
|
||||||
// Autostart at login
|
// Autostart at login
|
||||||
app.setLoginItemSettings({
|
app.setLoginItemSettings({
|
||||||
openAtLogin: startAtLogin(),
|
openAtLogin: config.get("options.startAtLogin"),
|
||||||
});
|
});
|
||||||
|
|
||||||
if (!is.dev() && autoUpdate()) {
|
if (!is.dev() && config.get("options.autoUpdates")) {
|
||||||
autoUpdater.checkForUpdatesAndNotify();
|
autoUpdater.checkForUpdatesAndNotify();
|
||||||
autoUpdater.on("update-available", () => {
|
autoUpdater.on("update-available", () => {
|
||||||
|
const downloadLink =
|
||||||
|
"https://github.com/th-ch/youtube-music/releases/latest";
|
||||||
const dialogOpts = {
|
const dialogOpts = {
|
||||||
type: "info",
|
type: "info",
|
||||||
buttons: ["OK"],
|
buttons: ["OK", "Download", "Disable updates"],
|
||||||
title: "Application Update",
|
title: "Application Update",
|
||||||
message: "A new version is available",
|
message: "A new version is available",
|
||||||
detail:
|
detail: `A new version is available and can be downloaded at ${downloadLink}`,
|
||||||
"A new version is available and can be downloaded at https://github.com/th-ch/youtube-music/releases/latest",
|
|
||||||
};
|
};
|
||||||
electron.dialog.showMessageBox(dialogOpts);
|
electron.dialog.showMessageBox(dialogOpts).then((dialogOutput) => {
|
||||||
|
switch (dialogOutput.response) {
|
||||||
|
// Download
|
||||||
|
case 1:
|
||||||
|
electron.shell.openExternal(downloadLink);
|
||||||
|
break;
|
||||||
|
// Disable updates
|
||||||
|
case 2:
|
||||||
|
config.set("options.autoUpdates", false);
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
});
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
// Optimized for Mac OS X
|
// Optimized for Mac OS X
|
||||||
if (is.macOS()) {
|
if (is.macOS()) {
|
||||||
if (!isAppVisible()) {
|
if (!config.get("options.appVisible")) {
|
||||||
app.dock.hide();
|
app.dock.hide();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -220,7 +243,7 @@ app.on("ready", () => {
|
|||||||
forceQuit = true;
|
forceQuit = true;
|
||||||
});
|
});
|
||||||
|
|
||||||
if (is.macOS() || isTrayEnabled()) {
|
if (is.macOS() || config.get("options.tray")) {
|
||||||
mainWindow.on("close", (event) => {
|
mainWindow.on("close", (event) => {
|
||||||
// Hide the window instead of quitting (quit is available in tray options)
|
// Hide the window instead of quitting (quit is available in tray options)
|
||||||
if (!forceQuit) {
|
if (!forceQuit) {
|
||||||
|
|||||||
112
menu.js
112
menu.js
@ -2,34 +2,34 @@ const { app, Menu } = require("electron");
|
|||||||
const is = require("electron-is");
|
const is = require("electron-is");
|
||||||
|
|
||||||
const { getAllPlugins } = require("./plugins/utils");
|
const { getAllPlugins } = require("./plugins/utils");
|
||||||
const {
|
const config = require("./config");
|
||||||
isPluginEnabled,
|
|
||||||
enablePlugin,
|
|
||||||
disablePlugin,
|
|
||||||
autoUpdate,
|
|
||||||
isAppVisible,
|
|
||||||
isTrayEnabled,
|
|
||||||
setOptions,
|
|
||||||
startAtLogin,
|
|
||||||
} = require("./store");
|
|
||||||
|
|
||||||
const mainMenuTemplate = (win) => [
|
const mainMenuTemplate = (win) => [
|
||||||
{
|
{
|
||||||
label: "Plugins",
|
label: "Plugins",
|
||||||
submenu: getAllPlugins().map((plugin) => {
|
submenu: [
|
||||||
return {
|
...getAllPlugins().map((plugin) => {
|
||||||
label: plugin,
|
return {
|
||||||
type: "checkbox",
|
label: plugin,
|
||||||
checked: isPluginEnabled(plugin),
|
type: "checkbox",
|
||||||
click: (item) => {
|
checked: config.plugins.isEnabled(plugin),
|
||||||
if (item.checked) {
|
click: (item) => {
|
||||||
enablePlugin(plugin);
|
if (item.checked) {
|
||||||
} else {
|
config.plugins.enable(plugin);
|
||||||
disablePlugin(plugin);
|
} else {
|
||||||
}
|
config.plugins.disable(plugin);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}),
|
||||||
|
{ type: "separator" },
|
||||||
|
{
|
||||||
|
label: "Advanced options",
|
||||||
|
click: () => {
|
||||||
|
config.edit();
|
||||||
},
|
},
|
||||||
};
|
},
|
||||||
}),
|
],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: "Options",
|
label: "Options",
|
||||||
@ -37,11 +37,39 @@ const mainMenuTemplate = (win) => [
|
|||||||
{
|
{
|
||||||
label: "Auto-update",
|
label: "Auto-update",
|
||||||
type: "checkbox",
|
type: "checkbox",
|
||||||
checked: autoUpdate(),
|
checked: config.get("options.autoUpdates"),
|
||||||
click: (item) => {
|
click: (item) => {
|
||||||
setOptions({ autoUpdates: item.checked });
|
config.set("options.autoUpdates", item.checked);
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
label: "Disable hardware acceleration",
|
||||||
|
type: "checkbox",
|
||||||
|
checked: config.get("options.disableHardwareAcceleration"),
|
||||||
|
click: (item) => {
|
||||||
|
config.set("options.disableHardwareAcceleration", item.checked);
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: "Restart on config changes",
|
||||||
|
type: "checkbox",
|
||||||
|
checked: config.get("options.restartOnConfigChanges"),
|
||||||
|
click: (item) => {
|
||||||
|
config.set("options.restartOnConfigChanges", item.checked);
|
||||||
|
},
|
||||||
|
},
|
||||||
|
...(is.windows() || is.linux()
|
||||||
|
? [
|
||||||
|
{
|
||||||
|
label: "Hide menu",
|
||||||
|
type: "checkbox",
|
||||||
|
checked: config.get("options.hideMenu"),
|
||||||
|
click: (item) => {
|
||||||
|
config.set("options.hideMenu", item.checked);
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]
|
||||||
|
: []),
|
||||||
...(is.windows() || is.macOS()
|
...(is.windows() || is.macOS()
|
||||||
? // Only works on Win/Mac
|
? // Only works on Win/Mac
|
||||||
// https://www.electronjs.org/docs/api/app#appsetloginitemsettingssettings-macos-windows
|
// https://www.electronjs.org/docs/api/app#appsetloginitemsettingssettings-macos-windows
|
||||||
@ -49,9 +77,9 @@ const mainMenuTemplate = (win) => [
|
|||||||
{
|
{
|
||||||
label: "Start at login",
|
label: "Start at login",
|
||||||
type: "checkbox",
|
type: "checkbox",
|
||||||
checked: startAtLogin(),
|
checked: config.get("options.startAtLogin"),
|
||||||
click: (item) => {
|
click: (item) => {
|
||||||
setOptions({ startAtLogin: item.checked });
|
config.set("options.startAtLogin", item.checked);
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
]
|
]
|
||||||
@ -62,23 +90,35 @@ const mainMenuTemplate = (win) => [
|
|||||||
{
|
{
|
||||||
label: "Disabled",
|
label: "Disabled",
|
||||||
type: "radio",
|
type: "radio",
|
||||||
checked: !isTrayEnabled(),
|
checked: !config.get("options.tray"),
|
||||||
click: () => setOptions({ tray: false, appVisible: true }),
|
click: () => {
|
||||||
|
config.set("options.tray", false);
|
||||||
|
config.set("options.appVisible", true);
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: "Enabled + app visible",
|
label: "Enabled + app visible",
|
||||||
type: "radio",
|
type: "radio",
|
||||||
checked: isTrayEnabled() && isAppVisible(),
|
checked:
|
||||||
click: () => setOptions({ tray: true, appVisible: true }),
|
config.get("options.tray") && config.get("options.appVisible"),
|
||||||
|
click: () => {
|
||||||
|
config.set("options.tray", true);
|
||||||
|
config.set("options.appVisible", true);
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: "Enabled + app hidden",
|
label: "Enabled + app hidden",
|
||||||
type: "radio",
|
type: "radio",
|
||||||
checked: isTrayEnabled() && !isAppVisible(),
|
checked:
|
||||||
click: () => setOptions({ tray: true, appVisible: false }),
|
config.get("options.tray") && !config.get("options.appVisible"),
|
||||||
|
click: () => {
|
||||||
|
config.set("options.tray", true);
|
||||||
|
config.set("options.appVisible", false);
|
||||||
|
},
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
{ type: "separator" },
|
||||||
{
|
{
|
||||||
label: "Toggle DevTools",
|
label: "Toggle DevTools",
|
||||||
// Cannot use "toggleDevTools" role in MacOS
|
// Cannot use "toggleDevTools" role in MacOS
|
||||||
@ -92,6 +132,12 @@ const mainMenuTemplate = (win) => [
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
label: "Advanced options",
|
||||||
|
click: () => {
|
||||||
|
config.edit();
|
||||||
|
},
|
||||||
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
];
|
];
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "youtube-music",
|
"name": "youtube-music",
|
||||||
"productName": "YouTube Music",
|
"productName": "YouTube Music",
|
||||||
"version": "1.6.3",
|
"version": "1.7.1",
|
||||||
"description": "YouTube Music Desktop App - including custom plugins",
|
"description": "YouTube Music Desktop App - including custom plugins",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"repository": "th-ch/youtube-music",
|
"repository": "th-ch/youtube-music",
|
||||||
@ -33,6 +33,7 @@
|
|||||||
"postinstall": "yarn run icon && yarn run plugins",
|
"postinstall": "yarn run icon && yarn run plugins",
|
||||||
"clean": "rimraf dist",
|
"clean": "rimraf dist",
|
||||||
"build": "yarn run clean && electron-builder --win --mac --linux",
|
"build": "yarn run clean && electron-builder --win --mac --linux",
|
||||||
|
"build:linux": "yarn run clean && electron-builder --linux",
|
||||||
"build:mac": "yarn run clean && electron-builder --mac",
|
"build:mac": "yarn run clean && electron-builder --mac",
|
||||||
"build:win": "yarn run clean && electron-builder --win",
|
"build:win": "yarn run clean && electron-builder --win",
|
||||||
"plugins": "yarn run plugin:adblocker && yarn run plugin:autoconfirm",
|
"plugins": "yarn run plugin:adblocker && yarn run plugin:autoconfirm",
|
||||||
@ -59,7 +60,7 @@
|
|||||||
"electron-updater": "^4.3.5",
|
"electron-updater": "^4.3.5",
|
||||||
"filenamify": "^4.2.0",
|
"filenamify": "^4.2.0",
|
||||||
"node-fetch": "^2.6.1",
|
"node-fetch": "^2.6.1",
|
||||||
"ytdl-core": "^4.0.3"
|
"ytdl-core": "^4.1.1"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"electron": "^10.1.3",
|
"electron": "^10.1.3",
|
||||||
|
|||||||
@ -1,2 +1,7 @@
|
|||||||
const { loadAdBlockerEngine } = require("./blocker");
|
const { loadAdBlockerEngine } = require("./blocker");
|
||||||
module.exports = (win) => loadAdBlockerEngine(win.webContents.session);
|
module.exports = (win, options) =>
|
||||||
|
loadAdBlockerEngine(
|
||||||
|
win.webContents.session,
|
||||||
|
options.cache,
|
||||||
|
options.additionalBlockLists
|
||||||
|
);
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
const { promises } = require("fs"); // used for caching
|
const { existsSync, promises, unlinkSync } = require("fs"); // used for caching
|
||||||
const path = require("path");
|
const path = require("path");
|
||||||
|
|
||||||
const { ElectronBlocker } = require("@cliqz/adblocker-electron");
|
const { ElectronBlocker } = require("@cliqz/adblocker-electron");
|
||||||
@ -8,16 +8,28 @@ const SOURCES = [
|
|||||||
"https://raw.githubusercontent.com/kbinani/adblock-youtube-ads/master/signed.txt",
|
"https://raw.githubusercontent.com/kbinani/adblock-youtube-ads/master/signed.txt",
|
||||||
];
|
];
|
||||||
|
|
||||||
const loadAdBlockerEngine = (session = undefined) =>
|
const loadAdBlockerEngine = (
|
||||||
|
session = undefined,
|
||||||
|
cache = true,
|
||||||
|
additionalBlockLists = []
|
||||||
|
) => {
|
||||||
|
const adBlockerCache = path.resolve(__dirname, "ad-blocker-engine.bin");
|
||||||
|
if (!cache && existsSync(adBlockerCache)) {
|
||||||
|
unlinkSync(adBlockerCache);
|
||||||
|
}
|
||||||
|
const cachingOptions = cache
|
||||||
|
? {
|
||||||
|
path: adBlockerCache,
|
||||||
|
read: promises.readFile,
|
||||||
|
write: promises.writeFile,
|
||||||
|
}
|
||||||
|
: undefined;
|
||||||
|
|
||||||
ElectronBlocker.fromLists(
|
ElectronBlocker.fromLists(
|
||||||
fetch,
|
fetch,
|
||||||
SOURCES,
|
[...SOURCES, ...additionalBlockLists],
|
||||||
{},
|
{},
|
||||||
{
|
cachingOptions
|
||||||
path: path.resolve(__dirname, "ad-blocker-engine.bin"),
|
|
||||||
read: promises.readFile,
|
|
||||||
write: promises.writeFile,
|
|
||||||
}
|
|
||||||
)
|
)
|
||||||
.then((blocker) => {
|
.then((blocker) => {
|
||||||
if (session) {
|
if (session) {
|
||||||
@ -27,6 +39,7 @@ const loadAdBlockerEngine = (session = undefined) =>
|
|||||||
}
|
}
|
||||||
})
|
})
|
||||||
.catch((err) => console.log("Error loading adBlocker engine", err));
|
.catch((err) => console.log("Error loading adBlocker engine", err));
|
||||||
|
};
|
||||||
|
|
||||||
module.exports = { loadAdBlockerEngine };
|
module.exports = { loadAdBlockerEngine };
|
||||||
if (require.main === module) {
|
if (require.main === module) {
|
||||||
|
|||||||
@ -7,6 +7,7 @@ let progress = null;
|
|||||||
const downloadButton = ElementFromFile(
|
const downloadButton = ElementFromFile(
|
||||||
templatePath(__dirname, "download.html")
|
templatePath(__dirname, "download.html")
|
||||||
);
|
);
|
||||||
|
let pluginOptions = {};
|
||||||
|
|
||||||
const observer = new MutationObserver((mutations, observer) => {
|
const observer = new MutationObserver((mutations, observer) => {
|
||||||
if (!menu) {
|
if (!menu) {
|
||||||
@ -43,11 +44,13 @@ global.download = () => {
|
|||||||
triggerAction(CHANNEL, ACTIONS.ERROR, error);
|
triggerAction(CHANNEL, ACTIONS.ERROR, error);
|
||||||
reinit();
|
reinit();
|
||||||
},
|
},
|
||||||
reinit
|
reinit,
|
||||||
|
pluginOptions
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
function observeMenu() {
|
function observeMenu(options) {
|
||||||
|
pluginOptions = { ...pluginOptions, ...options };
|
||||||
observer.observe(document, {
|
observer.observe(document, {
|
||||||
childList: true,
|
childList: true,
|
||||||
subtree: true,
|
subtree: true,
|
||||||
|
|||||||
@ -19,7 +19,13 @@ const ffmpeg = createFFmpeg({
|
|||||||
progress: () => {}, // console.log,
|
progress: () => {}, // console.log,
|
||||||
});
|
});
|
||||||
|
|
||||||
const downloadVideoToMP3 = (videoUrl, sendFeedback, sendError, reinit) => {
|
const downloadVideoToMP3 = (
|
||||||
|
videoUrl,
|
||||||
|
sendFeedback,
|
||||||
|
sendError,
|
||||||
|
reinit,
|
||||||
|
options
|
||||||
|
) => {
|
||||||
sendFeedback("Downloading…");
|
sendFeedback("Downloading…");
|
||||||
|
|
||||||
let videoName = "YouTube Music - Unknown title";
|
let videoName = "YouTube Music - Unknown title";
|
||||||
@ -29,6 +35,7 @@ const downloadVideoToMP3 = (videoUrl, sendFeedback, sendError, reinit) => {
|
|||||||
filter: "audioonly",
|
filter: "audioonly",
|
||||||
quality: "highestaudio",
|
quality: "highestaudio",
|
||||||
highWaterMark: 32 * 1024 * 1024, // 32 MB
|
highWaterMark: 32 * 1024 * 1024, // 32 MB
|
||||||
|
requestOptions: { maxRetries: 3 },
|
||||||
});
|
});
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
sendError(err);
|
sendError(err);
|
||||||
@ -53,11 +60,18 @@ const downloadVideoToMP3 = (videoUrl, sendFeedback, sendError, reinit) => {
|
|||||||
.on("error", sendError)
|
.on("error", sendError)
|
||||||
.on("end", () => {
|
.on("end", () => {
|
||||||
const buffer = Buffer.concat(chunks);
|
const buffer = Buffer.concat(chunks);
|
||||||
toMP3(videoName, buffer, sendFeedback, sendError, reinit);
|
toMP3(videoName, buffer, sendFeedback, sendError, reinit, options);
|
||||||
});
|
});
|
||||||
};
|
};
|
||||||
|
|
||||||
const toMP3 = async (videoName, buffer, sendFeedback, sendError, reinit) => {
|
const toMP3 = async (
|
||||||
|
videoName,
|
||||||
|
buffer,
|
||||||
|
sendFeedback,
|
||||||
|
sendError,
|
||||||
|
reinit,
|
||||||
|
options
|
||||||
|
) => {
|
||||||
const safeVideoName = randomBytes(32).toString("hex");
|
const safeVideoName = randomBytes(32).toString("hex");
|
||||||
|
|
||||||
try {
|
try {
|
||||||
@ -70,11 +84,17 @@ const toMP3 = async (videoName, buffer, sendFeedback, sendError, reinit) => {
|
|||||||
ffmpeg.FS("writeFile", safeVideoName, buffer);
|
ffmpeg.FS("writeFile", safeVideoName, buffer);
|
||||||
|
|
||||||
sendFeedback("Converting…");
|
sendFeedback("Converting…");
|
||||||
await ffmpeg.run("-i", safeVideoName, safeVideoName + ".mp3");
|
await ffmpeg.run(
|
||||||
|
"-i",
|
||||||
|
safeVideoName,
|
||||||
|
...options.ffmpegArgs,
|
||||||
|
safeVideoName + ".mp3"
|
||||||
|
);
|
||||||
|
|
||||||
|
const folder = options.downloadFolder || downloadsFolder();
|
||||||
const filename = filenamify(videoName + ".mp3", { replacement: "_" });
|
const filename = filenamify(videoName + ".mp3", { replacement: "_" });
|
||||||
writeFileSync(
|
writeFileSync(
|
||||||
join(downloadsFolder(), filename),
|
join(folder, filename),
|
||||||
ffmpeg.FS("readFile", safeVideoName + ".mp3")
|
ffmpeg.FS("readFile", safeVideoName + ".mp3")
|
||||||
);
|
);
|
||||||
|
|
||||||
|
|||||||
16
preload.js
16
preload.js
@ -2,31 +2,31 @@ const path = require("path");
|
|||||||
|
|
||||||
const { remote } = require("electron");
|
const { remote } = require("electron");
|
||||||
|
|
||||||
const { getEnabledPlugins, store } = require("./store");
|
const config = require("./config");
|
||||||
const { fileExists } = require("./plugins/utils");
|
const { fileExists } = require("./plugins/utils");
|
||||||
|
|
||||||
const plugins = getEnabledPlugins();
|
const plugins = config.plugins.getEnabled();
|
||||||
|
|
||||||
plugins.forEach(plugin => {
|
plugins.forEach(([plugin, options]) => {
|
||||||
const pluginPath = path.join(__dirname, "plugins", plugin, "actions.js");
|
const pluginPath = path.join(__dirname, "plugins", plugin, "actions.js");
|
||||||
fileExists(pluginPath, () => {
|
fileExists(pluginPath, () => {
|
||||||
const actions = require(pluginPath).global || {};
|
const actions = require(pluginPath).global || {};
|
||||||
Object.keys(actions).forEach(actionName => {
|
Object.keys(actions).forEach((actionName) => {
|
||||||
global[actionName] = actions[actionName];
|
global[actionName] = actions[actionName];
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
document.addEventListener("DOMContentLoaded", () => {
|
document.addEventListener("DOMContentLoaded", () => {
|
||||||
plugins.forEach(plugin => {
|
plugins.forEach(([plugin, options]) => {
|
||||||
const pluginPath = path.join(__dirname, "plugins", plugin, "front.js");
|
const pluginPath = path.join(__dirname, "plugins", plugin, "front.js");
|
||||||
fileExists(pluginPath, () => {
|
fileExists(pluginPath, () => {
|
||||||
const run = require(pluginPath);
|
const run = require(pluginPath);
|
||||||
run();
|
run(options);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
// Add action for reloading
|
// Add action for reloading
|
||||||
global.reload = () =>
|
global.reload = () =>
|
||||||
remote.getCurrentWindow().webContents.loadURL(store.get("url"));
|
remote.getCurrentWindow().webContents.loadURL(config.get("url"));
|
||||||
});
|
});
|
||||||
|
|||||||
@ -18,6 +18,10 @@
|
|||||||
|
|
||||||
You can check out the [latest release](https://github.com/th-ch/youtube-music/releases/latest) to quickly find the latest version.
|
You can check out the [latest release](https://github.com/th-ch/youtube-music/releases/latest) to quickly find the latest version.
|
||||||
|
|
||||||
|
**Arch Linux**
|
||||||
|
|
||||||
|
Install the `youtube-music-bin` package from the AUR. For AUR installation instructions, take a look at this [wiki page](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages).
|
||||||
|
|
||||||
## Available plugins:
|
## Available plugins:
|
||||||
|
|
||||||
- **Ad Blocker**: block all ads and tracking out of the box
|
- **Ad Blocker**: block all ads and tracking out of the box
|
||||||
|
|||||||
@ -1,35 +0,0 @@
|
|||||||
const Store = require("electron-store");
|
|
||||||
const plugins = require("./plugins");
|
|
||||||
|
|
||||||
const store = new Store({
|
|
||||||
defaults: {
|
|
||||||
"window-size": {
|
|
||||||
width: 1100,
|
|
||||||
height: 550,
|
|
||||||
},
|
|
||||||
url: "https://music.youtube.com",
|
|
||||||
plugins: ["navigation", "shortcuts", "adblocker"],
|
|
||||||
options: {
|
|
||||||
tray: false,
|
|
||||||
appVisible: true,
|
|
||||||
autoUpdates: true,
|
|
||||||
startAtLogin: false,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
module.exports = {
|
|
||||||
store: store,
|
|
||||||
// Plugins
|
|
||||||
isPluginEnabled: plugin => plugins.isEnabled(store, plugin),
|
|
||||||
getEnabledPlugins: () => plugins.getEnabledPlugins(store),
|
|
||||||
enablePlugin: plugin => plugins.enablePlugin(store, plugin),
|
|
||||||
disablePlugin: plugin => plugins.disablePlugin(store, plugin),
|
|
||||||
// Options
|
|
||||||
setOptions: options =>
|
|
||||||
store.set("options", { ...store.get("options"), ...options }),
|
|
||||||
isTrayEnabled: () => store.get("options.tray"),
|
|
||||||
isAppVisible: () => store.get("options.appVisible"),
|
|
||||||
autoUpdate: () => store.get("options.autoUpdates"),
|
|
||||||
startAtLogin: () => store.get("options.startAtLogin"),
|
|
||||||
};
|
|
||||||
@ -1,31 +0,0 @@
|
|||||||
function getEnabledPlugins(store) {
|
|
||||||
return store.get("plugins");
|
|
||||||
}
|
|
||||||
|
|
||||||
function isEnabled(store, plugin) {
|
|
||||||
return store.get("plugins").indexOf(plugin) > -1;
|
|
||||||
}
|
|
||||||
|
|
||||||
function enablePlugin(store, plugin) {
|
|
||||||
let plugins = getEnabledPlugins(store);
|
|
||||||
if (plugins.indexOf(plugin) === -1) {
|
|
||||||
plugins.push(plugin);
|
|
||||||
store.set("plugins", plugins);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function disablePlugin(store, plugin) {
|
|
||||||
let plugins = getEnabledPlugins(store);
|
|
||||||
let index = plugins.indexOf(plugin);
|
|
||||||
if (index > -1) {
|
|
||||||
plugins.splice(index, 1);
|
|
||||||
store.set("plugins", plugins);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
module.exports = {
|
|
||||||
isEnabled : isEnabled,
|
|
||||||
getEnabledPlugins: getEnabledPlugins,
|
|
||||||
enablePlugin : enablePlugin,
|
|
||||||
disablePlugin : disablePlugin
|
|
||||||
};
|
|
||||||
4
tray.js
4
tray.js
@ -2,15 +2,15 @@ const path = require("path");
|
|||||||
|
|
||||||
const { Menu, nativeImage, Tray } = require("electron");
|
const { Menu, nativeImage, Tray } = require("electron");
|
||||||
|
|
||||||
|
const config = require("./config");
|
||||||
const { mainMenuTemplate } = require("./menu");
|
const { mainMenuTemplate } = require("./menu");
|
||||||
const { isTrayEnabled } = require("./store");
|
|
||||||
const { clickInYoutubeMusic } = require("./utils/youtube-music");
|
const { clickInYoutubeMusic } = require("./utils/youtube-music");
|
||||||
|
|
||||||
// Prevent tray being garbage collected
|
// Prevent tray being garbage collected
|
||||||
let tray;
|
let tray;
|
||||||
|
|
||||||
module.exports.setUpTray = (app, win) => {
|
module.exports.setUpTray = (app, win) => {
|
||||||
if (!isTrayEnabled()) {
|
if (!config.get("options.tray")) {
|
||||||
tray = undefined;
|
tray = undefined;
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|||||||
35
yarn.lock
35
yarn.lock
@ -5857,12 +5857,12 @@ lru-cache@^6.0.0:
|
|||||||
dependencies:
|
dependencies:
|
||||||
yallist "^4.0.0"
|
yallist "^4.0.0"
|
||||||
|
|
||||||
m3u8stream@^0.8.0:
|
m3u8stream@^0.8.3:
|
||||||
version "0.8.0"
|
version "0.8.3"
|
||||||
resolved "https://registry.yarnpkg.com/m3u8stream/-/m3u8stream-0.8.0.tgz#025a63358ee32d7652bdc0a93f46078582ec5e96"
|
resolved "https://registry.yarnpkg.com/m3u8stream/-/m3u8stream-0.8.3.tgz#c4624e92b4240eb356d040c4a5e155586cf58108"
|
||||||
integrity sha512-vvSjdkBPdDHzVr2M+aIXbnYys4zX6m3UzxMaxBJr1PpE0e/3sawkLD4EEmz/q9hv87bleotR70cOWR3UBMtskw==
|
integrity sha512-0nAcdrF8YJKUkb6PzWdvGftTPyCVWgoiot1AkNVbPKTeIGsWs6DrOjifrJ0Zi8WQfQmD2SuVCjkYIOip12igng==
|
||||||
dependencies:
|
dependencies:
|
||||||
miniget "^2.0.1"
|
miniget "^4.0.0"
|
||||||
sax "^1.2.4"
|
sax "^1.2.4"
|
||||||
|
|
||||||
make-dir@^3.0.0, make-dir@^3.0.2:
|
make-dir@^3.0.0, make-dir@^3.0.2:
|
||||||
@ -6060,15 +6060,10 @@ min-indent@^1.0.0:
|
|||||||
resolved "https://registry.yarnpkg.com/min-indent/-/min-indent-1.0.1.tgz#a63f681673b30571fbe8bc25686ae746eefa9869"
|
resolved "https://registry.yarnpkg.com/min-indent/-/min-indent-1.0.1.tgz#a63f681673b30571fbe8bc25686ae746eefa9869"
|
||||||
integrity sha512-I9jwMn07Sy/IwOj3zVkVik2JTvgpaykDZEigL6Rx6N9LbMywwUSMtxET+7lVoDLLd3O3IXwJwvuuns8UB/HeAg==
|
integrity sha512-I9jwMn07Sy/IwOj3zVkVik2JTvgpaykDZEigL6Rx6N9LbMywwUSMtxET+7lVoDLLd3O3IXwJwvuuns8UB/HeAg==
|
||||||
|
|
||||||
miniget@^2.0.1:
|
miniget@^4.0.0:
|
||||||
version "2.0.1"
|
version "4.1.0"
|
||||||
resolved "https://registry.yarnpkg.com/miniget/-/miniget-2.0.1.tgz#e2188573317ad8239bab33f056aae64804fc8e47"
|
resolved "https://registry.yarnpkg.com/miniget/-/miniget-4.1.0.tgz#018cc1180d2fe4d45ed735ac6bd2ab7224e8bceb"
|
||||||
integrity sha512-MX+QfVIPAutz6c+T7WKuFKtjcw0nOyRRh1ubhTDD+z/e/pKcSAsfAV63aQKUgb1MFRT1GyfJeW53N5fHkX0wIA==
|
integrity sha512-kzhrNv5L7LlomwGmPGQsLQ2PnT1LeJJWfB0wNFGyv426gEM1gsfziBQmfkr6XOBA8EusZg9nowlNT5CbuKTjZg==
|
||||||
|
|
||||||
miniget@^2.1.0:
|
|
||||||
version "2.1.0"
|
|
||||||
resolved "https://registry.yarnpkg.com/miniget/-/miniget-2.1.0.tgz#2dfb9ecb3a9a55d9dc682102f65fca2a06e3f5ca"
|
|
||||||
integrity sha512-fy9x3d/0oOIhkwAms6kgxTYkHwdELhMfgj+9a/aYZpJdTWIIWGta9aXHUtnzUn+LjBmRoTdPRQSi2hkmEvXk3A==
|
|
||||||
|
|
||||||
minimalistic-assert@^1.0.0, minimalistic-assert@^1.0.1:
|
minimalistic-assert@^1.0.0, minimalistic-assert@^1.0.1:
|
||||||
version "1.0.1"
|
version "1.0.1"
|
||||||
@ -8941,14 +8936,14 @@ yauzl@^2.10.0:
|
|||||||
buffer-crc32 "~0.2.3"
|
buffer-crc32 "~0.2.3"
|
||||||
fd-slicer "~1.1.0"
|
fd-slicer "~1.1.0"
|
||||||
|
|
||||||
ytdl-core@^4.0.3:
|
ytdl-core@^4.1.1:
|
||||||
version "4.0.3"
|
version "4.1.1"
|
||||||
resolved "https://registry.yarnpkg.com/ytdl-core/-/ytdl-core-4.0.3.tgz#9772dc6f7f0272534d50f50903022f8502ae44fa"
|
resolved "https://registry.yarnpkg.com/ytdl-core/-/ytdl-core-4.1.1.tgz#191fabf472c44f969fe3eca15cb4d1c094e46282"
|
||||||
integrity sha512-+pM+EocvdHHTfH3xCr3c41cIm8bD7IE/wv/QKjaO7PwdLaaOMIj7xc/7yWwy9NwUDgIKA1YTotcn0qpQ0FVtMA==
|
integrity sha512-T2VIS64sHKdLLqvuTV7S4WyoUCZLdR7HOP/9jX1CyXKYUjKLFP9UpVIFH0ZUvFSmK48eNFErWLOO5dGouwqztQ==
|
||||||
dependencies:
|
dependencies:
|
||||||
html-entities "^1.3.1"
|
html-entities "^1.3.1"
|
||||||
m3u8stream "^0.8.0"
|
m3u8stream "^0.8.3"
|
||||||
miniget "^2.1.0"
|
miniget "^4.0.0"
|
||||||
sax "^1.1.3"
|
sax "^1.1.3"
|
||||||
|
|
||||||
zip-stream@^4.0.0:
|
zip-stream@^4.0.0:
|
||||||
|
|||||||
Reference in New Issue
Block a user