mirror of
https://github.com/RetroDECK/ES-DE.git
synced 2025-01-18 15:15:37 +00:00
Documentation update
This commit is contained in:
Leon Styhre
parent
fc68595a47
commit
9351718f23
|
|
@ -648,10 +648,10 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
|||
| 3do | 3DO Interactive Multiplayer | Opera | Real3DOPlayer **(Standalone)** | Yes | |
|
||||
| adam | Coleco Adam | MAME4droid 2024 [Diskette] **(Standalone)** | MAME4droid 2024 [Tape] **(Standalone)**,<br>MAME4droid 2024 [Cartridge] **(Standalone)**,<br>MAME4droid 2024 [Software list] **(Standalone)**,<br>ColEm **(Standalone)** | Yes for MAME4droid 2024 | |
|
||||
| ags | Adventure Game Studio Game Engine | _Placeholder_ | | | |
|
||||
| amiga | Commodore Amiga | PUAE | PUAE 2021 | Yes | |
|
||||
| amiga1200 | Commodore Amiga 1200 | PUAE | PUAE 2021 | Yes | |
|
||||
| amiga600 | Commodore Amiga 600 | PUAE | PUAE 2021 | Yes | |
|
||||
| amigacd32 | Commodore Amiga CD32 | PUAE | PUAE 2021 | Yes | |
|
||||
| amiga | Commodore Amiga | PUAE | PUAE 2021 | Yes | See the specific _Commodore Amiga and CDTV_ section in the user guide |
|
||||
| amiga1200 | Commodore Amiga 1200 | PUAE | PUAE 2021 | Yes | See the specific _Commodore Amiga and CDTV_ section in the user guide |
|
||||
| amiga600 | Commodore Amiga 600 | PUAE | PUAE 2021 | Yes | See the specific _Commodore Amiga and CDTV_ section in the user guide |
|
||||
| amigacd32 | Commodore Amiga CD32 | PUAE | PUAE 2021 | Yes | See the specific _Commodore Amiga and CDTV_ section in the user guide |
|
||||
| amstradcpc | Amstrad CPC | Caprice32 | CrocoDS,<br>MAME4droid 2024 **(Standalone)** | Yes for MAME4droid 2024 | Single archive or disk file |
|
||||
| android | Google Android | _Placeholder_ | | | |
|
||||
| androidapps | Android Apps | _Native apps_ | | No | |
|
||||
|
|
|
|||
|
|
@ -61,6 +61,7 @@
|
|||
|
||||
### Bug fixes
|
||||
|
||||
* When returning from a game the helpsystem was sometimes using the dimmed theme properties
|
||||
* The StringUtil::toCapitalized() function didn't correctly capitalize multi-byte Unicode characters
|
||||
* (Windows) Video textures were sometimes not sized and aligned correctly horizontally
|
||||
* There was a typo where the 32:9 aspect ratio was referred to as 32:0
|
||||
|
|
|
|||
40
CREDITS.md
40
CREDITS.md
|
|
@ -17,25 +17,27 @@ Nils Bonenberger
|
|||
|
||||
# Translations
|
||||
|
||||
**English (United Kingdom)**\
|
||||
Weestuarty\
|
||||
**French**\
|
||||
Fredy27 (neuromancer974)\
|
||||
**Polish**\
|
||||
kycho\
|
||||
**Portuguese (Brazil)**\
|
||||
MrVictorFull\
|
||||
**Romanian**\
|
||||
SilverGreen93\
|
||||
**Russian**\
|
||||
Lulzee\
|
||||
**Spanish**\
|
||||
Dani (stshunz)\
|
||||
**Swedish**\
|
||||
Leon Styhre\
|
||||
**Japanese**\
|
||||
冰棍\
|
||||
**Simplified Chinese**\
|
||||
**English (United Kingdom)** \
|
||||
Weestuarty \
|
||||
**French** \
|
||||
Fredy27 (neuromancer974) \
|
||||
**Italian** \
|
||||
Viler \
|
||||
**Polish** \
|
||||
kycho \
|
||||
**Portuguese (Brazil)** \
|
||||
MrVictorFull \
|
||||
**Romanian** \
|
||||
SilverGreen93 \
|
||||
**Russian** \
|
||||
Lulzee \
|
||||
**Spanish** \
|
||||
Dani (stshunz) \
|
||||
**Swedish** \
|
||||
Leon Styhre \
|
||||
**Japanese** \
|
||||
冰棍 \
|
||||
**Simplified Chinese** \
|
||||
邻家小熊
|
||||
|
||||
# Licenses
|
||||
|
|
|
|||
49
HAIKU.md
Normal file
49
HAIKU.md
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
# ES-DE Frontend - Haiku documentation
|
||||
|
||||
Note that support for Haiku is currently experimental as the operating system itself is experimental.
|
||||
|
||||
There are currently no pre-built packages available so you'll need to build ES-DE yourself. Detailed instructions are available in the _Building on Haiku_ section of the [INSTALL-DEV.md](INSTALL-DEV.md#building-on-haiku) document.
|
||||
|
||||
## Known problems
|
||||
|
||||
* Attempting to use the theme downloader crashes the application when using a nightly Haiku build, this is seemingly caused by an OS or libgit2 library bug as ES-DE runs correctly in R1/beta4 (but with other issues on that release)
|
||||
|
||||
* The video player behaves erratic and videos may randomly hang or refuse to play
|
||||
|
||||
* Key repeat doesn't work in text editing fields (but it works elsewhere in the application)
|
||||
|
||||
* There is no 3D acceleration as the operating system does not support that
|
||||
|
||||
## Emulator problems
|
||||
|
||||
In contrast with all other platforms which ES-DE runs on, on Haiku emulators which are not working correctly are still included in the configuration. This is done with the belief that things will improve in the future as the operating system matures.
|
||||
|
||||
**FS-UAE (Standalone)**
|
||||
|
||||
This emulator does not seem to accept command-line arguments, meaning games can't be launched from ES-DE.
|
||||
|
||||
**MAME (Standalone)**
|
||||
|
||||
When existing a game the OS screen resolution is sometimes not reset back to its previous state meaning it has to be manually reset to the correct resolution using the operating system's _Screen_ utility.
|
||||
|
||||
**PUAE**
|
||||
|
||||
Crashes on game start.
|
||||
|
||||
**ScummVM (Standalone)**
|
||||
|
||||
Games can only be launched if ES-DE has been started from the command line, i.e. from a _Terminal_ window.
|
||||
|
||||
## Supported game systems
|
||||
|
||||
The **@** symbol indicates that the emulator is _deprecated_ and will be removed in a future ES-DE release.
|
||||
|
||||
| System name | Full name | Default emulator | Alternative emulators | Needs BIOS | Recommended game setup |
|
||||
| :-------------------- | :--------------------------------------------- | :-------------------------------- | :-------------------------------- | :----------- | :----------------------------------- |
|
||||
| 3do | 3DO Interactive Multiplayer | Opera | | Yes | |
|
||||
| adam | Coleco Adam | MAME [Diskette] **(Standalone)** | MAME [Tape] **(Standalone)**,<br>MAME [Cartridge] **(Standalone)**,<br>MAME [Software list] **(Standalone)** | Yes | |
|
||||
| ags | Adventure Game Studio Game Engine | _Placeholder_ | | | |
|
||||
| amiga | Commodore Amiga | PUAE | FS-UAE **(Standalone)** | Yes | See the specific _Commodore Amiga and CDTV_ section in the user guide |
|
||||
| amiga1200 | Commodore Amiga 1200 | PUAE | FS-UAE **(Standalone)** | Yes | See the specific _Commodore Amiga and CDTV_ section in the user guide |
|
||||
| amiga600 | Commodore Amiga 600 | PUAE | FS-UAE **(Standalone)** | Yes | See the specific _Commodore Amiga and CDTV_ section in the user guide |
|
||||
| amigacd32 | Commodore Amiga CD32 | PUAE | FS-UAE **(Standalone)** | Yes | See the specific _Commodore Amiga and CDTV_ section in the user guide |
|
||||
|
|
@ -416,15 +416,15 @@ Both _appimagetool_ and _linuxdeploy_ are required for the build process but the
|
|||
|
||||
## Building on Haiku
|
||||
|
||||
Note that support for Haiku is currently experimental as the operating system itself is experimental. When OS updates are rolled out things may break in ES-DE or they could make the application crash. The video player also behaves erratic and the platform does not provide 3D acceleration meaning performance may not be that great. Apart from that most things should work fine.
|
||||
|
||||
You'll need to run a recent nightly Haiku release to build ES-DE as using R1/beta4 will not work. At the moment there is also no packaging support (i.e. for ES-DE specifically), so you'll need to run ES-DE from the build directory.
|
||||
You'll need to run a recent nightly Haiku release to build ES-DE as using R1/beta4 will not work.
|
||||
|
||||
If running Haiku in KVM/Qemu, make sure to use SATA storage intead of VirtIO storage as you may otherwise experience stability issues and filesystem corruption.
|
||||
|
||||
**Local build**
|
||||
|
||||
Use pkgman to install the required dependencies:
|
||||
```
|
||||
pkgman install cmake gettext curl_devel harfbuzz_devel freeimage_devel pugixml_devel libsdl2_devel libgit2_devel freetype_devel ffmpeg_devel poppler24_devel
|
||||
pkgman install cmake gettext curl_devel harfbuzz_devel freeimage_devel pugixml_devel libsdl2_devel libgit2_devel freetype_devel ffmpeg6_devel poppler24_devel
|
||||
```
|
||||
|
||||
To clone the ES-DE source repository, run the following:
|
||||
|
|
@ -433,10 +433,35 @@ git clone https://gitlab.com/es-de/emulationstation-de.git
|
|||
```
|
||||
You can then go ahead and build the application:
|
||||
```
|
||||
cd emulationstation-de
|
||||
cmake .
|
||||
make -j8
|
||||
```
|
||||
|
||||
Change the -j flag to whatever amount of parallel threads you want to use for the compilation.
|
||||
|
||||
**HaikuPorts package build**
|
||||
|
||||
Run the following to build the .hpkg package:
|
||||
|
||||
```
|
||||
cd ~
|
||||
git clone https://github.com/haikuports/haikuports.git --depth=50
|
||||
mkdir haikuports/games-emulation/es-de
|
||||
pkgman install haikuporter
|
||||
cp /boot/system/settings/haikuports.conf ~/config/settings/
|
||||
cd emulationstation-de
|
||||
cp es-app/assets/es_de-3.1.0.recipe ~/haikuports/games-emulation/es-de
|
||||
haikuporter -S --no-source-packages --get-dependencies -j8 es_de
|
||||
```
|
||||
|
||||
The first time you run haikuporter it will take a while as dependencies for all ports will get updated before the ES-DE build process starts.
|
||||
|
||||
Following this you can install the package into the running system:
|
||||
```
|
||||
cp ~/haikuports/packages/es_de-3.1.0-1-x86_64.hpkg /boot/system/packages
|
||||
```
|
||||
|
||||
## Building on macOS
|
||||
|
||||
ES-DE for macOS is built using Clang/LLVM which is the default compiler for this operating system. It's pretty straightforward to build software on this OS. The main problem is that there is no native package manager, but as there are several third party package managers available, this can be partly compensated for. The use of one of them, [Homebrew](https://brew.sh), is detailed below.
|
||||
|
|
|
|||
Loading…
Reference in a new issue