User Tools

Site Tools


getting_started

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
getting_started [2017/05/14 11:10]
bodbod
getting_started [2017/05/18 05:22]
phulshof
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
   - Edit the [[global settings.conf|global settings.conf]] file.   - Edit the [[global settings.conf|global settings.conf]] file.
-  - Edit the controls.conf file.+  - Edit the [[controls|controls.conf]] file.
   - Run RetroFE to verify if the front-end loads (and exits) correctly.   - Run RetroFE to verify if the front-end loads (and exits) correctly.
-  - Edit/​add/​delete collections.+  - Edit/​add/​delete ​[[collections|collections]].
   - Re-run RetroFE   - Re-run RetroFE
 +\\
 +===== RetroFE Root Directory Structure =====
  
-====== RetroFE Root Directory Structure ====== 
- 
-''​Root folder''​ 
  
 ^File / Folder^ Description^ ^File / Folder^ Description^
-|controls.conf|Controller configuration (up, down, select, back, etc)|+|[[controls|controls.conf]]|Controller configuration (up, down, select, back, etc)|
 |log.txt|Log output| |log.txt|Log output|
 |meta.db|Game %%(information database year, manufacturer,​ genre, #players, etc)%% | |meta.db|Game %%(information database year, manufacturer,​ genre, #players, etc)%% |
 |RetroFE.lnk|Windows link to core / retrofe.exe| ​     ​ |RetroFE.lnk|Windows link to core / retrofe.exe| ​     ​
-|settings.conf|Global frontend settings %%(display options, layout to use, base paths, etc)%%| ​    +|[[global_settings.conf|settings.conf]]|Global frontend settings %%(display options, layout to use, base paths, etc)%%| ​    
 |%%/​collections/​%%|Game lists, menus, artwork and ROMs| |%%/​collections/​%%|Game lists, menus, artwork and ROMs|
 |%%/​core/​%%|Windows specific libraries needed for retrofe to run %%(also includes retrofe.exe)%%| |%%/​core/​%%|Windows specific libraries needed for retrofe to run %%(also includes retrofe.exe)%%|
Line 25: Line 24:
 |%%/​meta/​%%|Files to import into meta.db (for scraping)| |%%/​meta/​%%|Files to import into meta.db (for scraping)|
  
 +\\
  
 +======Detailed Setup Guide======
  
-=====Detailed Setup Guide===== +\\ 
- +===== Installation ​=====
-==== Installation ​====+
  
  
Line 36: 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 ==== 
- 
- 
-The first configuration step is editing the RetroFE system configuration file RetroFE/​settings.conf. In here you configure the screen settings, global theme, base paths, etc. 
  
-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 spaceand not enter as some people expected.+The first configuration step is editing the RetroFE ​system configuration ​file RetroFE/[[global_settings.conf|settings.conf]]. In here you configure the screen settings, global theme, base pathsetc.
  
 +The second configuration step is editing the RetroFE controls file RetroFE/​[[controls|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 =====
  
  
-RetroFE starts with two (almost empty) collections,​ but more can be added easily. As an example, let's set up the Nintendo Entertainment System collection. First, enter the RetroFE/​collections directory, and create an empty collection using the following command: ../retrofe -createcollection "​Nintendo Entertainment System"​+RetroFE starts with two (almost empty) ​[[collections|collections]], but more can be added easily. As an example, let's set up the Nintendo Entertainment System collection. First, enter the RetroFE/​collections directory, and create an empty collection using the following command: ../retrofe -createcollection "​Nintendo Entertainment System"​
  
  
Line 72: 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"​.
getting_started.txt · Last modified: 2017/05/25 02:04 by phulshof