Amiberry.conf options

Description

Amiberry includes a generic config file named amiberry.conf, which controls several default options that apply before/without loading a specific .uae config.

Location

The amiberry.conf file is distributed with the release packages of Amiberry, but it's also recreated by Amiberry itself when you use the "Scan for ROMs" function or when it Quits. It's located in the <amiberry>/conf/ directory, where <amiberry> is where you have the binary located.

Options

Below is a description of what options are available, what values they accept and what their purpose is:

`Quickstart`

Controls if the Quickstart Panel should be the default, when opening the Amiberry GUI. If it's not set as the default, Configurations will be opened, instead.

Possible values: yes (disabled) or no (enabled)

Default value: yes (Quickstart is the selected Panel when the GUI opens up for the first time.)

Example: quickstart=yes

`read_config_descriptions`

Controls if Amiberry should open each config file and read the Description field, when showing the list of available Configs in the related Panel. This operation takes time, so it will slow down scanning the config list if you have a lot of files there. If you disable it, the list will show faster but you won't see the Description field in the list.

Possible values: yes or no

Default value: yes (Read all config file descriptions)

Example: read_config_descriptions=yes

`write_logfile`

If set to yes, Amiberry will attempt to write a logfile named amiberry_log.txt with information during normal operation. This is mostly useful for debugging and troubleshooting purposes. The logfile will be written in the same directory Amiberry is in, so make sure the user has permissions to create a new file there (otherwise it will silently fail to create it).

Possible values: yes or no

Default value: no (Don't create a logfile)

Example: write_logfile=yes

`default_line_mode`

You can choose the default Line mode Amiberry will use, when drawing the Amiga screen. The available options are: Single (default), Double or Scanlines. Scanlines and Line Doubling come with a slight performance hit (since double the amount of lines need to be drawn on screen), so you might want to change this option according to your hardware. If the vertical resolution is not high enough (e.g. if you have < 540 lines available), then this option will do nothing as Scanlines/Line Doubling cannot be shown in such low resolutions. Since Amiberry 5.4 the default has been changed from Single to Double Line mode.

Possible values: 0 (single), 1 (double) or 2 (scanlines)

Default value: 1

Example: default_line_mode=2

`rctrl_as_ramiga` (Since v3.4)

This option will change the behavior of the RCtrl key, and use it as the RAmiga key. It's useful in cases where a keyboard does not have a RWin or Menu key, which are normally the ones used for the RAmiga key.

Possible values: yes or no

Default value: no

Example: rctrl_as_ramiga=yes

`gui_joystick_control`

Amiberry will initialize and use the first detected controller for navigation in the GUI. You can use this option to disable that behavior, if you wish.

Possible values: yes or no

Default value: yes

Example: gui_joystick_control=no

`default_multithreaded_drawing`

Use a separate thread for drawing the native chipset output. This helps the performance, but it may cause glitches in some cases (e.g. flickering screens in Jesus on E's demo). This controls the default behavior if the relevant option in the Chipset panel is not configured.

Possible values: yes or no

Default value: yes

Example: default_multithreaded_drawing=no

`input_default_mouse_speed`

A generic setting which overrides the mouse speed for all games.

Possible values: integer values (higher numbers = more sensitivity)

Default value: 100

Example: input_default_mouse_speed=45

`input_keyboard_as_joystick_stop_keypresses`

When using keyboards as joysticks, often the joysticks also pressed keys and caused two inputs across varying games. Setting this option to yes, these keypresses are ignored.

Possible values: yes or no

Default value: no

Example: input_keyboard_as_joystick_stop_keypresses=yes

`default_open_gui_key`

The default key to open the Amiberry GUI, in plain text. The text here will be interpreted by SDL2's SDL_GetKeyFromName() function, to get the actual key code.

Possible values: any human-readable text representing a key

Default value: F12

Example: default_open_gui_key=F6

`default_quit_key`

The default key to Quit the Amiberry emulator, in plain text. The text here will be interpreted by SDL2's SDL_GetKeyFromName() function, to get the actual key code.

Possible values: any human-readable text representing a key

Default value: none

Example: default_quit_key=F11

`default_ar_key`

The default key to trigger the Action Replay or HRTMon, in plain text. The text here will be interpreted by SDL2's SDL_GetKeyFromName() function, to get the actual key code.

Possible values: any human-readable text representing a key

Default value: Pause

Example: default_ar_key=Pause

`default_fullscreen_toggle_key`

The default key to toggle Fullscreen mode, in plain text. The text here will be interpreted by SDL2's SDL_GetKeyFromName() function, to get the actual key code.

Possible values: any human-readable text representing a key

Default value: none

Example: default_fullscreen_toggle_key=F11

`rotation_angle`

If you want the output rotated, you can use this parameter to control by how many degrees it should be rotated. This is useful in devices which have a screen with portrait orientation (e.g. the Odroid Go Advance).

Possible values: 0, 90, 180, 270, etc.

Default value: 0

Example: rotation_angle=270

`default_horizontal_centering`

You can use this option to enable Smart Horizontal Centering by default.

Possible values: yes/no

Default value: no

Example: default_horizontal_centering=yes

`default_vertical_centering`

You can use this option to enable Smart Vertical Centering by default.

Possible values: yes/no

Default value: no

Example: default_vertical_centering=yes

`default_scaling_method`

You can use this option to set the desired Scaling method to use by default.

Possible values: -1 (Auto), 0 (Nearest neighbor) or 1 (Linear)

Default value: -1

Example: default_scaling_method=0 to enable Nearest neighbor scaling by default

`default_frameskip`

You can use this option to enable Frameskip by default.

Possible values: yes/no

Default value: no

Example: default_frameskip=yes

`default_correct_aspect_ratio`

You can use this option to control if the Aspect Ratio should be corrected by default.

Possible values: yes/no

Default value: yes

Example: default_correct_aspect_ratio=no

`default_auto_crop`

You can use this option to control if the Auto Crop feature should be Enabled by default.

Possible values: yes/no

Default value: no

Example: default_auto_crop=yes

`default_width`

You can use this option to set the default Screen Width value.

Possible values: 320-720

Default value: 720

Example: default_width=640

`default_height`

You can use this option to set the default Screen Height value.

Possible values: 400-568

Default value: 568

Example: default_height=512

`default_fullscreen_mode`

You can use this option to control what screen mode the emulator should start with, by default. There are currently 3 modes supported: 0 = Windowed (only possible in a Desktop environment) 1 = Fullscreen (changes resolution of the monitor) 2 = Full-window (scales the picture to the current monitor resolution)

Possible values: 0, 1 or 2

Default value: 0

Example: default_fullscreen_mode=2 to have the emulator start up in Full-window mode

`default_stereo_separation`

You can use this option to set the default Stereo Separation value. The scale is in percentage, from 0 (0%) to 10 (100%).

Possible values: 0-10

Default value: 7

Example: default_stereo_separation=7

`default_sound_buffer` - (Since v4.x)

You can use this option to configure the default size of the Sound Buffer. Valid values are multiples of 1024, up to 65536. Smaller values decrease latency, but put more stress on the CPU. Adjust as necessary for your hardware. The GUI uses an index (from 1-10) which corresponds to one of the valid values below.

Possible values: 1024, 2048, 3072, 4096, 6144, 8192, 12288, 16384, 32768, 65536

Default value: 8192 (which is position 6 from the GUI)

Example: default_sound_buffer=4096

`default_sound_pull` - (Since v4.x)

There are 2 modes for producing the sound output: Pull and Push. Pull will create a callback that runs separately from the main thread, and fetches audio chunks for playback. Push will switch to pushing audio chunks for playback as part of the sound emulation loop. Pull usually works better, but you may experience audio glitches on startup. Use the method that works best for you.

Possible values: yes, no

Default value: yes

Example: default_sound_pull=no

`default_joystick_deadzone`

You can use this option to set the default Joystick Deadzone value. The scale is from 0 to 100.

Possible values: 0-100

Default value: 33

Example: default_joystick_deadzone=50

`default_retroarch_quit`

You can use this option to control if the RetroArch Quit feature should be Enabled by default.

Possible values: yes/no

Default value: yes

Example: default_retroarch_quit=yes

`default_retroarch_menu`

You can use this option to control if the RetroArch Menu feature should be Enabled by default.

Possible values: yes/no

Default value: yes

Example: default_retroarch_menu=yes

`default_retroarch_reset`

You can use this option to control if the RetroArch Reset feature should be Enabled by default.

Possible values: yes/no

Default value: no

Example: default_retroarch_reset=yes

`default_retroarch_vkbd`

You can use this option to control if the Virtual Keyboard mapping should come from the RetroArch config (if available) by default. Please note that if you want to use RetroArch mapping for virtual keyboard, you should clear out the default_vkbd_toggle option to ensure there are no conflicts.

Possible values: yes/no

Default value: no

Example: default_retroarch_vkbd=yes

`default_controller1`

This setting is used by the WHDLoad booter function, to control the default first controller for WHDLoad games, that use a Joystick as Primary Control. The available options are: mouse (for the default mouse), joy0 (first connected game controller), joy1 (second connected game controller), etc.

Possible values: mouse/joy0/joy1/joy2/joy3/joy4

Default value: joy0

Example: default_controller1=joy1

`default_controller2`

This setting is used by the WHDLoad booter function, to control the default second controller for WHDLoad games, that use a Joystick as Primary Control. The available options are: mouse (for the default mouse), joy0 (first connected game controller), joy1 (second connected game controller), etc.

Possible values: mouse/joy0/joy1/joy2/joy3/joy4

Default value: joy1

Example: default_controller2=joy2

`default_controller3`

This setting is used by the WHDLoad booter function, to control the default first Parallel port controller for WHDLoad games, that use a Joystick as Primary Control. The available options are: mouse (for the default mouse), joy0 (first connected game controller), joy1 (second connected game controller), etc.

Possible values: mouse/joy0/joy1/joy2/joy3/joy4

Default value: None

Example: default_controller3=joy0

`default_controller4`

This setting is used by the WHDLoad booter function, to control the default second Parallel port controller for WHDLoad games, that use a Joystick as Primary Control. The available options are: mouse (for the default mouse), joy0 (first connected game controller), joy1 (second connected game controller), etc.

Possible values: mouse/joy0/joy1/joy2/joy3/joy4

Default value: None

Example: default_controller4=joy3

`default_mouse1`

This setting is used by the WHDLoad booter function, to control the default first controller for WHDLoad games, that use a Mouse as Primary Control. The available options are: mouse (for the default mouse), joy0 (first connected game controller), joy1 (second connected game controller), etc.

Possible values: mouse/joy0/joy1/joy2/joy3/joy4

Default value: mouse

Example: default_mouse1=joy1

`default_mouse2`

This setting is used by the WHDLoad booter function, to control the default second controller for WHDLoad games, that use a Mouse as Primary Control. The available options are: mouse (for the default mouse), joy0 (first connected game controller), joy1 (second connected game controller), etc.

Possible values: mouse/joy0/joy1/joy2/joy3/joy4

Default value: joy0

Example: default_mouse2=joy0

`default_whd_buttonwait`

This setting is used by the WHDLoad booter function, to control if the ButtonWait option should be turned on or off. This is combined with the showsplash setting below.

Possible values: yes/no

Default value: no

Example: default_whd_buttonwait=yes

`default_whd_showsplash`

This setting is used by the WHDLoad booter function, to control if the ShowSplash option should be turned on or off. Possible values: yes/no

Default value: yes

Example: default_whd_showsplash=no

`default_whd_configdelay`

This setting is used by the WHDLoad booter function, to control if the ConfigDelay value.

Possible values: -1, 0, 1, etc.

Default value: 0

Example: default_whd_configdelay=-1

`default_whd_writecache`

This setting is used by the WHDLoad booter function, to control if the WriteCache option is enabled or not.

Possible values: yes/no

Default value: no

Example: default_whd_writecache=yes

`default_whd_quit_on_exit`

This setting is used by the WHDLoad booter function, to enable running AmiQuit at the end of the startup-sequence, in order to quit the emulator after hte game exits.

Possible values: yes/no

Default value: no

Example: default_whd_quit_on_exit=yes

`disable_shutdown_button`

This setting controls if the Shutdown button in the GUI should be Disabled or not.

Possible values: yes/no

Default value: no

Example: disable_shutdown_button=yes

`allow_display_settings_from_xml`

This setting controls if the WHDLoad XML file's Display options (per game), should be allowed to override the defaults located in amiberry.conf.

Possible values: yes/no

Default value: yes

Example: allow_display_settings_from_xml=no

`default_soundcard`

This setting controls the default Sound Card Amiberry will use. The value needs to be an Integer starting from the default value of 0 (which means the first sound card found in the system) and increasing for every extra device available. For example, if you have an External USB sound card on your device, that might have the ID of 1, therefore you can set this option to 1 and have Amiberry automatically use that sound card always.

Possible values: 0, 1, 2, etc.

Default value: 0

Example: default_soundcard=1

`default_vkbd_enabled`

This setting controls if the Virtual Keyboard functionality will be enabled by default or not. The virtual keyboard needs to be enabled and also mapped to a controller button (either by using Custom Controls, or separately in the relevant option), in order to work. Use this option if you want it always enabled by default. Please note that you still need to map the button to toggle it, separately.

Possible values: yes/no

Default value: no

Example: default_vkbd_enabled=yes

`default_vkbd_hires`

This setting controls the default version of the virtual keyboard, if it's enabled (see also option above). There are currently two versions: a normal one, and a "high-resolution" one, which is larger and might be easier to see. Enabling this option will use the "HiRes"/larger version of the virtual keyboard, when it's shown on-screen.

Possible values: yes/no

Default value: no

Example: default_vkbd_hires=yes

`default_vkbd_exit`

This setting controls if the virtual keyboard should support Quitting Amiberry as well, by default. There's an extra button on the virtual keyboard that performs this task, if this setting is enabled. This allows you to Quit the emulator using your controller, after opening up the virtual keyboard.

Possible values: yes/no

Default value: no

Example: default_vkbd_exit=yes

`default_vkbd_language`

This setting controls the default language layout for the virtual keyboard. Currently there are four language options available: US, UK, FR and DE. If no setting is provided, it will default to the US keyboard layout.

Possible values: US, UK, FR or DE

Default value: nothing (defaults to US internally)

Example: default_vkbd_language=DE

`default_vkbd_style`

This setting controls the default theme/style of the virtual keyboard, when shown. Currently there are four styles available: Original, Warm, Cool and Dark.

Possible values: Original, Warm, Cool, Dark

Default value: nothing (defaults to Original internally)

Example: default_vkbd_style=Warm

`default_vkbd_transparency`

This setting controls the default transparency amount the virtual keyboard will have, when shown on-screen. The range of values is from 0 (no transparency, i.e. solid) to 100 % (full transparency, you won't be able to see the keyboard!). The default value if not specified here is zero (solid).

Possible values: 0...100

Default value: 0

Example: default_vkbd_transparency=50 (will set it at 50% transparency)

`default_vkbd_toggle`

This setting allows you to configure a default controller button for toggling the virtual keyboard on/off. The values used are the same as with the custom events, and come from SDL2's controller button strings. The default value is the guide button in XBox/PS style controllers (Xbox/PS4 button in the middle).

Possible values: text representation of controller button

Default value: guide

Example: default_vkbd_toggle=leftstick (set the Left Stick button)

`gui_theme_font_name`

This setting allows you to override the default font name used in Amiberry's GUI. The full font name is required, and it must be a TrueType font. The file must be placed inside the data directory of Amiberry, in order to be loaded on startup. This value will default to AmigaTopaz.ttf, which is the default font used, if nothing else is specified.

Possible values: the filename of the font, placed in data

Default value: AmigaTopaz.ttf

Example: gui_theme_font_name=MicroFont.ttf

`gui_theme_font_size`

This setting allows you to change the font size used in Amiberry's GUI. The default value here is 15, which is designed to go together with the default font used (see option above).

Possible values: any number higher than 0

Default value: 15

Example: gui_theme_font_size=16

`gui_theme_font_color`

This setting allows you to change the RGB values of the font color that will be used in Amiberry's GUI. The values must be comma-separated, and within the range of 0-255 each. At least 3 values (RGB) are required, but you can optionally also specify a fourth one for the alpha channel, if transparency is required. The default value for the Alpha channel is 255 (opaque). The default color is black.