This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
getting_started [2017/05/13 10:04] phulshof |
getting_started [2017/05/15 18:01] bodbod [Adding collections] |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Getting started ====== | + | ====== Getting Started ====== |
+ | \\ | ||
For Windows users, and some Linux users, getting started with RetroFE is as simple as following these steps: | For Windows users, and some Linux users, getting started with RetroFE is as simple as following these steps: | ||
- Download RetroFE from http://retrofe.nl/download | - Download RetroFE from http://retrofe.nl/download | ||
Line 8: | Line 8: | ||
- Edit/add/delete collections. | - Edit/add/delete collections. | ||
- Re-run RetroFE | - Re-run RetroFE | ||
+ | \\ | ||
+ | ===== RetroFE Root Directory Structure ===== | ||
- | =====Detailed Setup Guide===== | + | ^File / Folder^ Description^ |
+ | |controls.conf|Controller configuration (up, down, select, back, etc)| | ||
+ | |log.txt|Log output| | ||
+ | |meta.db|Game %%(information database year, manufacturer, genre, #players, etc)%% | | ||
+ | |RetroFE.lnk|Windows link to core / retrofe.exe| | ||
+ | |settings.conf|Global frontend settings %%(display options, layout to use, base paths, etc)%%| | ||
+ | |%%/collections/%%|Game lists, menus, artwork and ROMs| | ||
+ | |%%/core/%%|Windows specific libraries needed for retrofe to run %%(also includes retrofe.exe)%%| | ||
+ | |%%/launchers/%%|Configuration files for launchers (emulators)| | ||
+ | |%%/layouts/%%|Layouts / themes to use or display for the frontend| | ||
+ | |%%/meta/%%|Files to import into meta.db (for scraping)| | ||
- | ==== Installation ==== | + | \\ |
+ | |||
+ | ======Detailed Setup Guide====== | ||
+ | |||
+ | \\ | ||
+ | ===== Installation ===== | ||
Line 19: | Line 36: | ||
After copying the RetroFE system to the directory of your choice, you're set to give your installation a first test by running the retrofe executable in that directory. RetroFE comes with a pre-installed Sega Genesis system with one game so you can check if the installation went according to plan. | After copying the RetroFE system to the directory of your choice, you're set to give your installation a first test by running the retrofe executable in that directory. RetroFE comes with a pre-installed Sega Genesis system with one game so you can check if the installation went according to plan. | ||
- | + | \\ | |
- | ====Configuration ==== | + | =====Configuration===== |
Line 27: | Line 44: | ||
The second configuration step is editing the RetroFE controls file RetroFE/controls.conf. In here you configure the keys used to control the RetroFE front-end. Note that the default select key is space, and not enter as some people expected. | The second configuration step is editing the RetroFE controls file RetroFE/controls.conf. In here you configure the keys used to control the RetroFE front-end. Note that the default select key is space, and not enter as some people expected. | ||
- | + | \\ | |
- | ==== Adding collections ==== | + | ===== Adding Collections ===== |
Line 55: | Line 72: | ||
arguments = nes -cart "%ITEM_FILEPATH%" | arguments = nes -cart "%ITEM_FILEPATH%" | ||
- | As an example: if RetroFE starts th game Willow (USA).nes, this launcher will execute the command: | + | As an example: if RetroFE starts the game Willow (USA).nes, this launcher will execute the command: |
mame nes -cart "RetroFE/collections/Nintendo Entertainment System/roms/Willow (USA).nes". | mame nes -cart "RetroFE/collections/Nintendo Entertainment System/roms/Willow (USA).nes". |