贡献指南

欢迎为本站提交内容修改或补充。 本站使用 VuePress 构建，内容使用 Markdown 编写。

基本步骤

若要贡献，请遵循下列步骤。

  1. 在网站中点击右上角 GitHub 跳转至仓库
  2. Fork 仓库并克隆git clone到本地
  3. 下载安装 Node.js。
  4. 运行 npm install 安装依赖
  5. 修改或新增页面
  6. 本地预览、验证您的修改或新增效果
  7. 提交更改并发起 Pull Request

管理组须知

虽然管理组有直接修改的权限，但为避免冲突，请通过 Pull Request 提交更改，避免直接修改仓库。

如何创建页面

新建 Markdown 文件

在合适的文件夹创建合适的.md文件。文件路径将直接决定页面URL。文件名为“README.md”则为该目录。

  • /folder/README.md → /folder/
  • /folder/page.md → /folder/page

页面结构：

# 页面标题
正文内容
过时的信息

然后在文件中添加 frontmatter：

---
title: 群赛
lang: zh-CN
---

提示

无需添加 frontmatter，但添加也无妨。

正文使用 Markdown 语法，不再使用一级标题。

如果不会 Markdown，请自行搜索 Markdown 语法.

参考资料：

更新导航（可选）

如果增加、删除或重命名了文件，并且有必要添加到导航栏或边栏中， 在 .vuepress/config.ts 中更新导航栏和侧边栏配置。

参考文档：

VuePress 官方文档

导航栏配置侧边栏配置主配置

本地实时查看效果

提示

推荐使用 VS Code 进行开发。

启动开发服务器：

npm install    # 安装依赖
npm run docs:dev  # 启动预览

点击显示的本地链接即可查看效果。如不熟悉 VuePress，请务必在提交 Pull Request 前检查。

模块

本项目开发了部分 Vue Component，可以合理使用。

名人堂

使用了项目中的 AlumniList.vue 和 Card.vue 模块。

这个模块已经和腾讯表格联动：填写表格即可完成添加。

谱面推荐和出群遗言

使用了项目中的 Beatmap.vue、Score.vue、Player.vue 模块。

可以通过调用雨沐机器人 (YumuBot) 的特殊指令，来快速获取需要填写的属性。

展示谱面

可以使用指令 !gw 快速获取。

参数可以填多个谱面编号 (BID)，可以按逗号分隔，数量如果多于 5 个，则会打包成文件发送。

以下是需要写在文档里的属性和示例：

4.91268419Shadow CorpsYousei Teikoku // Lune Hivernale[Insane]osu!standard
<Beatmap
  bid=1268419
  sid=600246
  preview="Yousei Teikoku - Shadow Corps (Lune Hivernale) [Insane]"
  star=4.90
  max=1597
/>

机器人会给您提供前 5-6 个属性。

如果谱面无法下载，机器人会提供 disabled=true 选项。此时，谱面预览会变黑，也不允许玩家直接点击访问谱面页。

您也可以在自己构建一个不存在的谱面（比如已经删除，但是小夜还能下载）时，手动填写 disabled=true。

注意，自行构建时，需要按照 艺术家 - 曲名 ( 谱师 ) [ 难度名 ] 的格式填写。

color 为自定义属性，可以修改这个组件的最左侧颜色，与星级颜色区分开（方便归类谱面）

以下是示例。您可以自行尝试。

4.91268419Shadow CorpsYousei Teikoku // Lune Hivernale[Insane]osu!standard
<Beatmap
  bid=1268419
  sid=600246
  preview="Yousei Teikoku - Shadow Corps (Lune Hivernale) [Insane]"
  star=4.90
  max=1597
  disabled=true
  color="#92e"
/>

展示谱面集

可以使用指令 !gy 快速获取。

参数可以填多个谱面编号 (SID)，可以按逗号分隔，数量如果多于 5 个，则会打包成文件发送。

以下是需要写在文档里的属性和示例：

7.1s2260829Fragrance (XinBai-HW Remix)Tsukasa (Arte Refact) // MeAqua teteosu!standard
<Beatmap
  sid=2260829
  preview="Tsukasa (Arte Refact) - Fragrance (XinBai-HW Remix) (MeAqua tete)"
  star=7.13
  difficulties=[2.44,3.84,4.68,5.73,7.08,7.13]
/>

机器人会给您提供前 4 个属性。

前面提到的附加属性 disabled 和 color 也能用。

展示玩家

可以使用指令 !gu 快速获取。

参数可以填单个玩家名，或 id=...，或 @。

以下是需要写在文档里的属性和示例：

avatarcountry flag#6570CN#0Sayori_yui98.41% Lv.101(41%) 7532PP
<Player 
  id=7183040
  name="Sayori_yui"
  country=0
  global=6570
  from="CN"
  accuracy=98.41
  level=101
  progress=41
  performance=7532
/>

展示成绩

可以使用指令 !gx 快速生成。

参数需要填写 1-5 个：谱面编号 (BID)、准确率 (0-10000)、连击数、评级 (SS-D)、表现分 (PP)。

以下是需要写在文档里的属性和示例：

727PP7.2658127Blue Zenithxi // Asphyxia[FOUR DIMENSIONS] - 99.06% 2364x/2402x
<Score
  bid=658127
  sid=292301
  preview="xi - Blue Zenith (Asphyxia) [FOUR DIMENSIONS]"
  star=7.17
  max=2402
  mode="o"
  accuracy=99.06
  combo=2364
  rank="a"
  performance=727
/>

如果对应的成绩没有可用的表现分，可以在 performance 的位置填入 "..." 的字符串，PP 字样会自动消失。

许可声明

除非另有说明，本站内容采用 CC BY-NC-SA 4.0 协议授权。 提交贡献即表示您同意将内容置于相同协议之下。