diff --git a/README.md b/README.md index 8fbc7e6..9f164ed 100644 --- a/README.md +++ b/README.md @@ -1,208 +1,51 @@ -
-

- - Logo - -

YesPlayMusic

+# Fork Bug 维护版 -

- 高颜值的第三方网易云播放器 -
- 🌎 访问DEMO  |   - 📦️ 下载安装包 -
-
-

-

+发布只有预览版, 只供测试. -[![Library][library-screenshot]](https://music.qier222.com) + +胡乱用把你电脑卡爆了我直接免责声明 + -## ✨ 特性 +## 本地开发 -- ✅ 使用 Vue.js 全家桶开发 -- 🔴 网易云账号登录(扫码/手机/邮箱登录) -- 📺 支持 MV 播放 -- 📃 支持歌词显示 -- 📻 支持私人 FM / 每日推荐歌曲 -- 🚫🤝 无任何社交功能 -- 🌎️ 海外用户可直接播放(需要登录网易云账号) -- 🔐 支持 [UnblockNeteaseMusic](https://github.com/nondanee/UnblockNeteaseMusic)([使用 revincx 修复的 npm 包](https://github.com/revincx/UnblockNeteaseMusic)),自动使用 QQ/酷狗/酷我音源替换变灰歌曲链接 (网页版不支持) -- ✔️ 每日自动签到(手机端和电脑端同时签到) -- 🌚 Light/Dark Mode 自动切换 -- 👆 支持 Touch Bar -- 🖥️ 支持 PWA,可在 Chrome/Edge 里点击地址栏右边的 ➕ 安装到电脑 -- 🟥 支持 Last.fm Scrobble -- ☁️ 支持音乐云盘 -- ⌨️ 自定义快捷键和全局快捷键 -- 🛠 更多特性开发中 +1. 克隆代码 -## 📦️ 安装 - -Electron 版本由 [@hawtim](https://github.com/hawtim) 和 [@qier222](https://github.com/qier222) 适配并维护,支持 macOS、Windows、Linux。 - -访问本项目的 [Releases](https://github.com/qier222/YesPlayMusic/releases) -页面下载安装包。 - -macOS 用户也可以通过 `brew install --cask yesplaymusic` 来安装。 - -## ⚙️ 部署至 Vercel - -除了下载安装包使用,你还可以将本项目部署到 Vercel 或你的服务器上。下面是部署到 Vercel 的方法。 - -1. 部署网易云 API,详情参见 [Binaryify/NeteaseCloudMusicApi](https://neteasecloudmusicapi.vercel.app/#/?id=%e5%ae%89%e8%a3%85) - 。你也可以将 API 部署到 Vercel。 - -2. 点击本仓库右上角的 Fork,复制本仓库到你的 GitHub 账号。 - -3. 点击仓库的 Add File,选择 Create new file,输入 `vercel.json`,将下面的内容复制粘贴到文件中,并将 `https://your-netease-api.example.com` 替换为你刚刚部署的网易云 API 地址: - -```json -{ - "rewrites": [ - { - "source": "/api/:match*", - "destination": "https://your-netease-api.example.com/:match*" - } - ] -} -``` - -4. 打开 [Vercel.com](https://vercel.com),使用 GitHub 登录。 - -5. 点击 Import Git Repository 并选择你刚刚复制的仓库并点击 Import。 - -6. 点击 PERSONAL ACCOUNT 旁边的 Select。 - -7. 点击 Environment Variables,填写 Name 为 `VUE_APP_NETEASE_API_URL`,Value 为 `/api`,点击 Add。最后点击底部的 Deploy 就可以部署到 - Vercel 了。 - -## ⚙️ 部署到自己的服务器 - -除了部署到 Vercel,你还可以部署到自己的服务器上 - -1. 部署网易云 API,详情参见 [Binaryify/NeteaseCloudMusicApi](https://github.com/Binaryify/NeteaseCloudMusicApi) -2. 克隆本仓库 - -```sh -git clone https://github.com/qier222/YesPlayMusic.git -``` - -3. 安装依赖 - -```sh -yarn install - -``` - -4. (可选)使用 Nginx 反向代理 API,将 API 路径映射为 `/api`,如果 API 和网页不在同一个域名下的话(跨域),会有一些 bug。 - -5. 复制 `/.env.example` 文件为 `/.env`,修改里面 `VUE_APP_NETEASE_API_URL` 的值为网易云 API 地址。本地开发的话可以填写 API 地址为 `http://localhost:3000`,YesPlayMusic 地址为 `http://localhost:8080`。如果你使用了反向代理 API,可以填写 API 地址为 `/api`。 - -``` -VUE_APP_NETEASE_API_URL=http://localhost:3000 -``` - -6. 编译打包 - -```sh -yarn run build -``` - -7. 将 `/dist` 目录下的文件上传到你的 Web 服务器 - -## 👷‍♂️ 打包客户端 - -如果在 Release 页面没有找到适合你的设备的安装包的话,你可以根据下面的步骤来打包自己的客户端。 - -1. 打包 Electron 需要用到 Node.js 和 Yarn。可前往 [Node.js 官网](https://nodejs.org/zh-cn/) 下载安装包。安装 Node.js - 后可在终端里执行 `npm install -g yarn` 来安装 Yarn。 - -2. 使用 `git clone https://github.com/qier222/YesPlayMusic.git` 克隆本仓库到本地。 - -3. 使用 `yarn install` 安装项目依赖。 - -4. 复制 `/.env.example` 文件为 `/.env` 。 - -5. 选择下列表格的命令来打包适合的你的安装包,打包出来的文件在 `/dist_electron` 目录下。了解更多信息可访问 [electron-builder 文档](https://www.electron.build/cli) - -| 命令 | 说明 | -| ------------------------------------------ | ------------------------- | -| `yarn electron:build --windows nsis:ia32` | Windows 32 位 | -| `yarn electron:build --windows nsis:arm64` | Windows ARM | -| `yarn electron:build --linux deb:armv7l` | Debian armv7l(树莓派等) | -| `yarn electron:build --macos dir:arm64` | macOS ARM | - -## :computer: 配置开发环境 - -本项目由 [NeteaseCloudMusicApi](https://github.com/Binaryify/NeteaseCloudMusicApi) 提供 API,已经包含在本项目的`netease_api`目录。 - -运行本项目 +2. 安装依赖 ```shell -# 安装依赖 -yarn install +yarn -# 创建本地环境变量 -cp .env.example .env - -# 运行(网页端) -yarn serve - -# 运行(electron) -yarn electron:serve -``` - -本地运行 NeteaseCloudMusicApi,或者将 API [部署至 Vercel](#%EF%B8%8F-部署至-vercel) - -```shell -# 安装依赖 yarn netease_api:install - -# 运行 API (默认 3000 端口) -yarn netease_api:run ``` -## ☑️ Todo +3. 运行本地开发环境 -查看 Todo 请访问本项目的 [Projects](https://github.com/qier222/YesPlayMusic/projects/1) +```shell +yarn netease_api:run -欢迎提 Issue 和 Pull request。 +yarn electron:server +``` -## 📜 开源许可 +4. 编译打包 windows 版 -本项目仅供个人学习研究使用,禁止用于商业及非法用途。 +```shell +yarn electron:build-win +``` -基于 [MIT license](https://opensource.org/licenses/MIT) 许可进行开源。 +x86 -## 灵感来源 +```shell +yarn electron:build --windows nsis:ia32 +``` -API 源代码来自 [Binaryify/NeteaseCloudMusicApi](https://github.com/Binaryify/NeteaseCloudMusicApi) +5. 编译打包 mac 版 -- [Apple Music](https://music.apple.com) -- [YouTube Music](https://music.youtube.com) -- [Spotify](https://www.spotify.com) -- [网易云音乐](https://music.163.com) +```shell +yarn electron:build-mac +``` -## 🖼️ 截图 +arm64 -![lyrics][lyrics-screenshot] -![library-dark][library-dark-screenshot] -![album][album-screenshot] -![home-2][home-2-screenshot] -![artist][artist-screenshot] -![search][search-screenshot] -![home][home-screenshot] -![explore][explore-screenshot] - - - - -[album-screenshot]: images/album.png -[artist-screenshot]: images/artist.png -[explore-screenshot]: images/explore.png -[home-screenshot]: images/home.png -[home-2-screenshot]: images/home-2.png -[lyrics-screenshot]: images/lyrics.png -[library-screenshot]: images/library.png -[library-dark-screenshot]: images/library-dark.png -[search-screenshot]: images/search.png +```shell +yarn electron:build --macos dir:arm64 +```