https://github.com/freezy/vpweb

:joystick: Visual Pinball for the Web
https://github.com/freezy/vpweb

game pinball pinball-simulation visualpinball

Last synced: 2 months ago
JSON representation

:joystick: Visual Pinball for the Web

• Host: GitHub
• URL: https://github.com/freezy/vpweb
• Owner: freezy
• License: gpl-2.0
• Created: 2019-06-24T22:19:48.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T17:58:25.000Z (2 months ago)
• Last Synced: 2024-10-29T19:16:11.122Z (2 months ago)
• Topics: game, pinball, pinball-simulation, visualpinball
• Language: JavaScript
• Homepage:
• Size: 25.8 MB
• Stars: 15
• Watchers: 4
• Forks: 4
• Open Issues: 79
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Visual Pinball for the Web

[VPX-JS](https://github.com/vpdb/vpx-js) is only a library, so there must be

something that runs it. This is it. Its current main purpose is to serve as a

development tool. It doesn't do much but create a three.js scene and load VPX-JS

when a VPX file is dragged onto it.

*This is very much work in progress. You have been warned.*

## Usage

For the ambitious, you'll have to clone both repos. Some time in the future 

you'll find VPX-JS on NPM.

```bash

git clone https://github.com/vpdb/vpx-js.git

cd vpx-js

npm ci

npm run build

cd ..

git clone https://github.com/freezy/vpweb.git

cd vpweb

npm ci

npm start

```

## Quirks

The dragged VPX is locally cached so you wouldn't need to re-drag it every time

the page is reloaded. So it parses the VPX file on every page reload. This means

that if you want to test a different file, you'll have to clear the application

data and refresh the page.

Sometimes it might not work because VPX-JS changed the API on a new branch and

that branch isn't merged yet. In this case look for the freshest branch on 

VPX-JS and use that one.

## License

GPL-2.0