Skip to content

Commit db56a67

Browse files
arthurkehrwaldfreezy
authored andcommitted
Update README
1 parent 5f6db54 commit db56a67

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,52 +2,52 @@
22

33
[![UPM Package](https://img.shields.io/npm/v/org.visualpinball.engine.missionpinball?label=org.visualpinball.engine.missionpinball&registry_uri=https://registry.visualpinball.org&color=%2333cf57&logo=unity&style=flat)](https://registry.visualpinball.org/-/web/detail/org.visualpinball.engine.missionpinball)
44

5-
*Enables the Mission Pinball Framework to drive VPE*
5+
_Enables the Mission Pinball Framework to drive VPE_
6+
7+
Documentation at <https://docs.visualpinball.org/plugins/mpf/>
68

79
## Overview
810

9-
[MPF](https://missionpinball.org/latest/about/) is an open-source framework
11+
[MPF](https://missionpinball.org/latest/about/) is an open-source framework
1012
written in Python to drive real pinball machines. It has a "configuration over
11-
code" approach, meaning that 90% of what you'd do in a pinball game can be
13+
code" approach, meaning that 90% of what you'd do in a pinball game can be
1214
achieved through configuration (YAML files) rather than implementing it in code.
1315

1416
When you read MPF's [Getting Started](https://missionpinball.org/latest/start/)
15-
page, you'll notice a banner stating that "MPF is not a simulator." Well,
16-
you've found the simulator. ;)
17-
18-
This project lets you use MPF to drive game logic in [VPE](https://github.com/freezy/VisualPinball.Engine),
19-
a pinball simulator based on Unity. It does this by spawning a Python process running
20-
MPF and communicating with VPE through [gRPC](https://grpc.io/).
21-
22-
### Installation
23-
24-
This project is available as a Unity package at `registry.visualpinball.org`.
25-
To install it, make sure the scoped registry is added in your Package Manager
26-
settings. Then open the Package Manager in Unity and add
27-
`org.visualpinball.engine.missionpinball` under *Install package by name*.
28-
29-
The Unity package is build and published to our registry on every merge to master.
17+
page, you'll notice a banner stating that "MPF is not a simulator." Well, you've
18+
found the simulator. ;)
3019

31-
## Setup
20+
This project lets you use MPF to drive game logic in
21+
[VPE](https://github.com/freezy/VisualPinball.Engine), a pinball simulator based
22+
on Unity. It does this by spawning a Python process running MPF and
23+
communicating with VPE through [gRPC](https://grpc.io/).
3224

33-
You currently need Python and MPF installed locally.
25+
## User setup
3426

35-
1. Install Python 3
36-
2. `pip install --pre mpf mpf-mc`
27+
This project is available as a Unity package at `registry.visualpinball.org`. To
28+
install it, make sure the scoped registry is added in your Package Manager
29+
settings. Then open the Package Manager in Unity and add
30+
`org.visualpinball.engine.missionpinball` under _Install package by name_.
3731

38-
Or, if you already have it:
32+
The Unity package is built and published to our registry on every merge to
33+
master.
3934

40-
`pip install mpf mpf-mc --pre --upgrade`
35+
# Use
4136

42-
After that, `mpf --version` should return at least **MPF v0.55.0-dev.37**.
37+
1. Add the `MpfGamelogicEngine` component to the root object of your table
38+
2. Click on 'Get Machine Desciption' in its inspector
39+
3. Click on 'Populate Hardware' to bring the coils switches and lamps from MPFs
40+
machine description into VPEs respective manager windows
41+
4. Assign the coils, switches and lamps to items on your playfield using the
42+
coil, switch and lamp manager windows
4343

4444
## Development Setup
4545

4646
In order to import the package locally instead from our registry, clone and
4747
compile it. This will copy the necessary binaries into the Unity folder. Only
4848
then, import the project into Unity.
4949

50-
Since the Unity folder contains `.meta` files of the binaries, but not the
50+
Since the Unity folder contains `.meta` files of the binaries, but not the
5151
actual binaries, `.meta` files of uncompiled platforms are cleaned up by Unity.
5252
In order to not accidentally commit those files, we recommend to ignore them:
5353

@@ -71,4 +71,4 @@ git update-index --assume-unchanged Plugins/VisualPinball.Engine.Mpf.pdb.meta
7171

7272
## License
7373

74-
[MIT](LICENSE)
74+
[MIT](LICENSE)

0 commit comments

Comments
 (0)