- Notifications
You must be signed in to change notification settings - Fork1.7k
Pear 🍐 is extension for music player
License
pear-devs/pear-desktop
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
- Native look & feel extension
Important
No Affiliation
This project, and its contributors, are not affiliated with, authorized by, endorsed by, or in any way officially connected with Google LLC, YouTube, or any of their subsidiaries or affiliates.This is an independent, non-profit, and unofficial extension developed by a team of volunteers with the goal of providing a desktop experience.
Trademarks
The names "Google" and "YouTube Music", as well as related names, marks, emblems, and images, are registered trademarks of their respective owners. Any use of these trademarks is for identification and reference purposes only and does not imply any association with the trademark holder. We have no intention of infringing upon these trademarks or causing harm to the trademark holders.
Limitation of Liability
This application (extension) is provided "AS IS", and you use it at your own risk. In no event shall the developers or contributors be liable for any claim, damages, or other liability, including any legal consequences, arising from, out of, or in connection with the software or the use or other dealings in the software. The responsibility for any and all outcomes of using this software rests entirely with the user.
You can help with translation onHosted Weblate.
You can check out thelatest release to quickly find thelatest version.
Install thepear-desktop package from the AUR. For AUR installation instructions, take a look atthiswiki page.
You can install the app using Homebrew (see thecask definition):
brew install pear-devs/pear-desktop
If you install the app manually and get an error "is damaged and can’t be opened." when launching the app, run the following in the Terminal:
/usr/bin/xattr -cr /Applications/Pear\Desktop.appYou can use theScoop package manager to install thepear-desktop package fromtheextras bucket.
scoop bucket add extrasscoop install extras/pear-desktop
Alternately you can useWinget, Windows 11sofficial CLI package manager to install thepear-devs.pear-desktop package.
Note: Microsoft Defender SmartScreen might block the installation since it is from an "unknown publisher". This is alsotrue for the manual installation when trying to run the executable(.exe) after a manual download here on github (samefile).
winget install pear-devs.pear-desktop
- Download the
*.nsis.7zfile foryour device architecture inrelease page.x64for 64-bit Windowsia32for 32-bit Windowsarm64for ARM64 Windows
- Download installer in release page. (
*-Setup.exe) - Place them in thesame directory.
- Run the installer.
You can load CSS files to change the look of the application (Options > Visual Tweaks > Themes).
Some predefined themes are available inhttps://github.com/kerichdev/themes-for-ytmdesktop-player.
git clone https://github.com/pear-devs/pear-desktopcd pear-desktoppnpm install --frozen-lockfilepnpm devUsing plugins, you can:
- manipulate the app - the
BrowserWindowfrom electron is passed to the plugin handler - change the front by manipulating the HTML/CSS
Create a folder insrc/plugins/YOUR-PLUGIN-NAME:
index.ts: the main file of the plugin
importstylefrom'./style.css?inline';// import style as inlineimport{createPlugin}from'@/utils';exportdefaultcreatePlugin({name:'Plugin Label',restartNeeded:true,// if value is true, ytmusic show restart dialogconfig:{enabled:false,},// your custom configstylesheets:[style],// your custom style,menu:async({ getConfig, setConfig})=>{// All *Config methods are wrapped Promise<T>constconfig=awaitgetConfig();return[{label:'menu',submenu:[1,2,3].map((value)=>({label:`value${value}`,type:'radio',checked:config.value===value,click(){setConfig({ value});},})),},];},backend:{start({ window, ipc}){window.maximize();// you can communicate with renderer pluginipc.handle('some-event',()=>{return'hello';});},// it fired when config changedonConfigChange(newConfig){/* ... */},// it fired when plugin disabledstop(context){/* ... */},},renderer:{asyncstart(context){console.log(awaitcontext.ipc.invoke('some-event'));},// Only renderer available hookonPlayerApiReady(api,context){// set plugin config easilycontext.setConfig({myConfig:api.getVolume()});},onConfigChange(newConfig){/* ... */},stop(_context){/* ... */},},preload:{asyncstart({ getConfig}){constconfig=awaitgetConfig();},onConfigChange(newConfig){},stop(_context){},},});
- injecting custom CSS: create a
style.cssfile in the same folder then:
// index.tsimportstylefrom'./style.css?inline';// import style as inlineimport{createPlugin}from'@/utils';exportdefaultcreatePlugin({name:'Plugin Label',restartNeeded:true,// if value is true, pear-desktop will show a restart dialogconfig:{enabled:false,},// your custom configstylesheets:[style],// your custom stylerenderer(){}// define renderer hook});
- If you want to change the HTML:
import{createPlugin}from'@/utils';exportdefaultcreatePlugin({name:'Plugin Label',restartNeeded:true,// if value is true, ytmusic will show the restart dialogconfig:{enabled:false,},// your custom configrenderer(){console.log('hello from renderer');}// define renderer hook});
- communicating between the front and back: can be done using the ipcMain module from electron. See
index.tsfile andexample insponsorblockplugin.
- Clone the repo
- Followthis guide to install
pnpm - Run
pnpm install --frozen-lockfileto install dependencies - Run
pnpm build:OS
pnpm dist:win- Windowspnpm dist:linux- Linux (amd64)pnpm dist:linux:deb-arm64- Linux (arm64 for Debian)pnpm dist:linux:rpm-arm64- Linux (arm64 for Fedora)pnpm dist:mac- macOS (amd64)pnpm dist:mac:arm64- macOS (arm64)
Builds the app for macOS, Linux, and Windows,usingelectron-builder.
pnpm start
pnpmtestUsesPlaywright to test the app.
MIT ©pear-devs
IfHide Menu option is on - you can show the menu with thealt key (or` [backtick] if usingthe in-app-menu plugin)
About
Pear 🍐 is extension for music player
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.