Skip to content

Commit d73440e

Browse files
TrueRouTrueRou
committed
docs: migrate docs
basic str
1 parent cef7510 commit d73440e

11 files changed

Lines changed: 361 additions & 84 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
## 📦 安装使用
2121

22-
查阅 [官网](https://dxpass.turou.fun/) 了解更多，进入 **用户群**：363346002 获取帮助。
22+
查阅 [官网](https://up.turou.fun/) 了解更多，进入 **用户群**：363346002 获取帮助。
2323

2424
## 🛠️ 项目部署
2525

‎app/app.config.ts‎

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,9 @@
11
export default defineAppConfig({
2-
cover: '/cover.jpg',
3-
socials: {
4-
twitter: 'Atinux',
5-
github: 'Atinux/content-wind',
6-
mastodon: '@atinux@webtoo.ls',
7-
bluesky: 'atinux.com',
8-
},
9-
icon: {
10-
aliases: {
11-
'dark-mode': 'lucide-moon',
12-
'light-mode': 'lucide-sun',
2+
cover: '/cover.jpg',
3+
icon: {
4+
aliases: {
5+
'dark-mode': 'lucide-moon',
6+
'light-mode': 'lucide-sun',
7+
},
138
},
14-
},
159
})

‎app/components/banner/account-system.vue‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<div class="bg-base-200/50 rounded-lg px-4 py-3 mb-6">
33
<p class="text-sm text-base-content/70 text-center">
44
UsagiPass 与 兔卡账号 已完成深度融合升级，您将体验更稳定、更精彩的兔兔服务！
5-
<a href="https://up.turou.fun/docs" target="_blank" class="link link-primary text-sm">【查看详情】</a>
5+
<a href="https://up.turou.fun/docs/banner/account-system" target="_blank" class="link link-primary text-sm">【查看详情】</a>
66
</p>
77
</div>
88
</template>

‎app/components/cms/nav-bar.vue‎

Lines changed: 12 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,29 @@
1-
<script setup lang="ts">
2-
const { data: navigation } = await useAsyncData('navigation', () =>
3-
queryCollectionNavigation('content'))
4-
5-
const appConfig = useAppConfig()
6-
</script>
7-
81
<template>
92
<div class="flex justify-between px-4 py-4 mx-auto sm:px-8 max-w-2xl">
103
<!-- Navigation -->
114
<div class="text-gray-700 dark:text-gray-200">
12-
<NuxtLink
13-
v-for="link in navigation"
14-
:key="link.path" class="mr-6"
15-
:to="link.path"
16-
active-class="font-bold"
17-
>
18-
{{ link.title }}
5+
<NuxtLink class="mr-6" to="/docs/manual" active-class="font-bold">
6+
手册
7+
</NuxtLink>
8+
<NuxtLink class="mr-6" to="/docs/advanced" active-class="font-bold">
9+
开发者
10+
</NuxtLink>
11+
<NuxtLink class="mr-6" to="/docs/advanced/privacy-policy" active-class="font-bold">
12+
隐私政策
13+
</NuxtLink>
14+
<NuxtLink class="mr-6" to="/docs/advanced/terms-of-service" active-class="font-bold">
15+
服务条款
1916
</NuxtLink>
2017
</div>
2118
<!-- Social icons & Color Mode -->
2219
<div class="text-gray-500 space-x-3 transition">
2320
<a
24-
v-if="appConfig.socials?.github"
2521
class="dark:text-gray-100 hover:text-gray-700 dark:hover:text-gray-300"
26-
:href="`https://github.com/${appConfig.socials?.github}`"
22+
href="https://github.com/TrueRou/UsagiPass"
2723
title="GitHub"
2824
>
2925
<Icon class="size-5" name="i-simple-icons-github" />
3026
</a>
31-
<a
32-
v-if="appConfig.socials?.mastodon"
33-
class="dark:text-gray-100 hover:text-gray-700 dark:hover:text-gray-300"
34-
:href="`https://elk.zone/${appConfig.socials?.mastodon}`" title="Mastodon"
35-
>
36-
<Icon class="size-5" name="i-simple-icons-mastodon" />
37-
</a>
38-
<a
39-
v-if="appConfig.socials?.bluesky"
40-
class="dark:text-gray-100 hover:text-gray-700 dark:hover:text-gray-300"
41-
:href="`https://bsky.app/profile/${appConfig.socials?.bluesky}`" title="Bluesky"
42-
>
43-
<Icon class="size-5" name="i-simple-icons-bluesky" />
44-
</a>
4527
</div>
4628
</div>
4729
</template>

‎app/pages/docs/index.vue‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ function handleImageError(event: Event) {
2222
从零开始美化你的玩家二维码
2323
</p>
2424
<div class="hero-actions">
25-
<NuxtLink to="/begin" class="btn btn-primary">
25+
<NuxtLink to="/docs" class="btn btn-primary">
2626
<Icon name="heroicons:rocket-launch" class="btn-icon" />
2727
开始使用
2828
</NuxtLink>
29-
<NuxtLink to="/implementation" class="btn btn-secondary">
29+
<NuxtLink to="/docs#实现原理" class="btn btn-secondary">
3030
<Icon name="heroicons:book-open" class="btn-icon" />
3131
查看手册
3232
</NuxtLink>

‎content/docs/advanced/index.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
navigation:
3+
title: 高级内容
4+
seo:
5+
title: UsagiPass 实现原理与开发指南
6+
description: UsagiPass 实现原理与开发指南
7+
---
8+
9+
# UsagiPass 高级内容
10+
11+
本页面包含 UsagiPass 的实现原理，开发指南等相关内容。
12+
13+
## 目录
14+
15+
- [参与开发](#参与开发) - UsagiPass 开源仓库
16+
- [实现原理](#实现原理) - UsagiPass 的设计思路
17+
18+
## 参与开发
19+
20+
UsagiPass 的前后端以及官网均已开源，欢迎提出 Issues 和 PullRequests。
21+
22+
我们的 GitHub 仓库：[https://github.com/TrueRou/UsagiPass](https://github.com/TrueRou/UsagiPass)
23+
24+
## 实现原理
25+
26+
### 华立的设计
27+
28+
当点击公众号的玩家二维码后，**公众号后台**将玩家 ID 和过期时间以一定形式编码成 SGWCMAID。
29+
30+
公众号返回一个 `wq.sys-all.cn` 的网页，查询参数中包含 SGWCMAID，网页根据 SGWCMAID，显示对应的二维码图片和简陋的扫码界面。
31+
32+
舞萌 DX 识别二维码，解析出 SGWCMAID，SGWCMAID 配合机台信息和密钥，向后端请求得到玩家 ID。
33+
34+
> 因为 SGWCMAID 在微信公众号后台生成，对于我们来说属于黑箱，且无法从玩家 ID 逆向得到 SGWCMAID。故印制实体卡片，或者利用单片机实现算号登录的操作在当前情况下是没有可行性的。
35+
36+
### 我们的设计
37+
38+
通过代理替换 `sys-all.cn` 网页，将请求重定向到 `up.turou.fun`，在2025年12月更新后，`sys-all.cn` 网页开始使用 HTTPS，所以我们需要安装 CA 证书以实现 HTTPS 代理。
39+
40+
通过代理重定向时携带原网页中的查询参数（SGWCMAID），在**前端**以 JS 的方式直接绘制出二维码。
41+
42+
> UsagiPass 前后端代码在 GitHub 开源：[https://github.com/TrueRou/UsagiPass](https://github.com/TrueRou/UsagiPass)

‎content/docs/advanced/privacy-policy.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
navigation:
3+
title: 隐私政策
4+
seo:
5+
title: UsagiPass 隐私政策
6+
description: UsagiPass 隐私政策
7+
---
8+
9+
# 隐私政策
10+
11+
> 最后更新日期：2025/12/28
12+
13+
若要使用 UsagiPass 和 UsagiCard（以下简称本网站）的服务，请您务必仔细阅读并透彻理解本声明。
14+
15+
请注意，访问和使用本网站，您的使用行为将被视为对本声明全部内容的认可。如果您不同意本声明的任何内容，请您立即停止使用本网站。
16+
17+
## 定义
18+
19+
- **UsagiPass** 指基于水鱼/落雪查分器的数据动态生成玩家的 DXPASS 相关服务。
20+
- **UsagiCard** 指样式类似 DXPASS 的实体卡片以及围绕卡片提供的相关服务。
21+
- **本网站** 指 UsagiPass 和 UsagiCard。
22+
- **我们** 指本网站的运营者 [兔肉](https://github.com/TrueRou)。
23+
- **您** 指使用本网站的用户。
24+
- **舞萌DX** 是由 SEGA 发行的音乐游戏。
25+
- **游戏数据** 指您在上述游戏中产生的数据，包括但不限于您的好友码、玩家信息、玩家收藏品、游玩成绩等。
26+
27+
## 信息收集
28+
29+
- 您使用本网站时，我们会收集您的 IP 地址、浏览器信息、操作系统信息、访问时间等信息。
30+
- 您使用本网站提供的舞萌DX 游戏数据爬取服务时，我们会收集您的游戏数据。
31+
32+
## 信息使用
33+
34+
- UsagiPass **明文保存**您提供的水鱼用户名、水鱼上传密钥、落雪个人密钥，用于提供身份认证和更新查分器服务。
35+
- UsagiPass **不会收集**与您二维码相关的任何信息，不会持久化保存您的任何成绩数据，CA 证书仅用于必要的 HTTPS 流量的代理功能。
36+
- UsagiCard **加密保存**您提供的舞萌DX机台用户信息，用于提供实体卡片的相关服务。
37+
- 本网站收集的信息仅用于提供本网站的服务，不会用于任何其他用途。
38+
39+
## 条款修改
40+
41+
- 本条款是您在本网站签署的使用协议的组成部分之一，请您仔细阅读。
42+
- 当条款发生变更时，我们会在本页面上发布通知。如果您在条款修改后继续使用本网站提供的服务，即表示您同意并接受修改后的条款。
43+
- 我们保留对本条款作出不定时修改的权利。
44+
- 我们对本页面内容拥有最终解释权。

‎content/docs/advanced/terms-of-service.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
navigation:
3+
title: 服务条款
4+
seo:
5+
title: UsagiPass 服务条款
6+
description: UsagiPass 服务条款
7+
---
8+
9+
# 服务条款
10+
11+
> 最后更新日期：2025/12/28
12+
13+
若要使用 UsagiPass 和 UsagiCard（以下简称本网站）的服务，请您务必仔细阅读并透彻理解本声明。
14+
15+
请注意，访问和使用本网站，您的使用行为将被视为对本声明全部内容的认可。如果您不同意本声明的任何内容，请您立即停止使用本网站。
16+
17+
## 服务内容
18+
19+
- **UsagiPass** 提供的服务内容包括但不限于：
20+
- 代理 "舞萌 ｜ 中二" 公众号登入二维码网页，为您提供更美观的页面服务。
21+
- 代理 "舞萌 ｜ 中二" 公众号我的记录网页，为您提供舞萌DX 游戏数据爬取等服务。
22+
- 使用您的水鱼用户名、水鱼上传密钥、落雪个人密钥进行鉴权，为您提供更新查分器等服务。
23+
24+
- **UsagiCard** 提供的服务内容包括但不限于：
25+
- 印制样式类似 DXPASS 的实体卡片，为您提供实体卡片的相关服务。
26+
- 通过您提供的二维码，获取您的机台用户信息，为您提供舞萌DX 游戏数据爬取、查询等服务。
27+
28+
- 本网站提供的服务仅供个人学习、研究或欣赏使用，您不得将本网站提供的服务用于商业用途。
29+
- 本网站提供的服务内容可能会随时变更，本网站不承诺对用户提供任何形式的通知。
30+
31+
## 特别声明
32+
33+
- UsagiPass 与 UsagiCard 为本网站提供的两个相对独立的服务，与 SEGA 公司无关。
34+
- UsagiPass 与 UsagiCard 之间的数据不会相互共享，您在 UsagiPass 的数据不会被 UsagiCard 访问，反之亦然。
35+
- 原则上 UsagiCard 仅作为礼品赠送，属于非卖品，我们不提供任何形式的售卖服务，拒绝任何形式的商业用途。
36+
- 您有权在任何时候删除您在本网站的数据，我们会在收到您的删除请求后立即永久删除您的相关数据。
37+
38+
## 用户行为
39+
40+
- 您在使用本网站提供的服务时，应遵守中华人民共和国相关法律法规，不得利用本网站提供的服务从事任何违法违规行为。
41+
- 您不得利用本网站提供的服务干扰本网站的正常运行，包括但不限于利用本网站提供的服务对本网站的服务器进行攻击、利用本网站提供的服务对本网站的数据进行篡改等。
42+
- 对于任何违反上述协议的行为，本网站有权采取措施，包括但不限于限制、禁止您使用本网站提供的服务。
43+
44+
## 免责声明
45+
46+
您已知晓并同意，您使用本网站提供的服务存在违反[《舞萌&中二 游戏条款》](http://wc.wahlap.net/sega/music/terms/index.html)的风险，本网站不对您使用本网站提供的服务所产生的后果承担任何责任。
47+
48+
## 条款修改
49+
50+
- 本条款是您在本网站签署的使用协议的组成部分之一，请您仔细阅读。
51+
- 当条款发生变更时，我们会在本页面上发布通知。如果您在条款修改后继续使用本网站提供的服务，即表示您同意并接受修改后的条款。
52+
- 我们保留对本条款作出不定时修改的权利。
53+
- 我们对本页面内容拥有最终解释权。

‎content/docs/banner/account-system.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
seo:
3+
title: 账号迁移说明
4+
description: UsagiPass 与 兔卡账号迁移至 UsagiLab 平台的详细说明
5+
---
6+
7+
# 账号迁移说明
8+
9+
UsagiPass 与 兔卡账号 已完成深度融合升级，现统一更名为 UsagiLab 账号。
10+
11+
1. 原 UsagiCard 账号直接变为 UsagiLab 账号，可以直接使用原用户名和密码登录。上传过的图片将被正常保留。
12+
2. 原 UsagiPass 账号也会变成 UsagiLab 账号，但是初次只能使用水鱼或者落雪登录，第一次登录后，将要求您重新设置用户名、邮箱和密码。设置完成后，可以通过三种方式登录（用户名密码、水鱼、落雪）。上传过的图片、个性化设置、绑定的查分器账号将被正常保留。
13+
3. 考虑到部分用户可能同时使用过这两个平台，为了防止多账号带来的不便，我们添加了账号合并功能。任意登录一个账号后，进入设置，点击头像后方的三个点进入菜单，选择账号合并即可。
14+
15+
> 关于账号合并的更多信息，请进入账号合并页面查看详细说明。

‎content/docs/index.md‎

Lines changed: 0 additions & 38 deletions
This file was deleted.

0 commit comments

Comments
 (0)