README.md

YouTube Music Desktop App

Now with a Fresh new Codebase 😉

⬇️ Download at

Windows

• Winget: winget install "YouTube Music Desktop App" or winget install Ytmdesktop.Ytmdesktop
• Scoop: scoop bucket add extras then scoop install ytmdesktop (Community Maintained)
• Binaries: https://github.com/ytmdesktop/ytmdesktop/releases

Linux

• Arch Linux (AUR): https://aur.archlinux.org/packages/ytmdesktop (Community Maintained)
• Binaries: https://github.com/ytmdesktop/ytmdesktop/releases

Mac

• Brew: brew install --cask ytmdesktop-youtube-music (Community Maintained)
• Binaries: https://github.com/ytmdesktop/ytmdesktop/releases

Developing

To clone and run this repository you'll need Git and Node.js (v20) (which comes with npm) installed on your computer. From your command line:

# Clone this repository
git clone https://github.com/ytmdesktop/ytmdesktop.git
# Go into the directory
cd ytmdesktop

And:

# If you do not have Yarn Installed / New to Node as a whole you can enable Yarn with:
corepack enable

# Install dependencies
yarn install
# Run the app
yarn start

Building the Project

To build for your platform you need to run yarn make, however please see the information below regarding the required additionally Software, Tools and Packages which are needed to successfully package into a nice installer file.

Windows

To download the full suite of Tools/Software needed to build the app it is recommended to install the suite of build tools that electron provide which includes Visual Studio, Python and other tools.

npm i -g @electron/build-tools

This will start downloading and installing, and may require a few prompts here and there to finalise everything.

Linux

Building the project on Linux only requires you to install:

• For building on Debian based Linux Distros like Ubuntu, you will need to install fakeroot and dpkg
• For building on RedHat based Linux Distros like Fedora, you will need to install rpm or rpm-build

please note that by default both packages are built if you try building this application on a linux distro

Contributors

A Thank you to all the contributors throughout the project, without their work this project would have just been a small project and never expanded to where it is now.