SpriteSplit is a NodeJS project designed for video game speedrunners. SpriteSplit works with LiveSplit, the most popular timer for speedrunning, to allow for sprite animation based on a runner's current run. These animations are done using a canvas on an HTML page and the locally hosted project can be used as a browser source in OBS to have these animations show on livestreams or recordings.
This project supports using JSON files for Runs and Characters, and allows for users to create their own files that fit the needs of the game that they are running. Included with this project are files for two characters (Sora and Final World Sora) and a file for a run (KH3) that I personally use for my Kingdom Hearts III Beginner Any% speedruns. If you are looking to use this project for a run of your own, feel free to use the files that I have provided here, or if you have basic knowledge of JSON then you can make your own! More information on how these files work and should be setup can be found in the wiki for this project here: SpriteSplit Wiki
- Sprite animations for common actions in a run (splitting, being ahead/behind, golding a split, etc.)
- Automatically adjusts to comparison changes
- Supports switching characters mid run
As mentioned above, SpriteSplit works with the timer software LiveSplit. The newest version of LiveSplit can be downloaded here: LiveSplit Downloads Page
This project also requires the LiveSplit Server component in order to read information from LiveSplit. The download and setup information for this component can be found here: https://github.com/LiveSplit/LiveSplit.Server If you are using the latest development build of LiveSplit then it should already have this component included.