You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Packages/com.unity.inputsystem/Documentation~/Installation.md
+30-34Lines changed: 30 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,54 +5,50 @@ uid: input-system-installation
5
5
6
6
This page describes how to install and activate the **Input System** package for your Unity Project.
7
7
8
-
> [!NOTE]
9
-
> This version of the new Input System requires the .NET 4 runtime. It doesn't work in projects using the old .NET 3.5 runtime.
10
-
>
11
-
> This package is only compatible with Unity Editor release versions 2021.3 and later. If you are working in a release version of the Editor prior to 2021.3, you need to use the package version that works with that version of the Editor, indicated by the **Release** tag in the [Unity Package Manager](https://docs.unity3d.com/Manual/upm-ui.html) window.
12
-
13
8
## Install the package
14
9
15
-
To install the new Input System:
16
-
17
-
1. In the main menu of the Unity Editor, go to __Window__ > __Package Manager__ to open the Unity Package Manager.
18
-
19
-
2. Select **Unity Registry** from the navigation panel.
20
-
21
-
3. Select the __Input System__ package from the list.
22
-
23
-
The Package Manager automatically selects that version to install by default.
24
-
25
-
4. Select __Install__, follow any prompts to [enable the backends](#) for the new Input System.
10
+
From Unity 6.7, Input System is automatically included for new projects from templates.
26
11
27
-
This package also provides several samples that demonstrate how to work with the new Input System, which are also available on the [Unity Package Manager](https://docs.unity3d.com/Manual/upm-ui.html) window. Refer to [Install samples](#install-samples).
12
+
If you've created an empty project, or are upgrading an existing project's input, install the Input System package:
28
13
29
-
## Enable the new input backends
14
+
1. Go to **Main Menu** > **Window** > **Package Manager**.
15
+
1. Go to **Unity Registry**.
16
+
1. From the package list, select **Input System**.
17
+
1. Select **Install**.
18
+
1. Follow any prompts to [enable the backends](#enable-the-new-input-backends).
30
19
31
-
By default, Unity's classic Input Manager (`UnityEngine.Input`) is active, and support for the new Input System is inactive. This allows existing Unity Projects to keep working as they are.
20
+
## Select a back end
32
21
33
-
When you install the Input System package, Unity will ask whether you want to enable the new backends. Click **Yes** to enable the new backends and disable the old backends. The Editor restarts during this process.
- The legacy Input Manager for backwards compatibility.
25
+
- The Input System package for new or upgraded projects.
36
26
37
-
You can find the corresponding setting in __Edit__ > __Project Settings__ > __Player__ > __Other Settings__ > __Active Input Handling__. If you change this setting you must restart the Editor for it to take effect.
27
+
When you install the Input System package in your project, Unity will ask whether you want to enable the new backends. Click **Yes** to enable the new backends and disable the old backends. The Editor restarts to complete the change.
38
28
39
-
> [!NOTE]
40
-
> You can enable __both__ the old __and__ the new system at the same time. To do so, set **Active Input Handling** to **Both**.
1. Go to **Project Settings** > **Player** > **Other Settings**.
32
+
1. In **Active Input Handling**, select a back end:
33
+
- Input Manager (Old). Builds have the `ENABLE_LEGACY_INPUT_MANAGER=1` C# `#define`.
34
+
- Input System Package (New). Builds have the `ENABLE_INPUT_SYSTEM=1` C# `#define`.
35
+
- Both. Builds have both of the C# `#define`.
36
+
1. The Editor restarts with a new back end.
43
37
44
-
When the new input backends are enabled, the `ENABLE_INPUT_SYSTEM=1` C# `#define` is added to builds. Similarly, when the old input backends are enabled, the `ENABLE_LEGACY_INPUT_MANAGER=1` C# `#define` is added. Because both can be enabled at the same time, it is possible for __both__ defines to be 1 at the same time.
38
+
## Compatibility notes for existing projects
45
39
46
-
## Install samples
40
+
Before upgrading existing projects to use Input System, please ensure:
47
41
48
-
The package comes with a number of samples. You can install these directly from the Package Manager window in Unity (__Window > Package Manager__).
42
+
* You're using .NET 4 runtime or newer.
43
+
* You're using an Editor version of 2021.3 or newer. For older versions, match the package version to the Editor version as indicated by the **Release** tag in the [Unity Package Manager](https://docs.unity3d.com/Manual/upm-ui.html) window.
49
44
50
-
To view the list of samples:
45
+
## Samples and demos
51
46
52
-
1. Select the package in the **Package Manager** window.
53
-
1. Select the __Samples__ tab.
54
-
1. Select __Import__ next to any sample name to import that sample into the current project.
47
+
The Input System package includes several samples. To import a sample into your project:
55
48
56
-

49
+
1. Go to the **Package Manager** window.
50
+
1. Select the Input System package.
51
+
1. Go to the **Samples** tab.
52
+
1. To import a sample, select **Import** next to its name.
57
53
58
-
For a more comprehensive demo project for the Input System, refer to the [InputSystem_Warriors](https://github.com/UnityTechnologies/InputSystem_Warriors)GitHub repository.
54
+
For a more comprehensive demo, use the [Warriors](https://github.com/UnityTechnologies/InputSystem_Warriors)project.
0 commit comments