/netease-music-box

🎧 将你最近一周的网易云音乐的听歌记录更新到 Gist 和 READNE

Primary LanguageJavaScriptMIT LicenseMIT

Netease Music Box

将你最近一周的网易云音乐的听歌记录更新到 Gist 和 README


📌✨ 更多像这样的 Pinned Gist 项目请访问:https://github.com/matchai/awesome-pinned-gists

🖥 使用

🎒 前置工作

  1. 创建一个公开的 Github Gist (https://gist.github.com)

  2. 创建一个 GitHub Token,需要勾选 gist 权限(如果你需要更新README,请同时勾选repo权限),复制生成的 Token (https://github.com/settings/tokens/new)

  3. 获取网易云音乐用户 ID (https://music.163.com)

    • ID 为个人主页页面(https://music.163.com/#/user/home?id=xxx),id 后紧跟的那串数字

    USER_ID

  4. 获取网易云音乐用户 Token

    • 在登录态下打开浏览器开发者工具,查看 Cookie,获取 keyMUSIC_Uvalue

    USER_TOKEN

  5. 如果你需要更新README,请在你的README文件中加入以下内容

 <!-- netease-music-box start -->
 <!-- netease-music-box end -->

🚀 安装

  1. Fork 这个仓库

  2. 进入 Fork 后的仓库,启用 Github Actions

  3. 编辑 .github/workflows/schedule.yml 文件中的环境变量:

    • GIST_ID: ID 是新建 Gist 的 url 后缀: https://gist.github.com/Leecason/b51bc9844585c33775edc27bb38ad2ab

    • USER_ID: 网易云音乐用户 ID

    • LIST_LENGTH: 显示多少条听歌记录,默认为5

  4. 如果你需要更新README,你还要编辑以下环境变量

    • UPDATE_README: 是否更新到README

    • UPDATE_README_OWNER: 更新README的用户名

    • UPDATE_README_REPO: 更新README的仓库名

  5. 在项目的 Settings > Secrets 中创建两个变量 GH_TOKENUSER_TOKEN,分别为 Github Token 和 网易云音乐用户 Token

  6. 在个人资料中嵌入 Gist

🤔 工作原理

  • 基于 NeteaseCloudMusicApi 获取听歌记录
  • 基于 Github API 更新 Gist 和 README
  • 使用 Github Actions 自动更新 Gist 和 README (当数据一致时,README 将不会被更新,注:只有 README 支持此功能)

📄 开源协议

本项目使用 MIT 协议