Search Unity

  1. Welcome to the Unity Forums! Please take the time to read our Code of Conduct to familiarize yourself with the forum rules and how to post constructively.

[Open Source] OpenGraphGUI - Customize Material Inspectors from ShaderGraph

Discussion in 'Assets and Asset Store' started by SomeGuy22, Nov 17, 2022.

  1. SomeGuy22

    SomeGuy22

    Joined:
    Jun 3, 2011
    Posts:
    715
    Get OpenGraphGUI on GitHub here!
    ~~~~~~~~~~~~~~~~~~~~~

    What is OpenGraphGUI?

    OpenGraphGUI is an open-source Editor GUI for use with URP ShaderGraphs in Unity, aiming to clean up the look of Material Properties while providing ease-of-use via tagging.



    The default Inspector view for ShaderGraph-based materials can be somewhat bland at times, and often can't match the more streamlined look of the default Shaders provided by the Built-In renderer or other Render Pipelines. OpenGraphGUI opens up new options.

    Why use OpenGraphGUI?

    OpenGraphGUI lets you customize the appearance of your material properties right from ShaderGraph. Simply prefix your property names in the Shader's Blackboard with certain special characters, and any material using that Shader will display the custom GUI. This is a lightweight and easy to use script that provides more control over the design of your Shaders.



    Usage

    In ShaderGraph, simply change your "Custom Editor GUI" setting to the named class RPOpenGraphGUI, and you're all set to start prefixing!



    See the GitHub README file for the full feature set. Some examples:





    Installation
    1. Open the Package Manager in Unity
    2. Click the '+' icon and hit "Add package from git URL"
    3. Add the GitHub "HTTPS Clone" URL for OpenGraphGUI: https://github.com/RobProductions/OpenGraphGUI.git
    4. Wait for download to complete
    5. Add the custom GUI class RPOpenGraphGUI to the Custom Editor GUI field in your ShaderGraph of choice
    If installation fails due to version requirements, you may be able force OpenGraphGUI to work by downloading the project as .zip and editing the "package.json" file to lower the Unity requirement. Then use the "Add package from disk" option to add your custom version instead.

    If you're looking to add a specific release of OpenGraphGUI, you can specify a release tag with the hashtag like so: "https://github.com/RobProductions/OpenGraphGUI.git#ReleaseNumber"

    How to Contribute
    This open source project is free for all to suggest improvements, and I'm hoping that more contributors could help clean up the code and add further features as suggested by the community. These are the recommended steps to add your contribution:

    1. Fork the repository to your GitHub account
    2. Clone the code to the Assets folder in any Unity project (as long as it does not include OpenGraphGUI as a package)
    3. Create a new branch or work off of your own "working branch"
    4. When your changes are complete, submit a pull request to merge your code; ideally to the "working-branch" used to test changes before main
    5. If the PR is approved, aggregate changes will eventually be merged into main and a new release tag is created

    ~~~~~~~~~~~~~~~~~~~~~~~~~~~
    Get the OpenGraphGUI package here!

    License
    This work is licensed under the MIT License. The intent for this software is to expand the extend the functionality of ShaderGraph freely and openly, without requirement of attribution. The code may be considered "open source" and could include snippets from multiple collaborators. Contributors may be named in the README.md and Documentation files.

    The code is provided "as is" and without warranty.
     
    SugoiDev likes this.