Using AutoHotKey

HyperSpin uses two methods for launching emulators or programs. In the Wheel Settings: Emulator sub-tab you can select for HyperSpin to execute your files using the Normal or HyperLaunch method (highlighted in yellow).

The HyperLaunch executable file can be found in the root HyperSpin folder.  You’ll notice that there is another file named HyperLaunch.ahk (highlighted in yellow below).  This is an AutoHotKey script file.

AutoHotKey is a scripting software that allows users to automate program activity on the Microsoft Windows platform.  AutoHotKey basically allows you to assign ‘hotkeys’ for actions in Windows and it can be used in conjunction with HyperSpin to set escape keys and various configurations for programs, as well as running additional programs in coordination with any emulator. Download the AutoHotKey installer from www.autohotkey.org.

Once your download is finished, run the installer.  The file should look something like the one below.

If you receive a User Account Control dialog, just click Yes.

You’ll see the intro screen.  Click Next to begin installation.

The next page you’ll see is the Select Components page.  The third component, ‘Enable Drag and Drop’ is optional and by default is not checked.  Moving the mouse over any one of the selections brings up a description of that item in the box to the right.

Click ‘Next’ once more to select your installation location.  By default, the installer will install to your default Program Files location.  If you are installing on a 64-bit version of Windows, the program will install to the Program Files (x86) folder by default.  You can select any location to install and then click Install.

AutoHotKey installs with a context menu that allows you to edit, compile and run scripts.  If you want to add a system or change launch settings for a system in your HyperLaunch.ahk file you'll edit it in Notepad.  Just right click on the file and choose Edit Script (highlighted in yellow below).

As you can see, there is a lot of text to go through.  Much of the AHK script is commentary on what each item is for.  You can see that the Esc key has been set as the default exitEmulatorKey. 

If you have problems with unexpected exiting of your emulators or other problems, you may try changing the Universal Hotkeys setting near the top of the script (Main Settings section, highlighted above) from "q & s" to "~q & ~s".

If you want to add a system to your AHK file, you’ll do it further down in the ‘Run System’ section.

You might notice that the first system, Atari 5200, begins with an ‘if’ statement and that each system below that begins with an ‘else if’ statement.  If you decide to add your system to the AHK file before the first system in this section, be sure to change the ‘if’ statement to an ‘else if’. 
Throughout the forums you can find threads on using ‘unofficial’ systems.  You can find a collection of AHK additions here.  The image below is a link from this collection for the Atari 2600.

While some of the additions may not work with the current version of HyperSpin, you can find useful scripts that other users have tested.  For tested code like the Atari 2600 script shown above, you can just copy and paste that script into your open HyperLaunch.ahk file.

Save your changes and exit Notepad.  Before you compile your AHK script, take a look at the last few sections of the script. 

Below the Run Systems portion of the script are additional commands and actions that describe how HyperLaunch will behave after your emulator has closed or does not launch.   

If you are having difficulties getting an emulator or program to close, you can try setting alternate key commands in the Kill Commands section of the HyperLaunch script.  The script already sets alternative commands for the Jukebox.

The final portion of the script (above) contains error settings and handling; some deal with specific settings.  Again, there is almost never a need to add, delete or otherwise modify this part of the script.

Before you can run HyperLaunch with your changes, you must recompile the script.  Many times users make the changes they need to their AHK file but don’t compile before running HyperLaunch.  Right-click on HyperLaunch.ahk to bring up the context menu and select Compile Script (highlighted below).

That’s it, you’ve now edited and compiled your HyperLaunch.ahk file and are ready to run HyperSpin and test your changes!