https://github.com/MrStahlfelge/gdx-controllerutils

Controller Utilities for libGDX
https://github.com/MrStahlfelge/gdx-controllerutils

game-controllers gamepad libgdx scene2d

Last synced: 15 days ago
JSON representation

Controller Utilities for libGDX

• Host: GitHub
• URL: https://github.com/MrStahlfelge/gdx-controllerutils
• Owner: MrStahlfelge
• License: apache-2.0
• Created: 2017-11-27T20:11:08.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-11-19T13:26:03.000Z (12 months ago)
• Last Synced: 2024-04-12T15:28:49.461Z (7 months ago)
• Topics: game-controllers, gamepad, libgdx, scene2d
• Language: Java
• Homepage:
• Size: 320 KB
• Stars: 55
• Watchers: 3
• Forks: 13
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-libgdx - gdx-controllerutils - Adds Scene2D button input support, user configurable button mappings and hotplugging for LWJGL2. (Resources / Controllers)

README

        
# gdx-controllerutils

Utilities for using controllers with libGDX.

| :information_source: Note | The enhanced drop-in replacements for the official gdx-controllers extension are not needed any more. All features are included in [gdx-controllers v2](https://github.com/libgdx/gdx-controllers), usable with gdx 1.9.11+. If you still need to use an older gdx version, refer to [v2.2.1](https://github.com/MrStahlfelge/gdx-controllerutils/tree/2.2.1) |

| --- | --- |

![Compile and publish local](https://github.com/MrStahlfelge/gdx-controllerutils/workflows/Compile%20and%20publish%20local/badge.svg?branch=master&event=push)

![Maven Central](http://maven-badges.herokuapp.com/maven-central/de.golfgl.gdxcontrollerutils/gdx-controllerutils-mapping/badge.svg)

## Subprojects

All subprojects are technically independant, you can use only one of them in your project. They are bundled in a single Github project because all have something to do with Game Controller Input and libGDX.

### core-scene2d

Key and button supporting Stage with focusable Actors for Scene2d. This is also usable in games without Game Controller support.

[Documentation](https://github.com/MrStahlfelge/gdx-controllerutils/wiki/Button-operable-Scene2d)

### core-mapping

Support configurable mappings for game controllers in your projects.

[Documentation](https://github.com/MrStahlfelge/gdx-controllerutils/wiki/Configurable-Game-Controller-Mappings)

## Demos and examples

core-scene2d is shown with sources in [raeleus' Shadow Walker UI demo](https://github.com/raeleus/Shadow-Walker-UI).

All subprojects are used in my game [Falling Lightblocks Web/Android/iOS/FireTV](https://www.golfgl.de/lightblocks/).

Take a look at the [sources](https://github.com/MrStahlfelge/lightblocks).

## Installation

This project is published to the Sonatype Maven repository. You can integrate the lib into your project by just adding the dependencies to your `build.gradle` file.

Define the version of this API right after the gdxVersion:

    gdxVersion = '1.9.11' //or another gdx version you use

    cuversion = '2.3.0' // or 1.0.1 if you are on gdx <= 1.9.10

Then add the needed dependencies to your project. You will find the artifact ids on the subproject's wiki sites.

### Building from source

To build from source, clone or download this repository, then open it in Android Studio. Perform the following command to compile and upload the library in your local repository:

    gradlew clean publish -PLOCAL=true

    

See `build.gradle` file for current version to use in your dependencies.

## News & Community

You can get help on the [libgdx discord](https://discord.gg/6pgDK9F).

## License

The project is licensed under the Apache 2 License, meaning you can use it free of charge, without strings attached in commercial and non-commercial projects. We love to get (non-mandatory) credit in case you release a game or app using this project!