search

pastasfuture / com.hauntedpsx.render-pipelines.psx

A scriptable render pipeline for emulating Playstation-1-style graphics on contemporary hardware.
https://twitter.com/HauntedPs1/
MIT License
383 stars 26 forks source link

Installation guide with OpenUPM in the wiki #10

Open Cammin opened 3 years ago

Cammin commented 3 years ago

Hi, I'm a fellow package author. Great render asset by the way! Looks awesome 👍

I was just looking at the install instructions but it didn't talk about an install option for using OpenUPM. All package installation options are useful in their own way, but I personally find that using OpenUPM is the simplest way to install any packages because I don't need to dig into any manifest files. It's basically just one command and it adds to a package registry so that there is an easy update button in the Unity package manager, which is such a convenient feature also. Users installing your package could potentially have a smoother time trying to install, along with the other benefits like updates in the package manager.

It looks like your project was automatically generated up on the OpenUPM website (it's versioned by pushing git tags), so there's no extra effort required on your end. I think that the only thing to do is encourage this install option in your wiki guide. https://openupm.com/packages/com.hauntedpsx.render-pipelines.psx/

Just wanted to let you know about this if you didn't yet. I'm considering trying a game with this type of rendering, it might be cool 🙂

pastasfuture commented 2 years ago

Thanks @Cammin - I wasn't aware of the OpenUPM approach. If you're able - would you be willing to write a short guide? I'd happily add it to the wiki. I don't have personal experience with OpenUPM. Thanks!

Cammin commented 2 years ago

The instructions would be relatively simple, though it is a few steps. It's documented fairly decently on their own website where it explains some required dependencies to install. 🙂 The install instructions could be along the lines of this (You could copy this to add to the wiki; then fix the markdown, I typed it like this to copy more easily):

Installation via OpenUPM.

  1. [Install Node.js 12] (https://nodejs.org/en/) to use npm.
  2. [Install the OpenUPM-CLI] (https://openupm.com/docs/getting-started.html#installing-openupm-cli) by entering this into the command line: npm install -g openupm-cli
  3. [Install the Package] (https://openupm.com/docs/getting-started.html#installing-a-upm-package) by entering this into the command line while the directory is scoped on the root of your Unity project:
    openupm add com.hauntedpsx.render-pipelines.psx