https://github.com/am1goo/rewired.ui.hotkeys

A plugin for Guavaman's Rewired Unity Asset that provides an easy-to-use API for showing controller hotkeys to the player at runtime based on their bindings and input method.
https://github.com/am1goo/rewired.ui.hotkeys

advanced api asset glyphs guavamen hotkey input package rewired sdk system ui unity unity3d

Last synced: about 2 months ago
JSON representation

A plugin for Guavaman's Rewired Unity Asset that provides an easy-to-use API for showing controller hotkeys to the player at runtime based on their bindings and input method.

• Host: GitHub
• URL: https://github.com/am1goo/rewired.ui.hotkeys
• Owner: am1goo
• License: mit
• Created: 2024-05-20T07:17:28.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-10-10T15:26:44.000Z (4 months ago)
• Last Synced: 2024-12-20T23:51:34.120Z (about 2 months ago)
• Topics: advanced, api, asset, glyphs, guavamen, hotkey, input, package, rewired, sdk, system, ui, unity, unity3d
• Language: C#
• Homepage: https://github.com/am1goo/Rewired.UI.Hotkeys
• Size: 1.45 MB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Rewired.UI.Hotkeys



A plugin for Guavaman's Rewired Unity Asset that provides an easy-to-use API for showing controller hotkeys to the player at runtime based on their bindings and input method.

## Features

- full supports for Rewired's glyphs in UI

- binded to Rewired's actions (you don't miss any of actions)

- fast integration of keyboard, mouse and gamepads glyphs

- batch import for sprites into controller profile

- able to switch to another controller in realtime



## How to use

- create controller profiles for each device what you need via context menu `Create->Rewired->Controller Profile`





- create `Rewired Hotkeys Manager` via top menu `Window->Rewired->Create->Hotkeys Manager (in scene)` or `Window->Rewired->Create->Hotkeys Manager (prefab)`



- add `RewiredHotkey` component into your UI and select specific action what you want to bind



## Installation

##### via Unity Package Manager

The latest version can be installed via [package manager](https://docs.unity3d.com/Manual/upm-ui-giturl.html) using following git URL: \

`https://github.com/am1goo/Rewired.UI.Hotkeys.git#1.0.1`

## Requirements

- Unity Engine 2019.x or higher

- [Rewired Advanced Input System](https://assetstore.unity.com/packages/tools/utilities/rewired-21676)

## Tested in

- Unity 2019.4.x

- Unity 2020.3.x

with

- Rewired Advanced Input System 1.1.39.2 (U2019)

- Rewired Advanced Input System 1.1.51.1 (U2022)

  

## Using in

[Sin Slayers](https://www.gog.com/en/game/sin_slayers) - RPG with roguelike elements set in a dark fantasy world, where your choices determine how challenging the fights and enemies will be.

## Contribute

Contribution in any form is very welcome. Bugs, feature requests or feedback can be reported in form of Issues.