An auto splitter for Hollow Knight that supports Windows, Mac, and Linux.
Download the hollowknight_autosplit_wasm.wasm file from the Latest Release.
Or follow the steps in Compilation and use target/wasm32-wasi/release/hollowknight_autosplit_wasm.wasm.
To configure LiveSplit or a LiveSplit One prototype to use this, see:
- Instructions for LiveSplit Windows
- Instructions for OBS LiveSplit One (OBS plugin)
- Instructions for LiveSplit One Druid (Recommended Desktop prototype)
- Instructions for livesplit-one-desktop (Older Desktop prototype)
This auto splitter is written in Rust. In order to compile it, you need to install the Rust compiler: Install Rust.
Afterwards install the WebAssembly target:
rustup target add wasm32-wasi --toolchain stableThe auto splitter can now be compiled:
cargo releaseThe auto splitter is then available at:
target/wasm32-wasi/release/hollowknight_autosplit_wasm.wasm
Make sure too look into the API documentation for the asr crate.
You can use the debugger while developing the auto splitter to more easily see the log messages, statistics, dump memory, step through the code and more.
The repository comes with preconfigured Visual Studio Code tasks. During
development it is recommended to use the Debug launch action to run the
asr-debugger. You need to install the CodeLLDB extension to run it.
You can then use the Build Auto Splitter (Debug) task to manually build the
auto splitter. This will automatically hot reload the auto splitter in the
asr-debugger.
Alternatively you can install the cargo watch
subcommand and run the Watch Auto Splitter task for it to automatically build
when you save your changes.
The debugger is able to step through the code. You can set breakpoints in VSCode and it should stop there when the breakpoint is hit. Inspecting variables currently does not work all the time.
LiveSplit connects to this autosplitter and its settings
via a LiveSplit Layout (.lsl) file.
Make sure to use a different copy of your Layout for every
different splits file you run with this autosplitter.
For hit-counter mode, best to use a layout that formats times and deltas without the decimals, such as the splits/hits/layout-direct.lsl file included in this repository.
Right-click -> Edit Layout... and you should see a Layout
Editor with components like Title, Splits, Timer, etc.
If it does not have a component named Auto Splitting Runtime,
add one using the + Plus button -> Control -> Auto Splitting Runtime.
Once that's there, click Layout Settings -> Auto Splitting Runtime,
and next to Script Path, click Browse...,
then navigate to the hollowknight_autosplit_wasm.wasm file.
Then click Import Splits and select your splits file.
For hit-counter mode, change the Timing Method setting to
either Hits / dream falls or Hits / damage.
Click Ok and and save the layout with Save Layout As...,
with a name specific to the splits you're running with.
Deactivate the existing Hollow Knight autosplitter by Right-click -> Edit Splits...
then next to Configurable Load Remover / Auto Splitter. (By DevilSquirrel),
click Deactivate.
Then add this autosplitter via the Layout file you saved earlier.
In the same Splits Editor from Right-click -> Edit Splits...,
below where Configurable Load Remover / Auto Splitter. (By DevilSquirrel) was,
check the Use Layout checkbox, click Browse next to that,
and navigate to the Layout file from before.
Select it and click Ok.
Finally, do not manually split or skip while running with this autosplitter,
unless either it's explicitly marked as ManualSplit or it's the end-split.
Don't manually split, skip, or undo splits in any other situation.
The autosplitter will not know that you did that, and the autosplitter's state will be out of sync with LiveSplit's state.
Make sure to use obs-livesplit-one release v0.3.5 or later.
Go to the obs-livesplit-one releases page,
and under the Assets section, download the one that matches your architecture and operating system.
Follow the instructions in the
How to install
section of the obs-livesplit-one README file.
On Windows, extract the obs-livesplit-one.dll to either
C:\Program Files\obs-studio\obs-plugins\64bit or
C:\Program Files (x86)\obs-studio\obs-plugins\64bit.
For hit-counter mode, modify your splits file,
near the end after </Splits> but before </AutoSplitterSettings>,
so that it contains <TimingMethod>HitsDreamFalls</TimingMethod>
or <TimingMethod>HitsDamage</TimingMethod>.
Add OBS Source Livesplit One.
Properties:
- Splits: Select your splits file
- Use local autosplitter: Check
- Local Auto Splitter file: Select the
hollowknight_autosplit_wasm.wasmfile - Custom auto splitter settings: Select
Import Splits - Select a file: Select your splits file
Note: The main livesplit-one-druid repository might not
be up-to-date enough to run this autosplitter.
- If https://github.com/CryZe/livesplit-one-druid has a commit from December 2023 or later, then that's probably going to be up-to-date enough for this.
- However, if the most recent commit is still from April 2023, then you'll need to use a more up-to-date version, such as my fork https://github.com/AlexKnauth/livesplit-one-druid.
To install my fork, go to the
AlexKnauth LiveSplit One Druid Latest Release page, and under the Assets section,
download the one for your architecture and operating system.
For hit-counter mode,
modify your splits file before you open it in LiveSplit One Druid:
near the end after </Splits> but before </AutoSplitterSettings>,
so that it contains <TimingMethod>HitsDreamFalls</TimingMethod>
or <TimingMethod>HitsDamage</TimingMethod>.
If you need to after you've opened and saved it:
modify it so it contains <Setting id="timing_method" type="string" value="HitsDreamFalls" /> or <Setting id="timing_method" type="string" value="HitsDamage" />.
When you run LiveSplit One Druid,
it needs to have permission to read memory of other processes.
On Mac, that might require running it under sudo.
Right-click or Control-click for the context menu:
- Splits, Open... : Select your
.lsssplits file. - Layout, Open... : For the Layout, I recommend you use
.ls1llayout file for LiveSplit One Druid, not a.lsllayout file. You can make a.ls1lfile in the LiveSplit One Web version at https://one.livesplit.org/, or you can use thelayout-web.ls1lfile included in this repository as a starting point. - Open Auto-splitter... : Select the
hollowknight_autosplit_wasm.wasmfile. - Compare Against: Game Time.
- Settings: Configure the hotkeys you want.
Finally, do not manually split or skip while running with this autosplitter,
unless either it's explicitly marked as ManualSplit or it's the end-split.
Don't manually split, skip, or undo splits in any other situation.
The autosplitter will not know that you did that,
and the autosplitter's state will be out of sync with LiveSplit One Druid's state.
Note: The main livesplit-one-desktop repository might not
be up-to-date enough to run this autosplitter.
- If https://github.com/CryZe/livesplit-one-desktop has a commit from December 2023 or later, then that's probably going to be up-to-date enough for this.
- However, if the most recent commit is still from July 2023, then you'll need to use a more up-to-date version, such as my fork https://github.com/AlexKnauth/livesplit-one-desktop.
You can clone my fork with
git clone https://github.com/AlexKnauth/livesplit-one-desktop.gitAccording to the rust_minifb Build Instructions,
on Linux you may need to install these dependencies first:
sudo apt install libxkbcommon-dev libwayland-cursor0 libwayland-devIn the livesplit-one-desktop repository, modify the config.yaml file so that it contains
general:
splits: <path-to-splits.lss>
timing-method: GameTime
auto-splitter: <path-to-hollowknight_autosplit_wasm.wasm>where you replace <path-to-splits.lss> with the path to your splits file,
and you replace <path-to-hollowknight_autosplit_wasm.wasm>
with a path to the hollowknight_autosplit_wasm.wasm file.
To configure it with a layout file, modify the config.yaml file so that it contains
general:
layout: <path-to-layout.lsl>where you replace <path-to-layout.lsl> with a path to your layout file.
You can use either a .lsl or a .ls1l layout with livesplit-one-desktop.
To configure hotkeys, modify the config.yaml file so that it contains
hotkeys:
split: Numpad1
reset: Numpad3
undo: Numpad8
skip: Numpad2
pause: null
undo_all_pauses: null
previous_comparison: Numpad4
next_comparison: Numpad6
toggle_timing_method: nullWhere you can replace those hotkey values with variants from
livesplit_hotkey::KeyCode.
When you run livesplit-one-desktop,
it needs to have permission to read memory of other processes.
On Mac, that might require running it under sudo.
For example in the livesplit-one-desktop repository, you can run
cargo build --release
sudo ./target/release/livesplit-oneFor hit-counter mode, modify your splits file,
near the end after </Splits> but before </AutoSplitterSettings>,
so that it contains <TimingMethod>HitsDreamFalls</TimingMethod>
or <TimingMethod>HitsDamage</TimingMethod>.
Finally, do not manually split or skip while running with this autosplitter,
unless either it's explicitly marked as ManualSplit or it's the end-split.
Don't manually split, skip, or undo splits in any other situation.
The autosplitter will not know that you did that,
and the autosplitter's state will be out of sync with livesplit-one-desktop's state.
The keyboard shortcuts of livesplit-one-desktop assume the Qwerty keyboard layout,
so you may need to press where the key would be if you were using Qwerty.
For example to save splits is "Control S" on Qwerty, but on a Dvorak keyboard,
the Qwerty key "S" is where the Dvorak key "O" is, so use Dvorak "Control O" to save instead.
How to keep it on top over a Full Screen game on Mac: Start dragging the livesplit-one-desktop window, and while dragging it, do a multi-finger swipe motion to switch screens to the Full Screen game, and then stop dragging. It will stay on top of the Full Screen game temporarily, as long as you don't do any more screen-switching after that.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent