Add Path of Exile 2 (cross-platform WASM auto splitter)

[ransagy]

If you are adding or modifying an Auto Splitter, please fill out this checklist:

• My Auto Splitter does not contain any malicious functionality and I'm entirely responsible for any damages myself. (Any kind of abuse in an Auto Splitter will result in an immediate ban.)
• I am not replacing an existing Auto Splitter by a different author, or I have received permission from the author to replace the existing Auto Splitter. This adds a separate entry for Path of Exile 2; the existing component entry by JakeDev / SavageOranges is left untouched.
• The Auto Splitter has an open source license that allows anyone to fork and host it. (MIT.)

What does this PR do?

Adds a sandboxed Auto Splitting Runtime (WASM) auto splitter for Path of Exile 2 — a cross-platform port of JakeDev/SavageOranges' LiveSplit component, so it runs in LiveSplit One on Linux/macOS/Windows without Windows-specific tooling.

Details:

• Module: https://raw.githubusercontent.com/ransagy/PathOfExile2_AutoSplitterForLiveSplit/main/wasm/poe2_autosplitter.wasm (prebuilt binary committed alongside Rust sources in wasm/)
• Same triggering model as the original component: reads the game's Client.txt log and splits on first entry into campaign areas; modes mirror the component's (Campaign 100%, Campaign Any%, Level), plus a Custom mode driven by the user's splits file
• Ships ready-made .lss split files mirroring those modes
• Handles mid-run game restarts and pause/resume edge cases
• Tested end-to-end on Linux with LiveSplit One, including a full Act 1 campaign run
• Setup guide: https://github.com/ransagy/PathOfExile2_AutoSplitterForLiveSplit/blob/main/wasm/README.md

Thanks to JakeDev/SavageOranges for the original component this port is based on.

[ransagy]

@wooferzfg I see the CI failed on the dictionary key from the XML; i imagine that two autosplitters for the same game are not allowed at the moment?
The current component is fine and maintained; i don't intend to supersede it, just add the cross platform option.Maybe there should be a distinction on game+type at least. If that sounds alright, i can open a PR to modify the test as well, but that probably breaks other things.

[ransagy]

So after the CI fail, i dug into it a bit more.

This exact situation - adding a WASM splitter while keeping an existing entry for the same game - was already discussed in Dandara #2516, where the suggestion was to add the WASM as an extra URL in the existing record and to relax the validation to check only the first URL.

I also checked the pending LiveSplit One work (livesplit-one-druid #54 and livesplit-core #954) - it seems like it should work there too.

I can do that, but it does have the downside of not being able to point the WASM users at the right readme.

I would really appreciate your thoughts on this - happy to adjust the branch accordingly.

[wooferzfg]

Adding it as a second URL should work with the existing validations?

[AlexKnauth]

What if there were 2 xml files, one for LiveSplit to use, containing autosplitters of all types as it is now, and a second xml file for LiveSplit One to use, filtered to just contain AutoSplittingRuntime autosplitters. Maybe with a CI-enforced constraint that if an AutoSplittingRuntime autosplitter exists in the main xml, it must also exist with the same data in the second xml file. But allow AutoSplttingRuntime autosplitters to exist in the second xml file for games that have non-ASR autosplitters in the main xml file.

[ransagy]

@wooferzfg @AlexKnauth if we assume the desktop side shouldn't be auto-downloading/discovering ASR splitters at all, then: short term, relax the validations to check only the first URL (they currently check every URL, which is why adding a second one fails today) and merge the wasm into the existing PoE2 record - desktop keeps the component as-is, the wasm gets downloaded but only used by One/OBS. longer term, the separate One-side list makes sense given the desktop-one type split assumption. just let me know and i'll do the test PR or adjust the branch.

[AlexKnauth]

Or maybe it would be easier overall, in a Don't-Repeat-Yourself and Single-Point-Of-Truth kind of way, if this 2nd xml file only contained ASR autosplitters for games that have non-ASR autosplitters in the main xml file. LiveSplit One would have to search both xml files, but it would place much less of a maintenance burden on this repository.

I know of two entries so far that that 2nd xml file would have: this PR's autosplitter for PoE2, and another that I would add for Hollow Knight. (Edit: three entries, with Dandara)

[ransagy]

That can also work - in a sort of "main" and "extras" buckets sort of thing like many package managers do.
Current xml stays as the "main" and we add the additional listing, clients can opt in and read both.

[ransagy]

Just checking in if we want to take any action here from what was discussed or open the discussion elsewhere for wider audience, etc.

[CryZe]

So I haven't super deeply read through the thread here, but in my opinion, there probably should only be a single XML, and we should definitely allow an optional WebAssembly auto splitter for the auto splitters that have an ASL, simply because we cannot easily run ASL everywhere, and therefore the WASM auto splitter should definitely be allowed to exist as a fallback. In the future, we can then maybe let the user decide if they want the unsandboxed ASL or the safe WASM alternative. And then we will have to see in the future if eventually we maybe switch the default, where we recommend the WASM auto splitter over the ASL one because of safety or something. But then people can still fall back to it or something. I'm not 100% sure, but essentially having it all in a single "database" makes it easier for the different timers to choose whichever they can more easily and more safely execute and also potentially allow the user to choose. So I think that's the better approach. How we achieve that in terms of backwards compatibility of the XML file, I'm not 100% sure yet. I will have to look into it, or maybe someone else can look into it.

[ransagy]

If that's an agreed direction, I'll try and take a look and confirm again how LiveSplit Desktop Windows / livesplit-core frontends (druid/GTK?) and the OBS one look at the XML file to maintain backwards compat and open a PR to adjust the discovery/tests in each as needed.

[AlexKnauth]

What about adding a new element to the existing ASL and Component auto splitter entries in the XML, with an AutoSplittingRuntime WASM URL?

For example the Hollow Knight entry that currently looks like this:

    <AutoSplitter>
        <Games>
            <Game>HollowKnight</Game>
            <Game>Hollow Knight</Game>
            <Game>Hollow Knight Category Extensions</Game>
            <Game>Hollow Knight Mods</Game>
        </Games>
        <URLs>
            <URL>https://raw.githubusercontent.com/ShootMe/LiveSplit.HollowKnight/master/Components/LiveSplit.HollowKnight.dll</URL>
        </URLs>
        <Type>Component</Type>
        <Description>Configurable Load Remover / Auto Splitter. (By DevilSquirrel)</Description>
        <Website>https://github.com/ShootMe/LiveSplit.HollowKnight</Website>
    </AutoSplitter>

Would it work to extend it to look like this?

    <AutoSplitter>
        <Games>
            <Game>HollowKnight</Game>
            <Game>Hollow Knight</Game>
            <Game>Hollow Knight Category Extensions</Game>
            <Game>Hollow Knight Mods</Game>
        </Games>
        <URLs>
            <URL>https://raw.githubusercontent.com/ShootMe/LiveSplit.HollowKnight/master/Components/LiveSplit.HollowKnight.dll</URL>
        </URLs>
        <Type>Component</Type>
        <Description>Configurable Load Remover / Auto Splitter. (By DevilSquirrel)</Description>
        <Website>https://github.com/ShootMe/LiveSplit.HollowKnight</Website>
        <AutoSplittingRuntime>
            <URL>https://github.com/AlexKnauth/hollowknight-autosplit-wasm/releases/latest/download/hollowknight_autosplit_wasm_stable.wasm</URL>
            <Description>Configurable Load Remover / Auto Splitter / Auto Hit Counter. (By AlexKnauth)</Description>
            <Website>https://github.com/AlexKnauth/hollowknight-autosplit-wasm</Website>
        </AutoSplittingRuntime>
    </AutoSplitter>

[ransagy]

Updated the branch to the single-block shape as per the suggestion:

• Keeps the existing Path of Exile 2 Component entry exactly as is (Type=Component, single dll URL) for desktop
• Adds the WASM as an AutoSplittingRuntime child with its own Description/Website

Old builds ignore the unknown child, new builds (LiveSplit #2734, druid #56, obs #74) pick the wasm from the child.

Let me know if you want anything adjusted.