From 2f251a7c93bd54221e9355dedc83012fe29d2da1 Mon Sep 17 00:00:00 2001 From: Anthony van Winkle Date: Sun, 26 May 2024 13:38:22 -0700 Subject: [PATCH] Improve quickstart, document track > bus for audio configs --- docs/config/sound_player.md | 14 ++++++++++++++ docs/config/sounds.md | 17 ++++++++++++++++- docs/install/index.md | 4 ++++ docs/start/quickstart.md | 6 +++--- 4 files changed, 37 insertions(+), 4 deletions(-) diff --git a/docs/config/sound_player.md b/docs/config/sound_player.md index 056dec3549..dc9c4a1c70 100644 --- a/docs/config/sound_player.md +++ b/docs/config/sound_player.md @@ -129,6 +129,16 @@ sound_player: sw_jet_bumper_active: super_jet_bumper_sound|block ``` +### bus: + +!!! info "" + + New in MPF 0.80 + +Single value, type: `string`. Defaults to empty. + +Specifies an audio bus on which this sound should be played. Overrides the sound setting if one exists. + ### delay: Single value, type: `time string (secs)` @@ -238,6 +248,10 @@ overwrites the setting in your sound. ### track: +!!! warning "" + + Deprecated in MPF 0.80. Use `bus` instead. + Single value, type: `string`. Defaults to empty. Please refer to the [sounds:](sounds.md) documentation for details about this setting as it just diff --git a/docs/config/sounds.md b/docs/config/sounds.md index c08d2c4d3f..42fb57d212 100644 --- a/docs/config/sounds.md +++ b/docs/config/sounds.md @@ -51,7 +51,7 @@ sounds: file: extra_ball_12753.wav events_when_stopped: extra_ball_callout_finished streaming: false - track: voice + bus: voice volume: 0.5 priority: 50 max_queue_time: None @@ -85,6 +85,17 @@ duration of the sound, the event(s) will be posted as soon as the sound begins playback. This value is specified as a [time string](instructions/time_strings.md). + +### bus: + +!!! info "" + + New in MPF 0.80 + +Single value, type: `string`. Defaults to empty. + +Specifies an audio bus on which this sound should be played. If none is provided, the default bus will be used. + ### ducking: Single value, type: [sound_ducking:](sound_ducking.md). Defaults to empty. @@ -365,6 +376,10 @@ particular sound. When `streaming` is set to `True`, the ### track: +!!! warning "" + + Deprecated in MPF 0.80. Use `bus` instead. + Single value, type: `string`. Defaults to empty. This is the name of the track this sound will play on. (You configure diff --git a/docs/install/index.md b/docs/install/index.md index 5ff3dfdbac..cc181cb50d 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -75,6 +75,10 @@ Now when inside your virtual environment, you can run MPF simply by typing `mpf` * Mistakes can pollute Pip environments and cause dependency conflicts * No option to customize MPF or use bleeding-edge features +!!! note "Many Python Interpreters Supported" + + Without the MC's Kivy dependencies, MPF 0.80 now supports alternative Python interpreters like PyPy. You can use a different interpreter if you'd like. + ## Expert Installation: Local Repository (MPF 0.80) For complete control, you can clone the MPF repository to your computer and run it directly from the source code. diff --git a/docs/start/quickstart.md b/docs/start/quickstart.md index b527e19e88..278bde5a20 100644 --- a/docs/start/quickstart.md +++ b/docs/start/quickstart.md @@ -12,13 +12,13 @@ This is for people who know what they're doing. If you're lost, check out our fu 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. 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. Open the Godot Editor and create a new Project in a new folder of your choosing. This will be the project folder for your MPF machine code as well, so if you already have an MPF project choose that folder instead. 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, go to *Project Settings > Plugins* and check the Enable box for **Godot MC**. (Godot will show lots of errors during this step and the next, 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.