SoniFight v1.1.5

v1.1.5 - 2020/04/11

• Added this whatsnew.txt document to the repo which will be updated with each release (following MAME on this - it's a nice idea).
• The SoniFight process will now reconnect to your game process and resume sonification if you close the game and restart it (previously you had to stop and then re-start the running config).
• Added byte and unsigned integer data types to SoniFight and the Pointer Chain Tester apps.
• Preliminary work on hotkeys (this breaks previous configs with this version of the software - the GameConfig class has changed and hence the XML describing a config has changed)...
• ...however, I've obviously updated all the configs in this release to cater for this, and if you have your own custom config you may be able to load and then save it to overwrite in the new format - please make a backup of your config first though, I'd hate for you to lose any work.
• Street Fighter 4 - broken watches fixed with new or adjusted pointer chains.
• Street Fighter 4 config has been reworked to remove many samples and use speech synthesis via screen readers instead.
• Street Fighter 4 config trigger count decreased significantly by using a single "changed" trigger instead of individual watches for values like 1/2/3/4/5/etc.
• Street Fighter 4 triggers exist for combo count (triggers 454 and 455). I'm tempted to disable them as you can hear if you've made a "pow-pow-pow" 3-hit combo. Let me know if you want them to be on or off by default!
• Mortal Kombat 9 config checked - everything still working / nothing to do.
• Day of the Tentacle Remastered config updated, there's two configs now - one that speaks the voice options as "speech option 0" / "speech option 1" etc. and a second one that speaks the actual text but is not the same as the previous [Speech Fix] config which didn't update the speech option when it was multiple choices into a conversation. This one DOES update the live selected speech option to say the first 33 chars of the option text BUT - it only works sometimes. It's bizarre - it'll work 5 reboots in a row, then on the 6th reboot - nothing. Then it'll work again on the 7th reboot. If it keeps not working for you then please use the [Speech Option as Number] version of the config.
• Beneath A Steel Sky config updated to fix watches any broken watch pointer chains.

Potential Future work:

• It would be useful to specify a valid range of values either on a specific trigger or on a dependent trigger that could be applied to a normal trigger because triggers that use the "changed" criteria could then only provide sonification when values were within a predefined valid range. For example, if a valid health value is between 0 and 100 and it changes but stays within that range then (and only then) announce it.
• Get hotkeys working properly, both for single press (announce) actions and for press and hold (continuously announce) options
• If hotkeys could be bound to joysticks that would be cool i.e. Left trigger + select = announce watch X value etc.

SoniFight v1.1.4

Change log:

Fixed stale pointer chains to Killer Instinct (Windows Store version) - however, new clock timer defaults for single player are infinite time, so this is just the main menus sonified without half/low clock notifications in single player like back in the day.

SoniFight v1.1.3

• Added BlazBlue Continuum Shift Extend (Steam version) config,
• Renamed config directories to match steam build IDs where appropriate,
• Updated Tolk libraries,
• Remembered to include the PointerChainTester apps in this release,
• Minor documentation updates,
• SoniFight attempts to inform user of running/stopped status via Tolk output if screen reader available rather than having user rely on window title text (but NVDA can override this with its own output when starting/stopping configs so it's not 100% reliable at present),
• Changed "Use Tolk" flag to true on new triggers as it's far more likely to be used than separate samples,
• Minor UI bug fixes.

SoniFight v1.1.2

• Equals and changed comparisons now use CultureInvariant strings
• Internal thread culture locked to CultureInvariant to try to make configs that depend on strings work on systems which do not have English as their native language (Note: Games must be playing in English - for steam games see the Properties | Language tab for any given game).
• Added initial work-in-progress Beneath A Steel Sky config (version is the one taken from Good Old Games)

SoniFight v1.1.1

Stopped DoTT Remastered config saying "option -1", added options screen sonification (only main options like new game, bonus, load game, save game etc).

Added watch for DoTT speech options - because the text is not highlighted it just says speech option 0, speech option 1 etc, but that's likely the best we'll get at present because the speech text isn't copied into a buffer on highlight. However, because the speech option IS read out, you'll know exactly what's being said.

Update: Removed v1.1 upload binary and replaced with v1.1.1 binary - oops.

SoniFight v1.1

Includes sonification for Day of the Tentacle Remastered (Steam edition) - anything highlighted by the mouse is spoken via screen reader, along with options to push/pull/pick-up/open/close etc when a highlighted item is right-clicked.

Due to a coding error in the UTF8 string access method this has to be a new release and not a separate config - so do not use this config with SoniFight v1.0 because it won't work.

Have fun!

-Al

SoniFight v1.0 - Initial Release

Extract the zip archive wherever you want, then run the SoniFight_x86 or SoniFight_x64 batch files to run the 32/64 bit version of the software.

The 32-bit version of SoniFight currently supports the following games:

• Street Fighter 4 (specifically Ultra Street Fighter 4 Arcade Edition, Steam version), and
• Mortal Kombat 9 (specifically Mortal Kombat Komplete Edition, Steam version).

The 64-bit version of SoniFight currently supports the following games:

• Killer Instinct (Windows Store edition - this is merely a proof of concept and doesn't do much at present).

This is the very first release of the software so some patience would be appreciated ;-) Further games and increased coverage of existing games will be added in the future.

As specified in the LICENSE.txt - this software comes with no guarantee of fitness for purpose and you use it entirely at your own risk.

Please see the SoniFight user guide for instructions on how to use the software. If English isn't your native language you may prefer to look at the html version of the documentation as it contains a Google Translate widget at the top of the page which will convert the documentation into your language of choice.

If you want to run the 32/64 bit versions of the Pointer Chain Tester application then you can launch them directly from the x86/x64 folders inside the bin folder.

If you experience any issues with the software then please report them via the issues element of this github repository ( https://github.com/FedUni/SoniFight/issues ) and I'll do my best to address them.

Thanks & have fun!
-Al

P.S. If you deliberately try to break the software then, believe me, it won't take you very long - it has a significant amount of error-checking and validation, but while it'll warn you that something isn't right, it'll still let you do it because it assumes that you know what you're doing. If you end up in a situation where you want to enter -1 into a field and you enter the minus character and it says that's not a valid integer, just select the entire field (Ctrl+A), replace it with 1, then add the - char to the beginning of it. Hopefully that doesn't come up, but just in case.