NEOPOPRC(5)

NAME
neopoprc - NeoPop-SDL config file

DESCRIPTION
The neopoprc file contains the configuration of NeoPop-SDL(6).

Lines starting with a hash mark (‘#’) are ignored. All keywords and values (except for paths) are case-insensitive. Command-line options override config file settings.

The configuration values can be of the following types:
boolean
    Logical value, can be one of “on”, “off”, “yes”, “no”, “0”, and “1”.
enum
    A value chosen from a limited set (described next to the option).
int An integer.
string
    A string.

The following keywords are understood:

colour
    [enum] Whether to emulate a colour NeoGeo Pocket. The following values are understood:
    greyscale
        Emulate greyscale device.
    colour
        Emulate colour device.
    auto
        Determine device type to emulate from ROM.
    Defaults to auto.

comms-mode
    [enum] Describes the role NeoPop-SDL(6) should play with regard to network play:
    none
        Disable network play.
    server
        Have client connect to us (start first).
    client
        Connect to server.
    Defaults to none.

comms-port
    [int] Which TCP port to use for network play. Defaults to 7846.

comms-remote
    [string] Hostname of the server for network play. Has no default.

flash-dir
    [string] Path to the directory where Flash RAM images should be saved. Defaults to “~/.neopop/flash”. If the directory does not exist, it is created automatically.

frameskip
    [int (1..7)] Show only every Nth frame. Defaults to 1 (display every frame).

fullscreen
    [boolean] Start in fullscreen mode. Defaults to off.

language
    [enum] Which language the hardware should claim it supports. Possible values:
    english
    japanese
    Defaults to english.

magnify
    [int (1..3)] Magnification factor for the graphics display. Defaults to 1 (no magnification). Not used in YUV fullscreen mode.

map Assign a NeoPop-SDL(6) event to a key. For details, please see the BINDINGS section below.

osd-colour
    [string] Colour to use for on-screen display, in RGB with either one or two hex digits per colour component. Default is white (fff).

samplerate
    [int] Sample rate at which to play audio. Defaults to 44100.

screenshot-dir
    [string] Path to directory in which to store screenshots. Defaults to “~”.. If the directory does not exist, it is created automatically.

smooth
    [boolean] Smooth display when magnified. Defaults to on. Ignored in YUV overlay mode.

state-dir
    [string] Path to directory in which to store save states. Defaults to “~/.neopop/state”. If the directory does not exist, it is created automatically.

sound
    [boolean] Whether to play sound. Defaults to on.

use-rom-name
    [boolean] Whether to derive Flash RAM and save state file names from the name in the ROM header rather than the ROM file name. Defaults to off.

yuv [enum] Use a YUV overlay for display. On some machines, this allows hardware accelerated scaling. Possible values:
    never
        Don't use a YUV overlay.
    fullscreen
        Only use a YUV overlay when in fullscreen mode.
    magnified
        Use a YUV overlay when in fullscreen mode or when the magnification factor is greater than 1.
    always
        Always use a YUV overlay.
    Defaults to magnified.

yuv-software
    [boolean] Use a YUV overlay even if scaling is not hardware accelerated. Defaults to off.

BINDINGS
The map keyword can be used to set key bindings. The following actions can be bound:
none
    No action. Can be used to remove a key binding.

joy up
joy down
joy left
joy right
joy button a
joy button b
joy option
    NeoGeo Pocket Gamepad.

gui frameskip decrement
gui frameskip increment
    Decrease/increase frameskip.

gui fullscreen off
gui fullscreen on
gui fullscreen toggle
    Turn fullscreen mode off, on, or toggle it.

gui magnify 1
gui magnify 2
gui magnify 3
    Set graphics magnification factor.

gui mute off
gui mute on
gui mute toggle
    Turn sound and music on, off, or toggle it.

gui pause off
gui pause on
gui pause toggle
    Pause or unpause game.

gui quit
    Exit the emulator.

gui screenshot
    Make a screenshot.

gui smooth off
gui smooth on
gui smooth toggle
    Choose whether to use a smoothing filter.

gui state load
gui state save
    Load or save a game state.

gui state slot decrement
gui state slot increment
    Decrease or increase the current game state slot. Goes from 0 to 9 and then wraps around to 0 again.

The key events use the names from the SDL library; see SDLKey(3) for details. Additionally, C- can be prepended for the control key, and A- or M- for the alt key. See also the EXAMPLES section below.

The following joystick events are known:
joy m axis n neg|pos
    On joystick m axis n the negative or positive direction.
joy m button n
    Button n on joystick m.
joy m hat n up|left|down|right
    On joystick m hat n direction up, left, down, or right.

FILES
~/.neopop/neopoprc Location of the config file.

EXAMPLES
To exit the emulator with ALT-F4, add the following line to your ~/.neopop/neopoprc:
    map A-F4 = gui quit

To simulate a NeoGeo Pocket option key with button 5 on the second joystick use:
    map joy 2 button 5 = joy option

To save all game states and flash saves in subdirectories of ~/.neopop:
    flash-dir ~/.neopop/flash
    state-dir ~/.neopop/states

SEE ALSO
NeoPop-SDL(6)

http://www.nih.at/NeoPop-SDL/

AUTHORS
neopop_uk <neopop_uk@yahoo.co.uk> wrote the original NeoPop emulator. Marat Fayzullin provided the z80 core for sound. Thomas Klausner <wiz@danbala.tuwien.ac.at> ported it to SDL. Dieter Baron <dillo@danbala.tuwien.ac.at> made lots of improvements.