Quick-start
Hit the ground running.
Last updated
Hit the ground running.
Last updated
Before importing you should make sure that you have the Universal RP package installed in your project. More information about which versions are supported can be found here.
Upon importing the asset from the store, you will be greeted by the support window. In the 'Configure' tab, click on the Detect button. This will check if everything is set up correctly in your project. If the support window does not open, you can open it by clicking Tools > Stylized Water For URP > About and Support.
If you only see green check marks, you're good to go! You can go a head to creating a water object. If something is not set up correctly, a red or orange icon will appear. The following issues may need to be fixed.
Download a new Unity version. Check the compatibility page for all the supported Unity versions.
Download a new URP version through the package manager. Check the compatibility page for all the supported versions. You can also use the install button to install the latest available URP version automatically through the package manager.
Change the active renderer under Edit > Project Settings > Graphics by dragging in your UniversalRenderPipelineAsset. The fix button in the support window will open this menu for you.
If you don't already have an UniversalRenderPipelineAsset in your project, you can find one under Stylized Water For URP > Demos
Select your UniversalRenderPipelineAsset and enable the depth/opaque texture toggles.
It is important to note that the camera component is able to override these settings. Make sure that you select 'Use Pipeline Settings'.
Check the compatibility page to see all of the supported graphics APIs.
In order to have planar reflections in your project, you need to have a planar reflections component on your camera. Planar reflections are not necessary and you can leave the check mark orange if you don't need them.
To create a body of water you have 3 options.
Use the GameObject > 3D Object > Stylized Water menu to create a circular, square or hexagonal body of water.
Use one of the water prefabs located under the Stylized Water For URP > Prefabs folder.
Drag the StylizedWaterForURP.cs script onto the mesh you will be using as a water object. The object should have a compatible material that uses the Stylized Water URP shader. The object also needs an active mesh renderer component.
This asset comes with a nice and clean material editor to edit the properties of the water. In order to use it, add the StylizedWaterForURP.cs script to your water object (the object that has the material applied to it).
