/minish-cap-auto-splitter

An auto splitter for The Legend of Zelda: The Minish Cap for LiveSplit One's auto splitting runtime.

Primary LanguageRust

minish-cap-auto-splitter

An auto splitter for The Legend of Zelda: The Minish Cap.

Compilation

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-unknown-unknown --toolchain stable

The auto splitter can now be compiled:

cargo release

The auto splitter is then available at:

target/wasm32-unknown-unknown/release/minish_cap_auto_splitter.wasm

Make sure too look into the API documentation for the asr crate.

Development

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 Auto Splitter 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 may not work all the time.