Xargon/ES-DE
1
0
Fork 0
mirror of https://github.com/RetroDECK/ES-DE.git synced 2024-11-29 09:35:39 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Minor documentation formatting and updates

Browse source
This commit is contained in:
Cristi Mitrana 2019-02-14 09:41:26 +02:00
parent bec98369b6
commit 9d2f3de8a6
2 changed files with 29 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
GAMELISTS.md
View file

@ -32,6 +32,7 @@ There are a few types of metadata:
* `string` - just text. * `string` - just text.
* `image_path` - a path to an image. This path should be either the absolute to the image, a path relative to the system games folder that starts with "./" (e.g. `./mm2_image.png`), or a path relative to the home directory that starts with "~/" (e.g. `~/.emulationstation/downloaded_images/nes/mm2-image.png`). Images will be automatically resized by OpenGL to fit the corresponding `<image>` tag in the current theme. Smaller images will load faster, so try to keep resolution low! * `image_path` - a path to an image. This path should be either the absolute to the image, a path relative to the system games folder that starts with "./" (e.g. `./mm2_image.png`), or a path relative to the home directory that starts with "~/" (e.g. `~/.emulationstation/downloaded_images/nes/mm2-image.png`). Images will be automatically resized by OpenGL to fit the corresponding `<image>` tag in the current theme. Smaller images will load faster, so try to keep resolution low!
* `video_path` - a path to a video. Similar to `image_path`.
* `float` - a floating-point decimal value (written as a string). * `float` - a floating-point decimal value (written as a string).
* `integer` - an integer value (written as a string). * `integer` - an integer value (written as a string).
* `datetime` - a date and, potentially, a time. These are encoded as an ISO string, in the following format: "%Y%m%dT%H%M%S%F%q". For example, the release date for Chrono Trigger is encoded as "19950311T000000" (no time specified). * `datetime` - a date and, potentially, a time. These are encoded as an ISO string, in the following format: "%Y%m%dT%H%M%S%F%q". For example, the release date for Chrono Trigger is encoded as "19950311T000000" (no time specified).
@ -43,22 +44,24 @@ Some metadata is also marked as "statistic" - these are kept track of by ES and
* `name` - string, the displayed name for the game. * `name` - string, the displayed name for the game.
* `desc` - string, a description of the game. Longer descriptions will automatically scroll, so don't worry about size. * `desc` - string, a description of the game. Longer descriptions will automatically scroll, so don't worry about size.
* `image` - image_path, the path to an image to display for the game (like box art or a screenshot). * `image` - image_path, the path to an image to display for the game (like box art or a screenshot).
* `thumbnail` - image_path, the path to a smaller image, displayed in image lists like the grid view. Should be small to ensure quick loading. *Currently not used.* * `thumbnail` - image_path, the path to a smaller image, displayed in image lists like the grid view. Should be small to ensure quick loading.
* `video` - video_path, the path to a video to display for the game, for themes that support the _video_ viewstyle.
* `rating` - float, the rating for the game, expressed as a floating point number between 0 and 1. Arbitrary values are fine (ES can display half-stars, quarter-stars, etc). * `rating` - float, the rating for the game, expressed as a floating point number between 0 and 1. Arbitrary values are fine (ES can display half-stars, quarter-stars, etc).
* `releasedate` - datetime, the date the game was released. Displayed as date only, time is ignored. * `releasedate` - datetime, the date the game was released. Displayed as date only, time is ignored.
* `developer` - string, the developer for the game. * `developer` - string, the developer for the game.
* `publisher` - string, the publisher for the game. * `publisher` - string, the publisher for the game.
* `genre` - string, the (primary) genre for the game. * `genre` - string, the (primary) genre for the game.
* `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>`
* `name` - string, the displayed name for the folder. * `name` - string, the displayed name for the folder.
* `desc` - string, the description for the folder. * `desc` - string, the description for the folder.
* `image` - image_path, the path to an image to display for the folder. * `image` - image_path, the path to an image to display for the folder.
* `thumbnail` - image_path, the path to a smaller image to display for the folder. *Currently not used.* * `thumbnail` - image_path, the path to a smaller image to display for the folder.
Things to be Aware Of Things to be Aware Of

41
README.md
View file

@ -9,21 +9,21 @@ 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 VS2010 on Windows, to compile.
EmulationStation has a few dependencies. For building, you'll need CMake, SDL2, FreeImage, FreeType, and cURL. 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 libfreeimage-dev libfreetype6-dev libcurl4-openssl-dev \ sudo apt-get install libsdl2-dev libfreeimage-dev libfreetype6-dev libcurl4-openssl-dev rapidjson-dev \
libasound2-dev libgl1-mesa-dev build-essential cmake fonts-droid-fallback libvlc-dev \ libasound2-dev libgl1-mesa-dev build-essential cmake fonts-droid-fallback libvlc-dev \
libvlccore-dev vlc-bin 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 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
@ -57,10 +57,12 @@ Complete Raspberry Pi build instructions at [emulationstation.org](http://emulat
[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.3-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)
(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.) (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.)
[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)
@ -96,18 +98,21 @@ The new configuration will be added to the `~/.emulationstation/es_input.cfg` fi
You can use `--help` or `-h` to view a list of command-line options. Briefly outlined here: 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 - only display games defined in a gamelist.xml file. --gamelist-only skip automatic game search, only read from gamelist.xml
--ignore-gamelist - do not parse any gamelist.xml files. --ignore-gamelist ignore the gamelist (useful for troubleshooting)
--draw-framerate - draw the framerate. --draw-framerate display the framerate
--no-exit - do not display 'exit' in the ES menu. --no-exit don't show the exit option in the menu
--debug - show the console window on Windows, do slightly more logging --no-splash don't show the splash screen
--windowed - run ES in a window, works best in conjunction with --resolution [w] [h]. --debug more logging, show console on Windows
--vsync [1/on or 0/off] - turn vsync on or off (default is on). --scrape scrape using command line interface
--scrape - run the interactive command-line metadata scraper. --windowed not fullscreen, should be used with --resolution
--no-splash - don't show the splash screen. --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-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
--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.