Skip to content

Commit d0392e5

Browse files
authored
Merge pull request #7 from Momoko-Ayase/main
docs: Update
2 parents 1bdbcab + 26499d1 commit d0392e5

File tree

9 files changed

+103
-48
lines changed

9 files changed

+103
-48
lines changed

src/content/docs/general/community.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ title: About Community & Releases
33
description: Join the KanadeDX community and get help from other players.
44
---
55

6-
There is a discord server and a Telegram group chat for KanadeDX. Release files will be published on these platforms.
6+
There is a Discord server and a Telegram group chat for KanadeDX. Release files will be published on these platforms.
77

8-
However, from 2025 February 27, they are set to invite-only to control the rapid growth of the community and to avoid unwanted attention.
8+
However, from February 27, 2025, they are set to invite-only to control the rapid growth of the community and to avoid unwanted attention.
99

1010
If you want to join, please find someone who is already in the group and ask for an invite link.
1111

src/content/docs/general/issues.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,21 @@ description: Troubleshooting common issues and bugs.
55

66
If you are experiencing issues with the game, please check the following list of common issues and solutions. If you are unable to find a solution to your problem, please ask for help in the [Discord Server](https://kdx.nightcord.com.de/general/community) or [Telegram Group](https://kdx.nightcord.com.de/general/community).
77

8-
## Known Issues
8+
<!--
9+
## Known Issues (waiting to be updated)
910
1011
Below are some existing issues that are currently being worked on:
1112
1213
1. Importing assets other than A000 cause a black screen.
1314
2. Some areas may cause the game to crash.
1415
3. Camera may crash on some devices (You can disable camera permissions for now).
16+
-->
1517

1618
## Frequently Asked Questions
1719

18-
**Q: It says dummy.dat, DX_title.dat, or KALEID_BG_240412.dat is missing**
20+
**Q: It says dummy.dat, or KALEID_BG_240412.dat is missing**
1921

20-
> A: These files are part of the NoVideo torrent. If you are using your own assets and want to delete MovieData, you need to make sure these three files are preserved. If you already transferred the other files, please copy these three files from the NoVideo torrent to the `StreamingAssets/A000/MovieData` folder.
22+
> A: These files are part of the essential data for the game to run normally. If you are using your own assets and want to delete MovieData, you need to make sure these files are preserved. If you already transferred the other files, please copy these files to the `StreamingAssets/A000/MovieData` folder.
2123
2224
**Q: It says `tree.csv` is missing.**
2325

@@ -31,20 +33,16 @@ Below are some existing issues that are currently being worked on:
3133

3234
> A: Disable camera permissions by going into Settings > Apps and Notifications (or Apps, depending on your device maker and ROM) > searching "KanadeDX" and going to "Permissions". Set the Camera permissions to "Don't allow".
3335
34-
**Q: On iOS devices, if I go to a specific area/song/character, it crashes!**
35-
36-
> A: This issue is slowly being resolved and seems to only be a problem on iOS. Try avoiding whatever is making your game crash, or check if you added any unlock flags on your profile that you shouldn't have in AquaDX or your chosen server.
37-
3836
**Q: If I've originally installed the "NoVideo" version of the assets, would it damage anything if I installed the video data over it?**
3937

4038
> A: This isn't particularly tested yet, but it is recommended to redownload from Miniserve (MAKE SURE YOU HAVE ENOUGH FREE SPACE!) to prevent any data corruption. Make sure to also reinitialize your assets for KanadeDX to use in the settings menu.
4139
4240
**Q: How do I change my keychip to save my gameplay on leaderboards?**
4341

44-
> KanadeDX uses a placeholder/dummy keychip to make the game boot with basic necessities and not save any play data, so once you have registered for AquaDX (https://aquadx.net/), go to "Setup Connection", confirm, and copy the keychip number listed (should be something like A###-###########, with the hashtags being randomized numbers or letters.)
45-
>
42+
> KanadeDX uses a placeholder/dummy keychip to make the game boot with basic necessities and not save any play data, so once you have registered for [AquaDX](https://aquadx.net/), go to "Setup Connection", confirm, and copy the keychip number listed (should be something like A###-###########, with the hashtags being randomized numbers or letters.)
43+
>
4644
> Then, go back to KanadeDX, click the gear icon, and scroll down to "Keychip" (or SeriID in older versions) and paste your keychip ID there.
47-
>
45+
>
4846
> DO NOT SHARE YOUR KEYCHIP (or card number) WITH OTHERS! IT IS FOR YOURSELF ONLY AND MAY LEAD TO DAMAGES OR TAMPERED SCORES IF SHARED.
4947
5048
**Q: How do I rotate the game to Portrait orientation for phones?**

src/content/docs/general/update.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,33 @@ The game adds new content through OPT or option updates. These updates will be r
77

88
Before release version 250228.1208, only the base game (A000) was supported. However, support for other option updates was added in this version.
99

10-
Please note that only official updates are tested. They are: A000 (base game), A005, A011, A021.
10+
Please note that only official updates are tested. They are: A000 (base game), A005, A011, A021, A022.
11+
12+
If you are still playing the old versions, please do not merge the contents of the update files directly into A000, as this will cause the game to load data abnormally.
1113

1214
## Adding Options
1315

1416
To add an option, you can follow these steps:
1517

18+
### Directly update on device
19+
1620
1. Download the option archive on your mobile device.
17-
2. Unzip the archive and copy the Axxx folder to the `StreamingAssets` folder, next to A000.
21+
2. Unzip the archive and copy the Axxx folder to the `StreamingAssets` folder, next to A000.
1822
* Android: `/sdcard/Android/data/app.KanadeDX/files/KanadeDX/StreamingAssets`.
1923
* iOS: Files app > On My iPad > KanadeDX > StreamingAssets.
2024
3. Open KanadeDX version 250228.1208 or later.
2125
4. Before entering, click on the settings icon in the top right corner.
22-
5. Scroll down, click on "Manually reinitialize all AssetBundles," and start convert.
26+
5. Scroll down, click on "Manually reinitialize all AssetBundles", and start converting.
27+
28+
### Update through PC
29+
30+
1. Download the option archive on your computer.
31+
2. Unzip the archive and copy the Axxx folder to an empty folder, and place the Miniserve executable and [this Python script](/misc/scripts/tree.py) in the same directory.
32+
3. Run `python tree.py` in the command line, it will generate a `tree.csv` file in the current directory.
33+
4. Start Miniserve.
34+
5. Open KanadeDX version 250228.1208 or later.
35+
6. Click on the settings icon in the top right corner, scroll down, and click on "Manually re-download the resources".
36+
7. Enter the Miniserve URL and start downloading.
37+
8. After the download is complete, restart KanadeDX, go back to settings, click on "Manually reinitialize all AssetBundles", and start converting.
2338

2439
> If you are updating from an older version of KanadeDX, this process will recheck all asset bundles in A000 as well. However, this is a one-time process, future updates will no longer process files that have been processed before.

src/content/docs/start/install.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Please make sure your device meets the minimal requirements. You can check the "
1919

2020
## 2. Installing
2121

22-
### Android 🐸
22+
### Android 🤖
2323

2424
Just open the apk and click install.
2525

@@ -34,7 +34,7 @@ Since iOS does not want you to easily sideload apps, and I don't have spare $99/
3434

3535
There are many ways to sideload apps: TrollStore, AltStore/SideStore, and Sideloadly.
3636

37-
- **TrollStore** only work on iOS 14.0 beta 2 - 16.6.1, 16.7 RC (20H18), and 17.0, but it works very well when it does work. Apps are permanently signed in TrollStore while other options need to be refreshed every week. If your iOS version is supported, definitely try TrollStore first.
37+
- [**TrollStore**](https://github.com/opa334/TrollStore) only work on iOS 14.0 beta 2 - 16.6.1, 16.7 RC (20H18), and 17.0, but it works very well when it does work. Apps are permanently signed in TrollStore while other options need to be refreshed every week. If your iOS version is supported, definitely try TrollStore first.
3838
- **AltStore/SideStore** has a better-looking UI and is more convenient to refresh apps.
3939
- AltStore uses LAN network, while SideStore connects through a VPN
4040
- **Sideloadly** is more advanced and direct, has more features, but less convenient.
@@ -49,6 +49,6 @@ There are many ways to sideload apps: TrollStore, AltStore/SideStore, and Sidelo
4949

5050
1. Follow the guide on [Sideloadly](https://sideloadly.io/) to install the ipa from your computer.
5151

52-
Note that the sideloaded app is only valid for 7 days, so you will have to connect to your computer again to refresh the app every week.
53-
52+
Note that the sideloaded app with a free account is only valid for 7 days, so you will have to connect to your computer again (for AltStore or Sideloadly) / connect to VPN (for SideStore) to refresh the app every week.
5453

54+
If you have a paid developer account, you can use it to sign the app and it will be valid for 1 year. You may just need to resign when a new version is released.

src/content/docs/start/setup.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The game assets are separate from the program itself. After you downloaded the t
1313

1414
### Option A: Transferring via Miniserve
1515

16-
1. Start miniserve in StreamingAssets
16+
1. **Start miniserve in `StreamingAssets`**
1717
- **Windows**: Click on `StreamingAssets/miniserve.exe` and wait 3s.
1818
- **Mac**: Download the correct file from [GitHub Releases](https://github.com/svenstaro/miniserve/releases/tag/v0.29.0) depending on your system:
1919
- "aarch64-apple-darwin" if you have a M-series CPU.
@@ -25,9 +25,9 @@ The game assets are separate from the program itself. After you downloaded the t
2525
chmod +x ./miniserve* && ./miniserve* .
2626
```
2727

28-
- **Linux**: [You know what to do.](https://www.youtube.com/watch?v=FOrineGipnw)
29-
2. Enter the download url in game. It should look something like `http://192.168.1.123:8080`. You can find the ip address of your computer in wifi settings. (This is not the same as your public IP address, and it will most likely start with either `192.168` or `10.0`).
30-
3. Click download.
28+
- **Linux**: [You know what to do 😉.](https://www.youtube.com/watch?v=FOrineGipnw)
29+
2. **Enter the download url in game.** It should look something like `http://192.168.1.123:8080`. You can find the ip address of your computer in wifi settings. (This is not the same as your public IP address, and it will most likely start with either `192.168` or `10.0`).
30+
3. **Click download.**
3131

3232
> **Note**: If miniserve show multiple IP addresses, you should try each of them on your phone/tablet browser until you find the correct one. There should only be one IP address that works.
3333
>
@@ -65,13 +65,13 @@ Please only try this option if miniserve does not work for you. Do note that wir
6565

6666
## 3. Game Settings
6767

68-
You can adjust game settings by holding the start ▶️ button on the top right.
68+
You can adjust game settings by holding the  button on the top right.
6969

7070
**Latency**
7171

72-
- The default input latency is +1 frame, which matches the official cab. If you consistently have more LATE notes than EARLY notes, you can reduce it to 0.
72+
- The default input latency is **+1 frame**, which matches the official cab. If you consistently have more LATE notes than EARLY notes, you can reduce it to 0.
7373

7474
**Network**
7575

76-
- KanadeDX by default is connected to the AquaDX network. There is a default keychip included in the build, but accounts registered on that keychip will be hidden from the leaderboard.
77-
- If you want to see your scores, go to [https://aquadx.net](https://aquadx.net/) and register an account and obtain your keychip in the "Setup Connection" menu. Then, go to settings before entering the game and replace the default keychip with your keychip. Finally, you can click the AIME button to scan your virtual card and this will register your game profile with the server.
76+
- **KanadeDX** by default is connected to the **AquaDX network**. There is a default keychip included in the build, but accounts registered on that keychip will be hidden from the leaderboard.
77+
- If you want to see your scores, go to [https://aquadx.net](https://aquadx.net/) and register an account and obtain your keychip in the **"Setup Connection"** menu. Then, go to settings before entering the game and replace the default keychip with your keychip. Finally, you can click the **AIME button** to scan your virtual card and this will register your game profile with the server.

src/content/docs/zh/general/issues.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ description: 解决常见问题和错误的指南
55

66
如果您在游戏中遇到问题,请查看以下常见问题及其解决方案。如果仍无法解决您的问题,请在 [Discord 服务器](https://kdx.nightcord.com.de/zh/general/community)[Telegram 群组](https://kdx.nightcord.com.de/zh/general/community) 中寻求帮助。
77

8-
## 已知问题
8+
<!--
9+
## 已知问题 (等待更新)
910
1011
以下是一些正在修复的已知问题:
1112
@@ -17,12 +18,13 @@ description: 解决常见问题和错误的指南
1718
1819
1. 某些音乐音效消失问题
1920
(例如请不要大力拍打提示界面的音效,结束游戏的背景音乐,友人对战开始的音效)。
21+
-->
2022

2123
## 常见问题解答 (FAQ)
2224

23-
**:它说缺少 dummy.dat、DX_title.dat 或 KALEID_BG_240412.dat***
25+
**Q:它说缺少 dummy.dat 或 KALEID_BG_240412.dat**
2426

25-
> 答:这些文件是 NoVideo 数据的一部分。如果您使用自己的资产并想删除 MovieData,您需要确保保留这三个文件。如果您已经传输了其他文件,请将这三个文件从 NoVideo 数据复制到 `StreamingAssets/A000/MovieData` 文件夹。
27+
> A:这些文件是游戏正常运行所需数据的一部分。如果您使用自己的资产并想删除 MovieData,您需要确保保留这几个文件。如果您已经传输了其他文件,请将这几个文件复制到 `StreamingAssets/A000/MovieData` 文件夹。
2628
2729
**Q: 我正在使用自定义的 StreamingAssets,但下载失败,并提示 `tree.csv` 文件丢失。**
2830

@@ -36,20 +38,16 @@ description: 解决常见问题和错误的指南
3638

3739
> A: 请在设置中进入“设置 > 应用和通知”(或“应用”,取决于你的设备制造商和ROM),搜索“KanadeDX”,然后进入“权限”,将相机权限设置为“不允许”。
3840
39-
**Q: 在 iOS 设备上,如果我进入特定区域/歌曲/角色时,游戏就会崩溃!**
40-
41-
> A: 此问题正在逐步解决,目前似乎仅在 iOS 设备上出现。请尝试避免触发游戏崩溃的内容,或者检查你在 AquaDX 或你选择的服务器上是否意外添加了不应有的解锁标记。
42-
4341
**Q: 如果我最初安装了“NoVideo”版本的资源,后来再安装视频数据,会不会造成损害?**
4442

4543
> A: 这方面还没有充分测试,但建议你从 Miniserve 重新下载(请确保你有足够的可用空间!)以防数据损坏。同时,请在设置菜单中重新初始化 KanadeDX 的资源。
4644
4745
**Q: 如何更换我的 keychip 以便在排行榜上保存我的游戏记录?**
4846

49-
> KanadeDX 使用占位/虚拟 keychip 来启动游戏的基本功能,并且不会保存任何游戏数据。因此,一旦你在 AquaDXhttps://aquadx.net/上注册后,请进入“设置连接”,确认后复制所显示的 keychip 号码(应类似于 A###-###########,其中“#”代表随机数字或字母)。
50-
>
47+
> KanadeDX 使用占位/虚拟 keychip 来启动游戏的基本功能,并且不会保存任何游戏数据。因此,一旦你在 [AquaDX](https://aquadx.net/) 上注册后,请进入“设置连接”,确认后复制所显示的 keychip 号码(应类似于 A###-###########,其中“#”代表随机数字或字母)。
48+
>
5149
> 然后,返回 KanadeDX,点击齿轮图标,向下滚动至“Keychip”(或旧版本中的 SeriID),将你的 keychip ID 粘贴到该处。
52-
>
50+
>
5351
> 请勿与他人共享你的 keychip(或卡号)!该 keychip 仅供个人使用,共享可能导致数据损坏或成绩被篡改。
5452
5553
**Q: 如何将游戏旋转为手机的竖屏模式?**

src/content/docs/zh/general/update.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,33 @@ description: 向游戏数据添加 OPT 更新。
77

88
在 250228.1208 版本发布之前,仅支持基础游戏(A000)。然而,在此版本中,增加了对其他选项更新的支持。
99

10-
请注意,仅对官方更新进行了测试。目前支持的更新包括:A000(基础游戏)、A005、A011、A021。
10+
请注意,仅对官方更新进行了测试。目前支持的更新包括:A000(基础游戏)、A005、A011、A021、A022。
11+
12+
如果你仍在游玩旧版,请不要将更新文件内容直接合并到 A000 中,这会导致游戏加载数据时出现异常。
1113

1214
## 添加选项
1315

1416
要添加选项更新,请按照以下步骤操作:
1517

18+
### 直接在设备上更新
19+
1620
1. 在移动设备上下载选项更新的压缩文件。
1721
2. 解压文件并将 Axxx 文件夹复制到 `StreamingAssets` 目录,与 A000 目录放在一起:
1822
* Android:`/sdcard/Android/data/app.KanadeDX/files/KanadeDX/StreamingAssets`
1923
* iOS:文件应用 > 本地存储 > KanadeDX > StreamingAssets
2024
3. 打开 KanadeDX 250228.1208 或更新版本。
2125
4. 进入游戏前,点击右上角的设置图标。
22-
5. 向下滚动,点击“手动重新初始化所有 AssetBundle”,然后开始转换。
26+
5. 向下滚动,点击“手动重新初始化所有资源包”,然后开始转换。
27+
28+
### 通过 PC 更新
29+
30+
1. 在电脑上下载选项更新的压缩文件。
31+
2. 解压文件并将 Axxx 文件夹复制到一个空文件夹中,并将 Miniserve 可执行文件和[这个Python脚本](/misc/scripts/tree.py)放置在相同目录中。
32+
3. 在命令行中运行 `python tree.py`,它会在当前目录下生成一个 `tree.csv` 文件。
33+
4. 启动 Miniserve。
34+
5. 打开 KanadeDX 250228.1208 或更新版本。
35+
6. 点击右上角的设置图标,向下滚动,点击“手动重新下载资源包”。
36+
7. 输入 Miniserve URL,开始下载。
37+
8. 下载完成后,重启 KanadeDX,再次进入设置,点击“手动重新初始化所有资源包”,然后开始转换。
2338

2439
> 如果你从旧版本的 KanadeDX 更新,此过程还会重新检查 A000 中的所有资源包。但这是一次性操作,未来的更新不会再次处理已经处理过的文件。

src/content/docs/zh/start/install.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ description: 帮助您快速上手 KanadeDX 的指南。
1919

2020
## 2. 安装
2121

22-
### Android 🐸
22+
### Android 🤖
2323

2424
直接打开 APK 文件并点击“安装”。
2525

@@ -34,7 +34,7 @@ description: 帮助您快速上手 KanadeDX 的指南。
3434

3535
目前有多种方式可以安装自签应用:TrollStore、AltStore/SideStore 和 Sideloadly。
3636

37-
- **TrollStore** 仅支持 iOS 14.0 beta 2 - 16.6.1、16.7 RC (20H18) 和 17.0,但如果您的 iOS 版本符合要求,它是最佳选择。通过 TrollStore 安装的应用将被永久签名,而其他方法需要每周刷新。
37+
- [**TrollStore**](https://github.com/opa334/TrollStore) 仅支持 iOS 14.0 beta 2 - 16.6.1、16.7 RC (20H18) 和 17.0,但如果您的 iOS 版本符合要求,它是最佳选择。通过 TrollStore 安装的应用将被永久签名,而其他方法需要每周刷新。
3838
- **AltStore / SideStore** 界面更美观,且刷新应用更方便。
3939
- AltStore 通过局域网连接
4040
- SideStore 通过 VPN 连接
@@ -52,4 +52,6 @@ description: 帮助您快速上手 KanadeDX 的指南。
5252

5353
1. 按照 [Sideloadly](https://sideloadly.io/) 的官方指南,在电脑上安装 ipa 文件。
5454

55-
请注意,使用 Sideloadly 安装的应用只能使用 7 天,之后需要再次连接电脑刷新应用,否则应用将无法打开。
55+
请注意,使用免费账号签名并侧载安装的应用只能使用 7 天,之后需要再次连接电脑(对于 AltStore 和 Sideloadly)/ 连接 VPN(对于 SideStore)刷新应用,否则应用将无法打开。
56+
57+
如果你拥有付费的开发者账号,你可以使用它来签名应用,这样应用的有效期将为 1 年。你可能只需要在发布新版本时重新签名即可。

0 commit comments

Comments
 (0)