Giter Club home page Giter Club logo

customsrp's Introduction

Custom SRP Template

This is a template Scriptable Render Pipeline (SRP) package for Unity. It contains boiler plate code to be used as starting point when creating custom render pipelines. It also already creates base files to distribute and install this custom SRP as a package for Unity.

Create your custom SRP package from this template

  • Create a Github repository from this template by clicking on the Use this template button at the top.
  • Edit package.json file to configure the package manifest.
    • Note: If you change package name, be sure to all change shader includes.
  • Update README.md, CHANGELOG.md and LICENSE.md files to reflect the contents of your package.

How to install your package in your Unity project

  • In Unity, click at the top bar on Window -> Package Manager.
  • Follow these instructions to install it as a local package.

How to use

  • Create a render pipeline asset by clicking on Assets -> Create -> Custom Render Pipeline Asset.
  • In Graphics Settings, assign the newly created render pipeline asset in the Scriptable Render Pipeline Settings field.

What's in the package

The package follows the Unity's Package Manager recommended layout

  • package.json describes the package metadata required by Package Manager.
  • README.md contains project description used by Github.
  • CHANGELOG.md contains changelog entries. This is used by Package Manager to display changelog information in the Editor.
  • LICENSE.md containts package license information. This is used by Package Manager to display license information in the Editor.
  • Editor
  • Runtime
    • CustomRenderPipeline.cs - Contains rendering related code. Edit this file to add the desired rendering logic.
    • CustomRenderPipelineAsset.cs - Creates render pipeline instance. Can hold render pipeline resources.
    • Unity.com.render-pipelines.asmdef - the assembly definition file for editor scripts.
  • ShaderLibrary
    • Core.hlsl - Includes all basic shader necessary files.
    • UnityInput.hlsl - Contains declaration of all built-in Unity shader constants.
  • Shaders
    • Unlit.shader - Unlit shader example.
  • Tests
    • Contains Editor and Runtime test folders. To be used with UnityTestRunner to write automated package tests.
  • Documentation~
    • index.md - Contains index page for documentation. This is used by Package Manager to display package docs.
  • Samples~
    • Add any sample scenes to your package here. This will be displayed by Package Manager.

customsrp's People

Contributors

phi-lira avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

customsrp's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.