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

Documentation update

Browse source
This commit is contained in:
Leon Styhre 2023-11-13 21:36:34 +01:00
parent a01215a8db
commit 8eee151820
6 changed files with 117 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
CHANGELOG.md
View file

@ -1,5 +1,15 @@
# EmulationStation Desktop Edition (ES-DE) - Changelog
## Version 3.0.0 (in development)
**Release date:** TBD
### Release overview
### Detailed list of changes
### Bug fixes
## Version 2.2.1
**Release date:** 2023-11-12
@ -18,6 +28,8 @@ Some improvements were also made to the systems sorting functionality.
* The Orphaned data cleanup utility will now skip any system where a flatten.txt file is present
* Changed a number of error messages in the Orphaned data cleanup utility from uppercase to lowercase
* The application release number is now tracked on startup instead of the application version
* (macOS) Reclassified the application as a non-game to disable Game Mode on macOS 14 Sonoma
* (macOS) Added support for the Visual Pinball (vpinball) game system
* (slate-es-de) Added console graphics for the adam system
* Changed the systems sorting platform from "Peripheral" to "Console" for the fds, megacd, megacdjp, n64dd, pcenginecd and satellaview systems
* Changed the systems sorting platform from "Peripheral" to "Console" for the sega32x, sega32xjp, sega32xna, segacd, sgb, sufami and tg-cd systems

2
INSTALL-DEV.md
View file

@ -1,4 +1,4 @@
# EmulationStation Desktop Edition (ES-DE) v2.2 (development version) - Building and advanced configuration
# EmulationStation Desktop Edition (ES-DE) v3.0 (development version) - Building and advanced configuration
This document is only relevant for the current ES-DE development version, if you would like to see the documentation for the latest stable release, refer to [INSTALL.md](INSTALL.md) instead.

60
THEMES-DEV.md
View file

@ -1,4 +1,4 @@
# EmulationStation Desktop Edition (ES-DE) v2.2 (development version) - Themes
# EmulationStation Desktop Edition (ES-DE) v3.0 (development version) - Themes
**Note:** This document is only relevant for the current ES-DE development version, if you would like to see the documentation for the latest stable release, refer to [THEMES.md](THEMES.md) instead.
@ -158,17 +158,19 @@ Note that the legacy theme engine had quite inaccurate text sizing and font rend
* The defined line spacing was not always applied for automatically sized text elements
* Font sizes were rounded to integers, leading to imprecise text sizing across different resolutions (the rounding was also done incorrectly)
## System metadata and logo repositories
## Theme assets repositories
There are two useful repositories hosted by the ES-DE project that provide system metadata and system logotypes. This greatly simplifies the work of adding support for all systems that ES-DE supports.
There are several useful repositories hosted by the ES-DE project that provide system metadata and system graphics files. Using these greatly simplifies the work of adding support for all ES-DE systems to your theme.
**Metadata**
Make sure to regularly check for updates in these repositories as corrections, improvements and additions of new systems are made continuously.
### Metadata
The metadata repository provides descriptions, release dates, per-system color palettes etc. and it can be found here:
https://gitlab.com/es-de/themes/system-metadata
By adding this to your theme, either via manually downloading and including it, or by adding it as a Git subtree, you'll be able to access its defined variables. Make sure to regularly check for updates as corrections and additions of new systems are done continuously. Also check the README.md file in the repository for more details on how to actually use the variables.
By adding this to your theme, either via manually downloading and including it, or by adding it as a Git subtree, you'll be able to access its defined variables. Check the README.md file in the repository for details on how to actually use the variables.
Here's how to add this repository as a subtree inside your theme's Git repository:
```
@ -183,9 +185,47 @@ git subtree pull --prefix=system-metadata --squash system-metadata master
The directory name can be changed to whatever you like using the --prefix flag.
**Logos**
### Controller outline graphics
Likewise there's a repository of system logotypes that can also be added and used in the same fashion as the metadata. It can be found here:
This repository provides controller graphics files for each system in an outline style and it can be found here:
https://gitlab.com/es-de/themes/system-controllers-outline
Here's how to add this repository as a subtree inside your theme's Git repository:
```
git remote add system-controllers-outline https://gitlab.com/es-de/themes/system-controllers-outline.git
git subtree add --prefix=system-controllers-outline --squash system-controllers-outline master
```
To later pull in repository updates you'll run the following:
```
git subtree pull --prefix=system-controllers-outline --squash system-controllers-outline master
```
The directory name can be changed to whatever you like using the --prefix flag.
### Mini system graphics
This repository provides graphics files for each system in a "mini" style and it can be found here:
https://gitlab.com/es-de/themes/system-graphics-mini
Here's how to add this repository as a subtree inside your theme's Git repository:
```
git remote add system-graphics-mini https://gitlab.com/es-de/themes/system-graphics-mini.git
git subtree add --prefix=system-graphics-mini --squash system-graphics-mini master
```
To later pull in repository updates you'll run the following:
```
git subtree pull --prefix=system-graphics-mini --squash system-graphics-mini master
```
The directory name can be changed to whatever you like using the --prefix flag.
### Logos
This repository provides logos for each system in color and white (the latter for use with color shifting) and it can be found here:
https://gitlab.com/es-de/themes/system-logos
@ -202,11 +242,13 @@ git subtree pull --prefix=system-logos --squash system-logos master
The directory name can be changed to whatever you like using the --prefix flag.
**Adding remotes**
### Adding remotes
Note that the remotes are only setup for your local repository, so if you clone a theme you'll need to manually add the system-metadata and/or system-logos remotes to be able to pull to these subtrees. That means you'll need to run the following commands on a freshly cloned theme repository:
Note that the remotes are only setup for your local repository, so if you clone a theme you'll need to manually add the repository remotes to be able to pull from these subtrees. That means you'll need to run one or more of the following commands on a freshly cloned theme repository:
```
git remote add system-metadata https://gitlab.com/es-de/themes/system-metadata.git
git remote add system-controllers-outline https://gitlab.com/es-de/themes/system-controllers-outline.git
git remote add system-graphics-mini https://gitlab.com/es-de/themes/system-graphics-mini.git
git remote add system-logos https://gitlab.com/es-de/themes/system-logos.git
```
After doing this you'll be able to pull repository updates as described above.

58
THEMES.md
View file

@ -156,17 +156,19 @@ Note that the legacy theme engine had quite inaccurate text sizing and font rend
* The defined line spacing was not always applied for automatically sized text elements
* Font sizes were rounded to integers, leading to imprecise text sizing across different resolutions (the rounding was also done incorrectly)
## System metadata and logo repositories
## Theme assets repositories
There are two useful repositories hosted by the ES-DE project that provide system metadata and system logotypes. This greatly simplifies the work of adding support for all systems that ES-DE supports.
There are several useful repositories hosted by the ES-DE project that provide system metadata and system graphics files. Using these greatly simplifies the work of adding support for all ES-DE systems to your theme.
**Metadata**
Make sure to regularly check for updates in these repositories as corrections, improvements and additions of new systems are made continuously.
### Metadata
The metadata repository provides descriptions, release dates, per-system color palettes etc. and it can be found here:
https://gitlab.com/es-de/themes/system-metadata
By adding this to your theme, either via manually downloading and including it, or by adding it as a Git subtree, you'll be able to access its defined variables. Make sure to regularly check for updates as corrections and additions of new systems are done continuously. Also check the README.md file in the repository for more details on how to actually use the variables.
By adding this to your theme, either via manually downloading and including it, or by adding it as a Git subtree, you'll be able to access its defined variables. Check the README.md file in the repository for details on how to actually use the variables.
Here's how to add this repository as a subtree inside your theme's Git repository:
```
@ -181,9 +183,47 @@ git subtree pull --prefix=system-metadata --squash system-metadata master
The directory name can be changed to whatever you like using the --prefix flag.
**Logos**
### Controller outline graphics
Likewise there's a repository of system logotypes that can also be added and used in the same fashion as the metadata. It can be found here:
This repository provides controller graphics files for each system in an outline style and it can be found here:
https://gitlab.com/es-de/themes/system-controllers-outline
Here's how to add this repository as a subtree inside your theme's Git repository:
```
git remote add system-controllers-outline https://gitlab.com/es-de/themes/system-controllers-outline.git
git subtree add --prefix=system-controllers-outline --squash system-controllers-outline master
```
To later pull in repository updates you'll run the following:
```
git subtree pull --prefix=system-controllers-outline --squash system-controllers-outline master
```
The directory name can be changed to whatever you like using the --prefix flag.
### Mini system graphics
This repository provides graphics files for each system in a "mini" style and it can be found here:
https://gitlab.com/es-de/themes/system-graphics-mini
Here's how to add this repository as a subtree inside your theme's Git repository:
```
git remote add system-graphics-mini https://gitlab.com/es-de/themes/system-graphics-mini.git
git subtree add --prefix=system-graphics-mini --squash system-graphics-mini master
```
To later pull in repository updates you'll run the following:
```
git subtree pull --prefix=system-graphics-mini --squash system-graphics-mini master
```
The directory name can be changed to whatever you like using the --prefix flag.
### Logos
This repository provides logos for each system in color and white (the latter for use with color shifting) and it can be found here:
https://gitlab.com/es-de/themes/system-logos
@ -200,11 +240,13 @@ git subtree pull --prefix=system-logos --squash system-logos master
The directory name can be changed to whatever you like using the --prefix flag.
**Adding remotes**
### Adding remotes
Note that the remotes are only setup for your local repository, so if you clone a theme you'll need to manually add the system-metadata and/or system-logos remotes to be able to pull to these subtrees. That means you'll need to run the following commands on a freshly cloned theme repository:
Note that the remotes are only setup for your local repository, so if you clone a theme you'll need to manually add the repository remotes to be able to pull from these subtrees. That means you'll need to run one or more of the following commands on a freshly cloned theme repository:
```
git remote add system-metadata https://gitlab.com/es-de/themes/system-metadata.git
git remote add system-controllers-outline https://gitlab.com/es-de/themes/system-controllers-outline.git
git remote add system-graphics-mini https://gitlab.com/es-de/themes/system-graphics-mini.git
git remote add system-logos https://gitlab.com/es-de/themes/system-logos.git
```
After doing this you'll be able to pull repository updates as described above.

4
USERGUIDE-DEV.md
View file

@ -1,4 +1,4 @@
# EmulationStation Desktop Edition (ES-DE) v2.2 (development version) - User guide
# EmulationStation Desktop Edition (ES-DE) v3.0 (development version) - User guide
This version of the user guide is only relevant for the current ES-DE development version, if you are using the latest stable release, refer to [USERGUIDE.md](USERGUIDE.md) instead.
@ -4018,7 +4018,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| vic20 | Commodore VIC-20 | VICE xvic | VICE xvic **(Standalone)** | No | Single archive or tape, cartridge or diskette image file |
| videopac | Philips Videopac G7000 | O2EM | MAME - Current,<br>MAME **(Standalone)** | Yes | Single archive or ROM file | |
| virtualboy | Nintendo Virtual Boy | Beetle VB | Mednafen **(Standalone)** | No | |
| vpinball | Visual Pinball | Visual Pinball **(Standalone)** [UW] | | No | In separate folder interpreted as a file |
| vpinball | Visual Pinball | Visual Pinball **(Standalone)** | | No | In separate folder interpreted as a file |
| vsmile | VTech V.Smile | MAME - Current | MAME **(Standalone)** | Yes | Single archive or ROM file |
| wasm4 | WASM-4 Fantasy Console | WASM-4 | | No | Single .wasm file |
| wii | Nintendo Wii | Dolphin | Dolphin **(Standalone)**,<br>PrimeHack **(Standalone)** [UW] | No | |

2
USERGUIDE.md
View file

@ -4016,7 +4016,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| vic20 | Commodore VIC-20 | VICE xvic | VICE xvic **(Standalone)** | No | Single archive or tape, cartridge or diskette image file |
| videopac | Philips Videopac G7000 | O2EM | MAME - Current,<br>MAME **(Standalone)** | Yes | Single archive or ROM file | |
| virtualboy | Nintendo Virtual Boy | Beetle VB | Mednafen **(Standalone)** | No | |
| vpinball | Visual Pinball | Visual Pinball **(Standalone)** [UW] | | No | In separate folder interpreted as a file |
| vpinball | Visual Pinball | Visual Pinball **(Standalone)** | | No | In separate folder interpreted as a file |
| vsmile | VTech V.Smile | MAME - Current | MAME **(Standalone)** | Yes | Single archive or ROM file |
| wasm4 | WASM-4 Fantasy Console | WASM-4 | | No | Single .wasm file |
| wii | Nintendo Wii | Dolphin | Dolphin **(Standalone)**,<br>PrimeHack **(Standalone)** [UW] | No | |