Welcome! This repository was created as a place to collect and share extensions for PinballY. PinballY is a game launcher program for people who enjoy virtual pinball on a PC, especially people who build dedicated "virtual pin cabs" (a video game PC built into a real pinball machine body).
PinballY can be customized and extended via its built-in Javascript engine, so we expect that most of the items in this repository will be Javascript code. PinballY's Javascript engine can also access native code via DLLs, so native code extensions are also welcome here.
We expect that the collection here will be a mix of ready-to-use add-ons that you can just drop into your PinballY environment to add new features, and examples that you can use as starting points for your own customizations. Javascript is such an approachable language that there needn't be a hard line between the two, though. Anything that's presented here as an add-on can also serve as starting point for something more or something different that you have in mind.
| script | description | difficulty of installation |
|---|---|---|
| BatchCategoryTagging | Command to category-tag multiple games at once | easy |
| CategoryButtons | Turns the Control keys into Next/Previous Category navigation buttons | easy |
| FLEXdmd | shows animated manufacturer images, stats, ... | easy |
| command_example | How to add commands to the main menu (e.g. Table Setup) | very easy |
| seamless-launch | overlay while table is loading | very easy |
| seamless-launch-spinner | overlay while table is loading, with animation | very easy |
| two-tables-one-wheel | choose alternate version of same table | easy - read the docu |
| start_random_table | starts a random table from the current GameWheel | very easy |
| additional_filters | adds several filters to the "filter by rating" menu | easy |
| show_instruction_card | shows the instruction card window while playing a table | medium |
| auto_shutdown | shuts down your PC after 60 min "Attract Mode" / inactivity | very easy |
| menu_submenu_batch_file | example script how to create own menu items and how to start a batch file | medium |
| meta_filter | adds additional MetaFilters to narrow existing selection to additional criterias | very easy |
| MissingMediaFilter | adds a filter to show games with missing media items | medium |
| sleep_computer | adds "Sleep Computer" to system menu to allow sleeping rather than power off | easy |
NOTE: For the moment projects that are linked here are works-in-progress and may not be ready for general use. If you see one that looks like wheel-actions @ 2cdb718 with the @ symbol, that is a linked project. The projects that are directly included here, and listed above, are reasonably complete and are for general use.
To use one of the Javascript files you find here in PinballY:
- Download the script's .js file(s) and place them in the Scripts folder within your main PinballY program folder
- If you don't already have a file in your Scripts folder called Main.js, create one, using Notepad or any other plain-text editor you prefer
- Open Main.js (from the Scripts folder) in Notepad or your preferred editor, and add a line like this:
import "xxx.js"(replacing xxx with the actual name of the script file)
If a particular add-on consists of multiple .js files, you might or
might not have to add an import command for each one - it depends on
how the add-on is designed. Hopefully the code will include
instructions explaining what to do in this case.
For full details on using Javascript in PinballY, see the Javascript section in the Help files that accompany the program. You can also view the PinballY help online.
The items in this repository are copyrighted by their respective authors. Unless otherwise stated for a particular folder or script, everything is released under the MIT license.
If you've created your own PinballY scripts that you'd like to include here, get in touch and we'd be happy to add you as a contributor so that you can check your code into a folder here. We ask that code contributions be provided under an open-source license so that users can share and customize them; the default license unless you state otherwise (by placing a notice in a script file, for example) is the MIT License (see above).