This commit is contained in:
laz 2025-02-27 09:17:03 +01:00
parent 8be39c6b98
commit 8e3545c3af
3 changed files with 163 additions and 127 deletions

View file

@ -0,0 +1,54 @@
# Virtual Pinball (VPin / Vboard) Controllers
Virtual pinball machines are digital recreations of traditional pinball machines, designed to provide an immersive pinball experience using modern technology. These machines typically feature a large screen to display the playfield, along with various physical controls and feedback mechanisms to simulate the feel of a real pinball machine.
## Types of virtual pinball machines
### Standalone Virtual Pinball Machines
These are complete units that include everything needed to play virtual pinball games. They often come with high-definition screens, realistic controls, and built-in software to run various pinball simulations.
### DIY Virtual Pinball Machines
For those who enjoy building their own machines, DIY kits are available. These kits provide the necessary components, such as screens, buttons, and software, allowing users to assemble and customize their own virtual pinball machines.
### Hybrid Virtual Pinball Machines
These machines combine elements of both traditional and virtual pinball. They may feature physical pinball components, such as bumpers and flippers, along with digital displays and software to enhance the gameplay experience.
### Portable Virtual Pinball Machines
Designed for portability, these machines are smaller and more compact, making them easy to transport and set up in different locations. They often feature foldable screens and detachable controls.
### Arcade-Style Virtual Pinball Machines
These machines are designed to mimic the look and feel of classic arcade pinball machines. They often feature large cabinets, vibrant artwork, and high-quality sound systems to create an authentic arcade experience.
## Inputs for Virtual Pinball Machines
Virtual pinball machines have a variety of inputs to simulate the experience of playing a real pinball machine. These inputs include:
- **Flipper Buttons**: These are used to control the flippers on the pinball table, allowing the player to hit the ball.
- **Plunger**: This is used to launch the ball into play. It can be a physical plunger that mimics the action of a real pinball machine or a digital button.
- **Nudge and Tilt Sensors**: These sensors detect when the player nudges or tilts the machine, which can affect the ball's movement.
- **Start Button**: This button is used to start a new game.
- **Coin Door**: This input simulates the action of inserting coins to play the game.
- **Service Buttons**: These are used for maintenance and configuration of the machine.
- **LED and Light Controls**: These inputs control the various lights and LEDs on the machine, adding to the visual experience.
- **Feedback Devices**: These include solenoids, motors, and other devices that provide tactile feedback to the player, simulating the feel of a real pinball machine.
- **Digital Display**: This shows the score and other game information.
- **Sound System**: This provides the audio effects and music for the game.
- **Accelerometer**: This detects the movement and orientation of the machine.
- **Touchscreen**: Some virtual pinball machines have a touchscreen for additional controls and settings.
- **Motion Sensors**: These can detect the player's movements and gestures for interactive gameplay.
- **Launch Button**: An alternative to the plunger, this button can be used to launch the ball into play.
- **Extra Ball Button**: This button is used to activate an extra ball during gameplay.
- **Magna Save Button**: This button activates a magnetic save feature to prevent the ball from draining.
- **Volume Control**: This allows the player to adjust the sound volume.
- **Pause Button**: This button is used to pause the game.
- **Replay Button**: This button allows the player to replay a game or a specific part of the game.
- **Exit Button**: This button is used to exit the game or return to the main menu.
## Does RetroDECK Support Virtual Pinball?
Currently, RetroDECK does not support Virtual Pinball due to the complexity and variety of inputs. We hope to achieve compatibility with VPin hardware in the future, starting with implementing a Virtual Pinball System.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 69 KiB

View file

@ -24,177 +24,128 @@ The `RetroDECK Configurator` can be opened from:
What follows are the commands you can use inside the Configurator (more commands will be added during development).
## Presets & Settings
## Settings
In this menu you can set various presets.
In this menu you can set various settings.
#### Widescreen: Enable/Disable
Enables or disables Widescreen in all supported emulators and cores.
#### Ask to Exit prompt: Enable/Disable
Enables or disables ask to exit prompts in all supported emulators and cores.
If you disable this, the emulators will directly exit.
### Global: Presets & Settings
In this menu you will find presets and settings that span over multiple emulators.
#### RetroAchivements: Login
Login to RetroAchievements in all supported emulators and cores.
#### RetroAchivements: Logut
Logut from RetroAchievements in all supported emulators and cores.
#### RetroAchivements: Hardcore Mode
Enables `Hardcore Mode` from RetroAchievements in all supported emulators and cores.
#### Swap A/B and X/Y: Enable/Disable
Swaps `A/B` `X/Y` in supported emulators and cores.
#### Quick Resume: Enable/Disable
Enables `Quick Resume` aka `Auto Save` + `Auto Load` on exit in supported emulators and cores.
### RetroArch: Presets & Settings
In this menu you will find presets and settings for RetroArch.
#### Borders: Enable/Disable
### Borders
Enable / Disable borders across the RetroArch cores you choose.
#### Rewind: Enable/Disable
### Widescreen
Enable / Disable rewind across all of RetroArch (this may impact performance on some more demanding systems).
Enable / Disable Widescreen in all supported emulators and cores.
### Wii & Gamecube: Presets & Settings
### Ask-to-Exit
In this menu you will find presets and settings for Dolphin and Primehack.
Enable / Disable Ask-to-Exit prompts in all supported emulators and cores.
If you disable this, the emulators will directly exit.
### Rewind
Enable / Disable rewind across of RetroArch (this may impact performance on some more demanding systems).
#### Dolphin Textures: Universal Dynamic Input
### RetroAchivements: Login
Login to RetroAchievements in all supported emulators and cores.
### RetroAchivements: Logut
Logut from RetroAchievements in all supported emulators and cores.
### RetroAchivements: Hardcore Mode
Enable / Disable `Hardcore Mode` from RetroAchievements in all supported emulators and cores.
### Swap A/B and X/Y
Swaps `A/B` `X/Y` in supported emulators and cores.
### Quick Resume
Enable / Disable `Quick Resume` aka `Auto Save` + `Auto Load` on exit in supported emulators and cores.
### Universal Dynamic Input: Dolphin
Enable / Disable Venomalias's Universal Dynamic Input Texture for Dolphin.
#### Primehack Textures: Universal Dynamic Input
### Universal Dynamic Input: Primehack
Enable / Disable Venomalias's Universal Dynamic Input Texture for Primehack.
## Open Emulator / Component
### PortMaster: Hide
Here you launch and configure each emulator's settings, the option you choose will open that emulators GUI. For documentation on how to change the settings of each emulator's settings please check the website of each emulator.
Enable / Disable the PortMaster entry in ES-DE.
(Please note that most of the emulator interfaces where not designed with controller input in mind for handling the applications GUI, just the games. You might need to use other inputs like the Steam Decks touchscreen or a mouse and keyboard to navigate properly).
## Open Component
Launch and configure each components settings. The chosen option opens the components GUI.
The Components are all:
- Emulators
- Systems
- Engines
Shipped with RetroDECK.
**Steam Deck Note:**
Most component interfaces are not designed for controller input for the GUI. You may need to use the Steam Deck's touchscreen or a mouse and keyboard.
## RetroDECK: Tools
## Reset Component
This menu allows you to reset various components in RetroDECK or reset the entire application to its default settings. There is also a factory reset option.
### Tool: Remove empty ROM folders
## Tools
This tool removes all the roms folders under retrodeck/roms/ that are empty to only leave those that are populated with content.
### Tool: Rebuild all ROM folders
This tool rebuilds rom folders you have accidentally removed or used the `Remove empty ROM folders` tool.
### Tool: Move files
This option lets you choose the installation path of the RetroDECK folder that handles ROMS, Saves, BIOS, etc... to a new location.
You get the following three options.
`Internal Storage` - Moves the folder to the internal storage.
`SD CARD` - Moves the folder to the SD CARD
`Custom Location` - Choose where you want the RetroDECK folder to be.
### Tool: Compress games
This option enables you to compress disc-based game image files `.gdi` `.iso` `.bin` `.cue` to the less space demanding `.chd` format.
You can choose either a single game or many.
### Install: RetroDECK SD Controller Profile
This option installs the Steam controller profiles that RetroDECK into Steam.
### Install: PS3 Firmware
This option downloads and installs the latest PS3 firmware. At the end of the download, RPCS3 will open requesting the user to install it (just press OK).
### RetroDECK: Change update settings (cooker only)
This option lets you turn on or off automatic updates on launch.
## RetroDECK: Troubleshooting
Various troubleshooting options.
### Backup: RetroDECK Userdata
### Backup Userdata
Creates backups of the user data folders
### BIOS Checker
Launches the `BIOS Checker` tool that scans for needed BIOS files.
### Check & Verify: Multi-file structure
### Games Compressor
Verifies the structure of multi disc/file games that uses `.m3u` files.
Launches the `Games Compressor` tool that compresses games into smaller formats.
You can compress into:
- CHD
- ZIP
- RVZ
### Check & Verify: BIOS
Shows a detailed BIOS list of missing and current BIOS.
You can choose to compress one game or many.
### Install: RetroDECK Controller Layouts
This option installs the RetroDECK Steam Input Controller Templates into Steam.
### RetroDECK: Reset
The reset menu resets various features
### Install: PS3 Firmware
This option downloads and installs the latest PS3 firmware. After the download, RPCS3 will prompt you to install it.
### Install: PS Vita Firmware
#### Reset Specific Emulator
This option downloads and installs the latest PS Vita firmware.
Opens a menu where you can reset a specific emulator
### Update Notification
Enable / Disable the Update Notification for new RetroDECK versions.
#### Reset All Emulators
### Add RetroDECK to Steam
Resets all the emulators at once
A tool that adds RetroDECK to Steam with Art.
### Verify Multi-file Structure
#### Reset RetroDECK
Resets the entirety of RetroDECK.
`⚠️ WARNING! BACK UP YOUR DATA BEFORE RUNNING THIS! ⚠️`
## RetroDECK: About
This menu contains information about RetroDECK
### Credits
Displays the credits
A tool that checks the validity of .m3u files.
## Steam Sync
@ -204,4 +155,35 @@ Read more here:
[SRM Guide](../srm/srm-guide.md)
## Data Mangement
### Move Tools
Several move tools allow you to move specific folders to a new location.
`Internal Storage` - Moves the folder to the internal storage.
`SD CARD` - Moves the folder to the SD CARD
`Custom Location` - Choose where you want the RetroDECK folder to be.
### Clean Empty ROM Folders
This tool removes some or all the ROM folders under `retrodeck/roms/` that are empty, leaving only those populated with content.
### Rebuild All ROM Folders
This tool rebuilds ROM folders you have accidentally removed or used the `Clean Empty ROM Folders` tool.
## About RetroDECK
### Credits
Displays Credits.
### Version History
Menu for Patch Notes.
(Note: The patch notes are always more detailed on the wiki due to character limits during publication.)