Stonos / guildwars2-sab-autosplit

LiveSplit Auto Splitter for Guild Wars 2 Super Adventure Box

Guild Wars 2 LiveSplit Auto Splitter

This is a LiveSplit Auto Splitter which splits the timer whenever you pass a checkpoint on Guild Wars 2 Super Adventure Box or Map Completion.

Preview

How to use

1. Download LiveSplit
2. Download the latest release of this component
3. Extract all the files to LiveSplit's directory
4. Run LiveSplit
5. Open the Splits for the zone you intend to run by right clicking and going to Open Splits - From File and selecting the appropriate file from the Components\GW2SAB\Splits directory
6. Right click - Edit Layout - Add - Control - Guild Wars 2 Super Adventure Box auto splitter

For usage specific to map completion also check out MapComp.md

Adding custom checkpoints

You can modify gw2sab_checkpoints.json in order to add new checkpoints (you can use something like these scripts to grab the X and Z coordinates).

Make sure that the checkpoints are sorted, otherwise they may not trigger correctly!

Optional Features

Some features can be configured in gw2sab_config.json

• LoadingScreens control how loading-screens are timed. Options are: include/exclude from timer or only, which discards normal playtime. Default is include.
• StartCondition Allows the timer to start on moving (default), loading-screens, anything notLoading-screen (includes character select), notTransitioning (does not start on character select) or manual.
• PauseOnExit if set to true (default) will pause the timer when exiting the game. When resuming the first loading-screen will not automatically be timed in only-Mode.
• MaxSkippedTicks determines how many update cycles it takes notice a transition happening. The default is 3.
• BlackBarSize determines the percentage of your screen which is scanned for the black bar which appears durcing loading-screens. 0.1 = 10% is fine for 1080p screens. Higher resolutions need to go lower in percentage.
• BlackPixelPercentage determines the percentage of pixels in that area which need to be black during a loading-screens. Default is 0.8 = 80%.

How it works

It works by reading the player's position using the MumbleLink API, and comparing it to a list of known checkpoint locations.
When detecting a loading-screen it also screenshots the game and counts the number of black pixels at the bottom.

Limitations

It's not possible to detect when a boss dies through the MumbleLink API. As a workaround, a set amount of time is subtracted after the level changes while you're in a boss area. This means that in order to see your final time, you must wait until you get teleported to the next level.

How to Develop (for .Net newbies)

1. Download LiveSplit
2. Clone / Unzip this Repository
3. Create an environment variable or a global MSBuild property called LiveSplitPath. This should be set to the location where LiveSplit is installed, and it will be used to automatically copy the compiled files there. If LiveSplitPath is not defined, then the files will be placed in a directory called out, and you will have to copy them manually to the LiveSplit directory.
4. Open the Project in Visual Studio and fetch dependencies with NuGet