All pages
Powered by GitBook
1 of 1

Loading...

SETUP GUIDE

Color Space

It is recommended to use Linear color space with this asset.

You can find this setting at Project Settings/Player/Other Settings.

Universal Render Pipeline

The demo scene requires Universal Render Pipeline with 2D Renderer to work. You can install it in the Package Manager.

After the Universal Render Pipeline is properly installed, you can use the Universal Render Pipeline Asset that comes with this asset. You can find it at Cainos/Pixel Art Top Down – Village/Rendering.

If you are using your own render pipeline asset, make sure to set Transparency Sort Mode to Custom Axis with Transparency Sort Axis set to [0, 1, 1].

Unity 6 Support

Import Patch - Unity 6 package at the root folder of the asset to add Unity 6 support.

Sometimes you will get a error of [Top Down Pixel Water Renderer Feature] Blur shader not set. after importing. In this case, just follow the setup steps to add the material and shader to the renderer feature.

Building for WebGL in Unity 6

For the water to be rendered correctly in WebGL builds, you need to disable Auto Graphics API and set Graphics API to WebGPU in Project Settings > Player > Other Settings .

Input System in Unity 6.1

For compatiblity, the default input method in this asset still uses the old input manager. And in Unity 6.1, the old input manager is no longer the default option.

If you encounter any error regarding the input system. Please change the Active Input Handling in Project Settings/Player to Both .

Pixel Aligned Placement

By setting the move value of Increment Snapping to 0.03125 (1/32), and press CTRL when moving objects, the objects can be placed perfectly aligned to the pixel grid.

Top Down Pixel Water

This asset is uploaded as a complete project to included project settings. The Top Down Pixel Water renderer feature should be well setup by default.

If you need to set it up by yourself, follow the below instruction:

  • Add a Top Down Water Renderer Feature to the render pipeline asset.

  • Assign the water material at Cainos/Pixel Art Top Down - Village/Material/MT Top Down Pixel Water and gaussian blur shader at Cainos/Pixel Art Top Down - Village/Shader/SH Render Pass - Gaussian Blur to the Reference foldout.

  • Set Terrain Layer Mask

Optimize the Water for Mobile Platform

The rendering of the water is quite performance heavy. When optimizing for mobile platforms, please try the follows settings.

On Assets\Cainos\Pixel Art Top Down - Village\Rendering\Universal Render Pipeline Asset - 2D Renderer, find the Top Down Pixel Water Renderer Feature and tweak the blur settings of the water.

The idea is to make Downsample as large as possible and Kernel Size and Blur Pass as small as possible while maintaining an acceptable water rendering quality.

On the Universal Render Pipeline Asset, set Render Scale to 0.5. Mobile platforms usually have much higher DPI so we do not need to render at full resolution.

On Project Settings/Player, Set Graphics APIs to Vulkan, enable Multithreaded Rendering and Graphics Jobs.

With these settings, the demo scene can run at 60fps at Xiaomi MIX 2S, a pretty old device.

and
Water Layer Mask
. The
Terrain Layer Mask
is used to render refraction and a color gradient from shore to deep water. It should contain layers of the terrain tile map and other objects that directly touch the water, for example, the support of the dock. The
Water Layer Mask
should only contain the water prefab.
  • Find the PF Top Down Pixel Water in Cainos/Pixel Art Top Down – Village/Prefab/FX and drag it to the scene.

  • Top Down Pixel Water