Xargon/ES-DE
1
0
Fork 0
mirror of https://github.com/RetroDECK/ES-DE.git synced 2024-11-22 14:15:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation update

Browse source
This commit is contained in:
Leon Styhre 2024-09-02 18:57:48 +02:00
parent 580f075d85
commit a79e757f86
6 changed files with 31 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
CHANGELOG.md
View file

@ -6,21 +6,32 @@
### Release overview
This release brings full localization support and includes translations to ten new languages. More specifically these are Spanish (Spain), French, Italian, Polish, Portuguese (Brazil), Romanian, Russian, Swedish, Japanese and Simplified Chinese. More languages will follow in future releases.
As part of the localization work there have been substantial changes made to the application; text rendering has been improved with proper text shaping using the HarfBuzz library and case mappings and boundary analysis are now performed by the ICU library.
As for minor but notable improvements, entering the wrong ScreenScraper credentials will now display an error popup during scraping, specific subdirectories inside the system directories can now be exluded from getting loaded, and starting time for the video screensaver has been greatly reduced on devices with poor disk I/O performance, such as Android.
The release also brings a new port with experimental support for the Haiku operating system.
See the full list below for all changes like added emulators, launch command modifications and bug fixes.
### Detailed list of changes
* Added localization support
* Added text shaping support using the HarfBuzz library
* Replaced all built-in Unicode case conversion logic and lookup tables with facilities from the ICU library
* Added translations for English (United Kingdom) (en_US)
* Added translations for Spanish (Spain) (es_ES)
* Added translations for French (fr_FR)
* Added translations for Japanese (ja_JP)
* Added translations for Italian (it_IT)
* Added translations for Polish (pl_PL)
* Added translations for Portuguese (Brazil) (pt_BR)
* Added translations for Romanian (ro_RO)
* Added translations for Russian (ru_RU)
* Added translations for Simplified Chinese (zh_CN)
* Added translations for Spanish (Spain) (es_ES)
* Added translations for Swedish (sv_SE)
* Added translations for Japanese (ja_JP)
* Added translations for Simplified Chinese (zh_CN)
* Dramatically improved start times for the video and slideshow screensavers on devices with poor disk I/O performance (like Android)
* Added support for skipping the scanning of game system subdirectories (by using noload.txt files)
* Added an error popup if incorrect credentials (username and password) are used when scraping using ScreenScraper

7
CREDITS.md
View file

@ -19,6 +19,8 @@ Nils Bonenberger
**English (United Kingdom)** \
Weestuarty \
**Spanish (Spain)** \
Dani (stshunz) \
**French** \
Fredy27 (neuromancer974) \
**Italian** \
@ -31,14 +33,13 @@ MrVictorFull \
SilverGreen93 \
**Russian** \
Lulzee \
**Spanish (Spain)** \
Dani (stshunz) \
**Swedish** \
Leon Styhre \
**Japanese** \
冰棍 \
**Simplified Chinese** \
邻家小熊
邻家小熊 \
冰棍
# Licenses

10
HAIKU.md
View file

@ -118,6 +118,10 @@ Games can only be launched if ES-DE has been started from the command line, i.e.
Crashes on game start (Stella 2014 works fine).
### VICE x64sc Accurate / x64 SuperCPU / x128 / xplus4 / xvic
Games don't run, emulator instantly exits (VICE x64 Fast works fine).
### ZEsarUX
Crashes on game start.
@ -157,7 +161,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| atarixe | Atari XE | Atari800 | | Yes | |
| atomiswave | Sammy Corporation Atomiswave | Flycast | | Yes | Single archive file |
| bbcmicro | Acorn Computers BBC Micro | MAME **(Standalone)** | | Yes | Single archive or diskette image file |
| c64 | Commodore 64 | _Placeholder_ | | | |
| c64 | Commodore 64 | VICE x64sc Accurate | VICE x64 Fast,<br>VICE x64 SuperCPU,<br>VICE x128 | No | Single archive or image file for tape, cartridge or single-diskette games, .m3u playlist for multi-diskette games |
| cdimono1 | Philips CD-i | MAME **(Standalone)** | | Yes | |
| cdtv | Commodore CDTV | PUAE | FS-UAE **(Standalone)** | Yes | See the specific _Commodore Amiga and CDTV_ section in the user guide |
| chailove | ChaiLove Game Engine | _Placeholder_ | | | |
@ -253,7 +257,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| pcenginecd | NEC PC Engine CD | Beetle PCE | Beetle PCE FAST,<br>Beetle SuperGrafx,<br>Mednafen **(Standalone)** | Yes | |
| pcfx | NEC PC-FX | Beetle PC-FX | Mednafen **(Standalone)** | Yes | |
| pico8 | PICO-8 Fantasy Console | _Placeholder_ | | | |
| plus4 | Commodore Plus/4 | _Placeholder_ | | | |
| plus4 | Commodore Plus/4 | VICE xplus4 | | No | Single archive or image file for tape, cartridge or single-diskette games, .m3u playlist for multi-diskette games |
| pokemini | Nintendo Pokémon Mini | _Placeholder_ | | | |
| ports | Ports | _Script_ | OpenLara (Tomb Raider) | No | See the specific _Ports and desktop applications_ section in the user guide |
| ps2 | Sony PlayStation 2 | _Placeholder_ | | | |
@ -300,7 +304,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| type-x | Taito Type X | _Placeholder_ | | | |
| uzebox | Uzebox Open Source Console | _Placeholder_ | | | |
| vectrex | GCE Vectrex | vecx | MAME **(Standalone)** | Yes for MAME | Single archive or ROM file |
| vic20 | Commodore VIC-20 | _Placeholder_ | | | |
| vic20 | Commodore VIC-20 | VICE xvic | | No | Single archive or tape, cartridge or diskette image file |
| videopac | Philips Videopac G7000 | O2EM | MAME **(Standalone)** | Yes | Single archive or ROM file |
| virtualboy | Nintendo Virtual Boy | Beetle VB | Mednafen **(Standalone)** | No | |
| vpinball | Visual Pinball | _Placeholder_ | | | |

1
ROADMAP.md
View file

@ -10,7 +10,6 @@ A more detailed breakdown can be found on the [Kanban](https://gitlab.com/es-de/
* Bulk metadata editor
* Background music
* Controller button mappings from inside ES-DE (similar to pad2key in Batocera)
* Localization/multi-language support
* Auto-import tools for Android apps, Steam, Lutris etc.
**User interface**

7
TRANSLATIONS.md
View file

@ -188,11 +188,14 @@ Also note that this will not work unless support for your language has already b
## Theme translations
In addition to what has been described above there is translation work needed for the actual themes as well. Some portion of the text displayed by the theme engine is part of the .po files, like the system view game counter and the custom collection summary, but most text is contained within each theme's configuration files.
In addition to what has been described above there is translation work needed for the actual themes as well. Some portion of the text displayed by the theme engine comes from the application .po files (like the system view game counter and the custom collection summary), but most text is contained within each theme's configuration files.
So to have a fully translated experience it's important to work together with the theme developers so they can incorporate full localization support into their themes. There is also an official metadata repository available for developers to use to easily include things like game system descriptions and various other information, and the goal is to have this fully translated to all languages as well.
So to have a fully translated experience it's important to work together with the theme developers so they can incorporate full localization support into their themes. There is also an official system metadata repository available for theme developers to easily include things like game system descriptions and various other information, and the goal is to have this translated to all languages as well.
This repository can be found here:\
https://gitlab.com/es-de/themes/system-metadata
And here is a link to the language section of the theme engine documentation which contains some further relevant information:\
[THEMES-DEV.md](THEMES-DEV.md#languages)
Discussions regarding theme translations are also covered in the ES-DE Discord server.

2
USERGUIDE-DEV.md
View file

@ -3249,7 +3249,7 @@ Transition animations to play when navigating between different gamelists, betwe
**Theme language**
If the selected theme has multilingual support then you can select between its supported languages here. This setting is primarily intended for testing purposes and for theme developers, and should as such usually be left at _automatic_ which will select the same theme language as the overall application language (see the next setting below). Note that not all themes may support all languages that the ES-DE application supports.
If the selected theme has multilingual support then you can select between its supported languages here. This setting is primarily intended for testing purposes and for theme developers, and should as such usually be left at _automatic_ which will select the same theme language as the overall application language (see the next setting below). Note that not all themes may support all languages that the ES-DE application supports. Also note that a portion of the theme translations are contained within the base application itself and as such will not switch language unless you also change the _Application language_ setting accordingly.
**Application language**