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 1, 2021
1 parent 22fd42c commit 735a7fe
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@ Compatible with `Hollow Knight` 1.5.
## Features

- **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.
- **Frame Rate Limit**: Create a 50ms lag in every in-game frame.
- **Frame Rate Limit**: Create a lag in every in-game frame.

## Configuration

- `fastDreamWarp` (`Boolean`): Whether to enable the Fast Dream Warping feature. Defaults to `true`.
- `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`.

## Contributing

Expand Down

0 comments on commit 735a7fe

Please sign in to comment.