Skip to content

Installation Guide

Jump to bottom
Nicholas Brancaccio edited this page Jul 28, 2021 · 8 revisions

Installing the HPSXRP has been made simple so you can quickly jump in and start.

Before beginning the installation steps, ensure your Unity project is closed to decrease the risk of an issue occurring.

This installation process requires Git and Git LFS to be installed on your system. Make sure both are up to date before attempting installation of HPSXRP. A number of users have encountered problems in the past due to use of old versions of Git and / or Git LFS.

On Windows, Git can be downloaded and installed here: https://git-scm.com/download/win When installing, when you reach the Select Components screen in the install wizard, sure Git LFS is selected.

Installation via Release .zip extraction into your Packages Folder. Easy. Recommended.

In order to install in your project you'll want to:

  1. Close Unity.
  2. Download the com.hauntedpsx.render-pipelines.psx.zip file from the latest Release on the Releases Page . At the time of writing, that is 1.4.1
  3. Unzip the contents into your [Your Project Directory]/Packages/ folder.
  4. Open Unity. Unity will automatically install any Package placed inside your Packages folder.
  5. Go to Edit -> Project Settings -> Graphics -> Scriptable Render Pipeline Settings
  6. Select the PSXRenderPipelineAsset.asset file inside your Packages/com.hauntedpsx.render-pipelines.psx/Runtime/RenderPipeline/ folder and drag it into the property field in the inspector window displayed in step 5.

Updating via Release .zip extraction into your Packages Folder.

If you have previously installed an old version of HPSXRP via the Release .zip extraction into your Packages Folder method and would like to upgrade to the latest version:

  1. Close Unity.
  2. Delete the com.hauntedpsx.render-pipelines.psx folder inside the [Your Project Directory]/Packages/ folder.
  3. Repeat the installation instructions above.

Installation via Git URL in Packages.json file. Requires Git + Git LFS.

In order to install in your project you'll want to:

  1. Close Unity.
  2. Open the text file located in [Your Project Directory]/Packages/manifest.json
  3. Inside of the "dependencies" json object, add the line: "com.hauntedpsx.render-pipelines.psx":"https://github.com/pastasfuture/com.hauntedpsx.render-pipelines.psx.git"
  4. Save the file
  5. Open your project in Unity. It will automatically download the package from github and install it.
  6. Go to Edit -> Project Settings -> Graphics -> Scriptable Render Pipeline Settings
  7. Select the PSXRenderPipelineAsset.asset file inside your Packages/com.hauntedpsx.render-pipelines.psx/Runtime/RenderPipeline/ folder and drag it into the property field in the inspector window displayed in step 5.

Updating via Git URL in Packages.json file. Requires Git + Git LFS.

If you have previously installed an old version of HPSXRP via the Git URL method and would like to upgrade to the latest version:

  1. Close Unity.
  2. Open the text file located in [Your Project Directory]/Packages/packages-lock.json
  3. Delete the com.hauntedpsx.render-pipelines.psx json object from your packages-lock file and save it.
  4. Open Unity. The latest version will be automatically downloaded and installed.

If the render pipeline was set up correctly, your editor window might look slightly different.

Continue on to Getting Started with HPSXRP to learn how to start using the HPSXRP in your project.

Clone this wiki locally