controller-companion 0.7.3

Python app for assigning shortcut actions to game controllers.

Controller Companion

Easily create controller shortcuts to perform actions on your computer, such as using the controller to quit a game (that does not have a quit option), control the volume, or toggle full screen.

The following actions are supported

• Terminate a task by its name.
• Execute a keyboard shortcut.
• Execute any console command.

Features

• GUI and CLI options available
• Supports a wide range of controllers (those supported by pygame)
• Runs on Windows, Linux and Mac
• Autostart app on system startup (Windows only for now)
• GUI app can be compiled as standalone executable (using PyInstaller)

Screenshots

Main Window

Create a new shortcut

How to install

• Using pip:

  pip install controller-companion
  

• For the GUI version, executables are also available here for Windows, Mac and Linux. An installer is also available for Windows.

How to run

• CLI and GUI versions available
• CLI:

  • Multiple shortcuts can be created.

  • One or multiple input controller key combination that triggers an action can be defined using --input. The keys of one individual input combination are separated by commas, while each distinct input combination is separated by a space.

  • One or multiple actions can be defined using either --task-kill, --console or --shortcut. These actions will be mapped to the previously defined controller --input key combinations in the order --task-kill, --console and finally --shortcut

  • Example with 2 shortcuts:

    controller_companion --input A,B Back,Left --console explorer.exe --shortcut alt+f4
    

    will result in the following mapping:

    ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━┓
    ┃ Name                       ┃ Shortcut  ┃ Action       ┃ Type ┃
    ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━┩
    │ Run command "explorer.exe" │ A+B       │ explorer.exe │ Xbox │
    │ Shortcut "alt+f4"          │ Back+Left │ alt+f4       │ Xbox │
    └────────────────────────────┴───────────┴──────────────┴──────┘
    

  • Run controller_companion --help to see all available arguments

Build Executable

With poetry installed, run the following command to build the executable using PyInstaller:

poetry run build_controller_companion_executable

Credits

• Gamepad button icons (Xbox & PlayStation): https://80.lv/articles/free-button-icons-for-unreal-engine-and-unity