-
Notifications
You must be signed in to change notification settings - Fork 341
DOCS: 6.7 package installation update #2470
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
suearkinunity
wants to merge
10
commits into
develop
Choose a base branch
from
docs/6.7-package-installation-update
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
c741ef7
For older versions
suearkinunity fed85a7
Index.md updated for 6.7
suearkinunity 1d5ef19
Installation still sometimes needed
suearkinunity 7e9a51e
Small fix
suearkinunity d2afb09
Pre-enduser-docs
suearkinunity 9a724a1
Finishing up
suearkinunity 82c5afc
Apply suggestion from @suearkinunity
suearkinunity 9704905
Update Installation.md
suearkinunity 0ca60f2
Apply suggestion from @suearkinunity
suearkinunity 5c5041e
Update Packages/com.unity.inputsystem/Documentation~/index.md
suearkinunity File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
68 changes: 32 additions & 36 deletions
68
Packages/com.unity.inputsystem/Documentation~/Installation.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,58 +1,54 @@ | ||
| --- | ||
| uid: input-system-installation | ||
| --- | ||
| # Installation guide | ||
| # Install the Input System package | ||
|
|
||
| This page describes how to install and activate the **Input System** package for your Unity Project. | ||
|
|
||
| > [!NOTE] | ||
| > 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. | ||
| > | ||
| > 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. | ||
| Install the Input System package and enable the input back end for your project. | ||
|
|
||
| ## Install the package | ||
|
|
||
| To install the new Input System: | ||
|
|
||
| 1. In the main menu of the Unity Editor, go to __Window__ > __Package Manager__ to open the Unity Package Manager. | ||
|
|
||
| 2. Select **Unity Registry** from the navigation panel. | ||
|
|
||
| 3. Select the __Input System__ package from the list. | ||
|
|
||
| The Package Manager automatically selects that version to install by default. | ||
|
|
||
| 4. Select __Install__, follow any prompts to [enable the backends](#) for the new Input System. | ||
| Unity 6.1 and later include the Input System package in projects created from some templates. | ||
|
|
||
| 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). | ||
| If your project doesn't include the Input System package, you can install it: | ||
|
|
||
| ## Enable the new input backends | ||
| 1. In the main menu, go to **Window** > **Package Manager**. | ||
| 1. Go to **Unity Registry**. | ||
| 1. From the package list, select **Input System**. | ||
| 1. Select **Install**. | ||
| 1. Follow any prompts to [enable the backends](#select-a-back-end). | ||
|
|
||
| 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. | ||
| ## Select a back end | ||
|
|
||
| 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 Unity Editor has two back end options: | ||
|
|
||
|  | ||
| - The Input Manager for backwards compatibility. | ||
| - The Input System package for new or upgraded projects. | ||
|
|
||
| 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. | ||
| When you install the Input System package in your project, Unity asks whether to enable the Input System back ends. Select **Yes** to enable the Input System back ends and disable the Input Manager back ends. The Editor restarts to complete the change. | ||
|
|
||
| > [!NOTE] | ||
| > You can enable __both__ the old __and__ the new system at the same time. To do so, set **Active Input Handling** to **Both**. | ||
| To manually select a back end: | ||
|
|
||
|  | ||
| 1. In the main menu, go to **Edit** > **Project Settings** > **Player**. | ||
| 1. In the **Other Settings** section, set **Active Input Handling** to select a back end: | ||
| - Input Manager (Old): Builds have the `ENABLE_LEGACY_INPUT_MANAGER=1` C# `#define`. | ||
| - Input System Package (New): Builds have the `ENABLE_INPUT_SYSTEM=1` C# `#define`. | ||
| - Both: Builds have both of the C# `#define`. | ||
|
|
||
| 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. | ||
| The Editor restarts with a new back end. | ||
|
|
||
| ## Install samples | ||
| ## Import samples and demos | ||
|
|
||
| The package comes with a number of samples. You can install these directly from the Package Manager window in Unity (__Window > Package Manager__). | ||
| The Input System package includes several samples. To import a sample into your project: | ||
|
|
||
| To view the list of samples: | ||
| 1. Go to **Window** > **Package Manager**. | ||
| 1. Select the Input System package. | ||
| 1. Select **Samples**. | ||
| 1. To import a sample, select **Import** next to its name. | ||
|
|
||
| 1. Select the package in the **Package Manager** window. | ||
| 1. Select the __Samples__ tab. | ||
| 1. Select __Import__ next to any sample name to import that sample into the current project. | ||
| For a more comprehensive demo, use the [Warriors](https://github.com/UnityTechnologies/InputSystem_Warriors) project. | ||
|
|
||
|  | ||
| ## Additional resources | ||
|
|
||
| For a more comprehensive demo project for the Input System, refer to the [InputSystem_Warriors](https://github.com/UnityTechnologies/InputSystem_Warriors) GitHub repository. | ||
| * [Quickstart guide](quick-start-guide.md) | ||
| * [Migrate from the old input system](migrate-from-old-input-system.md) | ||
| * [Input System workflows](Workflows.md) |
4 changes: 2 additions & 2 deletions
4
Packages/com.unity.inputsystem/Documentation~/TableOfContents.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.