Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vpdb/vpx-js
:video_game: Visual Pinball in the Browser
https://github.com/vpdb/vpx-js
gltf javascript physics-engine pinball pinball-simulation visualpinball
Last synced: 2 months ago
JSON representation
:video_game: Visual Pinball in the Browser
- Host: GitHub
- URL: https://github.com/vpdb/vpx-js
- Owner: vpdb
- License: gpl-2.0
- Created: 2019-05-03T23:27:20.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-11-22T01:12:09.000Z (about 1 year ago)
- Last Synced: 2024-04-23T13:36:59.457Z (9 months ago)
- Topics: gltf, javascript, physics-engine, pinball, pinball-simulation, visualpinball
- Language: TypeScript
- Homepage:
- Size: 22.7 MB
- Stars: 47
- Watchers: 4
- Forks: 11
- Open Issues: 58
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Visual Pinball X in JavaScript
*A port of the best pinball simulator out there*
[![Build Status][travis-image]][travis-url]
[](https://codecov.io/gh/vpdb/vpx-js)
[![Dependencies][dependencies-image]][dependencies-url]
## Features
This isn't a ready-to-use game. It's a library of loosely-coupled components that
together implement [Visual Pinball](https://sourceforge.net/projects/vpinball/)'s
player for the web.
The player can be split into three parts:
1. The rendering engine
2. The physics engine
3. The scripting engine
This library provides an abstraction layer for rendering with [three.js](https://threejs.org/),
which covers the first point. A physics loop is implemented by the `Player`
class. Collision detection and rigid body dynamics are fully ported, covering the
second part. Work on scripting has begun with the wiring set up and the default
table script working. More info about how we go about this can be found
[here](https://github.com/freezy/vpweb/issues/1).
### Rendering
VPX-JS reads Visual Pinball's VPX format and extracts all meshes in VP's internal
format. Using an abstraction layer, any WebGL framework can convert this format
and construct a scene. An adapter for three.js is included.
Additionally, VPX-JS supports direct export to [GLTF](https://www.khronos.org/gltf/)
files, which is nice, because it allows off-loading the export to a server. It's
also nice because GLTF allows doing stuff that Visual Pinball's [OBJ](https://en.wikipedia.org/wiki/Wavefront_.obj_file)
export doesn't, for example:
- Include materials, textures and lights in one single file
- Apply optimizations:
- PNG textures with no transparency are converted to JPEG
- PNG textures with transparency are [PNG-crushed](https://en.wikipedia.org/wiki/Pngcrush)
- Compress meshes with [Draco](https://google.github.io/draco/)
*A table in the browser using three.js*
### Physics
VPX-JS uses the same physics code than Visual Pinball. That means the gameplay
is identical in the browser than when running VPX.
### Scripting and VPM
For scripting, see [this issue](https://github.com/freezy/vpweb/issues/1). About
VPM, there isn't a JavaScript implementation of PinMAME yet. However, @neophob
wrote a [WPC emulator](https://github.com/neophob/wpc-emu) from scratch that will
cover many games already.
## Development Setup
Given this is a lib, you'll need an actual web application to test. There is a
simple one we're currently using for development [here](https://github.com/freezy/vpweb).
This *vpweb* project retrieves VPX-JS from NPM, so in order to iterate rapidly,
we'll link it to your local working copy.
```bash
git clone https://github.com/vpdb/vpx-js.git
cd vpx-js
npm ci
npm link
npm run build:watch
```
And the vpweb host application:
```bash
git clone https://github.com/freezy/vpweb.git
cd vpweb
npm ci
npm link vpx-js
npm start
```
Then connect to `http://localhost:8080` and drag a VPX file into it. Note that
the scripting engine is still limited. However, the table script of the default
table should now work.
## Usage
WIP. The API will be documented when it's considered stable.
## Tests
Run tests with:
```bash
npm run test
```
For more infos about how tests are written, see [here](https://github.com/vpdb/vpx-js/tree/master/test#readme)
## Credits
* @jsm174 for getting the Nearley grammar right and his work on translating VBScript to JavaScript
* @neophob for his awesome WPC-EMU integration
Special thanks go to JetBrains for their awesome IDE and support of the Open Source Community!
## License
GPLv2, see [LICENSE](LICENSE).
[travis-image]: https://img.shields.io/travis/vpdb/vpx-js/master?style=flat-square
[travis-url]: https://travis-ci.org/vpdb/vpx-js
[dependencies-image]: https://david-dm.org/vpdb/vpx-js.svg?style=flat-square
[dependencies-url]: https://david-dm.org/vpdb/vpx-js