README.md

Input Rebinder

A Unity plugin for generating control settings UI. This repo only contains the documentation.

Currently supporting Unity version 2022 LTS.

Access the documentation here.

Source code

The source code is located in another repo.

Getting Started

1. Import the plugin from the Unity Asset store into your project.

2. Go to "Tools" > "Input Rebinder". This will open the editor plugin's window.

3. On the opened editor window, select your .inputactions file. This is a file that Unity generates when you use the Input System. To select, click the rounded symbol with a dot inside.

4. In Generated Prefab Folder, select where you want the prefab to be generated in your project. By default, it is "Assets/Prefabs" and it will create the folders if they don't exist.

5. In Generated Prefab Name, write the name of the prefab that will be generated by the Input Rebinder plugin. By default, the name is "Input Rebinder Controls".

6. Click Analyze.

7. Pick which actions and action maps you want the plugin to generate. Usually, the UI action map is deselected because you don't want players to change the in-game UI's event system.

8. Click Generate. A prefab variant is generated at your desired location. A prefab variant is an instance of another prefab that is instantiable by itself. You may detach the prefab variant after you have finished using the plugin.

9. Place the generated prefab into a scene. Click 2D in the editor to see in-game UI instead of the 3D world.

10. To integrate it into your game, there are many ways and it depends on you. For example, you may disable the prefab and write a script that enables the generated prefab when a game event occurs. Or you may place the generated prefab alone in a scene that is switched into.

By default, the Close button on the prefab disables the root of the prefab. You can modify its behavior by changing its attached listener in the inspector.