Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Clazex committed Oct 14, 2021
1 parent b3bb648 commit a8baedc
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Compatible with `Hollow Knight` 1.5.
- **Fast Dream Warping**: Remove dream warping charge time when in Godhome boss fight rooms. This decrease the total warping time from 2.25s to 0.25s.
- **Fast Super Dash**: Buff Super Dash speed in Hall of Gods.
- **Frame Rate Limit**: Create a lag in every in-game frame.
- **Memorize Bindings**: Memorize the Bindings selected last time, like difficulties in the Hall of Gods.

## Configuration

Expand All @@ -20,6 +21,7 @@ Compatible with `Hollow Knight` 1.5.
- `fastSuperDashSpeedMultiplier` (`Float`): Fast Super Dash speed multiplier. Ranges from `1` to `2`, defaults to `1.5`.
- `frameRateLimit` (`Boolean`): Whether to enable the Frame Rate Limit feature. Defaults to `false`.
- `frameRateLimitMultiplier` (`Integer`): Frame rate limit time span multiplier. Final lag time is 10ms multiplied by this value. Note that setting this to `0` does not mean zero lag. Ranges from `0` to `10`, defaults to `5`.
- `memorizeBindings` (`Boolean`): Whether to enable the Memorize Bindings feature. Defaults to `true`.

## Contributing

Expand Down
2 changes: 2 additions & 0 deletions README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
- **快速梦门传送**:当在神居 Boss 战房间中时,移除梦之门传送充能时间。这将总传送时间从 2.25 秒减少到 0.25 秒。
- **快速超级冲刺**:提升在诸神堂中的超级冲刺速度。
- **帧率限制**:在游戏内的每帧添加卡顿。
- **记住束缚**:记住上次选择的束缚,效果与诸神堂中的难度选择一样。

## 配置

Expand All @@ -20,6 +21,7 @@
- `fastSuperDashSpeedMultiplier` (`Float`):快速超冲速度倍率。范围从 `1``2`,默认为 `1.5`
- `frameRateLimit` (`Boolean`):是否启用 `帧率限制` 功能。默认为 `false`
- `frameRateLimitMultiplier` (`Integer`):帧率限制卡顿时间倍率。最终卡顿时间是 10ms 乘以这个值。注意将其设置为 `0` 并不意味着零卡顿。范围从 `0``10`,默认为 `5`
- `memorizeBindings` (`Boolean`):是否启用 `记住束缚` 功能。默认为 `true`

## 贡献

Expand Down

0 comments on commit a8baedc

Please sign in to comment.