HowTo

Installing Package

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.

OpenUPM Scoped Registry (2020.1 and newer)

Open Project Preferences and go to Package manager Window.

If not present, add this scoped registry:

• Name: OpenUPM
• URL : https://package.openupm.com
• Scopes : net.peeweek

Once added, you can close the project settings window.

Finally, Open Package manager (Window/Package Manager), select the Visual Effect Graph (Extras) package, and click the install button.

Local Package

• Clone repository somewhere of your liking
• Make sure your project is correctly configured with both HDRP and VFX Graph at correct revisions
• 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

Version Compatibility

VFXGraph is a package that ships alongside HD Render Pipeline, and can be an optional dependency of Universal Render Pipeline. These versions follow semver version numbering. However, the VFX Graph extras Package does not follow the exact numbering of HDRP/VFX/URP. Instead, version numbers follow unity version numbering as a base reference.

Requirements

• VFX Graph Package
• Unity
  • 2020.3 > Working (Use 2020.3.x version)
  • 2021.3 > Working (Use 2020.3.x version)
  • 2022.X <-- In progress (will use a 2022.2.x version)

Troubleshooting

(work in progress)