Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@peeweek
peeweek authored Oct 29, 2022
1 parent 51e61a5 commit 1d60acc
Showing 1 changed file with 4 additions and 107 deletions.
111 changes: 4 additions & 107 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ Additional Features for use with VFX Graph. These features are mostly unpolished
* 2021.3 > Working
* 2022.X <-- Probably not (due to multi window edition)

## Documentation

You can now access the documentation in the [Wiki](https://github.com/peeweek/net.peeweek.vfxgraph-extras/wiki)

## Installing

You can use a manual, local package installation if you need to alter the code locally or automate the fetch of the repository by using a git address directly. The latter option shall download and manage automatically the repository, with the drawback of being read-only.
Expand Down Expand Up @@ -37,110 +41,3 @@ Finally, Open Package manager (Window/Package Manager), select the **Visual Effe
* In your project, open the `Window/Package Manager` window and use the + button to select the `Add Package from Disk...` option.
* Navigate to your repository folder and select the `package.json` file
* The repository shall be added

## Features

Currently, these major features are available through the package.

### VFXGraph Extension

The VFXGraph Extension provides a menu with additional UI and functionality features in the VFX Graph Window.

![](https://raw.githubusercontent.com/peeweek/net.peeweek.vfxgraph-extras/master/Documentation%7E/VFXExtension.png)



### Graph Debug Stats

In the VFX Extension menu, you can toggle the Toggle Debug Stats menu entry to display additional information about particle systems and spawn systems. Many of these informations will require you to attach the graph window to a scene instance.

![](https://raw.githubusercontent.com/peeweek/net.peeweek.vfxgraph-extras/master/Documentation%7E/DebugStats.png)

### Globals

The globals feature enable users to define global shader data structures to be read from the graph, for example to use the player position in VFX Graphs without requiring to bind the values at the component level.

In order to read values, you need to create a VFX Globals definition asset, where you will reference an HLSL include (that you can generate/update as well using the inspector menu), and declare global values.

![](https://raw.githubusercontent.com/peeweek/net.peeweek.vfxgraph-extras/master/Documentation%7E/Globals.png)

Then, using the **Get Globals node** and the **Include Globals** Block (required for reading these values in a context), you can access the values set by the code. In order to set the values in monobehaviours, simply use the `Shader.SetGlobal...()` API. For example :

```csharp
[ExecuteAlways]
[RequireComponent(typeof(SphereCollider))]
public class SetSphereGlobal : MonoBehaviour
{
SphereCollider m_Collider;
private void OnEnable()
{
m_Collider = GetComponent<SphereCollider>();
}

private void Update()
{
Shader.SetGlobalVector("spherePosition", transform.position);
Shader.SetGlobalFloat("sphereRadius", m_Collider.radius * transform.localScale.x);
}
}
```

### Volume Mixer

Volume Mixer provides a way to define custom properties in the project and blend them through the volume system.

![](https://raw.githubusercontent.com/peeweek/net.peeweek.vfxgraph-extras/master/Documentation%7E/VFXVolumeMixer-Component.png)

These properties can then be retrieved and set to visual effects through a different VFX Volume Mixer PropertyBinders for each property type.

![](https://raw.githubusercontent.com/peeweek/net.peeweek.vfxgraph-extras/master/Documentation%7E/VFXVolumeMixer-Binder.png)

The list of settings available can be edited in the Project Settings, under __Volume Mixer__ category. Up to 8 float, 8 Vectors and 8 colors can be defined in the system.
![](https://raw.githubusercontent.com/peeweek/net.peeweek.vfxgraph-extras/master/Documentation%7E/VFXVolumeMixer-Settings.png)


### VFXGraph Scene Debug

A debug view that displays all the effects visible on screen. Editor Window is Available via the menu `Window/Analysis/VFX Graph Debug`.

![](https://raw.githubusercontent.com/peeweek/net.peeweek.vfxgraph-extras/master/Documentation%7E/VFXGraphDebug-Editor.png)

Alternatively, a Runtime view can be used with similar features. You can drop the `VFXDebug` prefab located in the Resources folder of the package.

![](https://raw.githubusercontent.com/peeweek/net.peeweek.vfxgraph-extras/master/Documentation%7E/VFXGraphDebug-Runtime.png)

### VFX Template Gallery

VFX Template Gallery enables picking a starting point upon creating a new VFX Graph or adding a new system in the VFX Graph window :
- For Asset creation, use the `Visual Effect Graph (from Template)`
- For adding a new system, use the `T` key shortcut in the Graph Window, or the menu entry in the VFX Extension Menu
- In order to create your new templates, please create a `Visual Effect Graph Template` asset from the same menu as VFX Graph asset creation. In the inspector, you can also also take screenshots from the scene view using the menu in the inspector header (Useful for making your template screenshots)

![](https://raw.githubusercontent.com/peeweek/net.peeweek.vfxgraph-extras/master/Documentation%7E/VFXGraphTemplateGallery.png)

### Custom Block

Custom Block enables writing a block with custom HLSL code, providing input properties, random, and accessing particle attributes, and even custom attributes.

![](https://raw.githubusercontent.com/peeweek/net.peeweek.vfxgraph-extras/master/Documentation%7E/CustomBlock.png)

### Output Camera

Output Camera provides values from the "Current Rendering Camera" that is used to render an output. It differs from the Camera nodes that target a single camera and thus are compatible with all contexts, as it will provide values per-rendering camera. General uses are to display screen-space particles on different cameras simultaneously.

![](https://raw.githubusercontent.com/peeweek/net.peeweek.vfxgraph-extras/master/Documentation%7E/OutputCamera-Operators.png)

![](https://raw.githubusercontent.com/peeweek/net.peeweek.vfxgraph-extras/master/Documentation%7E/OutputCamera-Block.png)

### Navigator

![](https://user-images.githubusercontent.com/4037271/194754662-3e71045b-4707-4d5b-bcb8-11df5a0b3310.gif)

Navigator handles populating and displaying contents of the graph as a tree view. You can filter it in order to search for nodes .

### Advanced Event Tester

The advanced event tester is a tool that enables to create and store test environments for sending Events to Visual Effects and setting up Event Attribute Payloads.

https://user-images.githubusercontent.com/4037271/197322716-9f7967dd-5273-4b36-b5b4-3b4e055e4952.mp4

0 comments on commit 1d60acc

Please sign in to comment.