Skip to content

Commit 9266f48

Browse files
committed
docs: Add README for Unity Project
1 parent c14f560 commit 9266f48

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Visual Pinball Engine - PinMAME Gamelogic Engine
2+
*Enables PinMAME to drive VPE*
3+
4+
## Setup
5+
6+
Add this to your Unity project via the package manager. When using a scoped
7+
registry, use `org.visualpinball.engine.pinmame`.
8+
9+
## Usage
10+
11+
This package adds a new Gamelogic Engine called *PinMAME*.
12+
Just add the component to your table and wire up the switches, coils, lights
13+
and DMD.
14+
15+
## Developer Setup
16+
17+
This UPM package gets build and published via CI. If you want to use it locally,
18+
you'll need to open and compile the VS solution first, which will copy the
19+
necessary binaries to the Unity package folder.
20+
21+
## License
22+
23+
[MIT](../LICENSE)

0 commit comments

Comments
 (0)