Skip to content

Commit

Permalink
Update 0.57.2 release notes and GMC installation
Browse files Browse the repository at this point in the history
  • Loading branch information
avanwinkle committed Jun 19, 2024
1 parent 1c59021 commit 7d586f1
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
11 changes: 8 additions & 3 deletions docs/gmc/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,14 @@ title: Installing GMC

Before you get working with GMC, you need to install MPF 0.80 by following the [MPF Installation Guide](../install/index.md).


!!! note "Upgrade is available"

If you already have a working MPF 0.57 installation, you can upgrade to MPF 0.80 with the command `pip install --upgrade --pre mpf`. However, to maintain the option of reverting back to 0.57 it's recommended to create a new, separate virtual enviroment for MPF 0.80 and install it there.

## Download Godot 4

The Godot Media Controller is, of course, built on the Godot game engine. Visit [https://godotengine.org](https://godotengine.org) to download the latest version of the Godot Editor (4.2 or later) and install it on your machine.
The Godot Media Controller is built on the Godot game engine. Visit [https://godotengine.org](https://godotengine.org) to download the latest version of the Godot Editor (4.2 or later) and place it wherever you typically keep applications on your machine (not in your game project folder).

After Godot is installed, open the editor and create a New Project. Select your MPF game project folder as the project path, and choose an appropriate render engine.

Expand All @@ -24,9 +29,9 @@ Finally, in your game project folder create a new folder called *addons*.

!!! note "Root project vs GMC subfolder"

Some users prefer to create a distinct "gmc" subfolder in their MPF machine folder, and save their Godot project there. This keeps the Godot Editor *FileSystem* tree cleaner because it's not filled with MPF config files, and can make it easier to navigate and maintain each piece independently.
Some users prefer to create a distinct "gmc" subfolder in their MPF machine folder, and save their Godot project there. This keeps the Godot Editor *FileSystem* tree cleaner because it's not mixing Godot files with MPF config files, which can make it easier to navigate and maintain.

Note that Godot only has access to files in its project folder and below. If you choose to make a "gmc" subfolder for your Godot project, all slides, sounds, and widgets will need to be in those respective subfolders in the gmc folder (e.g. */gmc/slides/*), NOT in the MPF mode subfolders (e.g. */modes/attract/slides/*).
However, note that Godot only has access to files in its project folder and subfolders. If you choose to make a "gmc" subfolder for your Godot project, all slides, widgets, sound files, and video files will need to be in those respective subfolders in the gmc folder (e.g. */gmc/slides/*), NOT in the MPF mode subfolders (e.g. */modes/attract/slides/*).

## Install the GMC Plugin

Expand Down
4 changes: 4 additions & 0 deletions docs/versions/release_notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,16 @@ MPF 0.57.2 includes improvements to ball search.

### New Features
* Switch `ignore_during_ball_search:` config option to prevent false positives during searches
* Switch support for `playfield:` config option to propagate to devices (drop targets, shots, etc.)
* Playfield `enable_ball_search:` now supports templates, e.g. `settings.enable_ball_search==1`
* OPP: Support for `WING_SOL_8` wings with up to 32 solenoids
* Virtual Pinball: Support for segment displays

### Improvements
* Playfield *playfield_active* event now includes the source of the active trigger
* Better (more reliable) suppression of switch hits from Drop Target firings during ball search
* Better error messaging for ball search on a playfield without iterator devices
* Ball devices that mark playfield active can now inherit the playfield from their switch

### Bug Fixes
* Fixed a bug in ball search phase/iteration counting that miscounted the number of phases and iterations to perform
Expand Down

0 comments on commit 7d586f1

Please sign in to comment.