mirror of
https://github.com/RetroDECK/ES-DE.git
synced 2024-11-22 14:15:38 +00:00
Updated the README.
This commit is contained in:
parent
4f99dec7c2
commit
7920753718
30
README.md
30
README.md
|
@ -9,10 +9,12 @@ I'm not associated with RetroArch in any way!
|
||||||
Building
|
Building
|
||||||
========
|
========
|
||||||
|
|
||||||
EmulationStation has a few dependencies. For building, you'll need SDL 1.2, the SDL TTF library, and Boost.Filesystem, which can easily be obtained with apt-get:
|
EmulationStation has a few dependencies. For building, you'll need SDL 1.2, the SDL TTF library, the SDL image library, and Boost.Filesystem, which can easily be obtained with apt-get:
|
||||||
`sudo apt-get install libsdl1.2-dev`
|
```sudo apt-get install libsdl1.2-dev
|
||||||
`sudo apt-get install libsdl-ttf2.0-dev`
|
sudo apt-get install libsdl-ttf2.0-dev
|
||||||
`sudo apt-get install libboost-filesystem-dev`
|
sudo apt-get install libboost-filesystem-dev
|
||||||
|
sudo apt-get install libsdl-image1.2-dev
|
||||||
|
```
|
||||||
|
|
||||||
You can build EmulationStation by simply running `make`.
|
You can build EmulationStation by simply running `make`.
|
||||||
|
|
||||||
|
@ -29,5 +31,25 @@ Keep in mind you'll have to set up your emulator separately from EmulationStatio
|
||||||
|
|
||||||
EmulationStation will return once your system's command terminates (i.e. your emulator closes). To close EmulationStation itself, you can press the F4 key on the keyboard.
|
EmulationStation will return once your system's command terminates (i.e. your emulator closes). To close EmulationStation itself, you can press the F4 key on the keyboard.
|
||||||
|
|
||||||
|
|
||||||
|
gamelist.xml
|
||||||
|
============
|
||||||
|
|
||||||
|
If a file named gamelist.xml is found, it will be parsed and the detailed GuiGameList will be used. This means you can define screenshots, descriptions, and alternate names for files.
|
||||||
|
Screenshots are meant to be 256x256, but ES won't stop you from using other sizes - they'll just be placed wrong.
|
||||||
|
An example gamelist.xml:
|
||||||
|
```<gameList>
|
||||||
|
<game>
|
||||||
|
<path>/home/pi/ROMs/nes/mm2.nes</path>
|
||||||
|
<name>Mega Man 2</name>
|
||||||
|
<desc>Mega Man 2 is a classic NES game which follows Mega Man as he murders eight robot masters.</desc>
|
||||||
|
<image>/home/pi/Screenshots/megaman2.png</image>
|
||||||
|
</game>
|
||||||
|
</gameList>
|
||||||
|
```
|
||||||
|
|
||||||
|
The path element should be the absolute path of the ROM. Special characters SHOULD NOT be escaped. The image element is the absolute path to an image to use (like a screenshot or boxart). Most formats can be used (including png, jpg, gif, etc.). Look up the SDL_image library for a full list. Not all elements need to be used.
|
||||||
|
|
||||||
|
|
||||||
-Aloshi
|
-Aloshi
|
||||||
http://www.aloshi.com
|
http://www.aloshi.com
|
||||||
|
|
Loading…
Reference in a new issue