|
2 | 2 |
|
3 | 3 | ## Introduction
|
4 | 4 |
|
5 |
| -The PlayableGraph Visualizer window can be used to display any `PlayableGraph`. |
6 |
| -The tool can be used in both Play and Edit mode and will always reflect the current state of the graph. |
7 |
| -Playable Handles in the graph are represented by colored nodes, varying according to their type. Wire color intensity indicates the local weight of the blending. |
| 5 | +The PlayableGraph Visualizer is a tool that displays the PlayableGraphs in the scene. |
| 6 | +It can be used in both Play and Edit mode and will always reflect the current state of the graph. |
| 7 | +Playable nodes are represented by colored nodes, varying according to their type. Connections color intensity indicates its weight. |
8 | 8 |
|
9 | 9 | ## Setup
|
10 | 10 |
|
11 |
| -- Download the release that matches your current Unity version, or the latest if your Unity version is more recent than the latest release. |
12 |
| -- Copy the content of this repo into a folder called GraphVisualizer in your Unity Project. You will need to do this for every project. |
| 11 | +🚨 Be careful to use a release that is compatible with your Unity version (see table below). The `master` branch is compatible with 2018.1 and later. |
13 | 12 |
|
14 |
| -OR |
| 13 | +There are two ways to install the PlayableGraph Visualizer: |
15 | 14 |
|
16 |
| -- From the command line change directory to your project's `Assets` directory. |
17 |
| -- Run `git clone https://github.com/Unity-Technologies/graph-visualizer` |
| 15 | +1. Standalone: |
| 16 | + - Download the release compatibles with your Unity version; |
| 17 | + - Uncompress the downloaded file in your `Assets` direcroty. |
18 | 18 |
|
19 |
| -## Window |
20 |
| - |
21 |
| -- You can open the Timeline Visualizer in **Window > PlayableGraph Visualizer**. |
| 19 | +2. Git (command line): |
| 20 | + - Change directory to your project's `Assets` directory. |
| 21 | + - Run `git clone https://github.com/Unity-Technologies/graph-visualizer` |
22 | 22 |
|
23 | 23 | ## Usage
|
24 | 24 |
|
| 25 | +- Open the PlayableGraph Visualizer in **Window > PlayableGraph Visualizer**. |
25 | 26 | - Open any scene that contains at least one `PlayableGraph`.
|
26 |
| -- By default, all the `PlayableGraph`s of your scene will be listed in the editor's top-left list. |
27 |
| - - You can show just your `PlayableGraph` using `GraphVisualizerClient.Show(PlayableGraph)`. |
28 |
| -- Select the `PlayableGraph` to display in the top-left list. |
29 |
| -- Click on a Node to display more information about the associated Playable Handle. |
30 |
| - |
31 |
| -## Notes |
| 27 | +- Select the `PlayableGraph` to display in the window's top-left list. |
| 28 | +- Click on the nodes to display more information about the associated Playable Handle. |
32 | 29 |
|
33 |
| -- This tool was previously named Timeline Visualizer, but was renamed as we are refactoring it to support `PlayableGraph` stored in different types of component. |
| 30 | +_Note:_ |
| 31 | +- You can show just your `PlayableGraph` using `GraphVisualizerClient.Show(PlayableGraph)` in the code. |
34 | 32 | - If your `PlayableGraph` is only available in Play mode, you will not be able to see it in Edit mode.
|
| 33 | + |
| 34 | +## Unity compatibility |
| 35 | + |
| 36 | +Release | Unity version |
| 37 | +--------------|-------------- |
| 38 | +v2.2 (master) | 2018.1+ |
| 39 | +v1.1 | 2017.1+ |
0 commit comments