NLyric 开源项目教程

NLyric 开源项目教程

NLyric网易云音乐歌词自动搜索下载项目地址:https://gitcode.com/gh_mirrors/nl/NLyric

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

NLyric 项目的目录结构如下：

NLyric/
├── README.md
├── LICENSE
├── src/
│   ├── main.py
│   ├── config.py
│   ├── lyrics_api.py
│   ├── plugins/
│   │   ├── vlc_plugin.py
│   │   ├── winamp_plugin.py
│   │   └── qqmusic_plugin.py
│   └── utils/
│       ├── cache.py
│       ├── network.py
│       └── parser.py
├── tests/
│   ├── test_main.py
│   ├── test_config.py
│   └── test_lyrics_api.py
└── settings.json

目录结构介绍

• README.md: 项目说明文档。
• LICENSE: 项目许可证文件。
• src/: 源代码目录。
  • main.py: 项目的主启动文件。
  • config.py: 配置文件处理模块。
  • lyrics_api.py: 歌词API接口模块。
  • plugins/: 插件目录，包含各种音乐播放器的插件。
  • utils/: 工具模块目录，包含缓存、网络请求和解析工具。
• tests/: 测试代码目录。
• settings.json: 项目的配置文件。

2. 项目的启动文件介绍

main.py

main.py 是 NLyric 项目的主启动文件，负责初始化配置、加载插件和启动歌词服务。以下是 main.py 的主要功能：

• 读取 settings.json 配置文件。
• 初始化歌词API接口。
• 加载并初始化各个音乐播放器的插件。
• 启动歌词服务，监听音乐播放状态并动态加载歌词。

3. 项目的配置文件介绍

settings.json

settings.json 是 NLyric 项目的配置文件，包含了项目的各种配置选项。以下是 settings.json 的主要内容：

{
  "Search": {
    "AudioExtensions": [
      "aac", "ape", "flac", "m4a", "mp3", "ogg", "wav", "wma"
    ],
    "Separators": "| /\\&:",
    "WholeWordReplace": [],
    "Limit": 15
  },
  "Fuzzy": {
    "TryIgnoringArtists": true,
    "TryIgnoringExtraInfo": true
  }
}

配置文件介绍

• Search: 搜索设置。
  • AudioExtensions: 支持的音乐文件扩展名。
  • Separators: 用于分割歌手名的分隔符。
  • WholeWordReplace: 搜索时替换的词。
  • Limit: 搜索结果数量限制。
• Fuzzy: 模糊搜索设置。
  • TryIgnoringArtists: 是否忽略艺术家进行模糊搜索。
  • TryIgnoringExtraInfo: 是否忽略括号/空格 + Cover/feat 之后的内容进行模糊搜索。

以上是 NLyric 开源项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用 NLyric 项目。

NLyric网易云音乐歌词自动搜索下载项目地址:https://gitcode.com/gh_mirrors/nl/NLyric