Open Gamepad UI

https://opengamepadui.readthedocs.io/en/latest/
Admin
Open Gamepad UI is a free and open source game launcher and overlay written using the Godot Game...
Tokens:35,025
Snippets:515
Trust Score:9.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### setup(device: PartitionDevice)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/PartitionCard

Initializes the PartitionCard with the specified PartitionDevice.

```APIDOC
## setup(device: PartitionDevice)

### Description
Performs ready functionality with the given PartitionDevice.

### Signature
void setup(device: PartitionDevice)

### Parameters
- **device** (PartitionDevice) - The partition device to be associated with this card.
```

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

### execute()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/ActionStartPowerStation

Executes the power station start action.

```APIDOC
## void execute()

### Description
Executes the action to start the power station. This method is part of the ActionStartPowerStation class.

### Signature
`void execute()`
```

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

### load_installed()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/Store

Loads the view of installed items in the store.

```APIDOC
## load_installed()

### Description
Loads the view of installed items in the store.

### Signature
Variant load_installed()
```

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

### install_update(download_url: String)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/SoftwareUpdater

Downloads and installs the update from the provided URL.

```APIDOC
## void install_update(download_url: String)

### Description
Downloads and installs the given update.

### Parameters
- **download_url** (String) - Required - The URL from which to download the update package.
```

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

### install_plugin(plugin_id: String, download_url: String, sha256: String)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/PluginLoader

Downloads and installs a plugin from a remote source.

```APIDOC
## install_plugin(plugin_id: String, download_url: String, sha256: String)

### Description
Downloads and installs the given plugin.

### Parameters
- **plugin_id** (String) - Required - The ID of the plugin.
- **download_url** (String) - Required - The URL to download the plugin from.
- **sha256** (String) - Required - The SHA256 hash for verification.
```

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

### assert_string_starts_with(text, search, match_case)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/GutTest

Verifies that a string starts with a specific substring.

```APIDOC
## assert_string_starts_with(text: Variant, search: Variant, match_case: Variant = true)

### Description
Verifies that a string starts with a specific substring.
```

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

### Retrieve installed games via LibraryManager

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/LibraryManager

Access the global LibraryManager instance to fetch a dictionary containing all installed games from every registered provider.

```gdscript
    const LibraryManager := preload("res://core/global/library_manager.tres")
    ...
    # Return a dictionary of all installed games from every library provider
    var installed_games := LibraryManager.get_installed()
```

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

### is_installed(plugin_id: String)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/PluginLoader

Checks if a plugin is currently installed.

```APIDOC
## is_installed(plugin_id: String)

### Description
Returns true if the given plugin is installed.

### Parameters
- **plugin_id** (String) - Required - The ID of the plugin.
```

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

### filter_installed(apps: LibraryItem[])

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/LibraryManager

Filters the given array of apps by installed status.

```APIDOC
## filter_installed(apps: LibraryItem[])

### Description
Filters the given array of apps by installed status.
```

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

### ready(root: Window)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/PlatformBazzite

Initializes the platform with the provided root window.

```APIDOC
## ready(root: Window)

### Description
Initializes the PlatformBazzite instance using the provided root window.

### Signature
`void ready(root: Window)`

### Parameters
- **root** (Window) - Required - The root window instance to be used by the platform.
```

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

### get_double_strategy()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/GutTest

Gets the current double strategy.

```APIDOC
## get_double_strategy()

### Description
Gets the current double strategy.
```

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

### launch(app: LibraryLaunchItem)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/LaunchManager

Launches the specified application and transitions the system to the in-game state.

```APIDOC
## launch(app: LibraryLaunchItem)

### Description
Launches the given application and switches to the in-game state. Returns a RunningApp instance of the application.

### Parameters
- **app** (LibraryLaunchItem) - Required - The application to launch.

### Returns
- **RunningApp** - The instance of the launched application.
```

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

### ready(root: Window)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/PlatformNixOS

Initializes the platform-specific logic after the scene tree has been initialized.

```APIDOC
## ready(root: Window)

### Description
Ready will be called after the scene tree has initialized.

### Parameters
- **root** (Window) - The root window of the scene tree.
```

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

### init_steam_lib(partition: PartitionDevice)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/SteamRemovableMediaManager

Initializes a specific partition as a Steam library.

```APIDOC
## init_steam_lib(partition: PartitionDevice)

### Description
Calls the SteamRemovableMedia init-media script to intialize a drive as a steam library.

### Parameters
- **partition** (PartitionDevice) - Required - The partition to initialize.
```

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

### ready(root: Window)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/PlatformSteamOS

Initializes the PlatformSteamOS instance with the provided root window.

```APIDOC
## ready(root: Window)

### Description
Initializes the PlatformSteamOS platform instance using the specified root window.

### Signature
void ready(root: Window)

### Parameters
- **root** (Window) - Required - The root window instance to be associated with the platform.
```

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

### uninstall_plugin(plugin_id: String)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/PluginLoader

Unloads and removes an installed plugin.

```APIDOC
## uninstall_plugin(plugin_id: String)

### Description
Unloads and uninstalls the given plugin. Returns OK if removed successfully.

### Parameters
- **plugin_id** (String) - Required - The ID of the plugin to uninstall.
```

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

### start_discovery()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/BluetoothAdapter

Initiates the device discovery process on the Bluetooth adapter.

```APIDOC
### start_discovery()

**Signature:** `void start_discovery()`

Starts the discovery process to find nearby Bluetooth devices.
```

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

### from_location(location: Library.InstallLocation)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/InstallLocationCard

Creates and returns a new instance of InstallLocationCard initialized with the provided Library.InstallLocation data.

```APIDOC
## from_location(location: Library.InstallLocation)

### Description
Creates an InstallLocationCard instance for the given install location.

### Signature
`InstallLocationCard from_location(location: Library.InstallLocation)`

### Parameters
- **location** (Library.InstallLocation) - The install location data used to populate the card.
```

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

### Launch and Manage Applications with LaunchManager

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/LaunchManager

Demonstrates loading the LaunchManager resource, launching an application via LibraryLaunchItem, retrieving running apps, and stopping a process.

```GDScript
    var launch_manager := load("res://core/global/launch_manager.tres") as LaunchManager
    ...
    # Create a LibraryLaunchItem to run something
    var item := LibraryLaunchItem.new()
    item.command = "vkcube"

    # Launch the app with LaunchManager
    var running_app := launch_manager.launch(item)

    # Get a list of running apps
    var running := launch_manager.get_running()
    print(running)

    # Stop an app with LaunchManager
    launch_manager.stop(running_app)
```

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

### get_binary_compatibility_cmd

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/OSPlatform

Returns the command and arguments prepended with the necessary compatibility tool if the OS requires running binaries through one.

```APIDOC
## get_binary_compatibility_cmd

### Description
If the OS requires running regular binaries through a compatibility tool, this method returns the given command and arguments prepended with the compatibility tool to use.

### Signature
String[] get_binary_compatibility_cmd(cmd: String, args: PackedStringArray)

### Parameters
- **cmd** (String) - The command to execute.
- **args** (PackedStringArray) - The arguments for the command.

### Returns
- **String[]** - The command and arguments formatted for the compatibility tool.
```

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

### get_command(app: LibraryLaunchItem)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/SandboxFirejail

Generates the command line arguments required to launch a specific application within a Firejail sandbox.

```APIDOC
## get_command(app: LibraryLaunchItem)

### Description
Returns an array defining the command line to launch the given application in a sandbox.

### Signature
`PackedStringArray get_command(app: LibraryLaunchItem)`

### Parameters
- **app** (LibraryLaunchItem) - The application to be launched.
```

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

### process()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/BluezInstance

Processes the Bluetooth instance tasks.

```APIDOC
### process()

#### Signature
`void process()`

#### Description
Executes the processing logic for the Bluetooth instance.
```

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

### get_instance()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/GutUtils

Retrieves the instance.

```APIDOC
## get_instance()

### Description
Retrieves the instance.

### Signature
`Variant get_instance()`
```

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

### load_home()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/Store

Loads the home view of the store.

```APIDOC
## load_home()

### Description
Loads the home view of the store.

### Signature
Variant load_home()
```

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

### get_sandbox()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/Sandbox

Retrieves the best sandbox instance to use for launching applications.

```APIDOC
### get_sandbox()

Returns the best sandbox to use for launching apps.

#### Returns
- **Sandbox** - The optimal sandbox instance.
```

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

### from_dict(d: Dictionary)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/LibraryLaunchItem

Creates a LibraryLaunchItem instance from a provided Dictionary.

```APIDOC
### Method
LibraryLaunchItem from_dict(d: Dictionary)

### Description
Instantiates a new LibraryLaunchItem object based on the data provided in the input dictionary.
```

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

### format_sd_card()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/SteamRemovableMediaManager

Formats the SD card (mmcblk0) as EXT4 and initializes it as a Steam library.

```APIDOC
## format_sd_card()

### Description
Calls the SteamRemovableMedia or SteamOS format-sd script to format mmcblk0 as EXT4 and intialize it as a steam library.
```

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

### create_process

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/Reaper

Spawns a process with PR_SET_CHILD_SUBREAPER set so child processes will reparent themselves to OpenGamepadUI.

```APIDOC
## int create_process(cmd: String, args: PackedStringArray, app_id: int = -1)

### Description
Spawn a process with PR_SET_CHILD_SUBREAPER set so child processes will reparent themselves to OpenGamepadUI. Returns the PID of the spawned process.

### Parameters
- **cmd** (String) - The command to execute.
- **args** (PackedStringArray) - Arguments for the command.
- **app_id** (int) - Optional application ID, defaults to -1.
```

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

### connect_to()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/BluetoothDevice

Initiates a connection to the Bluetooth device.

```APIDOC
## void connect_to()

### Description
Initiates a connection to the Bluetooth device.
```

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

### get_available()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/LibraryManager

Returns a dictionary of all available apps.

```APIDOC
## get_available()

### Description
Returns a dictionary of all available apps.
```

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

### load_library(library_id: String)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/LibraryManager

Loads the launch items from the given library.

```APIDOC
## load_library(library_id: String)

### Description
Loads the launch items from the given library.
```

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

### format_drive(device: BlockDevice)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/SteamRemovableMediaManager

Formats a specified block device as EXT4 and initializes it as a Steam library.

```APIDOC
## format_drive(device: BlockDevice)

### Description
Calls the SteamRemovableMedia format-media script to format a drive as EXT4 and intialize it as a steam library.

### Parameters
- **device** (BlockDevice) - Required - The block device to be formatted.
```

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

### process()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/PowerStationInstance

Executes the processing logic for the power station instance.

```APIDOC
### void process()

Performs the processing operations for the power station instance.
```

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

### connect(device: NetworkDevice, password: String)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/NetworkAccessPoint

Initiates a connection to the network access point using the specified network device and password.

```APIDOC
## connect(device: NetworkDevice, password: String)

### Description
Initiates a connection to the network access point using the provided network device and authentication password.

### Signature
`NetworkActiveConnection connect(device: NetworkDevice, password: String)`

### Parameters
- **device** (NetworkDevice) - The network device to use for the connection.
- **password** (String) - The password required to authenticate with the access point.

### Returns
- **NetworkActiveConnection** - Returns a NetworkActiveConnection object representing the established connection.
```

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

### pair()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/BluetoothDevice

Initiates the pairing process with the Bluetooth device.

```APIDOC
## void pair()

### Description
Initiates the pairing process with the Bluetooth device.
```

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

### init(manager: PluginManager)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/PluginLoader

Initializes the plugin loader and associates it with a PluginManager.

```APIDOC
## init(manager: PluginManager)

### Description
Initializes the plugin loader. Loaded plugins will be added to the given manager node.

### Parameters
- **manager** (PluginManager) - Required - The manager node to associate with the loader.
```

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

### add_library_launch_item(library_id: String, item: LibraryLaunchItem)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/LibraryManager

Add the given library launch item to the list of available apps.

```APIDOC
## add_library_launch_item(library_id: String, item: LibraryLaunchItem)

### Description
Add the given library launch item to the list of available apps.
```

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

### RunningApp Methods

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/RunningApp

Methods available for managing application lifecycle, window focus, and process control.

```APIDOC
## RunningApp::create

### Description
Creates a new instance of a running application.

### Signature
RunningApp create(app: LibraryLaunchItem, env: Dictionary, cmd: String, args: PackedStringArray)

## RunningApp::spawn

### Description
Spawns a new application process.

### Signature
RunningApp spawn(app: LibraryLaunchItem, env: Dictionary, cmd: String, args: PackedStringArray)

## RunningApp::start

### Description
Starts the application process.

### Signature
void start()

## RunningApp::suspend

### Description
Suspends or resumes the application process.

### Signature
void suspend(enable: bool)

## RunningApp::kill

### Description
Terminates the application process.

### Signature
void kill(sig: int = 15)

## RunningApp::grab_focus

### Description
Requests focus for the application.

### Signature
void grab_focus()

## RunningApp::is_running

### Description
Checks if the application is currently running.

### Signature
bool is_running()
```

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

### create_process(command: String, args: PackedStringArray)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/SubReaper

Creates a new process with the specified command and arguments.

```APIDOC
## create_process(command: String, args: PackedStringArray)

### Description
Creates a new process using the provided command and a list of arguments.

### Signature
int create_process(command: String, args: PackedStringArray)

### Parameters
- **command** (String) - The command to execute.
- **args** (PackedStringArray) - The arguments to pass to the command.

### Returns
- **int** - The process identifier or status code.
```

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

### populate_gamepad_mappings_for

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/GamepadMapper

Populates the gamepad mappings based on the provided capabilities and icon type.

```APIDOC
## void populate_gamepad_mappings_for(capabilities: PackedStringArray, gamepad_icons_type: String)

### Description
Populates the mappings for the given capabilities.

### Parameters
- **capabilities** (PackedStringArray) - The list of capabilities to map.
- **gamepad_icons_type** (String) - The type of gamepad icons to use.
```

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

### open(ctx: KeyboardContext)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/KeyboardInstance

Opens the on-screen keyboard using the provided keyboard context to define input targets.

```APIDOC
## void open(ctx: KeyboardContext)

### Description
Opens the on-screen keyboard with the specified context.

### Parameters
- **ctx** (KeyboardContext) - The context defining where inputs should be directed.
```

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

### Fetch box art using BoxArtManager

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/BoxArtManager

Demonstrates how to preload the BoxArtManager resource and request a specific box art layout for a library item.

```gdscript
    const BoxArtManager := preload("res://core/global/boxart_manager.tres")
    ...
    var boxart := BoxArtManager.get_boxart(library_item, BoxArtProvider.LAYOUT.LOGO)
```

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

### run()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/GutHookScript

Executes the hook logic.

```APIDOC
## run()

### Description
Executes the hook logic.

### Signature
`Variant run()`
```

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

### set_gamepad_profile(profile_path: String, target_gamepad: String)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/LaunchManager

Configures the gamepad profile for the current application.

```APIDOC
## set_gamepad_profile(profile_path: String, target_gamepad: String)

### Description
Sets the gamepad profile for the running app with the given profile.

### Parameters
- **profile_path** (String) - Required - Path to the profile file.
- **target_gamepad** (String) - Optional - The specific gamepad identifier.
```

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

### RunningApp Methods

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/RunningApp

A collection of methods for managing application lifecycles and window interactions.

```APIDOC
## RunningApp Methods

### create(app: LibraryLaunchItem, env: Dictionary, cmd: String, args: PackedStringArray) -> RunningApp
Creates a RunningApp instance with the specified command without executing it.

### spawn(app: LibraryLaunchItem, env: Dictionary, cmd: String, args: PackedStringArray) -> RunningApp
Executes the specified command and returns a RunningApp instance.

### start()
Starts the application process.

### update(all_windows: PackedInt64Array, app_pids: PackedInt64Array)
Updates the application state and triggers signals based on XWayland window IDs and process IDs.

### discover_app_type(all_windows: PackedInt64Array, app_pids: PackedInt64Array) -> int
Determines if the application is an X11 or Wayland application.

### suspend(enable: bool)
Pauses or resumes the application using kill signals.

### get_window_title(win_id: int) -> String
Retrieves the title of a specific window ID associated with the app.

### get_window_id_from_pid() -> int
Attempts to resolve the window ID from the application's PID.

### get_all_window_ids(all_windows: PackedInt64Array, app_pids: PackedInt64Array) -> PackedInt64Array
Retrieves all window IDs associated with the application's process group.

### is_running() -> bool
Checks if the application or its process group descendants are currently running.

### is_focused() -> bool
Checks if the application window currently has focus.

### grab_focus()
Sets focus to the application window.

### switch_window(win_id: int, focus: bool = true) -> int
Switches the active window to the specified ID.

### kill(sig: int = 15)
Terminates the application process.

### is_steam_app() -> bool
Checks if the application was launched via Steam.

### is_steam_window(window_id: int) -> bool
Checks if a specific window ID belongs to Steam.

### find_steam(app_pids: PackedInt64Array) -> int
Locates the Steam process for management purposes.
```

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

### launch_in_background(app: LibraryLaunchItem)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/LaunchManager

Launches an application in the background without switching the active state.

```APIDOC
## launch_in_background(app: LibraryLaunchItem)

### Description
Launches the given app in the background. Returns the RunningApp instance.

### Parameters
- **app** (LibraryLaunchItem) - Required - The application to launch in the background.

### Returns
- **RunningApp** - The instance of the background application.
```

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

### Displaying a Notification

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/NotificationManager

Demonstrates how to preload the NotificationManager resource and display a new notification instance.

```gdscript
    const NotificationManager := preload("res://core/global/notification_manager.tres")
    ...
    var notify := Notification.new("Hello world!")
    notify.icon = load("res://assets/icons/critical.png")
    NotificationManager.show(notify)
```

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

### open(message: String = "", cancel_txt: String = "")

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/ProgressDialog

Opens the progress dialog box with an optional message and custom cancel button text.

```APIDOC
### open()

**void open(message: String = "", cancel_txt: String = "")**

Opens the dialog box with the given settings.
```

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

### get_binary_compatibility_cmd(cmd: String, args: PackedStringArray)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/PlatformNixOS

Retrieves the command string required to execute binaries on NixOS, typically wrapping them in 'steam-run'.

```APIDOC
## get_binary_compatibility_cmd(cmd: String, args: PackedStringArray)

### Description
NixOS typically cannot execute regular binaries, so downloaded binaries will be run with 'steam-run'.

### Parameters
- **cmd** (String) - The command to execute.
- **args** (PackedStringArray) - The arguments for the command.

### Returns
- **String[]** - The modified command and arguments array.
```

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

### is_version_ok()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/GutUtils

Checks if the version is acceptable.

```APIDOC
## is_version_ok(engine_info: Variant = , required: Variant = req_godot)

### Description
Checks if the version is acceptable.

### Signature
`Variant is_version_ok(engine_info: Variant = , required: Variant = req_godot)`
```

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

### process()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/InputPlumberInstance

Executes the processing logic for the instance.

```APIDOC
## process()

### Signature
`void process()`
```

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

### is_available()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/Sandbox

Checks if the current sandbox implementation is available for use.

```APIDOC
### is_available()

Returns whether or not the given sandbox implementation is available.

#### Returns
- **bool** - True if the sandbox is available, false otherwise.
```

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

### get_config()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/MangoApp

Retrieves the current configuration options.

```APIDOC
## PackedStringArray get_config()

### Description
Retrieves the current configuration options as a PackedStringArray.

### Returns
- **PackedStringArray** - The current configuration settings.
```

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

### GamescopeXWayland Methods

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/GamescopeXWayland

A collection of methods for interacting with XWayland windows and applications.

```APIDOC
## get_all_windows(window_id: int) -> PackedInt64Array
## get_app_id(window_id: int) -> int
## get_input_counter() -> int
## get_overlay(window_id: int) -> int
## get_pids_for_window(window_id: int) -> PackedInt64Array
## get_window_children(window_id: int) -> PackedInt64Array
## get_window_depth(window_id: int) -> int
## get_window_name(window_id: int) -> String
## get_window_position(window_id: int) -> Vector2i
## get_window_root(window_id: int) -> int
## get_window_size(window_id: int) -> Vector2i
## get_window_sizes(window_ids: PackedInt64Array) -> Vector2i[]
## get_windows_for_pid(pid: int) -> PackedInt64Array
## has_app_id(window_id: int) -> bool
## has_input_focus(window_id: int) -> bool
## has_notification(window_id: int) -> bool
## has_overlay(window_id: int) -> bool
## is_focusable_app(window_id: int) -> bool
## remove_app_id(window_id: int) -> int
## remove_baselayer_app() -> void
## remove_baselayer_window() -> void
## request_screenshot() -> void
## set_app_id(window_id: int, app_id: int) -> int
## set_external_overlay(window_id: int, value: int) -> int
## set_input_focus(window_id: int, value: int) -> int
## set_main_app(window_id: int) -> int
## set_notification(window_id: int, value: int) -> int
## set_overlay(window_id: int, value: int) -> int
## unwatch_window(window_id: int) -> int
## watch_window(window_id: int) -> int
```

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

### LaunchManager Methods

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/LaunchManager

Methods available for managing application lifecycles and retrieving running app information.

```APIDOC
## Methods

### launch(app: LibraryLaunchItem) -> RunningApp
Launches an application and returns a RunningApp instance.

### launch_in_background(app: LibraryLaunchItem) -> RunningApp
Launches an application in the background.

### stop(app: RunningApp) -> void
Stops a currently running application.

### get_running() -> RunningApp[]
Returns an array of all currently running applications.

### get_running_background() -> RunningApp[]
Returns an array of applications running in the background.

### get_current_app() -> RunningApp
Returns the currently active application.

### is_running(app_name: String) -> bool
Checks if an application is currently running by its name.
```

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

### discover_device_mappings(mappings_dir: String)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/InputIconManager

Discovers all input icon mapping devices from the specified directory path.

```APIDOC
## discover_device_mappings(mappings_dir: String)

### Description
Discover all input icon mapping devices from the specified path.

### Parameters
- **mappings_dir** (String) - Required - The directory path to search for device mappings.

### Returns
- **Dictionary** - A dictionary containing the discovered device mappings.
```

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

### open(path: String)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/FifoReader

Opens a FIFO file at the specified path.

```APIDOC
## open(path: String)

### Description
Opens a FIFO file located at the provided path.

### Signature
`int open(path: String)`

### Parameters
- **path** (String) - The file path to the FIFO.
```

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

### load_matching_mapping(device_name: String)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/InputIconManager

Loads and returns the mapping that matches the provided device name.

```APIDOC
## load_matching_mapping(device_name: String)

### Description
Load and return the mapping that matches the given device.

### Parameters
- **device_name** (String) - Required - The name of the device.

### Returns
- **InputIconMapping** - The matching mapping object.
```

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

### open(return_node: Control, message: String, confirm_txt: String, cancel_txt: String)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/Dialog

Opens the dialog box with the specified message and button labels.

```APIDOC
## open(return_node: Control, message: String = "", confirm_txt: String = "", cancel_txt: String = "")

### Description
Opens the dialog box with the given settings.

### Parameters
- **return_node** (Control) - Required - The node to return to after the dialog is closed.
- **message** (String) - Optional - The text to display in the dialog box.
- **confirm_txt** (String) - Optional - The text for the confirm button.
- **cancel_txt** (String) - Optional - The text for the cancel button.
```

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

### exists()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/MangoApp

Checks if the configuration exists.

```APIDOC
## bool exists()

### Description
Checks if the configuration exists.

### Returns
- **bool** - True if the configuration exists, false otherwise.
```

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

### push_state_front(state: int, data: Dictionary = {})

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/StateManager

Pushes a new state to the front of the stack.

```APIDOC
## push_state_front(state: int, data: Dictionary = {})

### Signature
Variant push_state_front(state: int, data: Dictionary = {})
```

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

### populate_mouse_mappings_for

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/GamepadMapper

Populates the mouse mappings based on the provided capabilities.

```APIDOC
## void populate_mouse_mappings_for(caps: PackedStringArray)

### Description
Populates the mouse mappings for the given capabilities.

### Parameters
- **caps** (PackedStringArray) - The list of capabilities to map.
```

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

### process()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/GamescopeInstance

Executes the processing routine for the Gamescope instance.

```APIDOC
## process()

### Signature
`void process()`

### Description
Performs the internal processing tasks for the GamescopeInstance.
```

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

### register_store(store: Store)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/StoreManager

Registers a store instance.

```APIDOC
## register_store(store: Store)

### Signature
void register_store(store: Store)

### Description
Registers a store instance with the StoreManager.
```

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

### get_adapters()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/BluezInstance

Retrieves a list of available Bluetooth adapters.

```APIDOC
### get_adapters()

#### Signature
`BluetoothAdapter[] get_adapters()`

#### Description
Returns an array of available Bluetooth adapters.
```

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

### from_source_capability(capability: String)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/InputPlumberMapping

Creates a new InputPlumberMapping instance from a source capability string.

```APIDOC
## InputPlumberMapping.from_source_capability(capability: String)

### Description
Create a new mapping from the given source capability string.

### Parameters
- **capability** (String) - Required - The source capability string to map.
```

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

### from_dict(dict: Dictionary)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/InputPlumberTouchEvent

Creates an instance of InputPlumberTouchEvent from a dictionary.

```APIDOC
## InputPlumberTouchEvent.from_dict()

### Description
Creates an instance of InputPlumberTouchEvent from a provided dictionary.

### Signature
`InputPlumberTouchEvent from_dict(dict: Dictionary)`

### Parameters
- **dict** (Dictionary) - Required - The dictionary containing event data.
```

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

### get_filesystem()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/PartitionDevice

Retrieves the FilesystemDevice associated with the partition.

```APIDOC
## get_filesystem()

### Description
Returns the FilesystemDevice object associated with this partition.

### Signature
FilesystemDevice get_filesystem()
```

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

### get_app_by_name(name: String)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/LibraryManager

Returns the library item for the given app for all library providers.

```APIDOC
## get_app_by_name(name: String)

### Description
Returns the library item for the given app for all library providers.
```

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

### is_running()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/InputPlumberInstance

Checks if the InputPlumberInstance is currently running.

```APIDOC
## is_running()

### Signature
`bool is_running()`
```

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

### is_available()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/SandboxFirejail

Checks if the Firejail sandbox implementation is currently available on the system.

```APIDOC
## is_available()

### Description
Returns whether or not the given sandbox implementation is available.

### Signature
`bool is_available()`
```

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

### from_dict

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/InputPlumberGyroEvent

Creates an instance of InputPlumberGyroEvent from a dictionary.

```APIDOC
### from_dict

**Signature:** `InputPlumberGyroEvent from_dict(dict: Dictionary)`

Creates a new InputPlumberGyroEvent object initialized from the provided dictionary.
```

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

### from_dict(dict: Dictionary)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/InputPlumberTouchpadEvent

Creates an instance of InputPlumberTouchpadEvent from a dictionary.

```APIDOC
## InputPlumberTouchpadEvent.from_dict()

### Description
Creates an instance of InputPlumberTouchpadEvent from a provided dictionary.

### Signature
`InputPlumberTouchpadEvent from_dict(dict: Dictionary)`

### Parameters
- **dict** (Dictionary) - The dictionary containing event data.
```

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

### from_dict(dict: Dictionary)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/InputPlumberMouseEvent

Creates an instance of InputPlumberMouseEvent from a dictionary.

```APIDOC
### from_dict(dict: Dictionary)

Creates an instance of InputPlumberMouseEvent from a provided dictionary.

#### Parameters
- **dict** (Dictionary) - The dictionary containing event data.

#### Returns
- **InputPlumberMouseEvent** - A new instance of the class.
```

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

### Retrieve library items with custom filters

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/LibraryManager

Demonstrates how to use a custom filter function with get_library_items to retrieve specific items, such as non-installed games.

```GDScript
    const LibraryManager := preload("res://core/global/library_manager.tres")
    ...
    var filter := func(apps: Array[LibraryItem]) -> Array[LibraryItem]:
        return apps.filter(func(item: LibraryItem): not item.is_installed())

    # Return non-installed games
    var not_installed := LibraryManager.get_library_items([filter])
```

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

### to_dict()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/LibraryLaunchItem

Serializes the LibraryLaunchItem instance into a Dictionary.

```APIDOC
### Method
Dictionary to_dict()

### Description
Converts the current LibraryLaunchItem object into a Dictionary representation.
```

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

### from_dict(dict: Dictionary)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/InputPlumberGamepadEvent

Creates an instance of InputPlumberGamepadEvent from a dictionary representation.

```APIDOC
## InputPlumberGamepadEvent.from_dict(dict: Dictionary)

### Description
Creates and returns a new InputPlumberGamepadEvent instance populated from the provided dictionary.

### Parameters
- **dict** (Dictionary) - Required - The dictionary containing gamepad event data.

### Returns
- **InputPlumberGamepadEvent** - The initialized event object.
```

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

### get_devices()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/NetworkManagerInstance

Retrieves a list of available network devices.

```APIDOC
## NetworkDevice[] get_devices()

### Description
Retrieves an array of currently available network devices.

### Returns
- **NetworkDevice[]** - An array of network devices.
```

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

### supports_audio()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/AudioManager

Checks if the system supports audio control operations.

```APIDOC
### bool supports_audio()

Returns true if the system has audio controls supported by the AudioManager.
```

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

### get_output_devices()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/AudioManager

Retrieves a list of available audio output devices.

```APIDOC
### PackedStringArray get_output_devices()

Returns a list of available audio output devices.
```

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

### connect_to_profile(uuid: String)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/BluetoothDevice

Initiates a connection to a specific Bluetooth profile identified by the provided UUID.

```APIDOC
## void connect_to_profile(uuid: String)

### Description
Initiates a connection to a specific Bluetooth profile identified by the provided UUID.

### Parameters
- **uuid** (String) - The UUID of the profile to connect to.
```

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

### fetch(url: String, caching_flags: int = 3)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/HTTPImageFetcher

Fetches an image from the specified URL and returns it as a Texture2D.

```APIDOC
## fetch(url: String, caching_flags: int = 3)

### Description
Fetches an image from the provided URL. Returns a Texture2D object.

### Parameters
- **url** (String) - Required - The URL of the image to fetch.
- **caching_flags** (int) - Optional (Default: 3) - Flags used for caching the image.

### Returns
- **Texture2D** - The fetched image as a texture.
```

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

### enable_plugin(plugin_id: String)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/PluginLoader

Sets the specified plugin to an enabled state.

```APIDOC
## enable_plugin(plugin_id: String)

### Description
Sets the given plugin to enabled.

### Parameters
- **plugin_id** (String) - Required - The ID of the plugin to enable.
```

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

### has_app(name: String)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/LibraryManager

Returns true if the app with the given name exists in the library.

```APIDOC
## has_app(name: String)

### Description
Returns true if the app with the given name exists in the library.
```

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

### from_dict(dict: Dictionary)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/InputPlumberTouchMotionEvent

Creates an instance of InputPlumberTouchMotionEvent from a provided dictionary.

```APIDOC
## InputPlumberTouchMotionEvent.from_dict(dict: Dictionary)

### Description
Creates an instance of InputPlumberTouchMotionEvent from a provided dictionary.

### Parameters
- **dict** (Dictionary) - Required - The dictionary containing event data.

### Returns
- **InputPlumberTouchMotionEvent** - A new instance of the class.
```

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

### action_press(dbus_path: String, action: String, strength: float = 1.0)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/InputManager

Queues a press event for a specified action.

```APIDOC
### void action_press(dbus_path: String, action: String, strength: float = 1.0)

Queue a pressed event for the given action.
```

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

### set_source_capability(capability: String, direction: String = "")

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/CardMappingButton

Configures the button for the specified source capability.

```APIDOC
### void set_source_capability(capability: String, direction: String = "")

Configures the button for the given source capability.
```

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

### get_releases(project: String, per_page: int = 30, page: int = 1)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/GitHubClient

Fetches the releases for a specified GitHub project.

```APIDOC
## get_releases(project: String, per_page: int = 30, page: int = 1)

### Description
Returns the releases for the given project (e.g., "ShadowBlip/OpenGamepadUI").

### Parameters
- **project** (String) - Required - The repository identifier in the format "owner/repo".
- **per_page** (int) - Optional - Number of results per page (default: 30).
- **page** (int) - Optional - The page number to retrieve (default: 1).

### Returns
- **Variant** - The release data for the specified project.
```

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

### exec(command: String, args: PackedStringArray)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/Pty

Executes a command with the provided arguments.

```APIDOC
## exec(command: String, args: PackedStringArray)

### Description
Executes a specified command with a set of arguments.

### Signature
int exec(command: String, args: PackedStringArray)

### Parameters
- **command** (String) - The command to execute.
- **args** (PackedStringArray) - The arguments for the command.

### Returns
- **int** - The result code of the execution.
```

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

### play_sound()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/PlayAudioEffect

Triggers the playback of the configured audio effect.

```APIDOC
## void play_sound()

### Description
Plays the audio effect associated with the PlayAudioEffect instance.
```

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

### get_running()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/LaunchManager

Retrieves a list of currently running applications.

```APIDOC
## get_running()

### Description
Returns a list of currently running apps.

### Returns
- **RunningApp[]** - A list of active applications.
```

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

### push_state(state: int, unique: bool = true, data: Dictionary = {})

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/StateManager

Pushes a new state onto the stack.

```APIDOC
## push_state(state: int, unique: bool = true, data: Dictionary = {})

### Signature
Variant push_state(state: int, unique: bool = true, data: Dictionary = {})
```

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

### set_library_item(item: LibraryItem, free_on_remove: bool = true)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/GameCard

Configures the card with the provided library item data.

```APIDOC
## void set_library_item(item: LibraryItem, free_on_remove: bool = true)

### Description
Configures the card with the given library item.

### Parameters
- **item** (LibraryItem) - The library item to associate with the card.
- **free_on_remove** (bool) - Optional, defaults to true. Determines if the item should be freed when removed.
```

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

### discover_mappings(mappings_dir: String)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/InputIconManager

Discovers all input icon mappings from the specified directory path.

```APIDOC
## discover_mappings(mappings_dir: String)

### Description
Discover all input icon mappings from the specified path.

### Parameters
- **mappings_dir** (String) - Required - The directory path to search for mappings.

### Returns
- **Dictionary** - A dictionary containing the discovered mappings.
```

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

### show(notify: Notification)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/NotificationManager

Queues the given notification to be shown to the user.

```APIDOC
## show(notify: Notification)

### Description
Queues the given notification to be shown.

### Parameters
- **notify** (Notification) - Required - The notification object to be displayed.
```

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

### load_details(id: String)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/Store

Loads the details for a specific item in the store.

```APIDOC
## load_details(id: String)

### Description
Loads the details for a specific item in the store.

### Parameters
- **id** (String) - The unique identifier of the item to load.

### Signature
Variant load_details(id: String)
```

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

### create_script_from_source(source, override_path)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/GutUtils

Creates a script object from source code.

```APIDOC
## create_script_from_source(source, override_path)

### Signature
`Variant create_script_from_source(source: Variant, override_path: Variant = null)`
```

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

### from_dict(dict: Dictionary)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/InputPlumberMapping

Creates a new InputPlumberMapping instance from a dictionary representation.

```APIDOC
## InputPlumberMapping.from_dict(dict: Dictionary)

### Description
Creates a new InputPlumberMapping instance from a dictionary.

### Parameters
- **dict** (Dictionary) - Required - The dictionary containing mapping data.
```

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

### set_target_capability(capability: String, direction: String = "")

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/CardMappingButton

Configures the button for the specified target capability.

```APIDOC
### void set_target_capability(capability: String, direction: String = "")

Configures the button for the given target capability.
```

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

### SettingsManager Methods

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/SettingsManager

Methods available for managing user settings and library-specific values.

```APIDOC
## void save()
Saves the current settings to the configuration file.

## void reload()
Reloads the settings from the configuration file.

## Variant get_value(section: String, key: String, default: Variant = null)
Retrieves a value from the settings file based on the section and key.

## Variant get_library_value(item: LibraryItem, key: String, default: Variant = null)
Retrieves a library-specific value.

## void set_value(section: String, key: String, value: Variant, persist: bool = true)
Sets a value in the settings file. If persist is true, the change is saved to the file.

## void set_library_value(item: LibraryItem, key: String, value: Variant, persist: bool = true)
Sets a library-specific value. If persist is true, the change is saved to the file.

## void erase_section_key(section: String, key: String, persist: bool = true)
Removes a key from a specific section.

## void erase_library_key(item: LibraryItem, key: String, persist: bool = true)
Removes a key from a library item.
```

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

### get_backlight_paths()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/DisplayManager

Retrieves a list of all detected backlight devices.

```APIDOC
## PackedStringArray get_backlight_paths()

### Description
Returns a list of all detected backlight devices.
```

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

### Plugin Methods

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/Plugin

Methods available for plugin implementation to manage resources and UI integration.

```APIDOC
## void unload()

### Description
To be overridden by plugin implementation. Should unload changes done by the plugin.

## Control get_settings_menu()

### Description
To be overridden by plugin implementation. Should return a scene with plugin settings. This scene will be included in the plugin settings menu to let users modify plugin-specific settings.

## void add_library(library: Library)

### Description
Adds the given library implementation as a child of the plugin. A Library node will automatically register itself with the LibraryManager when it enters the scene tree.

## void add_store(store: Store)

### Description
Adds the given store implementation as a child of the plugin. A Store node will automatically register itself with the StoreManager when it enters the scene tree.

## void add_boxart(boxart: BoxArtProvider)

### Description
Adds the given boxart provider as a child of the plugin. A BoxArtProvider node will automatically register itself with the BoxArtManager when it enters the scene tree.

## void add_to_quick_bar(qb_item: Control, icon: Texture2D, focus_node: Control = null)

### Description
Adds the given menu scene to the Quick Bar Menu.

## void add_overlay(overlay: OverlayProvider)

### Description
Adds the given overlay.
```

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

### execute()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/PlatformAction

Executes the platform action. This method is intended to be overridden in child class implementations.

```APIDOC
## void execute()

### Description
Executes the given platform action. This should be overridden in the child class implementation.

### Returns
- **void** - No return value.
```

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

### get_cards()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/Gpu

Retrieves a list of available GPU cards.

```APIDOC
## GpuCard[] get_cards()

### Description
Returns an array of GpuCard objects representing the available GPUs.

### Returns
- **GpuCard[]** - A list of GPU cards.
```

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

### set_output_device(device: String)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/AudioManager

Sets the active audio output device.

```APIDOC
### int set_output_device(device: String)

Sets the current output device to the specified device name.
```

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

### pretty_print()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/GutUtils

Pretty prints a dictionary.

```APIDOC
## pretty_print(dict: Variant)

### Description
Pretty prints a dictionary.

### Signature
`Variant pretty_print(dict: Variant)`
```

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

### send_key(key: String, value: bool)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/KeyboardDevice

Sends a key event to the keyboard device.

```APIDOC
## send_key(key: String, value: bool)

### Description
Sends a key event to the keyboard device.

### Signature
void send_key(key: String, value: bool)

### Parameters
- **key** (String) - The identifier of the key to be pressed or released.
- **value** (bool) - The state of the key (true for pressed, false for released).
```

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

### retrigger_automounts()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/SteamRemovableMediaManager

Restarts all media-mount scripts.

```APIDOC
## retrigger_automounts()

### Description
Calls the SteamRemovableMedia or SteamOS retrigger-automounts script to restart all the media-mount@ scripts.
```

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

### reload_library()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/LibraryManager

Loads all library items from each provider and sorts them. This can take a while, so should be called asynchronously.

```APIDOC
## reload_library()

### Description
Loads all library items from each provider and sorts them. This can take a while, so should be called asynchronously.
```

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

### set_config(options: PackedStringArray)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/MangoApp

Sets the configuration options for the application.

```APIDOC
## void set_config(options: PackedStringArray)

### Description
Sets the configuration options for the application using a PackedStringArray.

### Parameters
- **options** (PackedStringArray) - The configuration options to set.
```

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

### CPU Class Methods

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/CPU

Methods available for interacting with the system CPU and retrieving core information.

```APIDOC
## get_enabled_core_count()
Returns the count of number of enabled CPU cores.

## get_core(num: int)
Returns an instance of the given CPU core.

## get_cores()
Returns an array of all CPU cores.

## get_total_core_count()
Returns the total number of detected CPU cores.

## get_online_core_count()
Returns the total number of CPU cores that are online.
```

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

### get_singleton_by_name(name)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/GutUtils

Retrieves a singleton instance by its name.

```APIDOC
## get_singleton_by_name(name)

### Signature
`Variant get_singleton_by_name(name: Variant)`
```

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

### set_context(ctx: KeyboardContext)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/KeyboardInstance

Updates the keyboard context for the instance.

```APIDOC
## void set_context(ctx: KeyboardContext)

### Description
Sets the keyboard context for the instance.

### Parameters
- **ctx** (KeyboardContext) - The new context to apply.
```

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

### supports_brightness()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/DisplayManager

Checks if the system has access to adjust display brightness.

```APIDOC
## bool supports_brightness()

### Description
Returns true if OpenGamepadUI has access to adjust brightness.

### Returns
- **bool** - True if brightness adjustment is supported, false otherwise.
```

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

### get_partitions()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/BlockDevice

Retrieves a list of partitions associated with the current block device.

```APIDOC
## get_partitions()

### Description
Returns an array of PartitionDevice objects associated with this block device.

### Signature
`PartitionDevice[] get_partitions()`
```

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

### show_notification(text: String, icon: Texture2D = null, timeout_sec: float = 5.0)

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/NotificationManager

Displays a notification with the specified text, icon, and timeout.

```APIDOC
## show_notification(text: String, icon: Texture2D = null, timeout_sec: float = 5.0)

### Parameters
- **text** (String) - Required - The text content of the notification.
- **icon** (Texture2D) - Optional - The icon to display with the notification.
- **timeout_sec** (float) - Optional - The duration in seconds before the notification times out.
```

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

### get_stores()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/StoreManager

Retrieves all registered stores.

```APIDOC
## get_stores()

### Signature
Array get_stores()

### Description
Returns an array containing all currently registered stores.
```

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

### check_for_updates()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/SoftwareUpdater

Checks to see if there is a newer version of OpenGamepadUI available.

```APIDOC
## void check_for_updates()

### Description
Checks to see if there is a newer version of OpenGamepadUI available.
```

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

### get_composite_devices()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/InputPlumberInstance

Retrieves a list of all available composite devices.

```APIDOC
## get_composite_devices()

### Signature
`CompositeDevice[] get_composite_devices()`
```

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

### is_running()

Source: https://opengamepadui.readthedocs.io/en/latest/class-reference/BluezInstance

Checks if the Bluetooth service is currently running.

```APIDOC
### is_running()

#### Signature
`bool is_running()`

#### Description
Returns true if the Bluetooth service is running, otherwise false.
```
Tokens:
Raw