diff --git a/README.md b/README.md new file mode 100644 index 0000000..2bc14f4 --- /dev/null +++ b/README.md @@ -0,0 +1,131 @@ +# yandex-music-linux + +## About +Native YandexMusic client for Linux. Built using repacking of Windows client (Electron app). + +## Table of content +- [Screenshots](#screenshots) +- [Installation](#installation) + - [Arch Linux](#arch-linux) + - [Debian/Ubuntu](#debianubuntu) +- [Manual Build](#manual-build) + - [Prerequisites](#prerequisites) + - [Extract app only](#extract-app-only) + - [ASAR archive](#asar-archive) + - [Arch Linux](#arch-linux-1) + - [Debian/Ubuntu](#debianubuntu-1) + +## Screenshots +![image](https://github.com/cucumber-sp/yandex-music-linux/assets/100789522/ab2f69ee-efc4-4a33-8110-131b4c4ff4de) +![image](https://github.com/cucumber-sp/yandex-music-linux/assets/100789522/de618654-15d1-4103-a323-faa00086d0a2) + + +## Installation + +### Arch Linux + +*** + +#### AUR + +You can obtain the latest version of package from `AUR` using one of the [AUR Helpers](https://wiki.archlinux.org/title/AUR_helpers). Then install it with `yandexmusic` as package name. + +For this example I will use [yay](https://github.com/Jguer/yay) + +``` +yay -S yandexmusic +``` + +#### Binary package file + +Download prebuilt binary package from [Releases](https://github.com/cucumber-sp/yandex-music-linux/releases) section. + +Then you can install it with the following command + +``` +pacman -U yandexmusic--any.pkg.tar.zst +``` + +*** + +### Debian/Ubuntu + +*** + +#### APT + +Package is currently unavailable at APT. We're still working on it + +#### Binary package file + +Download prebuilt binary package from [Releases](https://github.com/cucumber-sp/yandex-music-linux/releases) section. + +Then you can install it with the following command + +``` +dpkg -i yandexmusic__.deb +``` + +*** + +## Manual Build + +### Prerequisites + +That's the list of packages you might need to install to be able to manually build the app. However, you should remember that it might be different for your distro/machine. + +``` +- nodejs +- npm +- jq +- 7z (p7zip) +- unzip +``` + +In addition you will need to install [Asar](https://github.com/electron/asar) tool with `npm`. I recommend install it globally with the following command + +``` +npm install -g @electron/asar +``` + +Last step is to download original client `.exe` file. You can get it yourself or take link to the latest version from `version_info.json` file. + +*** + +### Extract app only + +If you only want to get extracted app project with applied patches, you can use the following command: + +``` +sh repack.sh -x [-o OUTPUT_DIR default=./app] +``` +*** + +### ASAR archive + +`.asar` is archive file that containes all electron app resources and information, but doesn't hold Electron binaries. If you have `.asar` file you can launch app using `electron .asar`. You can build this archive with the following command: + +``` +sh repack.sh [-o OUTPUT_DIR default=./app] +``` + +*** + +### Arch Linux + +You can build `pacman` package file manually using `PKGBUILD` file from the this repository. Run following commands in folder with `PKGBUILD` file inside to get `.pkg.tar.zst` package: + +``` +pacman -S electron libpulse +makepkg +``` + +*** + +### Debian/Ubuntu + +You can build `.deb` binary package using the following command: + +``` +sh build_deb.sh [-a default=x64] +``` diff --git a/readme.md b/readme.md deleted file mode 100644 index 67e46c1..0000000 --- a/readme.md +++ /dev/null @@ -1,23 +0,0 @@ -# yandex-music-linux - -Нативный клиент Яндекс Музыки для Linux. Создан с помощью перепаковки бета-версии клиента для OSX/Windows. - -Native Yandex Music client for Linux. Made with OSX/Windows beta client repacking. - -## Скриншоты/Screenshots -![image](https://github.com/cucumber-sp/yandex-music-linux/assets/100789522/ab2f69ee-efc4-4a33-8110-131b4c4ff4de) -![image](https://github.com/cucumber-sp/yandex-music-linux/assets/100789522/de618654-15d1-4103-a323-faa00086d0a2) - -## Установка/Install -Доступные архитектуры: x64, arm64. Установка возможна с помощью deb и rpm пакетов или распаковкой архива. Актуальная версия клиента доступна в https://github.com/cucumber-sp/yandex-music-linux/releases - -Available architectures: x64, arm64 -You can install this app with dep and rpm packages, or by extracting archive file. Actual version is available at https://github.com/cucumber-sp/yandex-music-linux/releases - -## Самостоятельная сборка -Скачайте файл `repack.sh` и .exe файл клиента. Запустите скрипт с помощью `bash repack.sh `. В процессе выберите сборку для нужных архитектур (x64, arm64). Зависимости которые могут понадобиться: `nodejs`, `jq`, `npm`, `7z`, `npm asar`, `rpm-tools` - -## NixOs -Запустите `nix run` в корне этого репозитория, чтобы запустить приложение. Так -же вы можете использовать поле `modules` из flake этого репозитория. Добавив его -в модули вашей системы, вы получите пакет `yandex-music` в коллекции pkgs.