Documentation update.

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

View file

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

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).

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.

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.

View file

@ -1,116 +1,116 @@
CC0 1.0 Universal CC0 1.0 Universal
Statement of Purpose Statement of Purpose
The laws of most jurisdictions throughout the world automatically confer The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator and exclusive Copyright and Related Rights (defined below) upon the creator and
subsequent owner(s) (each and all, an "owner") of an original work of subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work"). authorship and/or a database (each, a "Work").
Certain owners wish to permanently relinquish those rights to a Work for the Certain owners wish to permanently relinquish those rights to a Work for the
purpose of contributing to a commons of creative, cultural and scientific purpose of contributing to a commons of creative, cultural and scientific
works ("Commons") that the public can reliably and without fear of later works ("Commons") that the public can reliably and without fear of later
claims of infringement build upon, modify, incorporate in other works, reuse claims of infringement build upon, modify, incorporate in other works, reuse
and redistribute as freely as possible in any form whatsoever and for any and redistribute as freely as possible in any form whatsoever and for any
purposes, including without limitation commercial purposes. These owners may purposes, including without limitation commercial purposes. These owners may
contribute to the Commons to promote the ideal of a free culture and the contribute to the Commons to promote the ideal of a free culture and the
further production of creative, cultural and scientific works, or to gain further production of creative, cultural and scientific works, or to gain
reputation or greater distribution for their Work in part through the use and reputation or greater distribution for their Work in part through the use and
efforts of others. efforts of others.
For these and/or other purposes and motivations, and without any expectation For these and/or other purposes and motivations, and without any expectation
of additional consideration or compensation, the person associating CC0 with a of additional consideration or compensation, the person associating CC0 with a
Work (the "Affirmer"), to the extent that he or she is an owner of Copyright Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
and publicly distribute the Work under its terms, with knowledge of his or her and publicly distribute the Work under its terms, with knowledge of his or her
Copyright and Related Rights in the Work and the meaning and intended legal Copyright and Related Rights in the Work and the meaning and intended legal
effect of CC0 on those rights. effect of CC0 on those rights.
1. Copyright and Related Rights. A Work made available under CC0 may be 1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not limited Related Rights"). Copyright and Related Rights include, but are not limited
to, the following: to, the following:
i. the right to reproduce, adapt, distribute, perform, display, communicate, i. the right to reproduce, adapt, distribute, perform, display, communicate,
and translate a Work; and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s); ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or likeness iii. publicity and privacy rights pertaining to a person's image or likeness
depicted in a Work; depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work, iv. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(a), below; subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data in v. rights protecting the extraction, dissemination, use and reuse of data in
a Work; a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the vi. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation thereof, protection of databases, and under any national implementation thereof,
including any amended or successor version of such directive); and including any amended or successor version of such directive); and
vii. other similar, equivalent or corresponding rights throughout the world vii. other similar, equivalent or corresponding rights throughout the world
based on applicable law or treaty, and any national implementations thereof. based on applicable law or treaty, and any national implementations thereof.
2. Waiver. To the greatest extent permitted by, but not in contravention of, 2. Waiver. To the greatest extent permitted by, but not in contravention of,
applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
unconditionally waives, abandons, and surrenders all of Affirmer's Copyright unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
and Related Rights and associated claims and causes of action, whether now and Related Rights and associated claims and causes of action, whether now
known or unknown (including existing as well as future claims and causes of known or unknown (including existing as well as future claims and causes of
action), in the Work (i) in all territories worldwide, (ii) for the maximum action), in the Work (i) in all territories worldwide, (ii) for the maximum
duration provided by applicable law or treaty (including future time duration provided by applicable law or treaty (including future time
extensions), (iii) in any current or future medium and for any number of extensions), (iii) in any current or future medium and for any number of
copies, and (iv) for any purpose whatsoever, including without limitation copies, and (iv) for any purpose whatsoever, including without limitation
commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
the Waiver for the benefit of each member of the public at large and to the the Waiver for the benefit of each member of the public at large and to the
detriment of Affirmer's heirs and successors, fully intending that such Waiver detriment of Affirmer's heirs and successors, fully intending that such Waiver
shall not be subject to revocation, rescission, cancellation, termination, or shall not be subject to revocation, rescission, cancellation, termination, or
any other legal or equitable action to disrupt the quiet enjoyment of the Work any other legal or equitable action to disrupt the quiet enjoyment of the Work
by the public as contemplated by Affirmer's express Statement of Purpose. by the public as contemplated by Affirmer's express Statement of Purpose.
3. Public License Fallback. Should any part of the Waiver for any reason be 3. Public License Fallback. Should any part of the Waiver for any reason be
judged legally invalid or ineffective under applicable law, then the Waiver judged legally invalid or ineffective under applicable law, then the Waiver
shall be preserved to the maximum extent permitted taking into account shall be preserved to the maximum extent permitted taking into account
Affirmer's express Statement of Purpose. In addition, to the extent the Waiver Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
is so judged Affirmer hereby grants to each affected person a royalty-free, is so judged Affirmer hereby grants to each affected person a royalty-free,
non transferable, non sublicensable, non exclusive, irrevocable and non transferable, non sublicensable, non exclusive, irrevocable and
unconditional license to exercise Affirmer's Copyright and Related Rights in unconditional license to exercise Affirmer's Copyright and Related Rights in
the Work (i) in all territories worldwide, (ii) for the maximum duration the Work (i) in all territories worldwide, (ii) for the maximum duration
provided by applicable law or treaty (including future time extensions), (iii) provided by applicable law or treaty (including future time extensions), (iii)
in any current or future medium and for any number of copies, and (iv) for any in any current or future medium and for any number of copies, and (iv) for any
purpose whatsoever, including without limitation commercial, advertising or purpose whatsoever, including without limitation commercial, advertising or
promotional purposes (the "License"). The License shall be deemed effective as promotional purposes (the "License"). The License shall be deemed effective as
of the date CC0 was applied by Affirmer to the Work. Should any part of the of the date CC0 was applied by Affirmer to the Work. Should any part of the
License for any reason be judged legally invalid or ineffective under License for any reason be judged legally invalid or ineffective under
applicable law, such partial invalidity or ineffectiveness shall not applicable law, such partial invalidity or ineffectiveness shall not
invalidate the remainder of the License, and in such case Affirmer hereby invalidate the remainder of the License, and in such case Affirmer hereby
affirms that he or she will not (i) exercise any of his or her remaining affirms that he or she will not (i) exercise any of his or her remaining
Copyright and Related Rights in the Work or (ii) assert any associated claims Copyright and Related Rights in the Work or (ii) assert any associated claims
and causes of action with respect to the Work, in either case contrary to and causes of action with respect to the Work, in either case contrary to
Affirmer's express Statement of Purpose. Affirmer's express Statement of Purpose.
4. Limitations and Disclaimers. 4. Limitations and Disclaimers.
a. No trademark or patent rights held by Affirmer are waived, abandoned, a. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document. surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or warranties b. Affirmer offers the Work as-is and makes no representations or warranties
of any kind concerning the Work, express, implied, statutory or otherwise, of any kind concerning the Work, express, implied, statutory or otherwise,
including without limitation warranties of title, merchantability, fitness including without limitation warranties of title, merchantability, fitness
for a particular purpose, non infringement, or the absence of latent or for a particular purpose, non infringement, or the absence of latent or
other defects, accuracy, or the present or absence of errors, whether or not other defects, accuracy, or the present or absence of errors, whether or not
discoverable, all to the greatest extent permissible under applicable law. discoverable, all to the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons c. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without limitation that may apply to the Work or any use thereof, including without limitation
any person's Copyright and Related Rights in the Work. Further, Affirmer any person's Copyright and Related Rights in the Work. Further, Affirmer
disclaims responsibility for obtaining any necessary consents, permissions disclaims responsibility for obtaining any necessary consents, permissions
or other rights required for any use of the Work. or other rights required for any use of the Work.
d. Affirmer understands and acknowledges that Creative Commons is not a d. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to this party to this document and has no duty or obligation with respect to this
CC0 or use of the Work. CC0 or use of the Work.
For more information, please see For more information, please see
<http://creativecommons.org/publicdomain/zero/1.0/> <http://creativecommons.org/publicdomain/zero/1.0/>

View file

@ -1,18 +1,17 @@
Copyright (c) 2013-14 Mikko Mononen memon@inside.org Copyright (c) 2013-14 Mikko Mononen memon@inside.org
This software is provided 'as-is', without any express or implied This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages warranty. In no event will the authors be held liable for any damages
arising from the use of this software. arising from the use of this software.
Permission is granted to anyone to use this software for any purpose, Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions: freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not 1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be in a product, an acknowledgment in the product documentation would be
appreciated but is not required. 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.