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

Documentation update

Browse source
This commit is contained in:
Leon Styhre 2023-04-30 12:56:22 +02:00
parent b27f1fcd25
commit a7f84b7404
5 changed files with 121 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -8,8 +8,12 @@
### Detailed list of changes ### Detailed list of changes
* Added support for a dedicated es_systems_sorting.xml file to change systems sorting without having to modify es_systems.xml
* Placing an es_find_rules.xml file in custom_systems will now complement rather than override the bundled file
* Added the SameBoy RetroArch core as an alternative emulator for the sgb system * Added the SameBoy RetroArch core as an alternative emulator for the sgb system
* Added the .sh file extension to the ags system on Unix and macOS and set the %STARTDIR% variable to the game directory
* (Linux) Added support for the official Citra AppImage release * (Linux) Added support for the official Citra AppImage release
* Removed the experimental status for the theme downloader
* Changed the default OpenGL version from 4.6 to 3.3 when building for RetroDECK * Changed the default OpenGL version from 4.6 to 3.3 when building for RetroDECK
### Bug fixes ### Bug fixes

58
INSTALL-DEV.md
View file

@ -854,6 +854,30 @@ A theme is not mandatory to start the application, but ES-DE will be basically u
As indicated above, the home directory will always take precedence and any resources or themes located there will override the ones in the path of the ES-DE executable. As indicated above, the home directory will always take precedence and any resources or themes located there will override the ones in the path of the ES-DE executable.
## Working with Git subtrees
There are a couple of Git subtrees in the ES-DE repository for some bundled dependencies. In order to pull updates from these you'll need to add their respective remotes to your local ES-DE repository:
```
git remote add CImg-external https://github.com/dtschump/CImg.git
git remote add glm-external https://github.com/g-truc/glm.git
git remote add lunasvg-external https://github.com/sammycage/lunasvg.git
git remote add rapidjson-external https://github.com/Tencent/rapidjson.git
git remote add rlottie-external https://github.com/Samsung/rlottie.git
```
Following this, updates can be pulled like so (fetching up to the latest commit):
```
git subtree pull --prefix=external/glm --squash glm-external master
```
Or to pull at a specific commit:
```
git subtree add --prefix=external/glm --squash glm-external bf71a834948186f4097caa076cd2663c69a10e1e
```
Note that none of this is needed to build ES-DE, it's only needed when working on the project and updating any of the bundled dependencies.
## Using clang-format for automatic code formatting ## Using clang-format for automatic code formatting
The entire ES-DE codebase is formatted using clang-format and all new code must be formatted using this tool before being committed. The entire ES-DE codebase is formatted using clang-format and all new code must be formatted using this tool before being committed.
@ -1157,6 +1181,8 @@ It doesn't matter in which order you define the systems as they will be sorted b
Note that the `<systemsortname>` tags are sorted in [lexicographic order](https://en.wikipedia.org/wiki/Lexicographic_order) so 11 will be sorted above 2 but 002 will be sorted above 011. Note that the `<systemsortname>` tags are sorted in [lexicographic order](https://en.wikipedia.org/wiki/Lexicographic_order) so 11 will be sorted above 2 but 002 will be sorted above 011.
But instead of changing the sorting directly in the es_systems.xml file it could be a better idea to use the dedicated es_systems_sorting.xml file instead. How to do that is described later in this document.
Wildcards are supported for emulator binaries, but not for directories: Wildcards are supported for emulator binaries, but not for directories:
```xml ```xml
<!-- This is supported, first matching file will be selected --> <!-- This is supported, first matching file will be selected -->
@ -1432,11 +1458,41 @@ Here is yet another example with the addition of the `snes` system where some fi
</systemList> </systemList>
``` ```
## es_systems_sorting.xml
This file makes it possible to apply a custom systems sorting without having to modify the es_systems.xml file directly. It should be placed in the custom_systems directory, e.g. `~/.emulationstation/custom_systems/es_systems_sorting.xml`
The structure of this file is essentially a simplified version of the es_systems.xml file, but with only the `<name>` and `<systemsortname>` tags present per system.
Here's an example where three systems have been sorted by release year instead of the default full system name:
```xml
<?xml version="1.0"?>
<systemList>
<system>
<name>amiga</name>
<systemsortname>1985</systemsortname>
</system>
<system>
<name>c64</name>
<systemsortname>1982</systemsortname>
</system>
<system>
<name>vic20</name>
<systemsortname>1980</systemsortname>
</system>
</systemList>
```
You only need to include systems that you want to customize sorting for, and if there's also a systemsortname tag present in the es_systems.xml file for any system, then the es_systems_sorting.xml entry will take precedence.
Note that the `<systemsortname>` tags are sorted in [lexicographic order](https://en.wikipedia.org/wiki/Lexicographic_order) so 11 will be sorted above 2 but 002 will be sorted above 011.
## es_find_rules.xml ## es_find_rules.xml
This file makes it possible to define rules for where to search for the emulator binaries and emulator cores. This file makes it possible to define rules for where to search for the emulator binaries and emulator cores.
The file is located in the resources directory in the same location as the es_systems.xml file, but a customized copy can be placed in ~/.emulationstation/custom_systems, which will override the bundled file. The file is located in the resources directory in the same location as the es_systems.xml file, but a customized copy can be placed in ~/.emulationstation/custom_systems, which will complement the bundled file.
Here's an example es_find_rules.xml file for Unix (this is not the complete file shipped with ES-DE as that would be too large to include here): Here's an example es_find_rules.xml file for Unix (this is not the complete file shipped with ES-DE as that would be too large to include here):
```xml ```xml

24
INSTALL.md
View file

@ -852,6 +852,30 @@ A theme is not mandatory to start the application, but ES-DE will be basically u
As indicated above, the home directory will always take precedence and any resources or themes located there will override the ones in the path of the ES-DE executable. As indicated above, the home directory will always take precedence and any resources or themes located there will override the ones in the path of the ES-DE executable.
## Working with Git subtrees
There are a couple of Git subtrees in the ES-DE repository for some bundled dependencies. In order to pull updates from these you'll need to add their respective remotes to your local ES-DE repository:
```
git remote add CImg-external https://github.com/dtschump/CImg.git
git remote add glm-external https://github.com/g-truc/glm.git
git remote add lunasvg-external https://github.com/sammycage/lunasvg.git
git remote add rapidjson-external https://github.com/Tencent/rapidjson.git
git remote add rlottie-external https://github.com/Samsung/rlottie.git
```
Following this, updates can be pulled like so (fetching up to the latest commit):
```
git subtree pull --prefix=external/glm --squash glm-external master
```
Or to pull at a specific commit:
```
git subtree add --prefix=external/glm --squash glm-external bf71a834948186f4097caa076cd2663c69a10e1e
```
Note that none of this is needed to build ES-DE, it's only needed when working on the project and updating any of the bundled dependencies.
## Using clang-format for automatic code formatting ## Using clang-format for automatic code formatting
The entire ES-DE codebase is formatted using clang-format and all new code must be formatted using this tool before being committed. The entire ES-DE codebase is formatted using clang-format and all new code must be formatted using this tool before being committed.

18
THEMES-DEV.md
View file

@ -141,6 +141,24 @@ 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 regularly. Also check the README.md file in that 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. Make sure to regularly check for updates as corrections and additions of new systems are done regularly. Also check the README.md file in that repository for more details on how to actually use the variables.
Here's how to add this repository as a subtree inside your theme's Git repository:
```
git remote add system-metadata https://gitlab.com/es-de/themes/system-metadata.git
git subtree add --prefix=system-metadata --squash system-metadata master
```
To later pull in updates made to the system metadata repository, you'll run the following:
```
git subtree pull --prefix=system-metadata --squash system-metadata master
```
The directory name can be changed to whatever you like using the --prefix flag.
Note that the remote is only present on your local repository, so if you clone a theme you'll need to manually add the system-metadata remote to be able to pull from the subtree, i.e. you'll need to run this command on a freshly cloned theme repository:
```
git remote add system-metadata https://gitlab.com/es-de/themes/system-metadata.git
```
## Simple example ## Simple example
Here is a very simple theme that changes the color of the game name text: Here is a very simple theme that changes the color of the game name text:

18
THEMES.md
View file

@ -139,6 +139,24 @@ 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 regularly. Also check the README.md file in that 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. Make sure to regularly check for updates as corrections and additions of new systems are done regularly. Also check the README.md file in that repository for more details on how to actually use the variables.
Here's how to add this repository as a subtree inside your theme's Git repository:
```
git remote add system-metadata https://gitlab.com/es-de/themes/system-metadata.git
git subtree add --prefix=system-metadata --squash system-metadata master
```
To later pull in updates made to the system metadata repository, you'll run the following:
```
git subtree pull --prefix=system-metadata --squash system-metadata master
```
The directory name can be changed to whatever you like using the --prefix flag.
Note that the remote is only present on your local repository, so if you clone a theme you'll need to manually add the system-metadata remote to be able to pull from the subtree, i.e. you'll need to run this command on a freshly cloned theme repository:
```
git remote add system-metadata https://gitlab.com/es-de/themes/system-metadata.git
```
## Simple example ## Simple example
Here is a very simple theme that changes the color of the game name text: Here is a very simple theme that changes the color of the game name text: