# crest

**Repository Path**: bsuo/crest

## Basic Information

- **Project Name**: crest
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-30
- **Last Updated**: 2023-11-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">

![Header](https://github.com/wave-harmonic/crest/blob/master/img/Header.jpg?raw=true)

<hr><h3>CREST OCEAN SYSTEM</h3><hr>

<p align="center">
  An advanced water system implemented in Unity<br>
  <a href="https://crest.readthedocs.io/en/latest">Documentation</a> •
  <a href="https://discord.gg/JJjx9qcq83">Discord</a> •
  <a href="https://www.youtube.com/channel/UC7_ZKKCXZmH64rRZqe-C0WA">YouTube</a> •
  <a href="https://twitter.com/@crest_ocean">Twitter</a> •
  <a href="https://github.com/sponsors/wave-harmonic">Sponsorship</a>
</p>

This repository targets the built-in renderer. For other render pipelines, see the following:

|<a href="https://assetstore.unity.com/packages/tools/particles-effects/crest-ocean-system-252194?aid=1011lic2K" target="_blank"><img src="https://assetstorev1-prd-cdn.unity3d.com/key-image/fef53e24-736f-41f9-98de-bfbcdef4a4a8.jpg" alt="Crest Ocean System BIRP Asset" width="240" height="160"/></a>|<a href="https://assetstore.unity.com/packages/tools/particles-effects/crest-ocean-system-hdrp-164158?aid=1011lic2K" target="_blank"><img src="https://assetstorev1-prd-cdn.unity3d.com/key-image/1e89a1d1-6cae-4163-b3f9-ead226f53160.jpg" alt="Crest Ocean System HDRP Asset" width="240" height="160"/></a>|<a href="https://assetstore.unity.com/packages/tools/particles-effects/crest-ocean-system-urp-141674?aid=1011lic2K" target="_blank"><img src="https://assetstorev1-prd-cdn.unity3d.com/key-image/2b640420-1fed-4a76-a54e-e86b9693c2bb.jpg" alt="Crest Ocean System URP Asset" width="240" height="160"/></a>|
:-:|:-:|:-:|
[Crest Ocean System](https://assetstore.unity.com/packages/tools/particles-effects/crest-ocean-system-252194?aid=1011lic2K)|[Crest Ocean System HDRP](https://assetstore.unity.com/packages/tools/particles-effects/crest-ocean-system-hdrp-164158?aid=1011lic2K)|[Crest Ocean System URP](https://assetstore.unity.com/packages/tools/particles-effects/crest-ocean-system-urp-141674?aid=1011lic2K)

<br>

<hr><h3>SHOWCASE</h3><hr>

<a href="https://www.youtube.com/watch?feature=player_embedded&v=aU07QiKF2YQ" target="_blank"><img src="https://img.youtube.com/vi/aU07QiKF2YQ/0.jpg" alt="FAR: Changing Tides | Announcement Trailer" width="270" height="202" /></a>
<a href="https://www.youtube.com/watch?feature=player_embedded&v=70voKq6cdKQ" target="_blank"><img src="https://img.youtube.com/vi/70voKq6cdKQ/0.jpg" alt="Windbound - Brave the Storm Announce Trailer [Official]" width="270" height="202" /></a>
<a href="https://www.youtube.com/watch?feature=player_embedded&v=JsEWfFlkPxM" target="_blank"><img src="https://img.youtube.com/vi/JsEWfFlkPxM/0.jpg" alt="Wavetale | Accolades Trailer" width="270" height="202" /></a>
<a href="https://www.youtube.com/watch?feature=player_embedded&v=1edWpAlRd8Y" target="_blank"><img src="https://img.youtube.com/vi/1edWpAlRd8Y/0.jpg" alt="Critter Cove | Official Announcement Trailer" width="270" height="202" /></a>
<a href="https://www.youtube.com/watch?feature=player_embedded&v=zz_Yrw0Zang" target="_blank"><img src="https://img.youtube.com/vi/zz_Yrw0Zang/0.jpg" alt="Vertigo 2 - Launch Trailer" width="270" height="202" /></a>
<a href="https://www.youtube.com/watch?feature=player_embedded&v=rdPdxXsgI9c" target="_blank"><img src="https://img.youtube.com/vi/rdPdxXsgI9c/0.jpg" alt="Blade and Sorcery | Official Update 10 Trailer - The Dungeons Update" width="270" height="202" /></a>
<a href="https://www.youtube.com/watch?feature=player_embedded&v=_Rq5dfZfQ1k" target="_blank"><img src="https://img.youtube.com/vi/_Rq5dfZfQ1k/0.jpg" alt="Out of Reach: Treasure Royale - Trailer" width="270" height="202" /></a>
<a href="https://www.youtube.com/watch?feature=player_embedded&v=_thrrySB5YQ" target="_blank"><img src="https://img.youtube.com/vi/_thrrySB5YQ/0.jpg" alt="BUCKO • Announcement Trailer" width="270" height="202" /></a>
<a href="https://www.youtube.com/watch?feature=player_embedded&v=zCeK_Kdxqa0" target="_blank"><img src="https://img.youtube.com/vi/QvCPhk0e7-I/0.jpg" alt="Of Ships & Scoundrels - Crest Demo" width="270" height="202" /></a>
<a href="https://www.youtube.com/watch?feature=player_embedded&v=EExodzbapmo" target="_blank"><img src="https://img.youtube.com/vi/EExodzbapmo/0.jpg" alt="De Leon Legends VR Game" width="270" height="202" /></a>
<a href="https://www.youtube.com/watch?feature=player_embedded&v=6KC13zGgbOA" target="_blank"><img src="https://img.youtube.com/vi/6KC13zGgbOA/0.jpg" alt="Kredolis | Announcement Trailer" width="270" height="202" /></a>
<a href="https://www.youtube.com/watch?feature=player_embedded&v=Qfy5P4Zygvs" target="_blank"><img src="https://img.youtube.com/vi/Qfy5P4Zygvs/0.jpg" alt="Morild Navigator" width="270" height="202" /></a>

<br>

Handful of nice scenes:

<br>

<a href="https://www.youtube.com/watch?feature=player_embedded&v=8l0YaOymTQE" target="_blank"><img src="https://img.youtube.com/vi/8l0YaOymTQE/0.jpg" alt="Tug Symphony" width="270" height="202" /></a>
<a href="https://www.youtube.com/watch?feature=player_embedded&v=yLdjkTSX8E8" target="_blank"><img src="https://img.youtube.com/vi/yLdjkTSX8E8/0.jpg" alt="Unity Beach - Crest Ocean Shader Test [Looped 60FPS]" width="270" height="202" /></a>
<a href="https://www.youtube.com/watch?feature=player_embedded&v=aZScNG8-H2U" target="_blank"><img src="https://img.youtube.com/vi/aZScNG8-H2U/0.jpg" alt="Irval the Dragon in Crest Ocean and Lordenfel Ruins" width="270" height="202" /></a>
<a href="https://www.youtube.com/watch?feature=player_embedded&v=QSfHib7vcg0" target="_blank"><img src="https://img.youtube.com/vi/QSfHib7vcg0/0.jpg" alt="Crest Ocean Unity 3d Submarine Scene 2 Nautilus" width="270" height="202" /></a>
<a href="https://www.youtube.com/watch?feature=player_embedded&v=kmx8CLeZ2Ik" target="_blank"><img src="https://img.youtube.com/vi/kmx8CLeZ2Ik/0.jpg" alt="Mixed Reality Ship Ahoy! with Rift + ZED Mini" width="270" height="202" /></a>
<a href="https://www.youtube.com/watch?feature=player_embedded&v=t867fg_8hP0" target="_blank"><img src="https://img.youtube.com/vi/t867fg_8hP0/0.jpg" alt="ShoreWavesCrest" width="270" height="202" /></a>

<br>

And many more…

<br>

<hr><h3>DOCUMENTATION</h3><hr>

</div>

Full [documentation](https://crest.readthedocs.io/en/latest) is available online. There is also a [Wiki](../../wiki) with community contributions.

<br>

<hr><h3 align="center">REQUIREMENTS</h3><hr>

* Unity: 2020.3 or later
* [Shader compilation target](https://docs.unity3d.com/Manual/SL-ShaderCompileTargets.html) 4.5 or above
* *Crest* does **not** support OpenGL or WebGL backends

<br>

<hr><h3 align="center">INSTALLATION</h3><hr>

Grab the latest stable release from the top of the [tags](https://github.com/wave-harmonic/crest/tags) page.

Extract the files and copy anything under *crest/Assets/Crest* into an existing project.


> **Note**\
> *crest/Assets/Crest/Crest-Examples* contains example content that is useful for first time users but not required for the core *Crest* functionality. Furthermore, the *crest/Assets/Crest/Development* folder is not needed as it is only for *Crest* development.

#### Older Unity Versions

If you are using any of the following *Unity* versions, then use the provided *Crest* version:

- 2019.4: [4.11](https://github.com/wave-harmonic/crest/releases/tag/4.11)
- 2018.4: [4.2](https://github.com/wave-harmonic/crest/releases/tag/4.2)

<br>

<hr><h3 align="center">DONATIONS</h3><hr>

With your support we aim to increase our development bandwidth significantly. Please see our sponsor page for sponsor tiers:

[🩷 Sponsor](https://github.com/sponsors/wave-harmonic)

#### Sponsors

🥇 [@holdingjason](https://github.com/holdingjason)
🚀 [@ipthgil](https://github.com/ipthgil)