bwRavencl / ControllerBuddy

ControllerBuddy

This is the source code repository of ControllerBuddy, regular users should refer to ControllerBuddy's homepage for getting started.

License Information:

GNU General Public License v3.0

Download and Installation:

Hint: You may want to use the ControllerBuddy-Install-Script which automates the steps below and more.

Windows x86-64:

1. First ensure you have correctly installed vJoy on your system.
2. Click here and download the latest build of ControllerBuddy for Windows as a ZIP archive.
3. Extract the ControllerBuddy directory from the archive to any desired location on your hard-drive.
4. Run ControllerBuddy.exe inside the extracted ControllerBuddy directory.

Linux x86-64:

1. First ensure you have installed libsdl2 on your system:
   • Debian / Ubuntu: sudo apt-get install libsdl2-2.0
   • Red-Hat-based: sudo yum install SDL2
2. Configure uinput:
   1. Create an uinput group: sudo groupadd -f uinput
   2. Add yourself to the group: sudo gpasswd -a "$USER" uinput
   3. As root, create a file /etc/udev/rules.d/99-input.rules with the following content:
      SUBSYSTEM=="misc", KERNEL=="uinput", MODE="0660", GROUP="uinput"
   4. As root, create a file /etc/modules-load.d/uinput.conf with the following content:
      uinput
3. Reboot
4. Click here and download the latest build of ControllerBuddy for Linux as a TGZ archive.
5. Extract the ControllerBuddy directory from the archive to any desired location on your hard-drive.
6. Run ControllerBuddy inside the extracted ControllerBuddy/bin directory.

Description:

ControllerBuddy is a highly advanced gamepad mapping software, which supports the creation of input profiles for complex target applications such as flight simulators.
In addition to the simplistic mapping of buttons and axes of a physical game-controller to keyboard and mouse input, ControllerBuddy also supports the feeding of input commands to a virtual joystick device (vJoy / uinput).
ControllerBuddy's goal is to enable the user to control target applications solely via a gamepad and not having to reach for a keyboard or mouse at any point in time.

Features:

• Maps gamepad axes and buttons to highly customizable actions:
  • vJoy axis movements (absolute and relative)
  • vJoy button presses
  • Keyboard inputs
  • Mouse inputs
  • Cycles of actions
  • Mode switching
  • etc.
• Powerful user interface:
  • Allows the creation of mapping profiles
  • Configuration of settings
  • Support for a light and dark UI theme
• In-game overlay:
  • Displays currently active mode
  • Can display current position of virtual axes
  • On-Screen-Keyboard that can be controlled via gamepad
  • VR support (OpenVR-based)
  • Customizable position and colors
• Two scenarios of operation:
  • Local
  • Server to client (experimental! use only in trusted networks!)
• Supported gamepads:
  • Xbox 360 Controller
  • Xbox One Controller
  • Dual Shock 3
  • Dual Shock 4 (with special support for the touchpad, haptic feedback and lightbar)
  • Dual Sense (with special support for the touchpad, haptic feedback and lightbar)
  • etc. (to check if your controller is supported please refer to the SDL_GameControllerDB project)
• Supported operating systems:
  • Windows / Linux (local / client / server)
  • macOS (only server - no binaries provided!)
• Language support for:
  • English
  • German

Profiles:

Profiles are used to configure your gamepad for a certain target application.
A profile has the following general structure:

• Profile (.json file)
  • Default Mode
    • X Axis
      • some Action
      • another Action
    • Y Axis
      • some Action
    • A Button
      • some Action
      • another Action
    • B Button
      • Mode Action (switches to "Another Mode" and back)
    • X Button
      • Mode Action (switches to "Yet another Mode" and back)
    • Y Button
      • Cycle Action (performs Action 1, when pressed again Action 2, then Action 3, then starts over)
        • Action 1
        • Action 2
        • Action 3
  • Another Mode
    • X Axis
      • some Action
    • A Button
      • some Action
  • Yet another Mode
    • X Axis
      • some Action

When switching from one Mode to another, all the axes and buttons that are not used by the other mode retain their function from the previous mode. This works over multiple levels of modes.
Mode switching can be configured to operate in two different ways:

• Default: works like the SHIFT key on your keyboard
• Toggle: works like the Caps Lock key

A set of well thought out profiles for the most popular flight simulators are available here.

Architecture:

Local mode:

            Local:

     Physical Controller
              |
              |
              v
       ControllerBuddy
       |             |
       |             |
       v             v
vJoy / uinput   Win32 / X11
      |                |
      |                |
      v                v
      Target Application

Server-Client mode:

             Server:                             Client:

       Physical Controller
                |
                |
                v
         ControllerBuddy  --------------->  ControllerBuddy
                                            |             |
                                            |             |
                                            v             v
                                     vJoy / uinput   Win32 / X11
                                           |                |
                                           |                |
                                           v                v
                                           Target Application

Example Screenshots:

Command Line Parameters:

If an instance of ControllerBuddy is already running, launching a second instance with the parameters denoted as "available for scripting" will trigger the corresponding action in the first instance and immediately shutdown the second instance.
This can be used to integrate ControllerBuddy into third party applications.
For more information check out this exemplary integration of ControllerBuddy into DCS World.

Attribution:

ControllerBuddy uses the following awesome software technologies and libraries:

• OpenJDK 18
• Apache Batik
• Apache Commons CLI
• ClassGraph
• FlatLaf
• Gson
• Java Native Access (JNA)
• linuxio4j
• LWJGL - Lightweight Java Game Library 3
• Pure Java HID-API
• SDL_GameControllerDB
• Unique4j

Building:

If you want to build ControllerBuddy from its source code this section might be helpful to get you started.
ControllerBuddy uses the Gradle build system, the following Gradle tasks are supported: