Skip to content

Commit 2dbd1ad

Browse files
committed
doc: Update README.
1 parent b18f11f commit 2dbd1ad

File tree

2 files changed

+42
-22
lines changed

2 files changed

+42
-22
lines changed

.github/readme-editor.jpg

1.14 MB
Loading

README.md

Lines changed: 42 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,65 @@
11
![Banner](https://docs.visualpinball.org/creators-guide/introduction/jp-header.png)
22
# Visual Pinball Engine
33

4-
*A library that implements world's favorite pinball simulator.*
4+
*An engine for creating and re-creating pinball machines, virtually.*
55

66
[![build](https://github.com/freezy/VisualPinball.Engine/workflows/Build/badge.svg)](https://github.com/freezy/VisualPinball.Engine/actions?query=workflow%3ABuild) [![codecov](https://codecov.io/gh/freezy/VisualPinball.Engine/branch/master/graph/badge.svg?token=gyLOj3al3T)](https://codecov.io/gh/freezy/VisualPinball.Engine) [![UPM Package](https://img.shields.io/npm/v/org.visualpinball.engine.unity?label=org.visualpinball.engine.unity&registry_uri=https://registry.visualpinball.org&color=%2333cf57&logo=unity&style=flat)](https://registry.visualpinball.org/-/web/detail/org.visualpinball.engine.unity)
77

8-
## Why?
8+
VPE is a toolkit with the goal of making it easy to create pinball machines
9+
digitally. It uses [Unity's High Definition Render Pipeline](https://unity.com/srp/High-Definition-Render-Pipeline)
10+
and comes with extensive editor tooling that aims to provide all the features
11+
needed for such a task. It can read [Visual Pinball](https://github.com/vpinball/vpinball)'s
12+
file format and uses Visual Pinball's physics code for the simulation during gameplay.
913

10-
Today we have nice game engines like Unity or Godot that support C# out of the
11-
box. The goal of VPE is to easily provide what Visual Pinball makes so great to
12-
other "current gen" engines, while keeping backwards-compatibility.
14+
![image](.github/readme-editor.jpg)
1315

14-
VPE also aims to significantly improve the editor experience by extending the
15-
editor of the game engine.
16+
For a more detailed overview, header over to the [website](https://docs.visualpinball.org/creators-guide/introduction/overview.html). It's also where all the new features get documented.
1617

17-
For a more detailed overview, header over to the [website](https://docs.visualpinball.org/creators-guide/introduction/overview.html)!
1818

19-
## How?
19+
## History
20+
21+
The project started in late 2019 and is still actively being developed. We're part of the
22+
virtual pinball community and as such, this project is a community effort. The following is
23+
a list of relevant posts that document the progress of VPE so far.
24+
25+
- [Feburary 2020](https://www.vpforums.org/index.php?showtopic=43651) - First public post with VPX import working
26+
- [Feburary 2020](https://www.vpforums.org/index.php?showtopic=43651&page=7#entry443589) - It's alive!
27+
- [March 2020](https://www.vpforums.org/index.php?showtopic=43651&page=11#entry445624) - PinMAME is working
28+
- [May 2020](https://www.vpforums.org/index.php?showtopic=43651&page=12#entry451724) - Physics game loop ported over from Visual Pinball
29+
- [June 2020](https://www.vpforums.org/index.php?showtopic=43651&page=14#entry452533) - More physics
30+
- [August 2020](https://www.vpforums.org/index.php?showtopic=43651&page=21#entry456911) - Most editor tools ported from VPX
31+
- [October 2020](https://www.vpforums.org/index.php?showtopic=43651&page=26#entry459299) - Physics are complete, documentation site, scripting, MPF
32+
- [October 2020](https://www.vpforums.org/index.php?showtopic=43651&page=28#entry461034) - Materials, rendering
33+
- [November 2020](https://www.vpforums.org/index.php?showtopic=43651&page=29#entry461922) - Rendering
34+
- [December 2020](https://www.vpforums.org/index.php?showtopic=43651&page=31#entry464464) - More rendering
35+
- [March 2021](https://www.vpforums.org/index.php?showtopic=43651&page=32#entry470686) - Game logic
36+
- [April 2021](https://www.vpforums.org/index.php?showtopic=43651&page=34#entry476326) - Segment display shader
37+
- [June 2021](https://vpuniverse.com/forums/topic/5362-wip-visual-pinball-in-unity-2021-edition/) - Retrospect and the future
38+
- [September 2021](https://vpuniverse.com/forums/topic/5362-wip-visual-pinball-in-unity-2021-edition/?do=findComment&comment=55715) Prefabs, data, wiring, export and more
39+
- [December 2021](https://vpuniverse.com/forums/topic/5362-wip-visual-pinball-in-unity-2021-edition/?do=findComment&comment=57681) Insert lights rendering
40+
- [December 2021](https://vpuniverse.com/forums/topic/5362-wip-visual-pinball-in-unity-2021-edition/?do=findComment&comment=58676) - Visual Scripting POC
41+
- [January 2022](https://vpuniverse.com/forums/topic/5362-wip-visual-pinball-in-unity-2021-edition/?do=findComment&comment=59658) - It runs on an iPad!
42+
- [February 2022](https://vpuniverse.com/forums/topic/5362-wip-visual-pinball-in-unity-2021-edition/?do=findComment&comment=60788) - Lighting
43+
- [July 2022](https://vpuniverse.com/forums/topic/5362-wip-visual-pinball-in-unity-2021-edition/?do=findComment&comment=64348) - Visual Scripting, Physics, Asset Library, Tutorials, VR/AR, the future
44+
- [December 2022](https://vpuniverse.com/forums/topic/5362-wip-visual-pinball-in-unity-2021-edition/?do=findComment&comment=67277) - Asset library, world space, score motors
45+
46+
47+
If you're generally interested in virtual pinball, also check out [our guest article at thisweekinpinball.com](https://www.thisweekinpinball.com/a-peek-into-the-digital-creator-community/).
48+
49+
50+
## VPE Repositories
2051

2152
The "core" of VPE (i.e. the `VisualPinball.Engine` project) is a pure C# port
2253
of the original Visual Pinball. It has no dependencies to any proprietary third
2354
parties, and provides the data layer.
2455

25-
We're currently focusing on Unity as a game engine. Visual Pinball's physics
26-
engine has been ported to [DOTS](https://unity.com/dots), and we're focusing
27-
on Unity's [HDRP](https://docs.unity3d.com/Packages/[email protected]/manual/index.html)
28-
for the visuals.
29-
30-
## Dependency Graph
31-
3256
This repository is part of a number of packages. It is what we're referring to as the **main package**.
3357

3458
![image](https://user-images.githubusercontent.com/70426/103706031-64db6080-4fac-11eb-837e-5e7cddd86d7b.png)
3559

36-
## Current Status
37-
38-
VPE is still work in progress. You can check the current features list [here](https://docs.visualpinball.org/creators-guide/introduction/features.html)
39-
and the open issues [here](https://github.com/freezy/VisualPinball.Engine/issues).
60+
## Screenshots
4061

41-
There are a few videos in the [VPF thread](https://vpuniverse.com/forums/topic/5362-wip-visual-pinball-in-unity-2021-edition/),
42-
where you can discuss. Screenshots are [here](https://github.com/freezy/VisualPinball.Engine/wiki/Unity-Screenshots)! :)
62+
We've put them in [a Wiki](https://github.com/freezy/VisualPinball.Engine/wiki/Unity-Screenshots). :)
4363

4464
## Credits
4565

0 commit comments

Comments
 (0)