https://github.com/francisdb/vpinball-plugin-rust
Building Visual Pinball plugins in Rust
https://github.com/francisdb/vpinball-plugin-rust
plugins rust visual-pinball vpinball
Last synced: about 2 months ago
JSON representation
Building Visual Pinball plugins in Rust
- Host: GitHub
- URL: https://github.com/francisdb/vpinball-plugin-rust
- Owner: francisdb
- License: mit
- Created: 2024-05-28T12:07:38.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-12-09T22:01:28.000Z (5 months ago)
- Last Synced: 2025-03-02T14:40:51.562Z (about 2 months ago)
- Topics: plugins, rust, visual-pinball, vpinball
- Language: Rust
- Homepage:
- Size: 27.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vpinball-plugin-rust
Example of a Visual Pinball plugin written in Rust
## Visual Pinball Plugin system
This is still work in progress and the API is not stable yet. All documentation is currently
at https://github.com/vpinball/vpinball/blob/10.8.1/src/plugins/VPXPlugin.h
## Installing the plugin
```sh
# build the plugin (this will also download the vpinball plugin header)
cargo build
# set the vpinball folder location env var
export VPINBALL_FOLDER=$HOME/vpinball
# copy the plugin to the plugin folder
mkdir -p $VPINBALL_FOLDER/plugins/vpinball_plugin_fps
# Mac
cp target/debug/libvpinball_plugin_fps.dylib $VPINBALL_FOLDER/plugins/vpinball_plugin_fps
# Linux
cp target/debug/libvpinball_plugin_fps.so $VPINBALL_FOLDER/plugins/vpinball_plugin_fps
cp fpscounter/plugin.cfg $VPINBALL_FOLDER/plugins/vpinball_plugin_fps
```
### Setting up the plugin
Add the following section to the `$HOME/.vpinball/VPinballX.ini` config file
```ini
[Plugin.fps]
enable = 1
[Plugin.rainbow.dmd]
enable = 1
```
## Issues tracked on the vpinball repo
* https://github.com/vpinball/vpinball/issues/2008