Sunamu 项目教程

Sunamu 项目教程

SunamuShow your currently playing song in a stylish way!项目地址:https://gitcode.com/gh_mirrors/su/Sunamu

1. 项目目录结构及介绍

Sunamu 项目的目录结构如下：

Sunamu/
├── assets/
│   └── ...
├── dist/
│   └── www/
│       └── ...
├── src/
│   └── ...
├── .eslintrc.json
├── .gitignore
├── .nvmrc
├── COMPATIBILITY.md
├── LICENSE
├── README.md
├── electron-builder.yml
├── package.json
├── tsconfig.json
├── tsconfig.settings.json
└── yarn.lock

目录结构介绍

• assets/: 存放项目相关的静态资源文件。
• dist/www/: 存放编译后的前端代码。
• src/: 存放项目的源代码。
• .eslintrc.json: ESLint 配置文件，用于代码风格检查。
• .gitignore: Git 忽略文件配置，指定哪些文件或目录不需要被 Git 管理。
• .nvmrc: Node Version Manager 配置文件，指定项目所需的 Node.js 版本。
• COMPATIBILITY.md: 兼容性说明文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• electron-builder.yml: Electron 构建配置文件。
• package.json: 项目依赖和脚本配置文件。
• tsconfig.json: TypeScript 配置文件。
• tsconfig.settings.json: TypeScript 设置配置文件。
• yarn.lock: Yarn 依赖锁定文件。

2. 项目启动文件介绍

Sunamu 项目的启动文件主要是 package.json 中的 scripts 部分。以下是一些常用的启动命令：

{
  "scripts": {
    "start": "electron .",
    "build": "electron-builder"
  }
}

启动命令介绍

• npm start 或 yarn start: 启动 Electron 应用程序。
• npm run build 或 yarn build: 使用 Electron Builder 构建应用程序。

3. 项目配置文件介绍

Sunamu 项目的配置文件主要位于以下路径：

• Linux: ~/.config/sunamu/config.json5 或 $XDG_CONFIG_HOME/sunamu/config.json5
• Linux Flatpak: ~/var/app/xyz.nyaomi.sunamu/config/sunamu/config.json5

配置文件内容

配置文件 config.json5 用于启用或禁用各种功能。以下是一个示例配置文件的内容：

{
  "features": {
    "lyrics": true,
    "discordRichPresence": true,
    "pollingIntervals": 1000,
    "lyricsCacheSize": 1024
  }
}

配置项介绍

• lyrics: 是否启用歌词显示功能。
• discordRichPresence: 是否启用 Discord Rich Presence 功能。
• pollingIntervals: 轮询间隔时间，单位为毫秒。
• lyricsCacheSize: 歌词缓存大小，单位为 KB。

通过修改配置文件，用户可以自定义 Sunamu 的行为和功能。

SunamuShow your currently playing song in a stylish way!项目地址:https://gitcode.com/gh_mirrors/su/Sunamu