You've already forked emulationstation-next
mirror of
https://github.com/archr-linux/emulationstation-next.git
synced 2026-07-13 03:19:12 -07:00
Update Themes & general documentations
This commit is contained in:
Fabrice CARUSO
@@ -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.
|
||||
* `playcount` - statistic, integer, the number of times this game has been 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>`
|
||||
|
||||
@@ -1,15 +1,14 @@
|
||||
EmulationStation
|
||||
================
|
||||
|
||||
This is a fork of EmulationStation for RetroPie.
|
||||
EmulationStation is a cross-platform graphical front-end for emulators with controller navigation.
|
||||
|
||||
Building
|
||||
========
|
||||
|
||||
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 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 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).
|
||||
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).
|
||||
|
||||
**On Debian/Ubuntu:**
|
||||
All of this be easily installed with `apt-get`:
|
||||
@@ -63,11 +62,20 @@ Complete Raspberry Pi build instructions at [emulationstation.org](http://emulat
|
||||
|
||||
[RapisJSON](https://github.com/tencent/rapidjson) (you'll need the `include/rapidsjon` added to the include path)
|
||||
|
||||
(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.)
|
||||
[SDL Mixer](https://www.libsdl.org/projects/SDL_mixer/)
|
||||
|
||||
[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)
|
||||
|
||||
(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
|
||||
|
||||
mkdir c:\src\batocera-emulationstation\build
|
||||
cd c:\src\batocera-emulationstation\build /D
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
|
||||
Configuring
|
||||
@@ -107,11 +115,13 @@ You can use `--help` or `-h` to view a list of command-line options. Briefly out
|
||||
--debug more logging, show console on Windows
|
||||
--scrape scrape using command line interface
|
||||
--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)
|
||||
--max-vram [size] Max VRAM to use in Mb before swapping. 0 for unlimited
|
||||
--force-kid Force the UI mode to be Kid
|
||||
--force-kiosk Force the UI mode to be Kiosk
|
||||
--force-kid Force the UI mode to be Kid
|
||||
--force-kiosk Force the UI mode to be Kiosk
|
||||
--force-disable-filters Force the UI to ignore applied filters in gamelist
|
||||
--home Force the .emulationstation folder (windows)
|
||||
--help, -h summon a sentient, angry tuba
|
||||
```
|
||||
|
||||
@@ -133,44 +143,11 @@ The order EmulationStation displays systems reflects the order you define them i
|
||||
|
||||
**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.
|
||||
All systems must be contained within the <systemList> tag.-->
|
||||
|
||||
<systemList>
|
||||
<!-- Here's an example system to get you started. -->
|
||||
<system>
|
||||
<!-- A short name, used internally. -->
|
||||
<name>snes</name>
|
||||
See [SYSTEMS.md](SYSTEMS.md) for some live examples in EmulationStation.
|
||||
|
||||
<!-- A "pretty" name, displayed in the menus and such. This one is optional. -->
|
||||
<fullname>Super Nintendo Entertainment System</fullname>
|
||||
|
||||
<!-- The path to start searching for ROMs in. '~' will be expanded to $HOME or %HOMEPATH%, depending on platform.
|
||||
All subdirectories (and non-recursive links) will be included. -->
|
||||
<path>~/roms/snes</path>
|
||||
|
||||
<!-- A list of extensions to search for, delimited by any of the whitespace characters (", \r\n\t").
|
||||
You MUST include the period at the start of the extension! It's also case sensitive. -->
|
||||
<extension>.smc .sfc .SMC .SFC</extension>
|
||||
|
||||
<!-- The shell command executed when a game is selected. A few special tags are replaced if found in a command, like %ROM% (see below). -->
|
||||
<command>snesemulator %ROM%</command>
|
||||
<!-- This example would run the bash command "snesemulator /home/user/roms/snes/Super\ Mario\ World.sfc". -->
|
||||
|
||||
<!-- 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.
|
||||
You can use multiple platforms too, delimited with any of the whitespace characters (", \r\n\t"), eg: "genesis, megadrive" -->
|
||||
<platform>snes</platform>
|
||||
|
||||
<!-- The theme to load from the current theme set. See THEMES.md for more information.
|
||||
This tag is optional; if not set, it will use the value of <name>. -->
|
||||
<theme>snes</theme>
|
||||
</system>
|
||||
</systemList>
|
||||
```
|
||||
|
||||
The following "tags" are replaced by ES in launch commands:
|
||||
|
||||
@@ -180,7 +157,13 @@ The following "tags" are replaced by ES in launch commands:
|
||||
|
||||
`%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.
|
||||
`%HOME%` - Replaced with the home folder.
|
||||
|
||||
`%SYSTEM%` - Replaced with the current selected system name.
|
||||
|
||||
`%EMULATOR%` - Replaced with the current selected emulator.
|
||||
|
||||
`%CORE%` - Replaced with the current selected core.
|
||||
|
||||
gamelist.xml
|
||||
============
|
||||
@@ -208,11 +191,3 @@ 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
|
||||
|
||||
Reference in New Issue
Block a user