Skip to content

Commit 2518fdb

Browse files
committed
docs: 更新README
1 parent cfda19b commit 2518fdb

3 files changed

Lines changed: 97 additions & 149 deletions

File tree

README.en.md

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

README.md

Lines changed: 12 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -1,87 +1,14 @@
11
# ChuChartManager
22

3-
[简体中文](README.md) | [English](README.en.md)
4-
5-
CHUNITHM 谱面与资源管理工具
6-
7-
## 功能
8-
9-
### 谱面管理
10-
11-
- 浏览本地谱面列表,按 ID / 名称排序,按流派 / 难度筛选
12-
- 修改谱面基础信息(曲名、曲师、流派、等级、谱面设计)
13-
- 谱面导入 / 导出(C2S / UGC 格式互转)
14-
- 封面导入、BGM 导出 MP3
15-
- 批量操作(修改属性、导出封面 / 音频)
16-
17-
### 资源管理
18-
19-
- 创建自定义资源(称号、名牌、角色、地图图标、衣装、系统语音)
20-
- 资源浏览器(称号、名牌、边框、角色、衣装、系统语音、舞台背景)
21-
- 资源 ID 冲突检测
22-
23-
### 活动与地图
24-
25-
- 活动 / 地图浏览与编辑,创建自定义活动与地图
26-
- 地图背景 DDS 导入 / 替换,活动广告图导入 / 替换
27-
28-
### 其他
29-
30-
- 段位认定课程编辑
31-
- 登录奖励编辑
32-
- DDS 纹理提取(从 AFB / SVO 文件)
33-
- E-mote 模型 WebGL 预览
34-
- Option 目录管理(创建、导入、删除、自制谱标记)
35-
- 多语言(中文 / English / 日本語)
36-
- 远程模式(局域网访问)
37-
38-
## 项目结构
39-
40-
| 目录 | 说明 |
41-
|------|------|
42-
| `ChuChartManager/` | WinForms (.NET 10) 主程序 + ASP.NET Core 后端 |
43-
| `ChuChartManager/Front/` | Vue 3 + TypeScript 前端(Vite + UnoCSS + MuNET-UI) |
44-
| `ChuChartManager.CLI/` | 命令行工具 |
45-
46-
### 子模块
47-
48-
| 子模块 | 说明 |
49-
|--------|------|
50-
| `MuNET-UI` | UI 组件库 |
51-
| `MuConvert` | 谱面格式转换库 |
52-
| `SonicAudioTools` | CRIWARE 音频处理库 |
53-
| `XV2-Tools` | ACB/AWB 音频工具 |
54-
| `DDSExtractor` | DDS 纹理提取库 |
55-
| `FreeMote` | E-mote PSB 工具链 |
56-
| `FreeMote-SDK` | E-mote WebGL 驱动 |
57-
58-
## 构建
59-
60-
需要:
61-
- .NET 10 SDK
62-
- Node.js 18+、pnpm
63-
- .NET Framework 4.8.1 Targeting Pack(SonicAudioTools 依赖)
64-
65-
```bash
66-
# 初始化子模块
67-
git submodule update --init --recursive
68-
69-
# 构建前端
70-
cd ChuChartManager/Front
71-
pnpm install
72-
pnpm build
73-
74-
# 构建后端
75-
cd ../..
76-
dotnet build ChuChartManager.slnx
77-
78-
# 编译 FreeMote 工具链
79-
dotnet build FreeMote/FreeMote.Tools.PsbDecompile -c Release
80-
dotnet build FreeMote/FreeMote.Tools.PsBuild -c Release
81-
```
82-
83-
## 致谢
84-
85-
- [MuNET-UI](https://github.com/MuNET-OSS/MuNET-UI) — UI 组件库
86-
- [FreeMote](https://github.com/UlyssesWu/FreeMote) — E-mote PSB 工具链
87-
- [DDSExtractor](https://github.com/XNTech/DDSExtractor) — DDS 纹理提取库
3+
中二节奏谱面管理工具
4+
5+
## 目前已经实现的功能
6+
7+
- [x] 浏览本地谱面列表
8+
- [x] 修改谱面基础信息
9+
- [x] 导出谱面(C2S/UGC/SUS 互转)
10+
- [x] 封面导入、BGM 导出 MP3
11+
- [x] 创建自定义资源(称号、名牌、角色、地图图标、衣装、系统语音)
12+
- [x] 谱面格式转换(C2S ↔ UGC ↔ SUS)
13+
- [ ] 导入自制谱
14+
- [ ] 导出谱面ZIP

README.zh.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# ChuChartManager
2+
3+
CHUNITHM 谱面与资源管理工具
4+
5+
## 功能
6+
7+
### 谱面管理
8+
9+
- 浏览本地谱面列表,按 ID / 名称排序,按流派 / 难度筛选
10+
- 修改谱面基础信息(曲名、曲师、流派、等级、谱面设计)
11+
- 谱面导入 / 导出(C2S / UGC 格式互转)
12+
- 封面导入、BGM 导出 MP3
13+
- 批量操作(修改属性、导出封面 / 音频)
14+
15+
### 资源管理
16+
17+
- 创建自定义资源(称号、名牌、角色、地图图标、衣装、系统语音)
18+
- 资源浏览器(称号、名牌、边框、角色、衣装、系统语音、舞台背景)
19+
- 资源 ID 冲突检测
20+
21+
### 活动与地图
22+
23+
- 活动 / 地图浏览与编辑,创建自定义活动与地图
24+
- 地图背景 DDS 导入 / 替换,活动广告图导入 / 替换
25+
26+
### 其他
27+
28+
- 段位认定课程编辑
29+
- 登录奖励编辑
30+
- DDS 纹理提取(从 AFB / SVO 文件)
31+
- E-mote 模型 WebGL 预览
32+
- Option 目录管理(创建、导入、删除、自制谱标记)
33+
- 多语言(中文 / English / 日本語)
34+
- 远程模式(局域网访问)
35+
36+
## 项目结构
37+
38+
| 目录 | 说明 |
39+
|------|------|
40+
| `ChuChartManager/` | WinForms (.NET 10) 主程序 + ASP.NET Core 后端 |
41+
| `ChuChartManager/Front/` | Vue 3 + TypeScript 前端(Vite + UnoCSS + MuNET-UI) |
42+
| `ChuChartManager.CLI/` | 命令行工具 |
43+
44+
### 子模块
45+
46+
| 子模块 | 说明 |
47+
|--------|------|
48+
| `MuNET-UI` | UI 组件库 |
49+
| `MuConvert` | 谱面格式转换库 |
50+
| `SonicAudioTools` | CRIWARE 音频处理库 |
51+
| `XV2-Tools` | ACB/AWB 音频工具 |
52+
| `DDSExtractor` | DDS 纹理提取库 |
53+
| `FreeMote` | E-mote PSB 工具链 |
54+
| `FreeMote-SDK` | E-mote WebGL 驱动 |
55+
56+
## 构建
57+
58+
需要:
59+
- .NET 10 SDK
60+
- Node.js 18+、pnpm
61+
- .NET Framework 4.8.1 Targeting Pack(SonicAudioTools 依赖)
62+
63+
```bash
64+
# 初始化子模块
65+
git submodule update --init --recursive
66+
67+
# 构建前端
68+
cd ChuChartManager/Front
69+
pnpm install
70+
pnpm build
71+
72+
# 构建后端
73+
cd ../..
74+
dotnet build ChuChartManager.slnx
75+
76+
# 编译 FreeMote 工具链
77+
dotnet build FreeMote/FreeMote.Tools.PsbDecompile -c Release
78+
dotnet build FreeMote/FreeMote.Tools.PsBuild -c Release
79+
```
80+
81+
## 致谢
82+
83+
- [MuNET-UI](https://github.com/MuNET-OSS/MuNET-UI) — UI 组件库
84+
- [FreeMote](https://github.com/UlyssesWu/FreeMote) — E-mote PSB 工具链
85+
- [DDSExtractor](https://github.com/XNTech/DDSExtractor) — DDS 纹理提取库

0 commit comments

Comments
 (0)