User Guide

Getting Started

Minimum Requirements

  • Windows 7/8/10, 64-Bit Linux (Debian, Ubuntu, Mint), macOS Sierra or Higher
  • Dual-Core Processor
  • 2GB of Ram

Supported Devices

In general any joystick, gamepad, or controller that connects successfully to your operating system should work. There may be rare instances where software controllers or keyboard remaps may not work. If you encounter any, please submit an issue on our github page.

Downloads

Windows

Download v2.2 64-Bit Package
Download v2.2 32-Bit Package

Linux

Download v2.2 64-Bit Package
Download v2.2 32-Bit Package

macOS

Download v2.2 64-Bit Package

Installing

Installing is as simple as extracting the package and start the executable. No installers, no nonsense.

Uninstalling

As easy as installing, just delete the executable or folder in which you placed Open Joystick Display.

Open Joystick Display Server (Beta)

This tool will allow you to use Open Joystick display when you have a separate gaming and encoding computer. How this works is you run the server on your gaming computer and you run the client/overlay on your encoding computer. This way you have total control of the joystick layout on the encoding computer in OBS or whatever you use. This tool is for advanced users.

Downloads

System requirements, platforms, installation, and device support are identical to the Open Joystick Display client.

Windows

Download v0.1 64-Bit Package
Download v0.1 32-Bit Package

Linux

Download v0.1 64-Bit Package
Download v0.1 32-Bit Package

macOS

Download v0.1 64-Bit Package

Networking / Firewall

You will need to ensure that your firewall will allow network talk on TCP port 56709 and that both your encoding and gaming computers can talk to each other. Note that this server was designed for internal network only and for performance sake it's unencrypted.

Configuration

In your broadcast profile just set the driver to network and put in the IP address or hostname and click reconnect. If you're having issues please ensure that your controller is active and working on the server side.

Interface Overview

Open Joystick Display was designed to be powerful, yet easy to use. The interface may seem overwhelming at first, but in reality it's providing you with all of the information and tools you need to setup controller for streaming. In this section we will define each individual section of the application.

Toolbar

Here you can find developer tools, user and developer guides, and notifications of new updates to Open Joystick Display.

Broadcast Profiles (Left)

This toolbar holds all of the configuration for your broadcast profiles. These features include themes, mappings, chroma color, zoom level, poll rate, and even window sizing for easy scene setup.

Input Tester (Buttom)

This is simply where you see the raw input of your joystick. Buttons, directionals, and triggers of your connected device. This will help you debug and map your buttons and axes correctly using the input mapper. In general, this mimics your operating system dialog when you connect a joystick.

Theme View (Center)

Whatever theme you select, it will display in the center of the screen. You will also see button actions and highlights here.

Input Mapper (Right)

Here you will map your buttons, directionals, and triggers to the device theme of your choice. The input mapper is extremely powerful, allowing for remapping of directionals to d-pads/c-pads and even allow for soft triggers (like Gamecube) or thottles on flight sticks.

Broadcast Profiles

New in 1.0, broadcast profiles make it easy for you to define input profiles depending on what you're playing. This makes it easy to switch between platforms and setup scenes in OBS and XSplit.

Management

From here you can create new profiles, clone existing profiles, or delete your current profile.

Profile Name

From here you can update the name of your profile.

Themes

Selecting a Theme

Themes will change how your controller looks. You can do this by selecting a theme from the menu on the broadcast profile.

Selecting a Theme Style

Some themes will have alternative styles and colors. If the theme supports it you can select that style from the menu right below the theme selection.

Installing a Custom Theme

Create a folder anywhere on your computer and put your theme in there. Clicking the [Folder] icon next to the theme section of the [Broadcast Profile] will open up a dialog. Select the folder where you placed your custom themes. If the system detected any themes, the interface will update and then select your custom theme from the theme dropdown. You can add as many custom themes as you desire in that folder.

Creating a Custom Theme

For more information on creating a custom theme please read our developer guide. Creating a custom theme only requires basic knowledge of CSS and HTML.

Mappings

From here you can create new mappings, clone existing mappings, or delete your current mappings. Please note that mappings configurations are global to the application and not to the profile. So if you delete a mapping it will be gone in another broadcast profile. However, mapping selection is unique to each individual broadcast profile. (Example: One profile could have SNES and another Xbox for example).

Options

Chroma Color / Key

This allows you to change the background color of the theme so that you can use Chroma Color/Key in OBS or XSplit. This is useful if you want a transparent overlay in your stream. This field will take a CSS defined color like red or a hex color like #000000. Alternatively, you can just set the color to whatever you want and use it as a background.

Always on Top

This forces the window to always be on top while in broadcast mode.

Zoom Level

Controls the zoom level of your controller theme.

Poll Rate

Controls how often we're checking for new inputs from the controller.

Window Sizing

This controls the size of the window while in broadcast mode. By clicking [Lock] it will prevent the window from being resizable in broadcast mode.

Broadcast Mode

This removes the configuration interface and resizes the window to whatever you have defined in your broadcast profile. This is used for when you are streaming. You can enter this mode by simply pressing ESC on your keyboard. To exit, press ESC again to enter configuration mode.

NintendoSpy/RetroSpy Support

New in 2.0 we now support the ability to use your Arduino for NintendoSpy/RetroSpy. This couldn't have been done without the awesome work of zoggins and jaburns so go check out their work. This guide assumes you have some level of expertise.

As of right now, we currently support the following controller devices:

  • Nintendo Famicom (Nintendo Entertainment System)
  • Nintendo Super Famicom (Super Nintendo)
  • Nintendo 64
  • Nintendo Gamecube
  • Sega Master System and Mega Drive (Genesis)
  • NEC PC-Engine / TurboGrafx-16

Getting Started

We're not going to go over the entire process of setting up RetroSpy on your Arduino. If you're new to this please go and read the documentation on zoggins GitHub page here. In general you will need the following:

  • Working Arduino (or clone)
  • Working game console
  • Working controller
  • A wiring harness for your controller (see guide above).
  • RetroSpy firmware flashed to your Arduino.
Once you have done all of this and you have your ardunio working and plugged in proceed to the next step.

Using RetroSpy

  • Make sure you have the RetroSpy front-end application closed. We won't be using this.
  • Launch Open Joystick Display
  • In your [Profile] settings you should see a section called [Profile Input Driver]
  • Change the driver to 'RetroSpy'
  • Select your serial port and the device you're using.
  • You should see your joystick working in the [Input Tester]
  • Make a custom mapping or choose a mapping based upon your RetroSpy device.
  • Select a corresponding theme.

Support Inquiries

If you're using Open Joystick Display for your RetroSpy overlay, please contact us first on our GitHub to make sure it's not an implementation detail on our part. If we find out it's an actual bug in the RetroSpy firmware we will relay that information to the developers.

Input Tester

In this section we will go over each individual section of the input tester in detail. Learning these parts will help you configure your controller later using the input mapper.

Terminology

  • Buttons
    These are actual buttons that are pressed on your device. Typically buttons are binary, on or off in nature.
  • Directionals (Dimensional Axis)
    These are analog inputs. Unlike buttons, they have a range of motion. Generally the range is anywhere from -1 to 1. For example, on an Microsoft XBox 360 analog stick, these use two axes. In the default state (center) axis X and axis Y would be [0, 0]. However, move those to the top left it would be [-1, -1], conversely bottom right would be [1, 1].
  • Throttles and Triggers (Linear Axis)
    These are exactly the same as directionals, except they only move in one dimension instead of X and Y. Examples of this are Gamecube L/R triggers. They can be partly depressed to trigger an action. As an example, in a normal state L would be just [-1] however pressing on it slightly might give it a value of [-0.5] which would indicate that this trigger is active.

    Another example is on flight sticks (joysticks) where this might indicate throttle speed. [-1] being no speed and everthing above that to [1] means x speed. These are typically used in games like Descent or Elite Dangerous.

Buttons View

This section shows all of the avaliable buttons on the device. They will highlight on/off when a button is depressed. They also show the button ID in the center. You will use this ID for the input mapper.

Two Dimensional Axis (Directional) View

This section shows all analog inputs in a directional view (X and Y). These are paid in order as they are detected in the device. Each axis has an number (ID) starting with the number 0. You will use this ID for the input mapper.

One Dimensional Axis (Throttle/Triggers) View

This is very similar to the two dimensional view, however it decouples all of the axes to show you each of them individually. This view also shows the ID of each axis starting with the number 0. You will use this ID for the input mapper.

Understanding the Input Mapper

This is where the magic happens. In this section you will map your buttons to the theme you have selected. This allows you a wide range of mappings in relation to the theme. An example of this is, while the XBox 360 theme works with the XBox 360 mapping, you may want to play SNES games and show a SNES theme on your stream. You would make a new mapping and map your buttons in relation to a SNES mapping (BAYX instead of ABXY). This allows you to use any and all controllers with a wide varity of themes and platforms.

Configuration Section

This section simply lets you change the label of your mapping. It will also give you an overall count of each button, directional, or trigger you have mapped.

Buttons Section

Here you will map button labels to button IDs from the [Input Tester]. To add a button, click [Add Button] and then select your label [such as A or START] and then put the button ID in the box next to it. To delete a button, you simply click [Delete] next to it.

Directionals Section

Here you will map your analog or directional pad.

To add a directional, click [Add Directional]. [X Axis] is the horizontal axis of your input and [Y Axis] is the vertical axis of your input. Match these axes with the IDs from the [Input Tester].

Furthermore, the [Deadzone] attribute is the level of tolerance you wish to have to 'activate' the directional. This can be a number from [0] to [1] (the default is .25).

You can also make it so that the directional functions like a D-Pad or C-Pad (N64) by checking the appropriate boxes. This is good when you may use your left analog with a SNES theme or your right analog for N64, for example.

To delete a directional, you simply click [Delete] next to it.

Triggers Section

Triggers work the same as directionals except we're only using a single axis.

To add a trigger, click [Add Trigger]. [Axis] is the single axis ID you wish to use for this trigger. Match the axis with the IDs from the [Input Tester].

[Min] and [Max] are how sensitive you want the triggers to be. Generally the only value you'll be touching here is [Min]. These number can range from [-1] to [1]. View your axis on the [Input Tester] to get a good feel of what value this should be. Too sensitive and the trigger will always be on, too conservative and the trigger may not activate. This is all about your play style.

To delete a trigger, you simply click [Delete] next to it.

Getting Ready to Stream

In this section we will go over how to use Open Joystick Display for streaming. Setup is fairly straight forward and painless.

Entering Broadcast Mode

I'm sure you all want that lovely interface all over your Twitch steam, right? Joking aside, entering broadcast mode is painless. Simply hit the [ESC] key on your keyboard and it will hide the interface. Hit [ESC] again and the whole interface comes right back. It's right in the application title!

Setting up in Open Broadcaster Software (OBS)

We're making the assumption that you already have OBS installed and have a general understanding of how it works.

In OBS add a new [Scene] and add a [Window Capture]. Simply select the Open Joystick Display window and you're ready to stream. Don't forget to go into Broadcast Mode!

What's Next?

Congatulations Shinji

Congatulations Shinji! You're now using Open Joystick Display! If you have an issue or feature request please post an issue on our GitHub.

Thanks for using Open Joystick Display!