SPlayer 开源项目启动与配置教程

SPlayer 开源项目启动与配置教程

SPlayer 🎉 基于Imsyy二次开发, 加入UnblockNeteaseMusic功能, 让网页端也能使用Unblock播放灰色歌曲以及VIP歌曲 项目地址: https://gitcode.com/gh_mirrors/splay/SPlayer

1. 项目的目录结构及介绍

SPlayer 是一个基于 Vue 3 全家桶和 Naïve UI 组件库及 Electron 开发的开源音乐播放器项目。它支持网页端与客户端，目前主要适配 Windows 平台，其他平台可自行解决兼容性后进行构建。以下是 SPlayer 的主要目录结构：

SPlayer
├── auto-imports.d.ts                     # 自动导入 TypeScript 声明文件
├── commit.example                        # Git 提交信息示例
├── components.d.ts                       # 组件 TypeScript 声明文件
├── docker-compose.yml                    # Docker Compose 配置
├── Dockerfile                            # Docker 构建文件
├── electron-builder.yml                  # Electron Builder 配置
├── electron.vite.config.mjs             # Electron Vite 配置
├── index.html                           # 主页 HTML
├── nginx.conf                           # Nginx 配置
├── vercel.json                          # Vercel 部署配置
├── electron                             # Electron 相关文件
│   ├── main                            # 主进程
│   │   ├── index.js                    # 主进程入口
│   │   ├── mainIpcMain.js             # 主进程通信
│   │   ├── startMainServer.js         # 服务器启动
│   │   ├── startNcmServer.js         # 网易云音乐服务启动
│   │   └── utils                     # 工具函数
│   │       ├── checkPort.js          # 端口检查
│   │       ├── checkUpdates.js       # 更新检查
│   │       ├── createGlobalShortcut.js # 全局快捷键
│   │       ├── createSystemTray.js   # 系统托盘
│   │       ├── getNeteaseMusicUrl.js # 音乐 URL 获取
│   │       ├── kwDES.js             # DES 加密
│   │       └── readDirAsync.js      # 异步目录读取
│   └── preload
├── src
├── public
├── .gitignore
├── .editorconfig
├── .eslintrc.cjs
├── .eslintrc.json
├── .prettierrc.yaml
├── package.json
└── pnpm-lock.yaml

2. 项目的启动文件介绍

SPlayer 项目的启动主要分为客户端启动和服务器启动两部分。

客户端启动：

客户端启动主要涉及 Electron 的配置文件和主进程文件。在 electron 目录下，main 文件夹包含了主进程的入口文件 index.js 和其他辅助文件。index.js 负责启动应用程序、创建窗口、处理与渲染进程的通信等。

服务器启动：

服务器启动主要涉及服务器端代码的配置和启动。在 electron/main 目录下，startMainServer.js 负责启动服务器，而 startNcmServer.js 负责启动网易云音乐的第三方 API 服务。

3. 项目的配置文件介绍

SPlayer 项目的配置主要涉及 .env 文件和 vercel.json 文件。

.env 文件：

.env 文件用于存储项目的环境变量和配置信息，例如 API 地址、站点地址等。在使用 Vercel 部署时，需要将 .env.example 文件复制并重命名为 .env，并修改其中的配置信息。

vercel.json 文件：

vercel.json 文件用于配置 Vercel 部署的相关设置，例如重写规则、输出目录等。在使用 Vercel 部署时，需要根据实际情况修改 vercel.json 文件中的配置信息。

以上就是 SPlayer 开源项目的启动和配置教程，希望对您有所帮助。

SPlayer 🎉 基于Imsyy二次开发, 加入UnblockNeteaseMusic功能, 让网页端也能使用Unblock播放灰色歌曲以及VIP歌曲 项目地址: https://gitcode.com/gh_mirrors/splay/SPlayer