Skip to content

Commit

Permalink
Updates for dev moving to 0.57
Browse files Browse the repository at this point in the history
  • Loading branch information
toomanybrians committed Sep 16, 2023
1 parent 5ff1cf9 commit c51104c
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 23 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.vscode

# ignore all the generated files in the project folder
# except the files we need which start with _
docs/showcase/*
Expand Down
33 changes: 22 additions & 11 deletions docs/install/0.57.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,36 @@
title: Notes for upgrading to MPF 0.57
---

# MPF 0.57 plans & timeline (last updated August 7, 2023)
# The `dev` branch is now v0.57 (last updated Sept 16, 2023)

MPF 0.57 is being worked on now. It is not ready for testing yet, but we wanted to give you a heads up on what to expect.
We estimate MPF 0.57 will be ready for testing in the late August 2023 timeframe.

If you want to track the progress, the 0.57 working fork is here: [github.com/missionpinball/mpf/tree/0.57](https://github.com/missionpinball/mpf/tree/0.57)
The dev branch of MPF is now v0.57. (Technically `0.57.0.dev6` as of this writing, though the dev version number changes frequently.)

## Big changes in 0.57

* Add support for Python 3.10 and 3.11
* Remove support for Python 3.7
* Changes the YAML interface to remove "hacks" we added years ago. Now MPF supports pure YAML with no customizations.
* Add support for Python 3.10 and 3.11 (3.8 and 3.9 are still supported. 3.7 might work but is no longer being tested)
* Changes the YAML interface to remove "hacks" we added years ago. Now MPF supports the pure YAML spec.
* This requires [some changes](../config/instructions/config_v6.md) (not too bad) to your config files.
* Config files are now `config_version=6`
* Show files are now `show_version=6`
* Removed the config file migrator (hasn't been used in years)
* Completely overhauled FAST Pinball platform interface, with support for the FAST Neuron Controller and Expansion Boards

## How to install MPF dev / 0.57

The installation packages have been published, so you can install via `pip` just like how you install MPF. Just add the `--pre` flag to install the pre-release version:

``` bash
pip install mpf --pre
```

If you want to install a new version of Python (like 3.11), you can, and run it side-by-side your existing version. Then you can access Python 3.11 and pip for Python 3.11 via `pip3.11 install mpf --pre`

## What about MPF-MC?
## MPF-MC is not updated yet!

MPF required lots of internal engineering to support Python 3.10+ and pure YAML. MPF-MC will need that same work. The plan is to get MPF 0.57 to a good state, and then to start working on MPF-MC 0.57. This means there will be a delay between MPF 0.57 and MPF-MC 0.57. Hopefully that's only a few weeks or a month, but since MPF-MC is much more complicated than MPF, it could take longer.
MPF required lots of internal engineering to support Python 3.10+ and pure YAML. MPF-MC will need that same work and has not been done yet. Now that MPF 0.57 is
ready for testing, we'll start on MPF-MC. Hopefully that should be quick. (A few weeks?) But who knows what we find when we start digging in...

All this work is being done by one person (by me, Brian, hello!) If you want to help, please reach out to [email protected]. Thanks!
We also need to update MPF Monitor for 0.57, but that should be quick.

## Upgrading to MPF 0.57

Expand Down
15 changes: 4 additions & 11 deletions docs/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,7 @@ title: Downloading & Installing MPF (2023 Version)

# Installing MPF


The MPF Installers were rewritten from scratch and completely updated
for MPF 0.56 in August 2022. (If you're using an older version of MPF,
see the [docs for the version you're using](../versions/docs.md) for installation
instructions.)
The current stable version of MPF is `0.56.x`.

MPF should work with following platforms:

Expand All @@ -17,14 +13,11 @@ MPF should work with following platforms:
* Linux (64-bit, lots of distros)
* Raspberry Pi

Python 3.9 is the latest version of Python supported. Some platforms
also support Python 3.7 and 3.8. Python 3.10+ will not work.
MPF 0.56 only works with Python 3.7 - 3.9.

!!! note "MPF 0.57 will support Python 3.10 & 3.11"
!!! note "MPF 0.57 supports Python 3.10 & 3.11"

MPF 0.57, which is in progress now and should be available for testing
somewhere in the Aug/Sept 2023 timeframe will drop support for Python 3.7
and add support for Python 3.10 and 3.11. See our [0.57 page](0.57.md) for details.
MPF 0.57, which is the current `dev` branch of MPF, supports Python 3.8 - 3.11. See our [0.57 page](0.57.md) for details.

Here links to the installation guides for each platform:

Expand Down
2 changes: 1 addition & 1 deletion docs/start/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ 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).

1. MPF requires Python 3.7 - 3.9. Newer than 3.9 won't work.
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.)

2. `pip install mpf`

Expand Down

0 comments on commit c51104c

Please sign in to comment.