From 85f856753a422d2f91e9ea96034a60882c46dedb Mon Sep 17 00:00:00 2001 From: "sarah.welton" Date: Thu, 9 Sep 2021 13:14:35 -0400 Subject: [PATCH] Had to make new branch for formatter. Changes made based on peer and SME review --- com.unity.shadergraph/Documentation~/index.md | 14 ++++++++++++- com.unity.shadergraph/README.md | 21 ++++++++++++------- 2 files changed, 26 insertions(+), 9 deletions(-) diff --git a/com.unity.shadergraph/Documentation~/index.md b/com.unity.shadergraph/Documentation~/index.md index 3156ac92f81..a3efb2a4f22 100644 --- a/com.unity.shadergraph/Documentation~/index.md +++ b/com.unity.shadergraph/Documentation~/index.md @@ -6,6 +6,18 @@ Shader Graph enables you to build shaders visually. Instead of writing code, you For an introduction to Shader Graph, see [Getting Started](Getting-Started.md). -Shader Graph is available through the Package Manager window in supported versions of the Unity Editor. If you install a prebuilt Scriptable Render Pipeline (SRP) such as the [Universal Render Pipeline](https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@latest) (URP) or the [High Definition Render Pipeline](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@latest) (HDRP), Unity automatically installs Shader Graph in your project. +Shader Graph is available through the Package Manager window in supported versions of the Unity Editor. If you install a Scriptable Render Pipeline (SRP) such as the [Universal Render Pipeline (URP)](https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@latest) or the [High Definition Render Pipeline (HDRP)](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@latest), Unity automatically installs Shader Graph in your project. Shader Graph package versions on Unity Engine 2018.x are *Preview* versions, which do not receive bug fixes and feature maintenance. To work with an actively supported version of Shader Graph, use Unity Engine 2019.1 or higher. + +### SRP packages are part of the core + +With the release of Unity 2021.1, graphics packages are relocating to the core of Unity. This move simplifies the experience of working with new Unity graphics features, as well as ensuring that your projects are always running on the latest verified graphics code. + +For each release of Unity (alpha / beta / patch release) graphics packages are embedded within the main Unity installer. When you install the latest release of Unity, you also get the latest [Universal Render Pipeline (URP)](https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@latest), [High Definition Render Pipeline (HDRP)](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@latest), Shader Graph, [Visual Effect (VFX) Graph](https://docs.unity3d.com/Packages.com.unity.visualeffectgraph@latest) packages, among others. + +Tying graphics packages to the main Unity release allows better testing to ensure that the graphics packages you use have been tested extensively with the version of Unity you have downloaded. + +You can also use a local copy or a custom version of the graphics packages with an override in the manifest file. + +For more information, see the following post on the forum: [SRP v11 beta is available now](https://forum.unity.com/threads/srp-v11-beta-is-available-now.1046539/). diff --git a/com.unity.shadergraph/README.md b/com.unity.shadergraph/README.md index f8b958b2e3d..2afc4b14d91 100644 --- a/com.unity.shadergraph/README.md +++ b/com.unity.shadergraph/README.md @@ -4,17 +4,22 @@ A Shader Graph enables you to build shaders visually. Instead of hand writing code you create and connect nodes in a graph network. The graph framework gives instant feedback on the changes, and it’s simple enough that new users can become involved in shader creation. -### Disclaimer +Unless you intend to modify Shader Graph or want to try out the latest and unsupported features, Unity recommends that you install Shader Graph through the Unity Package Manager: -This repository is under active development. Everything is subject to change. The `master` branch is our current development branch and may not work on the latest publicly available version of Unity. Unless you intend to modify Shader Graph or want to try out the very latest and unsupported features, we recommend that you acquire Shader Graph through the Unity Package Manager. +1. Open a Unity project. +2. Open the **Package Manager** window (**Window** > **Package Manager**). +3. In the **Package Manager** window, in the **Packages** menu, select **Unity Registry**. +4. Do one of the following, based on your project needs: + - To use Shader Graph and the [Universal Render Pipeline (URP)](https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@latest) in your project, select **Universal RP**. + - To use Shader Graph and the [High Definition Render Pipeline (HDRP)](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@latest), select **High Definition RP**. + - To use Shader Graph with Unity's [Built-In Render Pipeline](https://docs.unity3d.com/2020.3/Documentation/Manual/built-in-render-pipeline.html), select **Shader Graph**. + +Unity recommends using Shader Graph with URP or HDRP. ## Instructions -At the moment we recommend using Shader Graph through the [SRP repository](https://github.com/Unity-Technologies/Graphics), which has the Shader Graph submodule setup as a submodule. Otherwise you will not have any Master Node backends available and thus your shaders will be pink. This also ensure that you get a compatible set of render pipeline and Shader Graph versions. Otherwise, carry on with the following instructions. +If you want to try out the latest features, we recommend obtaining the most recent version of Shader Graph through the [Unity Scriptable Render Pipeline (SRP) repository](https://github.com/Unity-Technologies/Graphics), which includes the Shader Graph project as a Git submodule. For more information on Git submodules, see [Git's documentation on Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules). -**Requires Unity 2018.1 Beta** +If you don't install Shader Graph through the SRP repository, you don't have any Master Node backends available and your shaders are invalid. Invalid shaders appear pink in the Unity Editor. Installing through the repository also ensures you have a compatible set of render pipeline and Shader Graph versions. -* Download the beta [here](https://unity3d.com/unity/beta) -* Create a new project (or use an existing) -* Clone branch `2018.1` into the `Assets` folder of your project, such that the repository is contained in a sub-folder of the `Assets` folder -* Quick start guide can be found [here](https://forum.unity.com/threads/feedback-wanted-shader-graph.511960/) +For more detailed instructions for installing from the repository, see the [SRP repository's README](https://github.com/Unity-Technologies/Graphics/blob/master/README.md).