archr/emulationstation-next
0
0
Fork 0
mirror of https://github.com/archr-linux/emulationstation-next.git synced 2026-07-13 03:19:12 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update Themes & general documentations

Browse Source
This commit is contained in:
Fabrice CARUSO
2019-10-21 17:35:36 +02:00
parent bd55c2b37d
commit 4c075a7b6f
3 changed files with 591 additions and 279 deletions
Download Patch File Download Diff File Expand all files Collapse all files
GAMELISTS.md
-1
View File
@@ -54,7 +54,6 @@ Some metadata is also marked as "statistic" - these are kept track of by ES and
* `players` - integer, the number of players the game supports. * `players` - integer, the number of players the game supports.
* `playcount` - statistic, integer, the number of times this game has been played. * `playcount` - statistic, integer, the number of times this game has been played.
* `lastplayed` - statistic, datetime, the last date and time this game was played. * `lastplayed` - statistic, datetime, the last date and time this game was played.
* `sortname` - string, used in sorting the gamelist in a system, instead of `name`.
#### `<folder>` #### `<folder>`
README.md
+181 -206
View File
@@ -1,103 +1,111 @@
EmulationStation EmulationStation
================ ================
This is a fork of EmulationStation for RetroPie. EmulationStation is a cross-platform graphical front-end for emulators with controller navigation.
EmulationStation is a cross-platform graphical front-end for emulators with controller navigation.
Building
Building ========
========
EmulationStation uses some C++11 code, which means you'll need to use at least g++-4.7 on Linux, or Visual Studio 2015 on Windows, to compile.
EmulationStation uses some C++11 code, which means you'll need to use at least g++-4.7 on Linux, or VS2010 on Windows, to compile.
EmulationStation has a few dependencies. For building, you'll need CMake, SDL2, FreeImage, FreeType, cURL, RapidJSON, LibVLC, SDLMixer. You also should probably install the `fonts-droid` package which contains fallback fonts for Chinese/Japanese/Korean characters, but ES will still work fine without it (this package is only used at run-time).
EmulationStation has a few dependencies. For building, you'll need CMake, SDL2, FreeImage, FreeType, cURL and RapidJSON. You also should probably install the `fonts-droid` package which contains fallback fonts for Chinese/Japanese/Korean characters, but ES will still work fine without it (this package is only used at run-time).
**On Debian/Ubuntu:**
**On Debian/Ubuntu:** All of this be easily installed with `apt-get`:
All of this be easily installed with `apt-get`: ```bash
```bash sudo apt-get install libsdl2-dev libsdl2-mixer-dev libfreeimage-dev libfreetype6-dev \
sudo apt-get install libsdl2-dev libsdl2-mixer-dev libfreeimage-dev libfreetype6-dev \ libcurl4-openssl-dev rapidjson-dev libasound2-dev libgl1-mesa-dev build-essential \
libcurl4-openssl-dev rapidjson-dev libasound2-dev libgl1-mesa-dev build-essential \ libboost-all-dev cmake fonts-droid-fallback libvlc-dev libvlccore-dev vlc-bin
libboost-all-dev cmake fonts-droid-fallback libvlc-dev libvlccore-dev vlc-bin ```
``` **On Fedora:**
**On Fedora:** All of this be easily installed with `dnf` (with rpmfusion activated) :
All of this be easily installed with `dnf` (with rpmfusion activated) : ```bash
```bash sudo dnf install SDL2-devel freeimage-devel freetype-devel curl-devel \
sudo dnf install SDL2-devel freeimage-devel freetype-devel curl-devel \ alsa-lib-devel mesa-libGL-devel cmake \
alsa-lib-devel mesa-libGL-devel cmake \ vlc-devel rapidjson-devel
vlc-devel rapidjson-devel ```
```
Note this Repository uses a git submodule - to checkout the source and all submodules, use
Note this Repository uses a git submodule - to checkout the source and all submodules, use
```bash
```bash git clone --recursive https://github.com/RetroPie/EmulationStation.git
git clone --recursive https://github.com/RetroPie/EmulationStation.git ```
```
or
or
```bash
```bash git clone https://github.com/RetroPie/EmulationStation.git
git clone https://github.com/RetroPie/EmulationStation.git cd EmulationStation
cd EmulationStation git submodule update --init
git submodule update --init ```
```
Then, generate and build the Makefile with CMake:
Then, generate and build the Makefile with CMake: ```bash
```bash cd YourEmulationStationDirectory
cd YourEmulationStationDirectory cmake .
cmake . make
make ```
```
**On the Raspberry Pi:**
**On the Raspberry Pi:**
Complete Raspberry Pi build instructions at [emulationstation.org](http://emulationstation.org/gettingstarted.html#install_rpi_standalone).
Complete Raspberry Pi build instructions at [emulationstation.org](http://emulationstation.org/gettingstarted.html#install_rpi_standalone).
**On Windows:**
**On Windows:**
[FreeImage](http://downloads.sourceforge.net/freeimage/FreeImage3154Win32.zip)
[FreeImage](http://downloads.sourceforge.net/freeimage/FreeImage3154Win32.zip)
[FreeType2](http://download.savannah.gnu.org/releases/freetype/freetype-2.4.9.tar.bz2) (you'll need to compile)
[FreeType2](http://download.savannah.gnu.org/releases/freetype/freetype-2.4.9.tar.bz2) (you'll need to compile)
[SDL2](http://www.libsdl.org/release/SDL2-devel-2.0.8-VC.zip)
[SDL2](http://www.libsdl.org/release/SDL2-devel-2.0.8-VC.zip)
[cURL](http://curl.haxx.se/download.html) (you'll need to compile or get the pre-compiled DLL version)
[cURL](http://curl.haxx.se/download.html) (you'll need to compile or get the pre-compiled DLL version)
[RapisJSON](https://github.com/tencent/rapidjson) (you'll need the `include/rapidsjon` added to the include path)
[RapisJSON](https://github.com/tencent/rapidjson) (you'll need the `include/rapidsjon` added to the include path)
[SDL Mixer](https://www.libsdl.org/projects/SDL_mixer/)
(Remember to copy necessary .DLLs into the same folder as the executable: probably FreeImage.dll, freetype6.dll, SDL2.dll, libcurl.dll, and zlib1.dll. Exact list depends on if you built your libraries in "static" mode or not.)
[LibVlc](http://download.videolan.org/pub/videolan/vlc/) (x86 sdk files are present in .7z files)
[CMake](http://www.cmake.org/cmake/resources/software.html) (this is used for generating the Visual Studio project)
[CMake](http://www.cmake.org/cmake/resources/software.html) (this is used for generating the Visual Studio project)
(If you don't know how to use CMake, here are some hints: run cmake-gui and point it at your EmulationStation folder. Point the "build" directory somewhere - I use EmulationStation/build. Click configure, choose "Visual Studio [year] Project", fill in red fields as they appear and keep clicking Configure (you may need to check "Advanced"), then click Generate.)
```
set ES_LIB_DIR=c:\src\lib
Configuring
=========== mkdir c:\src\batocera-emulationstation\build
cd c:\src\batocera-emulationstation\build /D
**~/.emulationstation/es_systems.cfg:**
When first run, an example systems configuration file will be created at `~/.emulationstation/es_systems.cfg`. `~` is `$HOME` on Linux, and `%HOMEPATH%` on Windows. This example has some comments explaining how to write the configuration file. See the "Writing an es_systems.cfg" section for more information. cmake -g "Visual Studio 14 2015 x86" .. -DEIGEN3_INCLUDE_DIR=%ES_LIB_DIR%\eigen -DRAPIDJSON_INCLUDE_DIRS=%ES_LIB_DIR%\rapidjson\include -DFREETYPE_INCLUDE_DIRS=%ES_LIB_DIR%\freetype-2.7\include -DFREETYPE_LIBRARY=%ES_LIB_DIR%\freetype-2.7\objs\vc2010\Win32\freetype27.lib -DFreeImage_INCLUDE_DIR=%ES_LIB_DIR%\FreeImage\Source -DFreeImage_LIBRARY=%ES_LIB_DIR%\FreeImage\Dist\x32\FreeImage.lib -DSDL2_INCLUDE_DIR=%ES_LIB_DIR%\SDL2-2.0.9\include -DSDL2_LIBRARY=%ES_LIB_DIR%\SDL2-2.0.9\build\Release\SDL2.lib;%ES_LIB_DIR%\SDL2-2.0.9\build\Release\SDL2main.lib;Imm32.lib;version.lib -DBOOST_ROOT=%ES_LIB_DIR%\boost_1_61_0 -DBoost_LIBRARY_DIR=%ES_LIB_DIR%\boost_1_61_0\lib32-msvc-14.0 -DCURL_INCLUDE_DIR=%ES_LIB_DIR%\curl-7.50.3\include -DCURL_LIBRARY=%ES_LIB_DIR%\curl-7.50.3\builds\libcurl-vc14-x86-release-dll-ipv6-sspi-winssl\lib\libcurl.lib -DVLC_INCLUDE_DIR=%ES_LIB_DIR%\libvlc-2.2.2\include -DVLC_LIBRARIES=%ES_LIB_DIR%\libvlc-2.2.2\lib\msvc\libvlc.lib;%ES_LIB_DIR%\libvlc-2.2.2\lib\msvc\libvlccore.lib -DVLC_VERSION=1.0.0 -DSDLMIXER_INCLUDE_DIR=%ES_LIB_DIR%\SDL2_mixer-2.0.4\include -DSDLMIXER_LIBRARY=%ES_LIB_DIR%\SDL2_mixer-2.0.4\lib\x86\SDL2_mixer.lib
```
**Keep in mind you'll have to set up your emulator separately from EmulationStation!**
**~/.emulationstation/es_input.cfg:** Configuring
When you first start EmulationStation, you will be prompted to configure an input device. The process is thus: ===========
1. Hold a button on the device you want to configure. This includes the keyboard. **~/.emulationstation/es_systems.cfg:**
When first run, an example systems configuration file will be created at `~/.emulationstation/es_systems.cfg`. `~` is `$HOME` on Linux, and `%HOMEPATH%` on Windows. This example has some comments explaining how to write the configuration file. See the "Writing an es_systems.cfg" section for more information.
2. Press the buttons as they appear in the list. Some inputs can be skipped by holding any button down for a few seconds (e.g. page up/page down).
**Keep in mind you'll have to set up your emulator separately from EmulationStation!**
3. You can review your mappings by pressing up and down, making any changes by pressing A.
**~/.emulationstation/es_input.cfg:**
4. Choose "SAVE" to save this device and close the input configuration screen. When you first start EmulationStation, you will be prompted to configure an input device. The process is thus:
The new configuration will be added to the `~/.emulationstation/es_input.cfg` file. 1. Hold a button on the device you want to configure. This includes the keyboard.
**Both new and old devices can be (re)configured at any time by pressing the Start button and choosing "CONFIGURE INPUT".** From here, you may unplug the device you used to open the menu and plug in a new one, if necessary. New devices will be appended to the existing input configuration file, so your old devices will remain configured. 2. Press the buttons as they appear in the list. Some inputs can be skipped by holding any button down for a few seconds (e.g. page up/page down).
**If your controller stops working, you can delete the `~/.emulationstation/es_input.cfg` file to make the input configuration screen re-appear on next run.** 3. You can review your mappings by pressing up and down, making any changes by pressing A.
4. Choose "SAVE" to save this device and close the input configuration screen.
You can use `--help` or `-h` to view a list of command-line options. Briefly outlined here:
``` The new configuration will be added to the `~/.emulationstation/es_input.cfg` file.
**Both new and old devices can be (re)configured at any time by pressing the Start button and choosing "CONFIGURE INPUT".** From here, you may unplug the device you used to open the menu and plug in a new one, if necessary. New devices will be appended to the existing input configuration file, so your old devices will remain configured.
**If your controller stops working, you can delete the `~/.emulationstation/es_input.cfg` file to make the input configuration screen re-appear on next run.**
You can use `--help` or `-h` to view a list of command-line options. Briefly outlined here:
```
--resolution [width] [height] try and force a particular resolution --resolution [width] [height] try and force a particular resolution
--gamelist-only skip automatic game search, only read from gamelist.xml --gamelist-only skip automatic game search, only read from gamelist.xml
--ignore-gamelist ignore the gamelist (useful for troubleshooting) --ignore-gamelist ignore the gamelist (useful for troubleshooting)
@@ -107,112 +115,79 @@ You can use `--help` or `-h` to view a list of command-line options. Briefly out
--debug more logging, show console on Windows --debug more logging, show console on Windows
--scrape scrape using command line interface --scrape scrape using command line interface
--windowed not fullscreen, should be used with --resolution --windowed not fullscreen, should be used with --resolution
--fullscreen-borderless fullscreen, non exclusive.
--vsync [1/on or 0/off] turn vsync on or off (default is on) --vsync [1/on or 0/off] turn vsync on or off (default is on)
--max-vram [size] Max VRAM to use in Mb before swapping. 0 for unlimited --max-vram [size] Max VRAM to use in Mb before swapping. 0 for unlimited
--force-kid Force the UI mode to be Kid --force-kid Force the UI mode to be Kid
--force-kiosk Force the UI mode to be Kiosk --force-kiosk Force the UI mode to be Kiosk
--force-disable-filters Force the UI to ignore applied filters in gamelist --force-disable-filters Force the UI to ignore applied filters in gamelist
--help, -h summon a sentient, angry tuba --home Force the .emulationstation folder (windows)
``` --help, -h summon a sentient, angry tuba
```
As long as ES hasn't frozen, you can always press F4 to close the application.
As long as ES hasn't frozen, you can always press F4 to close the application.
Writing an es_systems.cfg
========================= Writing an es_systems.cfg
=========================
Complete configuration instructions at [emulationstation.org](http://emulationstation.org/gettingstarted.html#config).
Complete configuration instructions at [emulationstation.org](http://emulationstation.org/gettingstarted.html#config).
The `es_systems.cfg` file contains the system configuration data for EmulationStation, written in XML. This tells EmulationStation what systems you have, what platform they correspond to (for scraping), and where the games are located.
The `es_systems.cfg` file contains the system configuration data for EmulationStation, written in XML. This tells EmulationStation what systems you have, what platform they correspond to (for scraping), and where the games are located.
ES will check two places for an es_systems.cfg file, in the following order, stopping after it finds one that works:
* `~/.emulationstation/es_systems.cfg` ES will check two places for an es_systems.cfg file, in the following order, stopping after it finds one that works:
* `/etc/emulationstation/es_systems.cfg` * `~/.emulationstation/es_systems.cfg`
* `/etc/emulationstation/es_systems.cfg`
The order EmulationStation displays systems reflects the order you define them in.
The order EmulationStation displays systems reflects the order you define them in.
**NOTE:** A system *must* have at least one game present in its "path" directory, or ES will ignore it! If no valid systems are found, ES will report an error and quit!
**NOTE:** A system *must* have at least one game present in its "path" directory, or ES will ignore it! If no valid systems are found, ES will report an error and quit!
Here's an example es_systems.cfg:
```xml
<!-- This is the EmulationStation Systems configuration file. See [SYSTEMS.md](SYSTEMS.md) for some live examples in EmulationStation.
All systems must be contained within the <systemList> tag.-->
<systemList>
<!-- Here's an example system to get you started. --> The following "tags" are replaced by ES in launch commands:
<system>
<!-- A short name, used internally. --> `%ROM%` - Replaced with absolute path to the selected ROM, with most Bash special characters escaped with a backslash.
<name>snes</name>
`%BASENAME%` - Replaced with the "base" name of the path to the selected ROM. For example, a path of "/foo/bar.rom", this tag would be "bar". This tag is useful for setting up AdvanceMAME.
<!-- A "pretty" name, displayed in the menus and such. This one is optional. -->
<fullname>Super Nintendo Entertainment System</fullname> `%ROM_RAW%` - Replaced with the unescaped, absolute path to the selected ROM. If your emulator is picky about paths, you might want to use this instead of %ROM%, but enclosed in quotes.
<!-- The path to start searching for ROMs in. '~' will be expanded to $HOME or %HOMEPATH%, depending on platform. `%HOME%` - Replaced with the home folder.
All subdirectories (and non-recursive links) will be included. -->
<path>~/roms/snes</path> `%SYSTEM%` - Replaced with the current selected system name.
<!-- A list of extensions to search for, delimited by any of the whitespace characters (", \r\n\t"). `%EMULATOR%` - Replaced with the current selected emulator.
You MUST include the period at the start of the extension! It's also case sensitive. -->
<extension>.smc .sfc .SMC .SFC</extension> `%CORE%` - Replaced with the current selected core.
<!-- The shell command executed when a game is selected. A few special tags are replaced if found in a command, like %ROM% (see below). --> gamelist.xml
<command>snesemulator %ROM%</command> ============
<!-- This example would run the bash command "snesemulator /home/user/roms/snes/Super\ Mario\ World.sfc". -->
The gamelist.xml file for a system defines metadata for games, such as a name, image (like a screenshot or box art), description, release date, and rating.
<!-- The platform(s) to use when scraping. You can see the full list of accepted platforms in src/PlatformIds.cpp.
It's case sensitive, but everything is lowercase. This tag is optional. If at least one game in a system has an image specified, ES will use the detailed view for that system (which displays metadata alongside the game list).
You can use multiple platforms too, delimited with any of the whitespace characters (", \r\n\t"), eg: "genesis, megadrive" -->
<platform>snes</platform> *You can use ES's [scraping](http://en.wikipedia.org/wiki/Web_scraping) tools to avoid creating a gamelist.xml by hand.* There are two ways to run the scraper:
<!-- The theme to load from the current theme set. See THEMES.md for more information. * **If you want to scrape multiple games:** press start to open the menu and choose the "SCRAPER" option. Adjust your settings and press "SCRAPE NOW".
This tag is optional; if not set, it will use the value of <name>. --> * **If you just want to scrape one game:** find the game on the game list in ES and press select. Choose "EDIT THIS GAME'S METADATA" and then press the "SCRAPE" button at the bottom of the metadata editor.
<theme>snes</theme>
</system> You can also edit metadata within ES by using the metadata editor - just find the game you wish to edit on the gamelist, press Select, and choose "EDIT THIS GAME'S METADATA."
</systemList>
``` A command-line version of the scraper is also provided - just run emulationstation with `--scrape` *(currently broken)*.
The following "tags" are replaced by ES in launch commands: The switch `--ignore-gamelist` can be used to ignore the gamelist and force ES to use the non-detailed view.
`%ROM%` - Replaced with absolute path to the selected ROM, with most Bash special characters escaped with a backslash. If you're writing a tool to generate or parse gamelist.xml files, you should check out [GAMELISTS.md](GAMELISTS.md) for more detailed documentation.
`%BASENAME%` - Replaced with the "base" name of the path to the selected ROM. For example, a path of "/foo/bar.rom", this tag would be "bar". This tag is useful for setting up AdvanceMAME.
Themes
`%ROM_RAW%` - Replaced with the unescaped, absolute path to the selected ROM. If your emulator is picky about paths, you might want to use this instead of %ROM%, but enclosed in quotes. ======
See [SYSTEMS.md](SYSTEMS.md) for some live examples in EmulationStation. By default, EmulationStation looks pretty ugly. You can fix that. If you want to know more about making your own themes (or editing existing ones), read [THEMES.md](THEMES.md)!
gamelist.xml
============
The gamelist.xml file for a system defines metadata for games, such as a name, image (like a screenshot or box art), description, release date, and rating.
If at least one game in a system has an image specified, ES will use the detailed view for that system (which displays metadata alongside the game list).
*You can use ES's [scraping](http://en.wikipedia.org/wiki/Web_scraping) tools to avoid creating a gamelist.xml by hand.* There are two ways to run the scraper:
* **If you want to scrape multiple games:** press start to open the menu and choose the "SCRAPER" option. Adjust your settings and press "SCRAPE NOW".
* **If you just want to scrape one game:** find the game on the game list in ES and press select. Choose "EDIT THIS GAME'S METADATA" and then press the "SCRAPE" button at the bottom of the metadata editor.
You can also edit metadata within ES by using the metadata editor - just find the game you wish to edit on the gamelist, press Select, and choose "EDIT THIS GAME'S METADATA."
A command-line version of the scraper is also provided - just run emulationstation with `--scrape` *(currently broken)*.
The switch `--ignore-gamelist` can be used to ignore the gamelist and force ES to use the non-detailed view.
If you're writing a tool to generate or parse gamelist.xml files, you should check out [GAMELISTS.md](GAMELISTS.md) for more detailed documentation.
Themes
======
By default, EmulationStation looks pretty ugly. You can fix that. If you want to know more about making your own themes (or editing existing ones), read [THEMES.md](THEMES.md)!
I've put some themes up for download on my EmulationStation webpage: http://aloshi.com/emulationstation#themes
If you're using RetroPie, you should already have a nice set of themes automatically installed!
-Alec "Aloshi" Lofquist
http://www.aloshi.com
http://www.emulationstation.org
THEMES.md
+410 -72
View File
File diff suppressed because it is too large Load Diff