From 724ba0cfea85c02324700d1c9b0d6f55c5c5a8e4 Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Sun, 19 May 2024 23:42:50 +0200 Subject: [PATCH] Documentation update --- FAQ.md | 2 +- INSTALL-DEV.md | 6 +++--- INSTALL.md | 10 +++++++++- 3 files changed, 13 insertions(+), 5 deletions(-) diff --git a/FAQ.md b/FAQ.md index 82b7a50b3..2db2d8edc 100644 --- a/FAQ.md +++ b/FAQ.md @@ -148,4 +148,4 @@ First check the project [Kanban](https://gitlab.com/es-de/emulationstation-de/-/ ## I want to setup a gaming appliance based on a single-board computer, can I use ES-DE for this? -This is not the goal of ES-DE, the application requires a desktop environment to run. If you want to run a frontend on a single-board computer without using Xorg or Wayland then there are better options out there. But many people run ES-DE on arcade cabinets and similar which is definitely possible, it just requires a desktop-class operating system. +Yes this is possible, although this is not the primary use case for ES-DE. As the application is not intended to be the sole user interface for the computer there is no built-in functionality to manage operating system settings and emulator settings for instance. ES-DE also generally requires a desktop environment to run, which means a window manager and a sound server. You can however use KMS/direct framebuffer access on Linux if you build with the DEINIT_ON_LAUNCH flag as explained in the _Building on Unix_ section of the [INSTALL.md](INSTALL.md#building-on-unix) document. This would in theory allow ES-DE to be a drop-in replacement for RetroPie EmulationStation for example. diff --git a/INSTALL-DEV.md b/INSTALL-DEV.md index e2bbc7fc6..d2951f4c6 100644 --- a/INSTALL-DEV.md +++ b/INSTALL-DEV.md @@ -67,7 +67,7 @@ sudo apt-get install libcec-dev libp8-platform-dev The Raspberry Pi 4/400 is the minimum recommended version and earlier boards have not been tested. The GPU memory should be set to at least 256 MB using `raspi-config` and the GL driver must be set to `GL (Fake KMS)` or the performance will be horrible. -Note that low-level ALSA sound support has been removed from ES-DE which means that a sound server like PulseAudio or PipeWire is required. Likewise a display server (Xorg or Wayland) is required, direct framebuffer access is not supported. +Note that low-level ALSA sound support has been removed from ES-DE which means that a sound server like PulseAudio or PipeWire is required. By default a display server (Xorg or Wayland) is also required but by using the DEINIT_ON_LAUNCH build option as explained later in this document KMS/direct framebuffer access can be used. Only the OpenGL ES 3.0 renderer works on Raspberry Pi and it's enabled by default. @@ -135,13 +135,13 @@ make Note that the application updater is always disabled when building for the AUR, RetroDECK, Raspberry Pi or BSD Unix. -On Linux specifically you can build with the DEINIT_ON_LAUNCH option which will deinit the renderer, application window and audio support when an emulator is launched. This makes it possible to use ES-DE with KMS/direct framebuffer access to for example make ES-DE a drop-in replacement for RetroPie Emulationstation: +On Linux specifically you can build with the DEINIT_ON_LAUNCH option which will deinit the renderer, application window and audio when an emulator is launched. This makes it possible to use ES-DE with KMS/direct framebuffer access to for example make ES-DE a drop-in replacement for RetroPie EmulationStation: ``` cmake -DDEINIT_ON_LAUNCH=on . make ``` -When this flag is enabled the menu option _Run in background (while game is launched)_ in the Other settings menu is removed and all functionality related to running ES-DE in the background is also disabled. +When this flag is enabled the menu option _Run in background (while game is launched)_ in the Other settings menu is disabled and all functionality related to running ES-DE in the background is also disabled. By default the master branch will be used, which is where development takes place. To instead build a stable release, switch to the `stable-x.x` branch for the version, for example: diff --git a/INSTALL.md b/INSTALL.md index cac9079cd..b8a915706 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -65,7 +65,7 @@ sudo apt-get install libcec-dev libp8-platform-dev The Raspberry Pi 4/400 is the minimum recommended version and earlier boards have not been tested. The GPU memory should be set to at least 256 MB using `raspi-config` and the GL driver must be set to `GL (Fake KMS)` or the performance will be horrible. -Note that low-level ALSA sound support has been removed from ES-DE which means that a sound server like PulseAudio or PipeWire is required. Likewise a display server (Xorg or Wayland) is required, direct framebuffer access is not supported. +Note that low-level ALSA sound support has been removed from ES-DE which means that a sound server like PulseAudio or PipeWire is required. By default a display server (Xorg or Wayland) is also required but by using the DEINIT_ON_LAUNCH build option as explained later in this document KMS/direct framebuffer access can be used. Only the OpenGL ES 3.0 renderer works on Raspberry Pi and it's enabled by default. @@ -133,6 +133,14 @@ make Note that the application updater is always disabled when building for the AUR, RetroDECK, Raspberry Pi or BSD Unix. +On Linux specifically you can build with the DEINIT_ON_LAUNCH option which will deinit the renderer, application window and audio when an emulator is launched. This makes it possible to use ES-DE with KMS/direct framebuffer access to for example make ES-DE a drop-in replacement for RetroPie EmulationStation: +``` +cmake -DDEINIT_ON_LAUNCH=on . +make +``` + +When this flag is enabled the menu option _Run in background (while game is launched)_ in the Other settings menu is disabled and all functionality related to running ES-DE in the background is also disabled. + By default the master branch will be used, which is where development takes place. To instead build a stable release, switch to the `stable-x.x` branch for the version, for example: ```