Rewired Documentation

For Rewired version 1.0.0.67+

The Essentials: (Start Here)

1. Overview
2. Installation
3. Quick Start
4. Basic Usage
5. Deployment
6. Rewired Editor
7. API Reference

 

Concepts: (Very Important!)

• Input Manager
• Players
• Actions
• Input Behaviors
• Controller Maps
• Map Categories
• Layouts
• Custom Controllers

 

How To's (FAQ):

• Important classes
• Getting a Player
• Getting Input
• Getting a Controller
• Receiving joystick connect and disconnect events
• Assigning joysticks to players
• Enabling and disabling controller maps
• Managing controller maps at runtime
• Displaying a button/axis/key name to the user for an Action
• Calibrating controller axes
• Vibration/Rumble with XInput Controllers
• Converting scripts from UnityEngine.Input to Rewired
• Implementing a "Press Start to Join" controller assignment system
• Creating a controller mapping screen
• Saving and loading controller maps
• Saving and loading calibration maps
• Modifying Input Behaviors during runtime
• Creating on-screen touch controllers
• Creating new controller definitions
• Creating new controller templates
• Adding a controller to an existing controller template
• Excluding controller definitions
• Identifying joysticks on Windows fallback or Windows Webplayer platforms
• Hiding input settings on the Unity launcher
• Configuring ArcadeGuns G-500 AimTrak Light Guns
• Logitech G27 Racing Wheel Support
• Saitek Pro Flight TPM Panel Support
• Using Rewired to control Unity's new UI

 

Tools:

• User Data Store
• Control Mapper

 

Help:

• Supported Controllers
• Special Platform Support
• Examples
• Integrations
• Updating Rewired
• Troubleshooting
• Known Issues

 

Unity Help:

• Unity Manual
• Unity Script Reference
• Unity Tutorials

 

Links:

• Rewired Website
• Web Documentation