OpenJVS

https://openjvs.github.io/
Admin
OpenJVS is an emulator for JVS Arcade IO boards, used in many arcade systems, allowing communication...
Tokens:2,303
Snippets:25
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install and Run Globally

Source: https://openjvs.github.io/

Install the binary to the system path and execute it globally.

```bash
sudo make install
sudo openjvs [optional outside mapping name]
```

--------------------------------

### Install OpenJVS

Source: https://openjvs.github.io/

Commands to install dependencies, clone the repository, and build the project.

```bash
sudo apt install git cmake
git clone https://github.com/OpenJVS/OpenJVS
cd OpenJVS
make
```

--------------------------------

### Example Mapping File

Source: https://openjvs.github.io/

A sample configuration file for mapping physical controller inputs to virtual controller outputs.

```text
# Example Mapping File
# Author: Bobby Dilley

# Map the button section
# <FROM> <TO>
BTN_SOUTH CONTROLLER_ANALOGUE_A
BTN_NORTH CONTROLLER_ANALOGUE_C

# Map the analogue section
ABS_X CONTROLLER_ANALOGUE_X
ABS_Y CONTROLLER_ANALOGUE_Y REVERSE
ABS_Z CONTROLLER_ANALOGUE_R REVERSE SENSITIVITY 1.5
ABS_RZ CONTROLLER_ANALOGUE_L SENSITIVITY 0.9


# Map a HAT controller
ABS_HAT0X CONTROLLER_BUTTON_LEFT CONTROLLER_BUTTON_RIGHT
```

--------------------------------

### Install evtest

Source: https://openjvs.github.io/

Install the evtest utility for identifying input device capabilities.

```bash
sudo apt install evtest
```

--------------------------------

### Run OpenJVS Locally

Source: https://openjvs.github.io/

Execute the built binary from the root directory.

```bash
sudo ./build/openjvs [optional outside mapping name]
```

--------------------------------

### Run evtest

Source: https://openjvs.github.io/

Execute evtest to inspect connected input devices.

```bash
sudo evtest
```

--------------------------------

### List Available Devices

Source: https://openjvs.github.io/

Display all input devices currently recognized by OpenJVS.

```bash
sudo openjvs --list
```

--------------------------------

### List of supported IO emulation types

Source: https://openjvs.github.io/

Reference list of valid IO types for the EMULATE keyword.

```text
IO TO EMULATE
-------------
SEGA_TYPE_3_IO
NAMCO_JYU_IO
NAMCO_V185_IO


```

--------------------------------

### Include and extend existing mapping files

Source: https://openjvs.github.io/

Use the INCLUDE keyword to inherit settings from another mapping file and add specific overrides.

```text
# Example Outrun 2 Mapping File
# Author: Bobby Dilley

# Set the IO to emulate
EMULATE SEGA_TYPE_3

# Include the generic driving file
INCLUDE generic-driving

# Make the additions
CONTROLLER_BUTTON_RIGHT_BUMPER CONTROLLER_1 BUTTON_UP PLAYER_2
CONTROLLER_BUTTON_LEFT_BUMPER CONTROLLER_1 BUTTON_DOWN PLAYER_2



```

--------------------------------

### Enable or Disable Devices

Source: https://openjvs.github.io/

Toggle specific input devices for use as players.

```bash
# To enable
sudo openjvs --enable sony-playstation-r-3-controller

# To disable
sudo openjvs --disable sony-playstation-r-3-controller
```

--------------------------------

### List of available ARCADE_INPUT keywords

Source: https://openjvs.github.io/

Reference list of valid keywords for arcade input mapping.

```text
MAPPING KEYWORD
---------------
BUTTON_TEST,
BUTTON_TILT,
BUTTON_START,
BUTTON_SERVICE,
BUTTON_UP,
BUTTON_DOWN,
BUTTON_LEFT,
BUTTON_RIGHT,
BUTTON_1,
BUTTON_2,
BUTTON_3,
BUTTON_4,
BUTTON_5,
BUTTON_6,
BUTTON_7,
BUTTON_8,
BUTTON_9,
BUTTON_10,
ANALOGUE_1,
ANALOGUE_2,
ANALOGUE_3,
ANALOGUE_4,
ANALOGUE_5,
ANALOGUE_6,
ROTARY_1,
ROTARY_2,
ROTARY_3,
ROTARY_4,
ROTARY_5,
ROTARY_6,


```

--------------------------------

### Define a controller mapping file

Source: https://openjvs.github.io/

Use this format to map controller inputs to arcade inputs. Supports reversing directions and secondary button outputs.

```text
# Example Mapping File
# Author: Bobby Dilley

# Map the button section
# <CONTROLLER_INPUT> <CONTROLLER_PLAYER> <ARCADE_INPUT> <ARCADE_PLAYER>
CONTROLLER_BUTTON_A CONTROLLER_1 BUTTON_1 PLAYER_1
CONTROLLER_BUTTON_B CONTROLLER_1 BUTTON_2 PLAYER_1

# Player Two
CONTROLLER_BUTTON_A CONTROLLER_2 BUTTON_1 PLAYER_2
CONTROLLER_BUTTON_B CONTROLLER_2 BUTTON_2 PLAYER_2

# Map the analogue section
CONTROLLER_ANALOGUE_X ANALOGUE_0
CONTROLLER_ANALOGUE_Y ANALOGUE_1



```

--------------------------------

### Virtual Controller Mapping Reference

Source: https://openjvs.github.io/

A visual representation of the controller layout and a table mapping keywords to their respective diagram labels and functional purposes.

```text
          ____________________________              __
         / [__LT__]          [__RT__] \               |
        / [__ LB __]        [__ RB __] \              | Front Triggers
     __/________________________________\__         __|
    /                                  _   \          |
   /      /\           __             (C)   \         |
  /       ||      __  |TE|  __     _       _ \        | Main Pad
 |    <===DP===> |SE|      |ST|   (B) -|- (D) |       |
  \       ||    ___          ___       _     /        |
  /\      \/   /   \        /   \     (A)   /\      __|
 /  \________ | LS  | ____ |  RS | ________/  \       |
|         /  \ \___/ /    \ \___/ /  \         |      |
|        /    \_____/      \_____/    \        |    __|
|       /                              \       |
 \_____/                                \_____/

     |________|______|    |______|___________|
       D-Pad    Left       Right   Action Pad
               Stick       Stick

                 |_____________|
                    Menu Pad

MAPPING KEYWORD                         DIAGRAM LABEL                 PURPOSE
---------------                         -------------                 -------
CONTROLLER_BUTTON_TEST                  TE                            Test Button,
CONTROLLER_BUTTON_TILT                                                Tilt Button,
CONTROLLER_BUTTON_COIN                  RS CLICK                      Coin Button,
CONTROLLER_BUTTON_START                 ST                            Start Button,
CONTROLLER_BUTTON_SERVICE               SE                            Service Button,
CONTROLLER_BUTTON_UP                    DP UP                         Joystick Up Button,
CONTROLLER_BUTTON_DOWN                  DP DOWN                       Joystick Down Button,
CONTROLLER_BUTTON_LEFT                  DP LEFT                       Joystick Left Button,
CONTROLLER_BUTTON_LEFT_BUMPER           LB                            Gear Down Button,
CONTROLLER_BUTTON_RIGHT                 DP RIGHT                      Joystick Right Button,
CONTROLLER_BUTTON_RIGHT_BUMPER          RB                            Gear Up Button,
CONTROLLER_BUTTON_A,                    A                             Button 1 / Trigger Button,
CONTROLLER_BUTTON_B,                    B                             Button 2 / Screen In / Out,
CONTROLLER_BUTTON_C,                    C                             Button 3 / Action Button 1,
CONTROLLER_BUTTON_D,                    D                             Button 4 / View Change Button,
CONTROLLER_BUTTON_E,                    LS CLICK                      Button 5,
CONTROLLER_BUTTON_F,                                                  Button 6,
CONTROLLER_BUTTON_G,                                                  Button 7,
CONTROLLER_BUTTON_H,                                                  Button 8,
CONTROLLER_BUTTON_I,                                                  Button 9,
CONTROLLER_BUTTON_J,                                                  Button 10,
CONTROLLER_ANALOGUE_X,                  LS X                          Analogue Joystick X / Steering Wheel,
CONTROLLER_ANALOGUE_Y,                  LS Y                          Analogue Joystick Y / Aeroplane Pitch,
CONTROLLER_ANALOGUE_Z,                  RS X                          Analogue Joystick Z,
CONTROLLER_ANALOGUE_R,                  RT                            Accelerator,
CONTROLLER_ANALOGUE_L,                  LT                            Breaks,
CONTROLLER_ANALOGUE_T,                  RS Y                          Analogue Joystick T,
```

--------------------------------

### Sense Line Wiring Diagram

Source: https://openjvs.github.io/

Wiring configuration for arcade systems requiring a sense line connection to a Raspberry Pi.

```text

|          GND   (BLACK) |-------------| GND           |                 |                        |
| ARCADE   A+    (GREEN) |-------------| A+  RS485 USB |-----------------| USB  RASPBERRY PI > 1  |
|          B-    (WHITE) |-------------| B-            |                 |                        |
|                        |                                               |                        |
|          SENSE (RED)   |----------+------------------------------------| GPIO 12                |
                                    |
                                    +---- (1kOhm Resistor or 4 Signal Dioes) ---- GND

```
Tokens:
Raw