Remove redundant information in README.md and add a link to the
documentation.
This commit is contained in:
Romain Failliot 2018-12-20 16:41:44 -05:00
Родитель bbff5c5116
Коммит 28b0e9c1f2
2 изменённых файлов: 39 добавлений и 33 удалений

Просмотреть файл

@ -0,0 +1,38 @@
# About PlayableGraph Visualizer
Use the *PlayableGraph Visualizer* package to have a visual representation of the
Playable graphs instantiated in the scene.
# Installing PlayableGraph Visualizer
To install this package, follow the instructions in the
[Package Manager documentation](https://docs.unity3d.com/Packages/com.unity.package-manager-ui@latest/index.html).
# Using PlayableGraph Visualizer
- Open the PlayableGraph Visualizer in **Window > PlayableGraph Visualizer**
- Open any scene that contains at least one `PlayableGraph`
- In the top-left list, select the `PlayableGraph` to display in the window
- Click on the nodes to display more information about the associated Playable handle
_Note:_
- You can show just your `PlayableGraph` using `GraphVisualizerClient.Show(PlayableGraph)` in the code
- If your `PlayableGraph` is only available in Play mode, you will not be able to see it in Edit mode
# Technical details
## Requirements
This version of *PlayableGraph Visualizer* is compatible with the following versions of the Unity Editor:
* 2018.1 and later (recommended)
## Package contents
The following table indicates the structure of the package:
|Location|Description|
|---|---|
|`Editor/`|Contains the editor scripts for the new *PlayableGraph Visualizer* window.|
|`Runtime/GraphVisualizerClient.cs`|Contains the class allowing the user to register specific Playable graphs.|

Просмотреть файл

@ -1,39 +1,7 @@
# PlayableGraph Visualizer
## Introduction
The PlayableGraph Visualizer is a tool that displays the PlayableGraphs in the scene.
It can be used in both Play and Edit mode and will always reflect the current state of the graph.
Playable nodes are represented by colored nodes, varying according to their type. Connections color intensity indicates its weight.
## Setup
🚨 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.
There are two ways to install the PlayableGraph Visualizer:
1. Standalone:
- Download the release compatibles with your Unity version;
- Uncompress the downloaded file in your `Assets` directory.
2. Git (command line):
- Change directory to your project's `Assets` directory.
- Run `git clone https://github.com/Unity-Technologies/graph-visualizer`
## Usage
- Open the PlayableGraph Visualizer in **Window > PlayableGraph Visualizer**.
- Open any scene that contains at least one `PlayableGraph`.
- Select the `PlayableGraph` to display in the window's top-left list.
- Click on the nodes to display more information about the associated Playable Handle.
_Note:_
- You can show just your `PlayableGraph` using `GraphVisualizerClient.Show(PlayableGraph)` in the code.
- If your `PlayableGraph` is only available in Play mode, you will not be able to see it in Edit mode.
## Unity compatibility
Unity version | Release
---------------|--------------
2018.1+ | v2.2 (master)
2017.1+ | v1.1
See the [Documentation](Documentation~/playablegraph-visualizer.md) for the installation and the usage.