Skip to content

Commit d539812

Browse files
committed
update README.md
1 parent 3a3fb4d commit d539812

2 files changed

Lines changed: 34 additions & 0 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,19 @@ As the name suggests, this a freecam tool for games built on the Unity engine.
2424
It also comes with an in-game speed change feature.
2525

2626
## Download
27+
2728
Pre-built versions can be downloaded from the [Release](https://github.com/flpflan/u-freecam/releases) page.
2829

2930
If you want the latest development version, you can also download it from the [CI](https://github.com/flpflan/u-freecam/actions) build artifacts.
3031

3132
## Build (Windows)
3233

3334
### Requirement
35+
3436
- Visual Studio (With C++ toolchain and Cmake)
3537

3638
### Compile
39+
3740
Open this project directly in Visual Studio, select the `freecam-x86_64-windows` target, and then generate it.
3841

3942
## Build (Android)
@@ -45,6 +48,7 @@ Open this project directly in Visual Studio, select the `freecam-x86_64-windows`
4548
- Ninja (Optional)
4649

4750
### Compile
51+
4852
```shell
4953
export ANDROID_NDK=/path/to/ndk # Set the path to Android NDK
5054
export GENERATOR=Ninja
@@ -58,6 +62,17 @@ output: `build/release-android-aarch64/libfreecam-aarch64-android.so`
5862
By any means, inject this dynamic library into the target process or application[^1]. \
5963
For example, on Windows, you can use the DLL injection tool that comes with Cheat Engine (CE), while on Android, you can use [XInjector](https://github.com/WindySha/XInjector) (Non-root environments can use [Android-Virtual-Inject](https://github.com/reveny/Android-Virtual-Inject/releases/latest)).
6064

65+
## Configuration
66+
67+
After injected to the process , a WebUI interface will be started on the local port __23333__. This interface can be accessed via a browser to adjust various program parameters.\
68+
To access it locally, simply open http://localhost:23333.
69+
70+
## Modes
71+
72+
u-freecam has three different operating modes, and their behavior can vary greatly depending on the game.\
73+
Depending on the game, some modes may not work correctly or may even cause the game to crash. Please try all three modes and choose the one that works best for you.\
74+
You can switch between modes in the [WebUI](#Configuration).
75+
6176
## Keybindings
6277

6378
> ** You can use an external keyboard on Android. **

README.zh-CN.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,24 @@ u-freecam
1818
----------
1919

2020
## 这是什么
21+
2122
如其名所示,这是一个针对基于 Unity 引擎制作的游戏的自由镜头工具。
2223

2324
此外,还附带了游戏内变速功能。
2425

2526
## 下载
27+
2628
可在 [Release](https://github.com/flpflan/u-freecam/releases) 页面下载预构建版本。
2729
如果你想获取最新的开发版本,也可从 [CI](https://github.com/flpflan/u-freecam/actions) 构建产物中下载。
2830

2931
## 构建 (Windows)
3032

3133
### 前置需求
34+
3235
- Visual Studio (包含 C++ 工具链和 Cmake)
3336

3437
### 编译
38+
3539
用 Visual Studio 打开本项目,选择 `freecam-x86_64-windows` 目标,然后生成。
3640

3741
## 构建 (Android)
@@ -43,6 +47,7 @@ u-freecam
4347
- Ninja (可选)
4448

4549
### 编译
50+
4651
```shell
4752
export ANDROID_NDK=/path/to/ndk # 设置 NDK 路径
4853
export GENERATOR=Ninja
@@ -52,10 +57,22 @@ make release-aarch64 # 或者其它目标,如 release-x86_64
5257
输出: `build/release-android-aarch64/libfreecam-aarch64-android.so`
5358

5459
## 如何使用
60+
5561
通过任何手段, 将动态库注入目标进程/app即可[^1]\
5662
举例来说,Windows 上可通过 CE 自带的 dll 注入工具进行注入,而 Android 上可以使用 [XInjector](https://github.com/WindySha/XInjector) (非 Root 环境可以用 [Android-Virtual-Inject](https://github.com/reveny/Android-Virtual-Inject/releases/latest))
5763

64+
## 配置
65+
66+
注入进程之后,程序会在本地 __23333__ 端口启动一个 WebUI 配置界面,可通过浏览器访问此界面来调整程序的各项参数。\
67+
如果是本机访问,打开 http://localhost:23333 即可。
68+
69+
## 模式
70+
u-freecam 具有三种不同的运行模式,效果根据游戏的不同效果会有很大差异。\
71+
根据游戏的不同,一些模式可能不能正常运作,甚至导致游戏直接崩溃,请尝试三种模式后选择合适的那个。\
72+
模式的切换可在 [WebUI](#配置) 中进行。
73+
5874
## 按键
75+
5976
> ** Android 上可使用外接键盘 **
6077
6178
| 自由镜头 | 键位 |
@@ -86,12 +103,14 @@ make release-aarch64 # 或者其它目标,如 release-x86_64
86103
| 冻结速度 / 恢复正常速度 | Backspace |
87104

88105
## 已测试游戏
106+
89107
- [蔚蓝档案](https://www.bilibili.com/video/BV1XRpmz8EBW)
90108
- 喵斯快跑
91109
- 托兰异世录 (移动端)
92110
- 明日方舟:终末地
93111

94112
## 特别鸣谢
113+
95114
- [UnityResolve.hpp](https://github.com/issuimo/UnityResolve.hpp)
96115

97116
## 常见问题

0 commit comments

Comments
 (0)