Hyperspintutorial.docx

11/14/2013 Bare Bones Hyperspin Install Tutorial By Fursphere I used a Windows XP VM box for this. For HyperSync Cloud support you’ll need a Hyperspin-FE Platinum Membership and an EMUMovies membership. 1) Locate and download the following a. "HyperSpin Install v1.3.2.0.zip" (458mb) – i. http://www.hyperspin-fe.com/forum/downloads.php?do=cat&id=118 b. Current version of MAME - “mame0151b.exe” (16.8mb) i. http://mamedev.org/release.html c. Install DirectX 9.0c for WindowsXP i. http://www.microsoft.com/en-us/download/details.aspx?id=34429 d. Install .NET 3.5 (for Hyperlaunch 3) i. http://www.microsoft.com/en-us/download/details.aspx?id=21 ii. Windows XP only I think e. Install .NET 4 (For HyperlaunchHQ & HyperSync Cloud support) i. http://www.microsoft.com/en-us/download/details.aswpx?id=17851 f. Install Windows Media Player 11 for HyperSync i. http://www.microsoft.com/en-us/download/windows-media-player-details.aspx 1. Windows XP only I think g. Don’s Hyperspin Tools – This is for ROM set auditing i. http://honerbrink.com/ ii. Current Version is 4.2 2) Install Hyperspin a. Unzip “Hyperspin Install v1.3.2.0.zip” to folder of choice (recommend c:\hyperspin for simplicity) b. RUN Hyperspin.exe to make sure it actually works. i. You should get the “out of the box” main menu wheel config with lots of systems you may or may not have. Intro video to MAME system wheel should play. ii. Exit Hyperspin c. Create \hyperspin\emulator\mame folder d. Unzip “mame0151b.exe to \hyperspin\emulator\mame folder i. Install at least one game into the MAME \ ROMS folder 1. I used Metal Slug (mslug.zip + neogeo.zip required) ii. RUN Mame.exe mslug 1. Verify MAME actually works. The game should boot if you have the correct rom set for the game you choose. This is just a sanity check! 2. Exit MAME e. We’ll get to all the wheel setups (adding, removing) and artwork configurations later! 3) Install Hyperlaunch 3 (This is critical – read carefully!) a. https://sites.google.com/site/hyperlaunch2/home/downloads i. Follow the instructions on the page verbatim! (these are high level steps, make sure you review the linked page for specific instructions) 1. Install GIT per instructions 2. Install Tortise GIT per instructions (GUI for GIT) 3. Setup GIT sync 4. Copy files to \hyperlaunch\ folder 4) Setup Hyperlaunch a. Navigate to \hyperspin\hyperlaunch\hyperlaunchHQ

b. Run hyperlaunchhq.exe i. I put a shortcut to this file in my \hyperspin\ folder for simplicity c. When it asks, tell hyperlaunchhq where your hyperlaunch folder is (\hyperspin\hyperlaunch\) d. Ok – here we go! e. On the left side you’ll see the emulators that Hyperspin is currently configured to use. Notice that each system has a “icon” next to the name. This means that it is a “supported” system, and there is a matching .AHK (autohotkey module) file that supports this system. Some key things to remember: i. The system name IS NOT the emulator – it is the game database ii. Systems need to specifically named in accordance with the HyperList naming conventions 1. http://hyperlist.hyperspin-fe.com/ iii. . f. For now, we’ll just configure MAME i. Emulators are configured globally in Hyperlaunch! An emulater is not tied to a specific system (although some of the assocations are obvious, others are not) ii. Some emulators support multiple systems, and can be configured to multiple system wheels 1. For example the “SNK Neo Geo” wheel is Neo Geo specific arcade games, however MAME emulates all of these games today, and even uses the same ROM names. So the MAME emulator can be linked to both the HyperSpin “MAME” wheel AND the “SNK Neo Geo” wheel. 2. . iii. With “Global” selected (highlighted) in the left column, click the “emulators” button towards the top center. 1. If your emulator list is empty (I had this problem) close HyperlaunchHQ a. Navigate to \Hyperspin\HyperLaunch\Settings\ i. Check “Global Emulators.ini” – it shouldn’t be blank ii. If it is blank (mine was), open “Global Emulators (Example).ini” and copy the complete contents to “Global Emulators.ini” iii. This should fix the list – go back to where you were above now. 2. If your emulator list is populated (yay!) a. This is the full list of the EMULATORS that Hyperlaunch 3 “officially” supports i. You can write your open AutoHotKey modules – but that’s madness b. Some of them are version specific, others not so much c. Scroll down the list until you find MAME – double click on it to open the config i. Modify the path to point to your mame.exe file – whatever it is 1. Use the magnifying glass ii. Notice the Rom Extensions box – it supports ROMs in ZIP and 7z format iii. Close the window d. Notice the little red “!” next to MAME is cleared. MAME is now configured in HL3. g. Now in the left column, select the MAME system i. Enter a rom path you’d like HL3 to look in to find MAME roms (you can do multiples if you like) 1. Click the green + symbol on the far right 2. Select the rom dir ii. Select the default emulator 1. Click the Magnifying glass on the far right a. Select “MAME” by double-clicking on it. iii. The Hyperspin MAME system (wheel) is now configured with a ROM path, and a Hyperlaunch Emulator h. At a very basic level – we’re done in HyperlaunchHQ for now. 5) Setup Hyperspin a. Verify HyperSpin is setup to use HyperLaunch correct i. Navigate to \HyperSpin\Settings\ 1. Open Settings.ini

2. Under [MAIN] 3. Verify “Hyperlaunch_Path=C:\Hyperspin\HyperLaunch\” exists, and is the proper path to YOUR setup 4. This was done for me in the version of Hyperspin I downloaded – previously this was a manual step. 5. Close the file. This is really just an informational step. b. Navigate to \Hyperspin\ and run HyperHQ.exe i. I’m going to call out locations by TAB names here “top row” “bottom row” ii. Main Settings – Screen 1. This where you’d set the resolution for windowed mode OR fullscreen mode. 2. This is just for Hyperspin! Configure your emulators independently outside of Hyperspin / Hyperlaunch iii. Wheel Settings – MAME 1. Since we only setup MAME so far, this is all we care about for now. 2. Emulator TAB a. Execution – Hyperlaunch i. This tells Hyperspin to use Hyperlaunch to run the emulator b. THAT’S IT! Since you’re using Hyperlaunch to run the emulators, you don’t have to fill anything else out on this tab. Hyperspin is handing the entire “launching” operation over to HyperLaunch – so everything else here is ignored c. If you weren’t using HyperLaunch – you’d need to fill out more 3. Wheel TAB a. This is look and feel stuff – moving things around graphically. 4. Navigation / Themes TAB a. More look and feel stuff 5. Video TAB a. This is the location of where the individual game videos are kept – the default location of \hyperpsin\media\system name\video is fine – don’t mess with it unless you have a reason too 6. Sounds TAB a. Self explanatory 7. Special Art Tab a. More look and feel stuff iv. Main Menu Wizard 1. This is where you ADD and REMOVE wheels from Hyperspin. You can do it manually with XML hacking, but there really is no need to. Use the Wizard. 2. Keep in mind this is basically a GAME DATABASE - remember all the emulators and games are configured in HyperLaunch! v. Controls – Keyboard (and or other tabs) 1. This is where you configure how Hyperspin is controlled. 2. Configure to your specific needs! vi. Done with HyperHQ.exe c. At this point, you should be able to run Hyperspin, navigate to the MAME wheel, find the game(s) you have installed (I used Metal Slug to test, or mslug.zip) and be able to LAUNCH that game from the wheel. i. ESC exits the emulator and sends you back to Hyperspin d. Success! You now have a functional wheel / game. Now we’ll get into how it all works. 6) HyperList, HyperSync, and other fun stuff a. With the exception of MAME (and a few other Arcade emulators that use MAME ROMs), most console emulators don’t care what you name your roms – they’ll open any file you throw at it. I have good news and bad news i. The BAD – HyperSpin, HyperSync, HyperLaunch all work off a pre-determined naming convention. The database XMLs you will download are looking for your ROMs to be named a specific way.

ii. The GOOD – There are a number of tools out there to help you audit your rom collections and get them in the naming convention that Hyperspin is expecting. b. You may be asking yourself WHY it’s this way. Why does Hyperspin care? What if I make my own databases with (insert your own XML file maker here) program? i. Hyperspin is a huge collection of files. And every one of those files needs to be named the same to support each and every ROM file. 1. Wheel art, intro video, theme pack, XMl database name, etc…. ii. All the hard work – creating and collecting the artwork has been done for you! If you match your ROM names to the Hyperspin Databases – “it just works”. (you can get as fancy and custom as you want, or you can use the “out of the box” artwork and just enjoy your project) c. So we’re at a point now where we need to do a few things: i. Finish syncing MAME – This will cover HyperSync setup and configuration ii. Decide what systems you want on your cabinet. 1. I’ll cover adding and removing wheels 2. I’ll cover setting up one console based emulator, all the way through a. This will including setting up Hypersync for that system 7) HyperSync a. As I stated before, I’m assuming you have both a Hyerspin-FE.com Platinum membership and a EMUMovies membership (Supporting Member / Lifetime Member) i. Hyperspin is a direct access to the artwork and intro video repositories as well as a sync / download utility that integrates with Hyperspin. b. Navigate to \Hyerpsin\HyperSync Cloud i. RUN HyperSync Cloud.exe 1. It’ll auto download an update ii. Once the update is downloaded click the little blue circle “!” in the upper right area to install the update iii. Close HyperSync, then relaunch to install the update iv. Now it’ll tell you to use “HyperSync Loader.exe” to start the program (go figure) v. RUN “HyperSync Loader.exe” 1. It’ll run through some quick pre-requisite checks a. On my Windows XP box – I had to deal with a Windows Media Player issue i. it wasn’t installed (fixed) ii. It wasn’t the right version (Media Player 11) 1. http://www.microsoft.com/en-us/download/windows-mediaplayer-details.aspx 2. Once it opens, you need to add your accounts a. Click the “person” symbol button i. Enter Hyperpsin account ii. Enter EmuMovies account b. You should now be “online” in HyperSync 3. Click the “arcade” symbol button to start “linking” your emulators to their respective repositories a. Scroll down and find MAME i. Click “YES” you’re sure you want to setup MAME b. Upper Right – “assigned to” = “MAME” c. CLICK SET (if you don’t, nothing will be saved!) 4. Lower Left Corner – “Sync system” = “ON” 5. Now the “tabs” under “assigned “ a. Main Menu i. Theme = the graphical theme you see on the main Hyperspin Wheel 1. Set to Default ii. Wheel = This is the graphic that “spins” around the wheel

1. Set to Default b. Game Settings – These settings tell Hyperspin (HyperHQ settings really) what to show) i. Box art = Console system have “box art” = pictures of the box the game it came in. This really doesn’t apply to arcade systems 1. Leave off ii. Cart Art = Picture of the console game cartright 1. Leave off iii. Wheel Art = This is the Wheel graphic that spins around for each game 1. Turn ON iv. Themes = Graphic theme for each individual game 1. Turn ON (assuming you want the themes for each game) c. System – This is the actual artwork downloads i. Box Art – Do not sync ii. Cart Art – Do not sync iii. System Theme – Default iv. Wheel Art – Default v. Themes – SYNC vi. Letters – Default vii. Pointer - Default viii. Sound – Default d. Video – These are the actual intro / demo videos i. Sync videos 1. ON ii. Sync intros 1. ON 6. Click “Close” in the lower right hand corner 7. Time to sync! a. Click the “sync” link on the main page b. Change system to MAME c. Media = All Media d. Click “begin sync” e. This will now sync based on the settings you choose. It uses the XML database file to sync against (remember the naming convention I talked about before?) f. It’s going to take A LONG TIME for MAME. There is a ton of stuff to download the first time you sync. g. Everything is going to download to \hyperspin\media\system name c. That’s basically all there is to HyerSync. Setup each system you want, configure what you want to sync (and notice there are multiple versions of some items – check out the other artwork that’s been done!). 8) Adding another System to Hyperspin, and Renaming ROM sets to match Hyperspin Database naming conventions. a. When you add a “new” System to Hyperspin, there are four basic things you do, in order. i. Setup the wheel in HyperSpin 1. Tool used – HyperHQ.exe 2. Reference HyperList to get the system name correct a. http://hyperlist.hyperspin-fe.com/ ii. Setup the emulator(s) to support the wheel in Hyperlaunch 1. Tool used – HyperlaunchHQ.exe iii. Setup (sync) the artwork and videos to support the System in HyperSpin 1. Tool used – HyperSync iv. Audit your ROM set to match the Hyperspin Database 1. Tool used – Don’s HyperSpin Tools b. So let’s setup Nintendo Entertainment System

i. The current version of Hyperspin comes with the NES (Nintendo Entertainment System) already setup, but for the sake of this tutorial we’re going to DELETE it, then re add it. 1. Actually, for my “test” Hyperspin Setup, I’m going to remove every wheel except MAME. You can do whatever you like with your own setup. ii. Open HyperHQ 1. Go to the Main Menu Wizard tab 2. Click the “Remove item from Main Menu” button 3. Select the item (wheel) you want to remove a. Nintendo Entertainment System 4. This applies to every wheel here – a. If you think you’re going to setup the system “someday in the future i. Click “Just Remove From Database” b. If you think you’re NOT going to setup that system in the future – “fully remove from install” c. The different here is one leaves the database and media files on your hard disk, the other removes them. Hypersync can pull everything back down from the internet – so it’s really up to you if you need the space or not. d. For my test hyperspin install, I just removed everything from the database. Leaving the files on the local hard drive. 5. When I was done, the only thing I had left was MAME. 6. Click another tab, then click back to Main Menu Wizard 7. Click “Add new item to the main menu” a. The name is critical! Go to HyperList can verify the naming convention used b. http://hyperlist.hyperspin-fe.com/ 8. Enter “Nintendo Entertainment System” as shown in HyperList 9. Click Next 10. Answer “YES” to “Does this menu item from a sub wheel” (the top choice) 11. Add it to the wheel before or after wherever you choose a. I put it after MAME 12. Finish up. 13. Now click on the “Wheel Settings” tab at the top a. Use the pulldown to select “Nintendo Entertainment System” b. Emulator TAB – Verify HyperLaunch is checked c. Video tab – Select your default video location i. \Hyperspin\Media\Nintendo Entertainment System\Video\ d. You can leave everything else default. iii. Put your Emulator in the proper location 1. I do this a bit differently for console systems – this is totally up to you and this next part is for reference only 2. Navigate to \HyperSpin\Emulators 3. Create a Folder for “Nintendo Entertainment System” 4. Open that folder 5. Create a folder for each of the emulators that you plan on use a. \Nestopia b. \RockNES c. \etc d. I just setup Nestopia for this tutorial. 6. Create a GAMES or ROMS folder ( your choice) a. I don’t put the ROMs in the same folder as the emulator anymore, since HyperLaunch supports the concept of multiple emulators are any given game b. I personally use _Games

iv.

v.

vi.

vii.

7. I also great an Installs folder where I put the emulator install files. Incase I have to reinstall it or something, I already have the install media handy. 8. Launch Netopia and spend a few minutes setting up the basic emulator functions – just make sure it works and loads at least one game. I always use Super Mario Bros 3. :) 9. Don’t start playing games – or you’ll never get this finished! Setup HyperLaunch 1. Open HyperLaunchHQ 2. First thing you should notice is the list of Systems on the left side has changed to reflect what you did in HyperHQ (assuming you removed some systems) 3. Click Global 4. Click Emulators 5. Scroll down and find Nestopia (by name – remember we’re setting up the emulator, not the system it supports) 6. Double-Click Nestopia a. Point it to your Nestopia.exe 7. Close that window 8. Click on “Nintendo Entertainment System” in the left hand pane a. Add your ROM path using the green “plus” symbol b. Select your default emulator i. The HyperLaunch team did a really good job here of showing you the emulators HL3 supports that in turn support the Nintendo Entertainment System. ii. We only setup Nestopia, so just choose that one c. Done! HyperSync time! 1. Launch HyperSync Cloud a. You should have already setup your accounts – so you’re done with that b. Click the Arcade button to link the system c. Using the procedure I described previously with MAME, link up Nintendo i. Don’t forget to click “SET” d. Once its configured, go sync the entire system (or whatever you want to specifically sync using the options provided) e. Remember – This is syncing media (artwork, videos) against the Hyperspin Nintendo Entertainment System Database (XML), NOT your rom collection. f. Close HyperSync Cloud when your done. At this point you can probably safely fire up HyperSpin and see the two systems you’ve configured (MAME and NES) and all the artwork you’ve downloaded / sync’d up. 1. MAME should work, assuming you matched your MAME ROMs to your MAME version a. CLRMAMEPRO is your friend, but I’m not going to get into that here b. The HyperSpin team usually keeps the MAME database up to date with the latest MAMEDEV release – Check HyperList for the current version c. You can use any flavor of MAME you want, but you may end up having some stuff out of whack due to the variances with other MAME distros – so you might have to create your own XML database – or seek out help on the Hyperspin forums. 2. NES will most likely NOT work, because your ROM names don’t match the names in the Hyperspin database (XML). Not to worry – I’m going to now show you how to fix that. Don’s Hyperspin Tools 1. ….to be written soon