Skip to content

Commit

Permalink
Separate quickstart into GMC, MPF, and running sections
Browse files Browse the repository at this point in the history
  • Loading branch information
avanwinkle committed May 25, 2024
1 parent d202912 commit b1580b8
Showing 1 changed file with 22 additions and 15 deletions.
37 changes: 22 additions & 15 deletions docs/start/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,25 @@ title: MPF Quickstart
This is for people who know what they're doing. If you're lost, check out our full
[installation guides](../install/index.md).


## Quickstart for GMC

1. Download the Godot Editor from [https://godotengine.org](https://godotengine.org)

1. Download the latest GMC release from [https://github.com/missionpinball/mpf-gmc/releases/](https://github.com/missionpinball/mpf-gmc/releases/) (under Assets > Source code).

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

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*.

## Quickstart for MPF

1. MPF requires Python 3.8 - 3.12. Validate that you have a supported version of Python with `python3 --version`.

1. Create a virtual environment for mpf. In your home folder (or virtual environments folder) type `python3 -m venv mpf`
Expand All @@ -15,29 +34,17 @@ This is for people who know what they're doing. If you're lost, check out our fu

1. Install MPF 0.80: `pip install --pre mpf`

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.
1. In your terminal, navigate to the project folder you created and initialize 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*.
## Running the Game

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. 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 and text reading "Waiting for MPF..."

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

Expand Down

0 comments on commit b1580b8

Please sign in to comment.