From 3ff229509ab669ceaf193ae3f06dbaa31d843be9 Mon Sep 17 00:00:00 2001 From: Anthony van Winkle Date: Sat, 25 May 2024 15:45:55 -0700 Subject: [PATCH] Update quickstart guide for 0.80+GMC --- docs/start/quickstart.md | 39 ++++++++++++++++++++++++++++++++------- 1 file changed, 32 insertions(+), 7 deletions(-) diff --git a/docs/start/quickstart.md b/docs/start/quickstart.md index 6417cf6b8c..9d7ac0a9c6 100644 --- a/docs/start/quickstart.md +++ b/docs/start/quickstart.md @@ -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!