From 9d2f3de8a68dbd9edcdea7ed04ecac5973c56d5c Mon Sep 17 00:00:00 2001 From: Cristi Mitrana <31816814+cmitu@users.noreply.github.com> Date: Thu, 14 Feb 2019 09:41:26 +0200 Subject: [PATCH] Minor documentation formatting and updates --- GAMELISTS.md | 9 ++++++--- README.md | 41 +++++++++++++++++++++++------------------ 2 files changed, 29 insertions(+), 21 deletions(-) diff --git a/GAMELISTS.md b/GAMELISTS.md index 5c0ae1736..7064a27ca 100644 --- a/GAMELISTS.md +++ b/GAMELISTS.md @@ -32,6 +32,7 @@ There are a few types of metadata: * `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 `` 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). * `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). @@ -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. * `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). -* `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). * `releasedate` - datetime, the date the game was released. Displayed as date only, time is ignored. * `developer` - string, the developer for the game. * `publisher` - string, the publisher for the game. * `genre` - string, the (primary) genre for the game. * `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. +* `sortname` - string, used in sorting the gamelist in a system, instead of `name`. #### `` * `name` - string, the displayed name for the folder. * `desc` - string, the description 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 diff --git a/README.md b/README.md index 96c5c6782..49ff0c533 100644 --- a/README.md +++ b/README.md @@ -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 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:** -All of this be easily installed with apt-get: +All of this be easily installed with `apt-get`: ```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 \ libvlccore-dev vlc-bin ``` **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 sudo dnf install SDL2-devel freeimage-devel freetype-devel curl-devel \ 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 @@ -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) -[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) +[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.) [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: ``` ---resolution [width] [height] - try and force a particular resolution ---gamelist-only - only display games defined in a gamelist.xml file. ---ignore-gamelist - do not parse any gamelist.xml files. ---draw-framerate - draw the framerate. ---no-exit - do not display 'exit' in the ES menu. ---debug - show the console window on Windows, do slightly more logging ---windowed - run ES in a window, works best in conjunction with --resolution [w] [h]. ---vsync [1/on or 0/off] - turn vsync on or off (default is on). ---scrape - run the interactive command-line metadata scraper. ---no-splash - don't show the splash screen. ---max-vram [size] - Max VRAM to use in Mb before swapping. 0 for unlimited. ---force-kiosk - Force the UI mode to be Kiosk. +--resolution [width] [height] try and force a particular resolution +--gamelist-only skip automatic game search, only read from gamelist.xml +--ignore-gamelist ignore the gamelist (useful for troubleshooting) +--draw-framerate display the framerate +--no-exit don't show the exit option in the menu +--no-splash don't show the splash screen +--debug more logging, show console on Windows +--scrape scrape using command line interface +--windowed not fullscreen, should be used with --resolution +--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-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.