Skip to content

Commit 47a3060

Browse files
committed
docs: improve expression
1 parent e05273e commit 47a3060

File tree

4 files changed

+85
-47
lines changed

4 files changed

+85
-47
lines changed

docs/.vitepress/config.mts

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ export default defineConfig({
88
themeConfig: {
99
// https://vitepress.dev/reference/default-theme-config
1010
nav: [
11-
{ text: '主页', link: '/' },
12-
{ text: '手册', link: '/implementation' },
11+
{ text: '快速开始', link: '/' },
1312
{ text: '博客', link: 'https://turou.fun/' },
1413
{ text: '❤️', link: 'https://afdian.com/a/turou' },
1514
],
@@ -18,20 +17,20 @@ export default defineConfig({
1817
{
1918
text: '介绍',
2019
items: [
21-
{ text: '安装', link: '/begin' },
20+
{ text: '快速开始', link: '/begin' },
2221
],
2322
},
2423
{
25-
text: '代理',
24+
text: '受支持的代理',
2625
items: [
27-
{ text: 'Clash', link: '/proxies/clash' },
26+
{ text: 'Clash / Mihomo', link: '/proxies/clash' },
2827
{ text: 'Shadowrocket', link: '/proxies/rocket' },
2928
{ text: 'Sing-box', link: '/proxies/singbox' },
3029
{ text: 'Quantumult X', link: '/proxies/quantx' },
3130
],
3231
},
3332
{
34-
text: '手册',
33+
text: '开发者手册',
3534
items: [
3635
{ text: '实现方式', link: '/implementation' },
3736
{ text: '参与开发', link: '/development' },

docs/begin.md

Lines changed: 43 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,38 +16,64 @@ DXPass 是**日服限定**的,可以在制卡机上制作的具有特殊功能
1616

1717
安装 UsagiPass 需要你具有一定的动手能力,下面我们将逐步讲解如何安装 UsagiPass:
1818

19-
1. 安装代理软件,UsagiPass 需要代理才能运行,如果你不清楚什么是代理,请点击下方推荐方式即可:
20-
- 安卓:[**Clash(推荐)**](https://dxpass.turou.fun/proxies/clash.html)[Sing-box](https://dxpass.turou.fun/proxies/singbox.html)
21-
- iOS:[**Shadowrocket(推荐)**](https://dxpass.turou.fun/proxies/rocket.html)[Sing-box](https://dxpass.turou.fun/proxies/singbox.html)[QuantX](https://dxpass.turou.fun/proxies/quantx.html)
22-
2. 启动代理软件:UsagiPass 需要代理才能运行,请确保你的代理已经运行在手机后台;
23-
3.**微信 -> 舞萌|中二公众号**中正常打开**登入二维码**,你应该已经跳转到 UsagiPass 的登录界面;
24-
4. 使用水鱼或落雪查分器账号进行登录,登录后即可进入 UsagiPass 主页,享受可登录的国服 DXPass 功能。
25-
26-
::: tip
27-
UsagiPass 利用代理来重定向华立二维码网页,请保证在使用过程中代理不要关闭。
19+
### 第一步:安装 CA 证书
20+
21+
UsagiPass 需要代理 HTTPS 流量以实现二维码页面的替换功能,故需要安装 CA 证书。
22+
23+
::: details 安卓设备
24+
下载 [https://up.turou.fun/ca.pem](https://up.turou.fun/ca.pem) 并安装。
25+
:::
26+
27+
::: details iOS 设备
28+
下载 [https://up.turou.fun/ca.pem](https://up.turou.fun/ca.pem) 并安装。
2829
:::
2930

30-
## 使用 UsagiPass
31+
### 第二步:配置代理软件
32+
33+
UsagiPass 需要代理才能运行,请根据你的设备选择合适的代理软件:
34+
35+
::: details 安卓设备
36+
推荐使用 **Mihomo**
3137

32-
登录 UsagiPass 后,将使用默认的个性化配置,点击画面右下方的齿轮图标可以进入设置页面。
38+
1. 下载安装 Mihomo:
39+
- **Github(推荐)**[https://github.com/MetaCubeX/ClashMetaForAndroid/releases](https://github.com/MetaCubeX/ClashMetaForAndroid/releases)
40+
- **蓝奏云(国内)**[https://wwps.lanzouj.com/iXMCk2cydjmd](https://wwps.lanzouj.com/iXMCk2cydjmd)
41+
- 加入 UsagiPass 用户群,在群公告处获取:363346002
3342

34-
在设置中,可以按照喜好调整个性化配置,切换背景、角色、边框等资源,在调整结束后可以点击最下方的保存。
43+
2. 导入 UsagiPass 配置:
44+
- 一键导入:[导入 Clash 配置](clash://install-config?url=https://up.turou.fun/UsagiPass.yaml&name=UsagiPass)
45+
- 复制链接到 Clash 导入:`https://up.turou.fun/UsagiPass.yaml`
46+
- 从群文件获取配置:363346002
47+
:::
48+
49+
::: details iOS 设备
50+
推荐使用 **Singbox**
3551

36-
请初次使用的玩家在设置中粘贴自己的好友代码(可在舞萌DX-好友页面查询)。
52+
1. 切换外区账号,在 AppStore 中搜索 **Singbox VT** 并下载
3753

38-
同时,我们还支持覆盖页面中的部分文本,玩家可以自行尝试相关功能。
54+
2. Profiles -> New Profile -> Name: 随意,Type: Remote,URL: `https://up.turou.fun/UsagiPass.json` -> Create
3955

40-
::: tip
41-
想了解更多 UsagiPass 的功能,可以在左侧的目录(手机用户请点击左上角 Menu 按钮)找到。
56+
3. **确保选择了 UsagiPass 配置,点击启动代理即可生效!**
4257
:::
4358

59+
### 第三步:访问 UsagiPass
60+
61+
1.**微信 -> 舞萌|中二公众号**中正常打开**登入二维码**
62+
2. 你应该已经跳转到 UsagiPass 的登录界面
63+
3. 使用水鱼或落雪查分器账号进行登录
64+
4. 登录后即可进入 UsagiPass 主页,享受可登录的国服 DXPass 功能
65+
4466
## 支持 UsagiPass
4567

4668
如果觉得 UsagiPass 好用的话,不妨给[我们的仓库](https://github.com/TrueRou/UsagiPass)点一个 ⭐ 吧。
4769

4870
我们也开放了爱发电入口,如果你愿意[赞助 UsagiPass](https://afdian.com/a/turou) 我们会在特别感谢中提到你的名字。
4971

50-
## Q&A
72+
## 常见问题
73+
74+
### Q: 打开网页后提示不安全,或者证书无效
75+
76+
A: 请确保你已经正确安装了 UsagiPass 的 CA 证书。
5177

5278
**Q:我不清楚 UsagiPass 的某某功能如何使用**
5379

docs/development.md

Lines changed: 34 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,34 +10,47 @@ UsagiPass 的前后端以及官网均已开源,欢迎提出 Issues 和 PullReq
1010

1111
我们的 GitHub 仓库:https://github.com/TrueRou/UsagiPass
1212

13-
## 配置私人MITM
13+
## 项目部署
1414

15-
UsagiPass 使用 [MITM 中间人](https://developer.mozilla.org/zh-CN/docs/Glossary/MitM)转发并修改来自华立服务器的流量。
15+
### 前置环境
1616

17-
当前版本的 UsagiPass 会修改来自 `wq.sys-all.cn``tgk-wcaime.wahlap.com` 的流量,后者主要用于更新查分器。
17+
- Node.js 18+ 或 Bun 1.0+
18+
- pnpm 包管理器
19+
- **PostgreSQL 15.0+** 数据库
1820

19-
有条件的开发者可以搭建属于自己的代理服务器,可以在降低服务器负载的同时提升安全性。
21+
### 部署方式
2022

21-
### 前置环境
23+
1. **克隆项目并安装依赖**
24+
25+
```bash
26+
git clone https://github.com/TrueRou/UsagiPass.git
27+
cd UsagiPass
28+
pnpm install
29+
```
30+
31+
保证 PostgreSQL 服务已启动,并创建好用于 UsagiPass 的数据库。
32+
33+
2. **配置环境变量**
34+
35+
创建 `.env` 文件,至少配置以下环境变量:
36+
37+
```env
38+
# 数据库配置(请根据实际情况修改:postgresql://用户名:密码@主机:端口/数据库名))
39+
NUXT_USAGIPASS_DATABASE_URL=postgresql://postgres:password@localhost:5432/usagipass
40+
```
41+
42+
3. **启动开发服务器**
2243

23-
- 合适的 Linux 发行版,这里以 Debian 为例
24-
- 能够连接至 GitHub 的网络环境
25-
- Python 3.12+
26-
- MySQL Community Server
44+
```bash
45+
pnpm dev
46+
```
2747

28-
### 搭建方式
48+
访问 `http://localhost:7200` 即可使用。
2949

30-
- 前往对应的查分器网站申请开发者密钥并等待审核通过;
31-
- 在 项目根目录 下创建 `.env` 文件, 可以根据 `.env.example.mitm-only` 模板文件进行配置,别忘了在 `LXNS_DEVELOPER_TOKEN``DIVINGFISH_DEVELOPER_TOKEN` 中填入你申请的开发者密钥;
32-
- 执行 `pip install poetry` 全局安装 Poetry;
33-
- 执行 `poetry install` 安装项目依赖;
34-
- 执行 `poetry run app` 运行后端及代理;
35-
- 执行 `cd web && npm run dev` 运行前端。
50+
### 关于代理
3651

37-
> 更新项目: `git pull && poetry install && poetry run app`
52+
UsagiPass 更新成绩需要配合中间人代理(MITM)使用,在开发环境下,需要使用支持 ClashMeta 规则的代理软件。
3853

39-
::: tip
40-
切记:必须暴露 TCP `2560` 端口,如部署防火墙的请在规则允许 `2560` 端口的外网访问
54+
`pnpm dev` 启动后,默认监听 HTTP 代理 `http://localhost:7300`
4155

42-
端口可以在 `.env` 文件中进行配置
43-
:::
56+
`public/UsagiPassDev.yaml` 导入支持 ClashMeta 规则的代理软件后,启动系统代理即可。

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ hero:
99
tagline: 从零开始美化你的玩家二维码
1010
actions:
1111
- theme: brand
12-
text: 开始使用
12+
text: 快速开始
1313
link: /begin
1414
- theme: alt
15-
text: 手册
15+
text: 开发者手册
1616
link: /implementation
1717
- theme: alt
1818
text:
@@ -22,7 +22,7 @@ hero:
2222

2323
features:
2424
- title: 动态生成
25-
details: 基于水鱼 / 落雪查分器的数据动态生成玩家的 DXPASS,用户个性化数据云端储存。
25+
details: 基于舞萌 NET 的数据动态生成玩家的 DXPASS,用户个性化数据云端储存。
2626
- title: 高度自定义
2727
details: 自定义 DXPASS 背景、外框、角色,支持使用预设素材或个性化上传自己的图片。
2828
- title: 支持登录

0 commit comments

Comments
 (0)