Xargon/ES-DE
1
0
Fork 0
mirror of https://github.com/RetroDECK/ES-DE.git synced 2024-11-22 14:15:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated the README.

Browse source
This commit is contained in:
Aloshi 2012-08-02 13:27:37 -05:00
parent 4f99dec7c2
commit 7920753718
1 changed files with 26 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -9,10 +9,12 @@ I'm not associated with RetroArch in any way!
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:
`sudo apt-get install libsdl1.2-dev`
`sudo apt-get install libsdl-ttf2.0-dev`
`sudo apt-get install libboost-filesystem-dev`
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 libsdl-ttf2.0-dev
sudo apt-get install libboost-filesystem-dev
sudo apt-get install libsdl-image1.2-dev
```
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.
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
http://www.aloshi.com