Merge pull request #11 from hiulit/develop

Develop

.override_defaults.cfg

@@ -0,0 +1,3 @@
+[audio]
+mix_rate=44100
+output_latency=15

CHANGELOG.md

@@ -4,6 +4,21 @@
 
 - Up to date
 
+## [1.5.0] - 2021-03-23
+
+### Added
+
+- A new `override.cfg` file in `~/RetroPie/roms/godot-engine`, with some default audio values, to let the user [override settings](https://docs.godotengine.org/de/stable/classes/class_projectsettings.html) of the Godot "emulator.
+- New documentation about audio issues (see [#7](https://github.com/hiulit/RetroPie-Godot-Engine-Emulator/issues/7)).
+
+### Changed
+
+- New Pixel theme's Godot logo.
+
+### Fixed
+
+- Godot `2.1.6` command line options [#4](https://github.com/hiulit/RetroPie-Godot-Engine-Emulator/issues/4).
+
 ## [1.4.0] - 2021-03-17
 
 ### Added
@@ -20,7 +35,6 @@
 
 - Configuration dialog back button was exiting instead of going back.
 
-
 ### Removed
 
 - Godot binaries compiled for the Raspberry Pi 4. RetroPie doesn't use X11 so they were useless :)

README.md

@@ -4,21 +4,23 @@
 
 A scriptmodule to install a Godot "emulator" for RetroPie.
 
+![Retropie-Godot-Banner](example-images/retropie-godot-banner.jpg)
+
 Thanks to [@efornara](https://github.com/efornara) (for creating [FRT - A Godot "platform" targeting single board computers](https://github.com/efornara/frt)) you can now play 2D games made with the [Godot Engine](https://godotengine.org/) on the Raspberry Pi (and other single-board computers) using [RetroPie](https://retropie.org.uk/).
 
-If you are running RetroPie on an `x86/x86_64` Linux PC, you can also play Godot games since the Godot "emulator" is actually the official **Linux/X11** export template.
+If you are running RetroPie on an `x86/x86_64` Linux PC you can also play Godot games, since the Godot "emulator" is actually the official **Linux/X11** export template.
 
 ## Table of contents
 
 - [Where to find games made with Godot](#-where-to-find-games-made-with-godot)
-- [Compatibility list](#-compatibility-list)
-- [Setup script](#-setup-script)
+- [Compatibility list](#%EF%B8%8F-compatibility-list)
+- [Setup script](#%EF%B8%8F-setup-script)
 - [Install the Godot "emulator" from RetroPie-Setup](#install-the-godot-emulator-from-retropie-setup)
 - [Uninstall the Godot "emulator" from RetroPie-Setup](#uninstall-the-godot-emulator-from-retropie-setup)
 - [Update the Godot "emulator" from RetroPie-Setup](#update-the-godot-emulator-from-retropie-setup)
 - [How to install Godot games](#how-to-install-godot-games)
 - [Using a GPIO/Virtual keyboard](#using-a-gpiovirtual-keyboard)
-- [Troubleshooting](#-troubleshooting)
+- [Troubleshooting](#ℹ%EF%B8%8F-troubleshooting)
 - [How to create a new Godot system for an EmulationStation theme](#-how-to-create-a-new-godot-system-for-an-emulationstation-theme)
 - [Pre-made Godot systems](#-pre-made-godot-systems)
 
@@ -132,7 +134,7 @@ Go to:
 
 ## Update the Godot "emulator" from RetroPie-Setup
 
-> Before updating the "emulator", you must update the setup script and the scriptmodule.
+> Before updating the "emulator", you must update the **setup script** and the **scriptmodule**.
 
 Run:
 
@@ -167,7 +169,7 @@ To install it, just copy the `.pck` file to `/home/pi/RetroPie/roms/godot-engine
 
 ## Using a GPIO/Virtual keyboard
 
-**Warning! When using a GPIO/Virtual keyboard, the actual keyboard won't work anymore. But you can always remove the GPIO/Virtual keyboard (see below).**
+> ⚠️ When using a GPIO/Virtual keyboard, the actual keyboard won't work anymore. But you can always remove the GPIO/Virtual keyboard (see below).
 
 As of **v1.2.0**, when using the **FRT** "emulator", you can use a GPIO/Virtual keyboard, such as [GPIOnext](https://github.com/mholgatem/GPIOnext) or [Adafruit's Retrogame](https://github.com/adafruit/Adafruit-Retrogame).
 
@@ -186,11 +188,11 @@ and then go to:
 
 Select **Use a GPIO/Virtual keyboard**.
 
-![Configuration dialog](example-images/configuration-dialog.png)
+![Configuration dialog](example-images/gpio-virtual-keyboard-dialog.png)
 
 Select **Yes**.
 
-![GPIO/Virtual keyboard dialog](example-images/gpio-virtual-keyboard-dialog.png)
+![GPIO/Virtual keyboard dialog](example-images/gpio-virtual-keyboard-dialog_yesno.png)
 
 You will be prompted with a menu showing all the results from the command `cat /proc/bus/input/devices`. Select the GPIO/Virtual keyboard that you want.
 
@@ -231,14 +233,40 @@ Go to:
 
 Select **Force GLES2 video driver**.
 
-![Configuration dialog](example-images/configuration-dialog.png)
+![Configuration dialog](example-images/force-gles2-video-driver-dialog.png)
 
 Select **Yes**.
 
-![Force GLES2 video driver dialog](example-images/force-gles2-video-driver-dialog.png)
+![Force GLES2 video driver dialog](example-images/force-gles2-video-driver-dialog_yesno.png)
 
 If you want to to reverse that action, follow the same steps and select **No**.
 
+### Audio issues
+
+If you find that the sound is glitchy, you can try to fix it by changing some values in the `override.cfg` file.
+
+Run:
+
+```
+sudo /home/pi/RetroPie-Setup/retropie_setup.sh
+```
+
+Go to:
+
+- Configuration/tools
+- godot-engine
+
+Select **Edit "override.cfg"**.
+
+![Override dialog](example-images/override-dialog.png)
+
+Under the `[audio]` section, set:
+
+- `mix_rate` to `48000`.
+- `output_latency` to `20` (or `30`).
+
+![Edit override dialog](example-images/edit-override-dialog.png)
+
 ## 🎨 How to create a new Godot system for an EmulationStation theme
 
 As there is no way to create a script to automate this, because themes don't have the same structure, the best way is to manually create a new system in your preferred theme.
@@ -257,18 +285,20 @@ The folder structure in the theme you are using might differ. Take a look at how
 
 I've created a couple of ready-to-use Godot systems:
 
-- For the **Carbon theme**, which is the default EmulationStation theme that comes in RetroPie.
+- For the **Carbon theme**, which is the default EmulationStation theme that comes with RetroPie.
 - For the **Pixel theme**, my personal favourite theme.
 
+If you want to add a new theme, feel free to open a [pull request](https://github.com/hiulit/cross-compile-godot-raspberry-pi/pulls).
+
 To install a Godot system, copy the `theme/[THEME]/godot-engine` folder from this repository to `/etc/emulationstation/themes/[THEME]`.
 
 ### Carbon theme
 
-![Godot system for EmulationStation's Carbon theme](example-images/godot-engine-carbon-theme.jpg)
+![Godot system for EmulationStation's Carbon theme](example-images/godot-engine-carbon-theme.png)
 
 ### Pixel theme
 
-![Godot system for EmulationStation's Pixel theme](example-images/godot-engine-pixel-theme.jpg)
+![Godot system for EmulationStation's Pixel theme](example-images/godot-engine-pixel-theme.png)
 
 ## 🗒️ Changelog
 
@@ -315,7 +345,7 @@ Thanks to:
 - **Emanuele Fornara** ([@efornara](https://github.com/efornara)) - For creating [FRT - A Godot "platform" targeting single board computers](https://github.com/efornara/frt).
 - **Andrea Calabró** - For creating the "Godot logo". Changes made to it:
   - Created an outline version.
-- **Alícia Folgarona Ribot** (Alfórium Studios - [@alforiumstudios](https://twitter.com/alforiumstudios)) - For creating the "Pixel Godot logo". Changes made to it:
+- **Alícia Folgarona Ribot** ([@pingudroid](https://twitter.com/pingudroid)) - For creating the "Pixel Godot logo". Changes made to it:
   - New colors.
   - Added white outline.
 
@@ -324,5 +354,5 @@ Thanks to:
 - Source code: [MIT License](/LICENSE).
 - Godot Engine: [MIT License](/LICENSE_GODOT.txt).
 - FRT - A Godot platform targeting single board computers: [MIT License](/LICENSE_FRT.txt).
-- Godot logo: [CC BY](https://creativecommons.org/licenses/by/3.0/).
+- Godot logo: [CC BY](https://creativecommons.org/licenses/by/4.0/).
 - Pixel Godot logo: [CC BY-NC-SA](https://creativecommons.org/licenses/by-nc-sa/4.0/).