Configuration files (json)

WRITING IN PROGRESS

Contents

1. Overview
2. General preferences
3. Platforms
4. Application styles

## 1- Overview ArcadeRoom is plently configurable through json format files.
Following features can be configured: * General preferences * Platform * Application styles ## 2- General preferences > FILENAME preferences.json

The json preferences allows to configure the following:

Feature	Json tag
Cover size factor	coverSizeFactor
Language	language
Layout type	layoutType
Display consoles	showConsoles
Display No Covers games	showNoCovers
Display Status Bar	showStatusBar
Display Tools Bar	showToolsBar
ArcadeRoom Style	style

### 2.1- Cover Size Factor > JSON TAG coverSizeFactor DEFAULT VALUE 1

Allowing to size the diplayed game covers by applying a scale factor.
It can be adjusted using game tools bar.

Values	Description
Real number from 0.5 to 1.5	Scaling factor to apply

### 2.2- Language > JSON TAG language DEFAULT VALUE en_english

Allowing to choose the ArcadeRoom language.
Language can be choosen using preference window.

Values	Description
en_english	English
es_espanol	Spanish
fr_francais	French

### 2.3- Layout type > JSON TAG layoutType DEFAULT VALUE 0

Allowing to choose the layout for game displayed in game tab TODO link to game tab page.
Layout type can be choosen using game tools bar.

Values	Description
0	Grid 3 columns
1	Grid 4 columns
2	Grid 5 columns
3	Horizontal (single line)
4	List

### 2.4- Display consoles > JSON TAG showConsoles DEFAULT VALUE true

Allowing to display console tab.
It can be choosen using view menu.

Values	Description
true	Display
false	No display

### 2.5- Display no cover games > JSON TAG showNoCovers DEFAULT VALUE true

Allowing to display no cover game in game tab.
It can be choosen using game tools bar.

Values	Description
true	Display
false	No display

### 2.6- Display Status Bar > JSON TAG showStatusBar DEFAULT VALUE true

Allowing to display status bar TODO link to status bar page.
It can be choosen using view menu.

Values	Description
true	Display
false	No display

### 2.7- Display Tools Bar > JSON TAG showToolsBar DEFAULT VALUE true

Allowing to display the tools bar in game tab.
It can be choosen using view menu.

Values	Description
true	Display
false	No display

### 2.8- Style > JSON TAG style DEFAULT VALUE dark

Allowing to choose the ArcadeRoom style to be applied.
Style can be choosen using preference window.

Values	Description
Name of json style file without extension	Style to be applied

## 3- Platforms > FILENAME [platform_name].json with platform_name, the name of platform to be configured.

The json platform file allows to configure the following:

Feature	Json tag
Constructor name	constructor_name
Description	description
Emulator arguments	emulator_arguments
Emulator path	emulator_path
Icon height	icon_height
Icon path	icon_path
Icon width	icon_width
Image path	image_path
Name	name
Generation	generation
Games path	rom_path
Games extension	rom_extensions
Screenshot URL	screenshot_urls
Video URL	video_urls

### 3.1- Constructor name > JSON TAG constructor_name DEFAULT VALUE N.A.

The platform constructor name.
Any name must be indicated.

Values	Description
Character string	Constructor name

### 3.2- Description > JSON TAG description DEFAULT VALUE N.A.

A platform description.
Any description must be indicated.
It should indicate the platform story, special features and greatest games.

Values	Description
Character string	The description

### 3.3- Emulator arguments > JSON TAG emulator_arguments DEFAULT VALUE N.A.

Define the emulator arguments to be used when launching a game.
Any number of arguments must be indicated (must be empty).

Values	Description
Tab of comma separated character strings	The arguments

### 3.4- Emulator path > JSON TAG emulator_path DEFAULT VALUE N.A.

Path to the emulator executable.
It must contain the executable name (with extension if exists).
Path can be an absolute or a relative path from ArcadeRoom launching directory.

Values	Description
Character string	The path

### 3.5- Icon height > JSON TAG icon_height DEFAULT VALUE N.A.

Height of icon to be displayed in console tab for the platform.

Values	Description
Integer	Icon height in pixels

### 3.6- Icon path > JSON TAG icon_path DEFAULT VALUE N.A.

Path to the icon to be displayed in console tab for the platform.
It must contain the icon name (with extension if exists).
Path can be an absolute or a relative path from ArcadeRoom launching directory.

Values	Description
Character string	The icon path

### 3.7- Icon width > JSON TAG icon_width DEFAULT VALUE N.A.

Width of icon to be displayed in console tab for the platform.

Values	Description
Integer	Icon width in pixels

### 3.8- Image path > JSON TAG image_path DEFAULT VALUE N.A.

Path to the image to be displayed in overview tab for the platform.
It must contain the image name (with extension if exists).
Path can be an absolute or a relative path from ArcadeRoom launching directory.

Values	Description
Character string	The image path

### 3.9- Name > JSON TAG name DEFAULT VALUE N.A.

The platform name.
Any name must be indicated.

Values	Description
Character string	Platform name

### 3.10- Generation > JSON TAG generation DEFAULT VALUE N.A.

The platform generation name.
Any character string must be indicated.
It should be a character string as 2, second, 2nd ...

Values	Description
Character string	The generation

### 3.11- Games path > JSON TAG rom_path DEFAULT VALUE N.A.

Path to the directory which contains platform games.
Path can be an absolute or a relative path from ArcadeRoom launching directory.

Values	Description
Character string	The game directory path

### 3.12- Games extensions > JSON TAG rom_extensions DEFAULT VALUE N.A.

Define authorized extensions of platform game files taken into account by ArcadeRoom.
Game files with unauthorized extensions are ignored by ArcadeRoom (not displayed).
Any number of extension must be indicated (but at least one).

Values	Description
Tab of comma separated character strings without dot.	The arguments

### 3.13- Screenshot URL > JSON TAG screenshot_urls DEFAULT VALUE N.A. TODO ### 3.14- Video URL > JSON TAG video_urls DEFAULT VALUE TODO **TODO** ## 4- Application styles TODO