COZY Documentation
  • Welcome!
    • πŸ‘‹Hello!
    • πŸ—ΊοΈRoadmap
    • πŸ†˜Support & Community
    • πŸŽ“Changelog
  • Getting Started
    • πŸ”ŒInstallation
    • πŸ› οΈSetting Up Your Project
    • 🌐Creating a New Scene
    • πŸ“¦COZY Samples
  • How it works
    • βš™οΈThe System Perspective
    • ⏱️Meridiem Time
    • 🌈Gradients & Curves
    • βš–οΈWeighted Random Chance (WRC)
    • πŸ§‘β€πŸ«Weather Selection & Forecasting
    • The Weather Sphere
      • 🌌The Sky Dome
      • ☁️The Cloud Dome
        • COZY Desktop Clouds
        • COZY Mobile Clouds
        • Soft Clouds
        • Painted Skies
        • Ghibli Desktop & Mobile Clouds
        • Single Texture Clouds
        • Luxury Clouds
      • 🌫️The Fog Dome
    • Modules
      • 🌌Atmosphere Module
      • πŸ•‘Time Module
      • 🌦️Weather Module
      • πŸƒAmbience Module
      • 🌑️Climate Module
      • ⚑Events Module
      • 🎨Interactions Module
      • ☁️Buto Module
      • 🌎MicroSplat Module
      • 🌳The Vegetation Engine (TVE) Module
      • πŸͺžReflections Module
      • πŸŒ™Satellite Module
      • πŸ—ƒοΈSave & Load Module
      • πŸŒ„Transit Module
      • πŸ’¨Wind Module
      • πŸ•‘System Time Module
      • πŸ›Debug Module
      • ☁️Plume Module
      • πŸŒ‡Blocks Module
      • πŸŒ‘Eclipse Module
      • πŸ“†Habits Module
      • 🎼ReSound Module
      • πŸ”—Link Module
    • Profiles
      • Ambience Profile
      • Atmosphere Profile
      • Forecast Profile
      • Perennial Profile
      • Satellite Profile
      • Material Profile
      • Weather Profile
      • FX Profiles
        • Audio FX
        • Climate FX
        • Cloud FX
        • Event FX
        • Filter FX
        • Multi FX
        • Particle FX
        • Precipitation FX
        • Thunder FX
        • Visual FX
        • Wind FX
      • Climate Profile
    • Biomes
    • Settings
  • Extending COZY
    • Stopping Indoor FX
    • Developing the Render Queue
    • Utilities
  • Integrations
    • Crest Water 4 (URP Only)
    • Crest Water 5
    • Stylized Water 2
    • KWS Water System
    • Generic Shader Graph
    • The Vegetation Engine
    • MicroSplat
  • Appendix
    • Frequently Asked Questions (FAQs)
    • Improving Performance With COZY 3
Powered by GitBook
On this page
  • Project Setup
  • Optional Setup
  • Samples

Was this helpful?

  1. Getting Started

Setting Up Your Project

Starting a new project with COZY? Not to worry!

PreviousInstallationNextCreating a New Scene

Last updated 7 months ago

Was this helpful?

COZY is designed with mobile in mind and it is easy to achieve good fps even on low-end devices! Check out the for detailed instructions on how to setup COZY for mobile use.

Project Setup

Setting up COZY for Unity is simple! Simply follow the guide for your render pipeline:

  1. Install the package using one of the two import methods detailed .

  2. Use to setup a scene with COZY.

  3. In the inspector for the COZY window, click on the status bar to open the project setup dialog.

  1. In the render pipeline setup section, click the import button next to your project's pipeline

  1. If you are using SSAO, please be sure to set the source to depth rather than depth normals

  1. In the inspector for the COZY window, click on the status bar to open the project setup dialog.

  1. In the render pipeline setup section, click the import button next to your project's pipeline

  1. In the inspector for the COZY window, click on the status bar to open the project setup dialog.

  1. In the render pipeline setup section, click the import button next to your project's pipeline

  1. If you are using SSAO, please be sure to set the source to depth rather than depth normals

  1. Import the Particle System Shader Samples sample package from the High Definition RP package.

Optional Setup

If you plan on using the COZY Trigger System, we highly recommend adding the tag β€œFX Block Zone” to your project however you can set this to any tag you like in the COZY Trigger Module!

Samples

As of COZY 3.1.0, some optional features are placed in downloadable sample packages. Check out the COZY Samples page for more information!

Install the package using one of the two import methods detailed .

Use to setup a scene with COZY.

Install the package using one of the two import methods detailed .

Use to setup a scene with COZY.

here
this guide
here
this guide
πŸ› οΈ
performance page
here
this guide
Page cover image