FBNeo/README-PI.md

# FinalBurn Neo for Raspberry Pi

## Compiling
To compile the emulator, run `make pi`. You will need SDL 1.2 libraries for
sound and input:

```
sudo apt-get install libsdl1.2-dev
```

To build on Pi4, you may need additional libraries, including:

```
sudo apt-get install libgles2-mesa-dev libgbm-dev libdrm-dev
```

If you receive "failed to fetch" errors during `apt-get install`, update
the definitions (`sudo apt-get update`) and try again.

## Compatibility
The emulator runs very smoothly on Pi 1, 2 and 3. It runs on 4, but the
performance isn't nearly as good.

## Input
To customize joystick input, place a text file in a directory named `joyconfig`.
The file should have extension `.jc`, and named as follows:

```
<name of romset>.jc
<name of parent romset>.jc
capcom6.jc
default.jc
```

To determine mapping for a particular set, emulator will look for the first
applicable file, in that order. `capcom6.jc` will only be checked if the set
is determined to be a 6-button Capcom ROMset, such as SFII, III, etc. 
`default` is a fallback file.

For instance, for set `sfau`, emulator will look for `sfau`, `sfa`, `capcom6`,
then `default`, in that order. For `mkr4` (Mortal Kombat rev 4.0), `mkr4`,
`mk`, `default` are applicable.

### Joyconfig file format
The format of the file is as follows:

```
<INPUT NAME>=<hardware joystick button number>
...
```

Input name can be one of: `TEST` (usually `F2` on keyboard), `SERVICE` (`9` on
keyboard) , `RESET` (`F3`), `QUIT`, `START`, `COIN`, or `BUTTONx` (where `x` is
a numeric digit between 1 and 9).

### Example
A generic `default` file could look as follows:

```
BUTTON1=1
BUTTON2=2
BUTTON3=3
BUTTON4=4
BUTTON5=6
BUTTON6=7
BUTTON7=8
COIN=9
START=10
```

In this case, buttons 1-8 on the hardware joystick map to emulated buttons 1-8,
while joystick buttons 9 and 10 map to "Coin" and "Start", respectively.

## Command-line switches
`-f`: Enables free play in games that include a Free Play dipswitch. This
switch isn't guaranteed to always work, since not every game has a free play
dipswitch, and because different sets may have the switch labeled differently.
`-F`: Enables free play hack mode. In hack mode, pressing Start also generates
a Coin button press.

## About
Pi build is maintained by [0xe1f](https://github.com/0xe1f).