osuplus 项目使用教程

osuplus 项目使用教程

osuplus 项目地址: https://gitcode.com/gh_mirrors/os/osuplus

1. 项目目录结构及介绍

osuplus 项目的主要目录结构如下：

osuplus/
├── README.md           # 项目说明文件
├── LICENSE             # 项目许可证文件
├── Changlog.md         # 项目更新日志
├── osuplus.user.js      # 项目主脚本文件
├── ...                 # 其他相关文件和目录

• README.md：项目的主要介绍文件，包含项目的功能、安装方法和使用说明。
• LICENSE：项目遵循的许可证文件，本项目遵循 GPL-3.0 许可。
• Changelog.md：记录了项目的更新历史和各个版本的主要变化。
• osuplus.user.js：项目的主要脚本文件，用于在用户浏览器中添加功能。

2. 项目的启动文件介绍

项目的启动文件为 osuplus.user.js。这是一个用户脚本（userscript），需要在支持用户脚本的浏览器插件（如 Tampermonkey 或 Greasemonkey）中安装。

• 安装步骤如下：
  1. 确保你的浏览器中安装并启用了 Tampermonkey 或 Greasemonkey 插件。
  2. 访问项目的 GitHub 页面：osuplus.user.js（注意：这里不提供链接，仅作说明）。
  3. 插件会自动打开一个新的标签页，提示你安装用户脚本。根据提示安装脚本。
  4. 在基于 Chromium 的浏览器中，可能需要启用开发者模式才能正确运行用户脚本。

3. 项目的配置文件介绍

osuplus 脚本需要一个 osu!API 密钥才能正常工作。配置 API 密钥的步骤如下：

1. 访问 osu! 官方网站，获取你的 API 密钥：

   • 通过 osu! API 页面 或在账户编辑页面中的“Legacy API”部分生成新的 API 密钥。
   • 应用名称填写“osuplus”，应用 URL 填写“https://github.com/limjeck/osuplus”。
   • 点击“Show Key”显示你的 API 密钥并复制。

2. 在访问任何 osu! 网页时，会看到一个红色横幅提示你输入 API 密钥。

3. 点击横幅中的“here”，粘贴你的 API 密钥。

项目启动后，用户可以根据需要通过脚本界面中的设置选项来启用或禁用特定的功能。

osuplus 项目地址: https://gitcode.com/gh_mirrors/os/osuplus