Open Gamepad UI

About

Open Gamepad UI is a free and open source game launcher and overlay written using the Godot Game Engine 4 designed with a gamepad native experience in mind. Its goal is to provide an open and extendable foundation to launch and play games.

⚠️ NOTE: This project is currently in the very early stages of development.

Documentation

You can read documentation about how to use and develop for the project here:

• User Guide
• Developer Guide
• Plugin Guide

Requirements

Runtime Requirements

The following are required to run Open Gamepad UI:

• gamescope
• gcc-libs
• glibc
• libevdev
• libx11
• libxau
• libxcb
• libxdmcp
• libxext
• libxres
• ryzenadj (optional)
• mangoapp (optional)
• wireplumber (optional)
• nmcli (optional)
• firejail (optional)

Installation

⚠️ OpenGamepadUI is still in the early stages of development, so expect to encounter many bugs.

Knowing this, if you still want to try, use the following steps below to install and run OpenGamepadUI:

From source

• Ensure that you have the build dependencies from the developer guide installed.

• Clone this repository locally

git clone https://github.com/ShadowBlip/OpenGamepadUI.git

• Build the project with make

cd OpenGamepadUI
make build

• Install OpenGamepadUI to your user directory (default: ~/.local)

make install

If you wish to install OpenGamepadUI system-wide, you can do the following:

sudo make install PREFIX=/usr

From pre-built binary

• Ensure you have the runtime dependencies listed above installed.

• Download the latest version of OpenGamepadUI from the releases page.

• Extract the archive to a folder

tar xvfz opengamepadui.tar.gz

• Install OpenGamepadUI (default: ~/.local)

cd opengamepadui
make install

If you wish to install OpenGamepadUI system-wide, you can do the following:

sudo make install PREFIX=/usr

ArchLinux

If you are using ArchLinux, you can install OpenGamepadUI from the AUR:

https://aur.archlinux.org/packages/ogui-bin

https://aur.archlinux.org/packages/ogui-git

Usage

Once OpenGamepadUI is installed, it should show up as an application you can launch from your desktop environment.

Alternatively you can launch it from the command line with:

opengamepadui

or, if installed in the local user directory:

~/.local/bin/opengamepadui

License

OpenGamepadUI is licensed under THE GNU GPLv3+. See LICENSE for details.