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 2020-12-16 19:27:51 +01:00
parent ab2b29f398
commit 6b43cdf5d6
7 changed files with 185 additions and 173 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CONTRIBUTING.md
View file

@ -1,6 +1,4 @@
Contributing to EmulationStation Desktop Edition (ES-DE) # Contributing to EmulationStation Desktop Edition (ES-DE)
========================================================
### Help needed: ### Help needed:

28
CREDITS.md
View file

@ -1,5 +1,4 @@
Programming # Programming
===========
Alec "Aloshi" Lofquist (original version) \ Alec "Aloshi" Lofquist (original version) \
http://www.aloshi.com http://www.aloshi.com
@ -10,21 +9,20 @@ https://retropie.org.uk
Leon Styhre (Desktop Edition fork, based on the RetroPie version) \ Leon Styhre (Desktop Edition fork, based on the RetroPie version) \
https://gitlab.com/leonstyhre/emulationstation-de https://gitlab.com/leonstyhre/emulationstation-de
The shader code for blur_horizontal.glsl, blur_vertical_glsl and scanlines.glsl has been borrowed from the [RetroArch](https://www.retroarch.com) project.
UI Art & Design
=============== # UI Art & Design
Nils Bonenberger Nils Bonenberger
Licenses # Licenses
========
Please find the individual license files inside the `licenses` directory. Please find the individual license files inside the `licenses` directory. There is also additional license information in the headers of the source files.
Libraries # Libraries
=========
cURL \ cURL \
http://curl.haxx.se http://curl.haxx.se
@ -35,6 +33,9 @@ http://www.freetype.org
FreeImage \ FreeImage \
http://www.freeimage.sourceforge.net http://www.freeimage.sourceforge.net
GLEW \
http://glew.sourceforge.net
libVLC \ libVLC \
https://wiki.videolan.org/LibVLC https://wiki.videolan.org/LibVLC
@ -51,8 +52,7 @@ SDL2 \
http://www.libsdl.org http://www.libsdl.org
Resources # Resources
=========
DejaVu font \ DejaVu font \
https://dejavu-fonts.github.io https://dejavu-fonts.github.io
@ -76,8 +76,7 @@ MAME ROM information \
https://www.mamedev.org https://www.mamedev.org
rbsimple-DE theme # rbsimple-DE theme
=================
Recalbox Multi (rbsimple-DE is based on this theme) \ Recalbox Multi (rbsimple-DE is based on this theme) \
https://gitlab.com/recalbox/recalbox-themes https://gitlab.com/recalbox/recalbox-themes
@ -86,8 +85,7 @@ Carbon (some graphics taken from this theme) \
https://github.com/RetroPie/es-theme-carbon https://github.com/RetroPie/es-theme-carbon
Sounds # Sounds
======
Used by the default rbsimple-DE theme as well as for fallback sounds (for themes that lack navigation sounds). Used by the default rbsimple-DE theme as well as for fallback sounds (for themes that lack navigation sounds).

9
README.md
View file

@ -1,5 +1,4 @@
EmulationStation Desktop Edition (ES-DE) # EmulationStation Desktop Edition (ES-DE)
========================================
EmulationStation Desktop Edition is a cross-platform graphical front-end for emulators with controller and keyboard navigation. EmulationStation Desktop Edition is a cross-platform graphical front-end for emulators with controller and keyboard navigation.
@ -41,8 +40,7 @@ Check out the [User Guide](USERGUIDE.md) for how to quickly get the application
If you would like to contribute to the development of ES-DE, then that's great! Please read how to participate [here](CONTRIBUTING.md). (You can also read about planned future features there). If you would like to contribute to the development of ES-DE, then that's great! Please read how to participate [here](CONTRIBUTING.md). (You can also read about planned future features there).
Other information # Other information
=================
[NEWS.md](NEWS.md) contains information about the current release as well as previous releases. This covers the features, improvements and bug fixes. [NEWS.md](NEWS.md) contains information about the current release as well as previous releases. This covers the features, improvements and bug fixes.
@ -52,8 +50,7 @@ Other information
[THEMES.md](THEMES.md) is a guide on how theming works which is useful for those who would like to develop a new theme, or perhaps customize an existing theme. [THEMES.md](THEMES.md) is a guide on how theming works which is useful for those who would like to develop a new theme, or perhaps customize an existing theme.
Some feature highlights # Some feature highlights
=======================
Here are some highlights of what EmulationStation Desktop Edition provides, displayed using the default theme set rbsimple-DE. There are of course many more features available, please refer to the [User Guide](USERGUIDE.md) for a comprehensive overview of all options and functionality. Here are some highlights of what EmulationStation Desktop Edition provides, displayed using the default theme set rbsimple-DE. There are of course many more features available, please refer to the [User Guide](USERGUIDE.md) for a comprehensive overview of all options and functionality.

21
THEMES.md
View file

@ -1,5 +1,4 @@
Themes # Themes
======
EmulationStation allows each system to have its own "theme." A theme is a collection **views** that define some **elements**, each with their own **properties**. EmulationStation allows each system to have its own "theme." A theme is a collection **views** that define some **elements**, each with their own **properties**.
@ -45,8 +44,7 @@ If both files happen to exist, ES will pick the first one (the one located in th
Again, the `[CURRENT_THEME_SET]` value is set in the "UI Settings" menu. If it has not been set yet or the previously selected theme set is missing, the first available theme set will be used as the default. Again, the `[CURRENT_THEME_SET]` value is set in the "UI Settings" menu. If it has not been set yet or the previously selected theme set is missing, the first available theme set will be used as the default.
Simple Example # Simple Example
==============
Here is a very simple theme that changes the description text's color: Here is a very simple theme that changes the description text's color:
@ -67,8 +65,7 @@ Here is a very simple theme that changes the description text's color:
</theme> </theme>
``` ```
How it works # How it works
============
Everything must be inside a `<theme>` tag. Everything must be inside a `<theme>` tag.
@ -113,10 +110,7 @@ Or, you can create your own elements by adding `extra="true"` (as is done in the
``` ```
# Advanced Features
Advanced Features
=================
It is recommended that if you are writing a theme you launch EmulationStation with the `--debug` and `--windowed` switches. This way you can read error messages without having to check the log file. You can also reload the current gamelist view and system view with `Ctrl-R` if `--debug` is specified. It is recommended that if you are writing a theme you launch EmulationStation with the `--debug` and `--windowed` switches. This way you can read error messages without having to check the log file. You can also reload the current gamelist view and system view with `Ctrl-R` if `--debug` is specified.
@ -166,7 +160,6 @@ Is equivalent to this `snes/theme.xml`:
Notice that properties that were not specified got merged (`<fontPath>`) and the `snes/theme.xml` could overwrite the included files' values (`<color>`). Also notice the included file still needed the `<formatVersion>` tag. Notice that properties that were not specified got merged (`<fontPath>`) and the `snes/theme.xml` could overwrite the included files' values (`<color>`). Also notice the included file still needed the `<formatVersion>` tag.
### Theming multiple views simultaneously ### Theming multiple views simultaneously
Sometimes you want to apply the same properties to the same elements across multiple views. The `name` attribute actually works as a list (delimited by any characters of `\t\r\n ,` - that is, whitespace and commas). So, for example, to easily apply the same header to the basic, grid, and system views: Sometimes you want to apply the same properties to the same elements across multiple views. The `name` attribute actually works as a list (delimited by any characters of `\t\r\n ,` - that is, whitespace and commas). So, for example, to easily apply the same header to the basic, grid, and system views:
@ -216,7 +209,6 @@ This is equivalent to:
``` ```
### Theming multiple elements simultaneously ### Theming multiple elements simultaneously
You can theme multiple elements *of the same type* simultaneously. The `name` attribute actually works as a list (delimited by any characters of `\t\r\n ,` - that is, whitespace and commas), just like it does for views, as long as the elements have the same type. This is useful if you want to, say, apply the same color to all the metadata labels: You can theme multiple elements *of the same type* simultaneously. The `name` attribute actually works as a list (delimited by any characters of `\t\r\n ,` - that is, whitespace and commas), just like it does for views, as long as the elements have the same type. This is useful if you want to, say, apply the same color to all the metadata labels:
@ -274,7 +266,6 @@ Just remember, *this only works if the elements have the same type!*
You can now change the order in which elements are rendered by setting `zIndex` values. Default values correspond to the default rendering order while allowing elements to easily be shifted without having to set `zIndex` values for every element. Elements will be rendered in order from smallest z-index to largest. You can now change the order in which elements are rendered by setting `zIndex` values. Default values correspond to the default rendering order while allowing elements to easily be shifted without having to set `zIndex` values for every element. Elements will be rendered in order from smallest z-index to largest.
#### Navigation sounds #### Navigation sounds
The navigation sounds are configured globally per theme set, so it needs to be defined as a feature and with the view set to the special 'all' category. The navigation sounds are configured globally per theme set, so it needs to be defined as a feature and with the view set to the special 'all' category.
@ -403,8 +394,8 @@ or to specify only a portion of the value of a theme property:
<path>./art/logo/${system.theme}.svg</path> <path>./art/logo/${system.theme}.svg</path>
```` ````
Reference
========= # Reference
## Views, their elements, and themable properties: ## Views, their elements, and themable properties:

29
licenses/GLEW Normal file
View file

@ -0,0 +1,29 @@
The OpenGL Extension Wrangler Library
Copyright (C) 2008-2016, Nigel Stewart <nigels[]users sourceforge net>
Copyright (C) 2002-2008, Milan Ikits <milan ikits[]ieee org>
Copyright (C) 2002-2008, Marcelo E. Magallon <mmagallo[]debian org>
Copyright (C) 2002, Lev Povalahev
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* The name of the author may be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
THE POSSIBILITY OF SUCH DAMAGE.

1
licenses/nanosvg
View file

@ -15,4 +15,3 @@ appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be 2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software. misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution. 3. This notice may not be removed or altered from any source distribution.