Skip to content

Commit

Permalink
Update quickstart guide for 0.80+GMC
Browse files Browse the repository at this point in the history
  • Loading branch information
avanwinkle committed May 25, 2024
1 parent eb45227 commit 3ff2295
Showing 1 changed file with 32 additions and 7 deletions.
39 changes: 32 additions & 7 deletions docs/start/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,43 @@
title: MPF Quickstart
---

# Quickstart guide to MPF
# Quickstart guide to MPF 0.80 and GMC

This is for people who know what they're doing. If you're lost, check out our full
[installation guides](../install/index.md).

1. MPF requires Python 3.7 - 3.9. Newer than 3.9 won't work. (Update: MPF 0.57 supports Python 3.10 & 3.11. See our [0.57 page](0.57.md) for details.)
1. MPF requires Python 3.8 - 3.12. Validate that you have a supported version of Python with `python3 --version`.

2. `pip install mpf`
1. Create a virtual environment for mpf. In your home folder (or virtual environments folder) type `python3 -m venv mpf`

3. `pip install mpf-monitor`
1. Activate your virtual environment: `source mpf/bin/activate` (on Mac/Linux) or `mpfenv/Scripts/Activate.ps1` (Windows PowerShell)

4. Create a folder for your machine config files as outlined in the [tutorial](../tutorial/index.md).
1. Install MPF 0.80: `pip install --pre mpf`

We do not recommend installing the Media Controller right away since it's more of a pain to get installed, and
you don't need it yet.
1. Download the Godot Editor from https://godotengine.org

1. Download the latest GMC release from https://github.com/missionpinball/mpf-gmc/releases/

1. Open the Godot Editor and create a new Project in a new folder of your choosing.

1. Navigate to that folder in your terminal and create an MPF config file.

``` console

mkdir config
echo "#config_version=6" > config/config.yaml
```

1. Extract the GMC download and copy the *addons* folder into your project folder.

1. In the Godot Editor, go to *Project Settings > Plugins" and check the Enable box for **Godot MC**. (Godot will show lots of errors, ignore them).

1. In the Godot Editor *Project Settings > Autoload* select the folder to add a new Autoload and choose the file *addons/mpf-gmc/mpd_gmc.gd*. Set the Node name to `MPF` (all caps) and press Add.

1. Save your Godot project and then in the editor menu select *Project > Reload Current Project*.

1. Press the play button in the top-right of the Godot Editor. When prompted to select a main scene, select *addons/mpf-gmc/slides/window.tscn*. You should see a window appear with the MPF logo.

1. In your terminal, type `mpf -xt`

The Godot window should now say "Connected to MPF". Congratulations, you're running a pinball game!

0 comments on commit 3ff2295

Please sign in to comment.