Skip to content

Commit 10e63ef

Browse files
committed
DOCATT-8537: Clarified the installation requirements
- Updated the installation instructions to use steps and make it standard compliant - Also changed the titles to be doc standard compliant (and updated external links pointing there)
1 parent 69461db commit 10e63ef

File tree

5 files changed

+22
-10
lines changed

5 files changed

+22
-10
lines changed

Packages/com.unity.inputsystem/Documentation~/Debugging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ To prevent conflicts between simulated touchscreen inputs and native mouse and p
110110

111111
The Unity Remote is an app available for iOS and Android which allows using a mobile device for input while running in the Unity Editor. You can find details about the app and how to install it in the [Unity manual](https://docs.unity3d.com/Manual/UnityRemote5.html).
112112

113-
If you would like to try out the Unity Remote app, you can [install](Installation.md#installing-samples) the "Unity Remote" sample that is provided with the Input System package.
113+
If you would like to try out the Unity Remote app, you can [install](Installation.md#install-samples) the "Unity Remote" sample that is provided with the Input System package.
114114

115115
> [!NOTE]
116116
> Joysticks/gamepads are not yet supported over the Unity Remote. No joystick/gamepad input from the mobile device will come through in the editor.
-94.8 KB
Binary file not shown.

Packages/com.unity.inputsystem/Documentation~/Installation.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,30 @@ uid: input-system-installation
88
- [Enabling the new input backends](#enabling-the-new-input-backends)
99
- [Installing samples](#installing-samples)
1010

11-
This guide describes how to install and activate the Input System package for your Unity Project.
11+
This page describes how to install and activate the Input System package for your Unity Project.
1212

1313
> [!NOTE]
14-
> The new Input System requires Unity 2019.4+ and the .NET 4 runtime. It doesn't work in projects using the old .NET 3.5 runtime.
14+
> 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.
15+
>
16+
> 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.
1517
16-
## Installing the package
18+
## Install the package
1719

18-
To install the new Input System, open Unity's package manager (menu: __Window > Package Manager__). Select the __Input System__ package from the list, then click __Install__.
20+
To install the new Input System:
1921

20-
![Install Input System Package](Images/InputSystemPackage.png)
22+
1. In the main menu of the Unity Editor, go to __Window__ > __Package Manager__ to open the Unity Package Manager.
2123

22-
## Enabling the new input backends
24+
2. Select **Unity Registry** from the navigation panel.
25+
26+
3. Select the __Input System__ package from the list.
27+
28+
The Package Manager automatically selects that version to install by default.
29+
30+
4. Select __Install__, follow any prompts to [enable the backends](#) for the new Input System.
31+
32+
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).
33+
34+
## Enable the new input backends
2335

2436
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.
2537

@@ -36,7 +48,7 @@ You can find the corresponding setting in __Edit__ > __Project Settings__ > __Pl
3648

3749
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.
3850

39-
## Installing samples
51+
## Install samples
4052

4153
The Input System package comes with a number of samples. You can install these directly from the Package Manager window in Unity (__Window > Package Manager__). To see the list of samples, select the Input System package in the Package Manager window and click the __Samples__ tab. Then click __Import__ next to any sample name to import it into the current Project.
4254

Packages/com.unity.inputsystem/Documentation~/Migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This is because there are a number of different ways to read input using the Inp
2323

2424
## Which system is enabled?
2525

26-
When installing the new Input System, Unity prompts you to enable the new input system and disable the old one. You can change this setting at any time later, by going to **Edit > Project Settings > Player > Other Settings > Active Input Handling**, [as described here](./Installation.md#enabling-the-new-input-backends).
26+
When installing the new Input System, Unity prompts you to enable the new input system and disable the old one. You can change this setting at any time later, by going to **Edit > Project Settings > Player > Other Settings > Active Input Handling**, [as described here](./Installation.md#enable-the-input-backends).
2727

2828
There are scripting symbols defined which allow you to use conditional compilation based on which system is enabled, as shown in the example below.
2929

Packages/com.unity.inputsystem/Documentation~/UISupport.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ The Input System package provides a **Virtual Mouse** component for this purpose
236236
> [!NOTE]
237237
> This component is only compatible with the [Unity UI](https://docs.unity3d.com/Manual/com.unity.ugui.html) (uGUI) system, and not UI Toolkit.
238238
239-
To see an example of the Virtual Mouse in a project, see the [Gamepad Mouse Cursor sample](Installation.md#installing-samples) included with the Input System package.
239+
To see an example of the Virtual Mouse in a project, see the [Gamepad Mouse Cursor sample](Installation.md#install-samples) included with the Input System package.
240240

241241
### Using the Virtual Mouse component
242242

0 commit comments

Comments
 (0)