NukePA - Documentation
WIP V 1.2
This is a work-in-progress and I want all feedback, good or bad. Please let me know how it worked for you.
Short version history of Pinball Arcade launcher - NukePA
Version 1.2 2015/01/10: Removed running as admin check
Version 1.1 2015/01/01: Optimization, Adding EarthShaker and support for Pinball Arcade 1.33.8
Version 1.0 2014/07/3: Alpha version - local testing and debugging (lots and lots of debugging and beating my head against a wall);.
Also I am open to writing, spelling, and grammar correction and improvements, so feel free to edit this HTML and send it back to me or just send me the changes in an email. Please place [ ] around anything you have changed so I can quickly review it, verify the changes, and update this file for everyone.
I know this document is kind of long but I want it to be clear. I want you to be able to do this yourself in one sitting with no outside help needed.
Hopefully this program will help you. My email is listed at the top of this page so if you need help, contact me and I will see what I can do or search the fourms.
If someone contacts me I will update the documentation to address their issue so all can benefit from their questions. If you want to help make NukePA better or add support for a new feature just send me an email.
This will work for PinballX and HyperSpin and should work with HyperPin (soon) and any other system that can pass the table name in quotes along a command line. If you test this with another system and it works please let me know so I can add instructions for that system.
HyperPin doesn't support Pinball Arcade tables but if they just added the support it would work the same way as all the other systems they support. Please, anyone that can put pressure on the guys at HyperPin to support Pinball Arcade. Write emails talk about it on the forums ask loudly and it should happen. Go comment on this post. All they have to do is make HyperPin look at 3 sub folders instead of two for XMLs files and give us a place to point to a launcher like this one.
Features list with fun names not to be taken too seriously, except the features they are real.
Tips / Notes
A few tips and notes before we begin:
Thanks for actually reading this file first. You just saved yourself some time! If you just try to run the .EXE it will fail.
You should disable Windows UAC! PinballX, Pinball Arcade, Pinball Emulators and NukePA all run better without the extra interference UAC creates. This will help avoid issues created by hidden security warnings popup windows.
Click "Start" then search for UAC click on it to launch the UAC screen then drag the slider all the way to the bottom and click "OK"
Before you do anything else, open Pinball Arcade (NOT NukePA), and take a screen-shot if you can. This will be helpful if the guessing engine is not successful later on. If you can't take a screenshot that's ok. Just read on and make a few notes for use later in the setup.
Let's get down to the business. First make sure you have all the files needed to run NukePA. They are all in the zip file you downloaded from our homepage.
If you don't have them here is another link. Download NukePA ZIP
Make sure you have the files in the correct location. See example paths listed below.
Your NukePA files must be run from the correct folder.
For the Steam version it's the folder where Steam.exe is located.
For the offline version of Pinball Arcade it's the folder were Pinball Arcade.exe is located.
Steam: C:\Program Files (x86)\Steam\
PC/Offline: C:\Program Files (x86)\Pinball Arcade\
If you are using the Steam version your NukePA files should be located in the main steam folder where steam.exe is like shown above and in the screen shot. If you place your files here NukePA will auto detect that you are using Steam and will automatically know to use the proper command line for Steam. This is how the game will be launched - "Steam.exe -applaunch 238260"
Special note to Steam users: Do not put the NukePA files in this location "C:\Program Files (x86)\Steam\steamapps\common\Pinball Arcade"
Your file locations may be different but these are the default locations Pinball Arcade installs to.
Always run apps like PinballX, NukePA,Pinball Arcade. as Administrator.
To do that "right click" on each exe and click on "Properties", then Click the "Compatibility" tab and check the box "Run this program as an Administrator" and click "OK"
See screen shot if you need help.
If you're in a hurry and don't want all the details of each setting, just do the following sections and give it a try.
Read and perform the steps in the following sections "XMLFile", and "How to launch." After you have set those two variables you should be up and running. Then you can come back and do some tweaking. In order for this to work,
However, I recommend you read through everything first. You will benefit from having a clearer understating of what everything is and how it all works.
If you run into problems, come back here and look through all of the information including the troubleshooting section.
Edit the "XMLFile" to point to your Pinball Arcade.xml database. It will read the PinballX and HypersPin databases.
Example Path: C:\PinballX\Databases\Pinball Arcade\Pinball Arcade.xml
Example Path: C:\Hyperspin\Databases\Pinball Arcade\Pinball Arcade.xml
Here you will find links to different Pinball Arcade XML files.
I am providing several different files for people who have purchased various season passes.
For example if you have paid for season one and two and three you will want to download the file below titled "Seasons 1-3".
Some web browsers want to open XML files instead of downloading them, so to get around that just right click on the link and select "Save As" or "Save Target as" then pick the folder "C:\PinballX\Databases\Pinball Arcade\" and then rename the file "Pinball Arcade.XML"
Here are some pre-made XML files for people who own a specific season or multiple seasonsSeason 1 only XML File
Season 2 only XML File
Season 3 only XML File
Season 4 only XML File
Seasons 1-2 XML File
Seasons 1-3 XML File
Seasons 1-4 XML File
XML File with all tables
This very important, but at the same time optional. Let me explain below.
If you point this to your Pinball Arcade.xml file it will attempt to parse the XML and extract your unique Pinball Arcade table names. You may have used dashes (-), underscores (_), or removed all the spaces from the file names when you downloaded your media files. This would make your media files list different than mine. Take this table name for example: TTotan. This is how Farsight Studios named that table, but when I went looking for the wheel, backglass, and table images they had names like "Tales of the Arabian Nights" or "TOTAN" or "Arabian Nights" So I settled on my own naming convention and made all of my media files match, then I added that name to my XML file. I wanted to make a program that everyone can use, but I had to know the way they named their files and how they correlate to the menu locations of Pinball Arcade. So I went to work writing some code to untangle this mess and I think I found a great solution.
I call it the Guessing Engine. I won't bore you with descriptions of my coding prowess (the code is not really all that complicated), but the bottom line is it works perfectly about 98 to 99 percent of the time. Back to where I started, the XML is OPTIONAL. If you enter it my code will try to work its magic and match up all of your table names with the positions in the menu table list. If you don't add it you will need to manually edit the PinballTables files and add your table name in the proper order. See Section "Manually adding your tables" under "Trouble Shooting / FAQ".