-
Notifications
You must be signed in to change notification settings - Fork 0
Configuration files (json)
WRITING IN PROGRESS
## 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 |
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 |
Allowing to choose the ArcadeRoom language.
Language can be choosen using preference window.
| Values | Description |
|---|---|
| en_english | English |
| es_espanol | Spanish |
| fr_francais | French |
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 |
Allowing to display console tab.
It can be choosen using view menu.
| Values | Description |
|---|---|
| true | Display |
| false | No display |
Allowing to display no cover game in game tab.
It can be choosen using game tools bar.
| Values | Description |
|---|---|
| true | Display |
| false | No display |
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 |
Allowing to display the tools bar in game tab.
It can be choosen using view menu.
| Values | Description |
|---|---|
| true | Display |
| false | No display |
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 |
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 |
The platform constructor name.
Any name must be indicated.
| Values | Description |
|---|---|
| Character string | Constructor name |
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 |
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 |
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 |
Height of icon to be displayed in console tab for the platform.
| Values | Description |
|---|---|
| Integer | Icon height in pixels |
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 |
Width of icon to be displayed in console tab for the platform.
| Values | Description |
|---|---|
| Integer | Icon width in pixels |
Path to the image to be displayed in overview tab for the platform TODO link to overview tab page.
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 |
The platform name.
Any name must be indicated.
| Values | Description |
|---|---|
| Character string | Platform name |
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 |
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 |
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 |