Skip to content

Latest commit

 

History

History
39 lines (23 loc) · 2.85 KB

README.md

File metadata and controls

39 lines (23 loc) · 2.85 KB

HSH Speedrun Mod

A modded version of the Flash game "Home Sheep Home" for speedrunners, which allows timing individual-level or full-game runs without an external timer, as well as recording runs in the form of replayable demos.

Is it accurate?

Depends on what you mean by accurate. The time is measured using in-game frames and then converted to seconds. So while it's always going to be consistent and timing will be frame-perfect, the in-game timer might not always show the same end time compared an external timer. This is because external timers don't account for load times or frame drops. And since Flash is not really the most stable platform for games, you're guaranteed to have some variances here and there.

How much different is it from an external timer?

Version 1.2 and onwards aims to simulate a real timer as closely as possible, but it's impossible to eliminate all variation. In some cases the in-game timer might end up being a second faster than other timing methods.

Why should runners use this?

Unlike timing with LiveSplit, for example, runs will always begin and end on the same frame, and no matter how overwhelmingly bad or good your computer's performance is, the same run will always end up with the same time no matter what configuration it's recorded with.

Starting and ending runs is automated. It's easier to retry-spam runs without having to reset your timer, and inconsistencies coming from human error when starting or stopping the timer are completely eliminated.

Individual level timers and PBs seen on the level end screen have millisecond precision, so it's easier to monitor your improvement.

You can use the inbuilt demo recording tool to automatically record runs without having to worry about performance or disk space.

The mod also includes other small quality of life features. For example, an attempt counter.

Is this legal for runs uploaded to speedrun.com?

Yes, the moderator, ShevaDecai, has agreed to allowing this mod in runs, and a majority of records have already been set with it.

Installation

Just go to the releases page, and download the latest version of the mod. Then open the .swf file in your Flash player.

Sadly, highscores are not automatically copied between releases. However, you can manually move and rename the mod .swf file to replace your old Home Sheep Home installation. This should, in most cases, load your old save data instead. This depends on your flash player.

Usage

To start the timer, simply enter a level. The timer will stop once you've finished level 15.

To reset the timer, exit to the menu by pressing Esc or clicking on the menu button.

To record a demo, make sure the "record demos" checkmark on the main menu screen is ticked, then enter a level.

To play a demo, exit to the main menu after recording and click on the "play demo" button.