Introduction

Welcome to the Poiyomi Shaders Documentation! This website provides detailed information about the features currently offered in Poiyomi Shaders and how to utilize them.

Each category and feature documented on the left-hand Sidebar is organized and sorted in descending order, based on the order of appearance in the Shader's User Interface. Use the left-hand Sidebar to navigate (if on Mobile, click the "hamburger" icon).

Shader UI Redirects

All features in the Shader UI will redirect here for further reading. They are indicated by the icon on the category header. When clicked on, it will redirect you to the appropriate page on this website.

Getting Started

VRChat

Poiyomi Shaders is primarily built for use in VRChat. Make sure you refer to the VRChat Creators Documentation for setting up your Project and the SDK in Unity. Use the only supported Unity Version for VRChat (2022.3.22f1) and ensure you're always on the latest version of the VRChat SDK.

After doing so, follow the instructions found in Download & Install to learn how to begin using the Shader in your Project.

Download & Install

Other Games / System Requirements

Poiyomi Shaders is primarily built for usage in VRChat. Therefore, limitations may apply when used for other purposes.

If you are a Game Developer or hobbyist wishing to use Poiyomi Shaders on a non-VRChat Project, here are the requirements:

• Supported Unity Versions (Built-In Rendering Pipeline): 2021.3, 2022.3
• Supported Unity Versions (URP): 6000.0 and newer
• Supported Platforms: Windows

Please note that this information above are strict requirements. We do NOT support the High Definition Render Pipeline (HDRP) in the Unity versions mentioned above.

URP Version is in Beta!

If using Unity 6 (6000.0 and up), our Universal Render Pipeline (URP) version is currently in BETA and may be unstable!

Please join the Poiyomi Shaders Discord in order to access to the Unity 6-compatible URP version of Poiyomi Shaders.

Version 10.0

Poiyomi Shaders 10.0 is now being rolled out in phases! Therefore, all affected features documented will be updated with new text over time as new information becomes available. If something's missing, there's a good chance it's already on our radar, so hold tight!

Version Selection

All information in this Documentation has been "versioned" to accommodate this major update. When navigating the Documentation, please be aware of the Version number dropdown menu found in the Navigation Bar:

If you're looking for accurate information referring to a specific version, such as 9.3, please use this dropdown and select the appropriate version of the shader you are using to see relevant context! Otherwise, the latest version (10.0) will be the default viewing mode. The versions in this dropdown will be updated over time as Poiyomi Shaders continues it's ongoing development.

If you have any questions or if you think you've found an issue, please join the Discord or open an Issue on our Docs Repository ! The Documentation is continuously being edited, updated, and proofread by our contributors, so please don't hesitate to reach out!