francisdb/vpin

Rust library for the visual/virtual pinball ecosystem

vpin

Rust library for the visual/virtual pinball ecosystem

https://crates.io/crates/vpin

Join #vpxtool on "Virtual Pinball Chat" discord for support and questions.

Documentation

https://docs.rs/vpin

Example code

Check the examples folder

Projects using vpin

https://github.com/francisdb/vpxtool

Other links

• Visual Pinball https://github.com/vpinball/vpinball
• VPUniverse https://vpuniverse.com/
• VPForums https://www.vpforums.org/
• Virtual Pinball Chat on Discord https://discord.com/invite/YHcBrtT

Running the integration tests

We expect a folder ~/vpinball/tables to exist that contains a lot of vpx and directb2s files. The tests will recursively search for these files and run the tests on them.

cargo test --release -- --ignored --nocapture

Making a release

We use https://github.com/MarcoIeni/release-plz which creates a release pr on every commit to master

vpin's Issues

set up clippy on ci

enforce no clippy issues

Extracted format: Give enum/type values proper names

We probably want strings for types instead of numeric values

eg for reflectionmode "dynamic" instead of 5 or at least support both

Extracted format: use ini field names?

We probably want the json field names to match the ini file?

eg

[DefaultProps\Light]
Falloff = 
FalloffPower = 
LightState = 
TimerEnabled = 
TimerInterval = 
Color = 
ColorFull = 
...

implement TimerDataRoot

In vpinball timer info is stored in this structure and used by most items

https://github.com/vpinball/vpinball/blob/10.8.1/src/parts/timer.h#L13-L18

Store sound output target in json as enum

In the vpx ui you can choose Table or Backglass

unhandled tag BRST

Indexing tables/Humpty Dumpty (Gottleb 1947)/Humpty Dumpty (Gottlieb 1947)v2_1.vpx
unhandled tag BRST 4 bytes

Extract dedupe obj files?

This is just an idea:

Can we de-duplicate the obj files by having them all point to the same file?

handle the internal lzw bitmap format

port over from the c# / js code?

https://github.com/vpdb/vpx-js/blob/master/lib/gltf/lzw-reader.ts
https://github.com/freezy/VisualPinball.Engine/blob/master/VisualPinball.Engine/IO/LzwReader.cs
https://github.com/freezy/VisualPinball.Engine/blob/master/VisualPinball.Engine/IO/LzwWriter.cs

Extracted format: very big folders

All gameitems are in a single folder
The github gui can't handle that and stops after 1000 items

Options:

• folder by type, probably not enough
• animation files in subfolder
• using something else than obj, but keep the obj option?

  I would say that vpx import/export for 3D model is also largely deprecated (wavefront obj). gltf/fbx are more used nowadays

• add more here

Add support for vpinball material files

Add support for materials files that can be exported from the editor.
What other things can be exported?

Extracted: Alternative mesh file format

I would say that vpx import/export for 3D model is also largely deprecated (wavefront obj). gltf/fbx are more used nowadays

Extracted: link meshes with textures

possible related to #42
Wevefront files can however have materials.

Maybe more a specific feature to extract a single mesh will related texture.
eg: vpxtool vpx extract gameitem x gltf test.vpx

Add lib to work with ipdb

https://github.com/xantari/Ipdb.Database

Probably something to do in a different repo

directb2s continue running/fixing integration tests

continuation of #12

• tafia/quick-xml#670
• tafia/quick-xml#671

run the integration tests to see if thee are any remaining issues

new vpx fields TMAP/TLCK

unhandled tag TMAP 4 bytes

https://www.vpforums.org/index.php?app=downloads&showfile=17871

directb2s do automatic base64 translation

do base64 serialization/de-serialization in on the fly

https://gist.github.com/ripx80/33f80618bf13e3f4964b0d75c62bfd28

improve or remove the listing

The current listing is incomplete.
We could remove that.
We might want to make it look like the exported format?
see also francisdb/vpxtool#305

hide any cfb in public interfaces

This is a low level detail that should not be exposed or exposed in a single place.

set up automated releases

upload to crates.io when a github release is made

Check function

That does general checks on the table

Some of these things might be caused by editing the file using vpxtool and might not actually be possible in the editor
Some of these might be more related to and extracted table

• duplicate sounds
• references to sounds that don't exist
• references to images that don't exist (warning this one is case insensitive but we might still report casing issues on the lowest level)
• references to materials that don't exist
• missing table info
• maximum object name length vpinball/vpinball#1706
• duplicates in images
• duplicates in meshes (currently there is difference in mesh vs mesh instance)
• extreme values that might cause artifacts, eg reflection of playfield > .2
• old bmp images
• suggest webp
• missing fonts
• unrecognized enum values
• mixed or non CRLF line endings in the script

Check what checks the vpinball audit performs
vpinball/vpinball#1502

Harder as we need to parse the code

• find unused images
• find referenced objects that don't exist vpinball/vpinball#1706
• find old deprecated calls
• suggest Option Explicit and Randomize

see also vpinball/vpinball#1706

directb2s add example

in the docs

Extracted: Improve image json format

See if we can get rid of the width / height fields
See if we can just detect .bmp files and not require different json compared to other formats.

GLAB tag ot handled

unhandled tag GLAB 4 bytes

Saw this when loading newer 10.8 tables

Timer interval is a signed int

Found this value on Label ScoreBox in Space Station https://www.vpforums.org/index.php?app=downloads&showfile=12717

4294967295 but this should be -1

Add lib to work with Virtual Pinball Spreadsheet

Virtual Pinball Spreadsheet
https://github.com/xantari/VPS.Database

see also https://virtual-pinball-spreadsheet.web.app/

Probably something to do in a different repo