Loic.wave-harmonic.crest 1.0.0

dotnet add package Loic.wave-harmonic.crest --version 1.0.0
                    
NuGet\Install-Package Loic.wave-harmonic.crest -Version 1.0.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Loic.wave-harmonic.crest" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Loic.wave-harmonic.crest" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Loic.wave-harmonic.crest" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Loic.wave-harmonic.crest --version 1.0.0
                    
#r "nuget: Loic.wave-harmonic.crest, 1.0.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#addin nuget:?package=Loic.wave-harmonic.crest&version=1.0.0
                    
Install Loic.wave-harmonic.crest as a Cake Addin
#tool nuget:?package=Loic.wave-harmonic.crest&version=1.0.0
                    
Install Loic.wave-harmonic.crest as a Cake Tool

<img src="https://raw.githubusercontent.com/wave-harmonic/crest/master/logo/crest-oceanrender-logomark128.png" width="107">

Intro

Crest is a technically advanced ocean renderer implemented in Unity3D 2019.4.8 and later. The version hosted here targets the built-in render pipeline, links to the scriptable render pipeline versions (URP/HDRP) on the Asset Store are below.

Teaser

Supporting us: Asset Store sales partially cover our dev costs, for the rest we are looking for sponsorship. Please see our sponsorship page for more detals.

Discord for news/updates/discussions: https://discord.gg/g7GpjDC

YouTube for tutorials and showcases: Crest Ocean System

Twitter: @crest_ocean

<a href="https://assetstore.unity.com/packages/tools/particles-effects/crest-ocean-system-urp-141674" target="_blank"><img src="https://assetstorev1-prd-cdn.unity3d.com/key-image/ae4a1e07-c6f1-4b2e-b1c3-9f2065d43515.jpg" alt="Crest Ocean System URP Asset" width="240" height="180"/></a> <a href="https://assetstore.unity.com/packages/tools/particles-effects/crest-ocean-system-urp-141674" target="_blank"><img src="https://assetstorev1-prd-cdn.unity3d.com/key-image/68d1442e-488d-4ae9-8ec4-a7e3ff913788.jpg" alt="Crest Ocean System HDRP Asset" width="240" height="180"/></a>
Crest Ocean System URP Crest Ocean System HDRP

<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="240" height="180" /></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="240" height="180" /></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="240" height="180" /></a> <a href="https://www.youtube.com/watch?feature=player_embedded&v=ZmKto87To-0" target="_blank"><img src="https://img.youtube.com/vi/ZmKto87To-0/0.jpg" alt="An Adventure to the World of Artificial Intelligenc" width="240" height="180" /></a> <a href="https://www.youtube.com/watch?feature=player_embedded&v=nsQJ5IJVHVw" target="_blank"><img src="https://img.youtube.com/vi/nsQJ5IJVHVw/0.jpg" alt="Hope Adrift Gameplay & Release Trailer" width="240" height="180" /></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="240" height="180" /></a> <a href="https://www.youtube.com/watch?feature=player_embedded&v=LNIQ6RF5lrw" target="_blank"><img src="https://img.youtube.com/vi/LNIQ6RF5lrw/0.jpg" alt="Blue Water Dev Diary - CIWS Expo" width="240" height="180" /></a> <a href="https://www.youtube.com/watch?feature=player_embedded&v=3i6VpdKw2Q0" target="_blank"><img src="https://img.youtube.com/vi/3i6VpdKw2Q0/0.jpg" alt="Crest Ocean System - Pirate Cove Example Scene" width="240" height="180" /></a> <a href="https://www.youtube.com/watch?feature=player_embedded&v=m2ZojyD4PZc" target="_blank"><img src="https://img.youtube.com/vi/m2ZojyD4PZc/0.jpg" alt="Critter Cove & Crest Trailer" width="240" height="180" /></a> <a href="https://www.youtube.com/watch?feature=player_embedded&v=zCeK_Kdxqa0" target="_blank"><img src="https://img.youtube.com/vi/zCeK_Kdxqa0/0.jpg" alt="Of Ships & Scoundrels - Crest Demo" width="240" height="180" /></a> <a href="https://www.youtube.com/watch?feature=player_embedded&v=HVlJa2J0wSc" target="_blank"><img src="https://img.youtube.com/vi/HVlJa2J0wSc/0.jpg" alt="Rogue Waves" width="240" height="180" /></a> <a href="https://www.youtube.com/watch?feature=player_embedded&v=e1maUIXQIRI" target="_blank"><img src="https://img.youtube.com/vi/e1maUIXQIRI/0.jpg" alt="Ship Simulator : Realistic" width="240" height="180" /></a>

Documentation

Full documentation is available online, including initial setup steps.

Prerequisites

  • Unity version:
    • The SRP assets on the Asset Store specify the minimum version required.
    • Releases on this GitHub target the built-in render pipeline, and each release specifies which version of Unity it was developed on. Currently Unity 2019.4.8 or later is the minimum version. See further down for 2018.4 support.
  • Crest example content:
    • The post processing package is used (for aesthetic reasons), if this is not present in your project you will see an unassigned script warning which you can fix by removing the offending script.
  • .NET 4.x runtime
  • Shader compilation target 4.5 or above
    • Crest unfortunately does not support OpenGL or WebGL backends

Installation

You can download the latest version from here.

Another way to obtain Crest is to fork/clone this repository.

The files that should be copied into an existing project are under crest/Assets/Crest.

Note that 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.

Releases: Currently we do not prepare release packages. However, we do tag each asset store version, so the zip corresponding to each version can be downloaded by clicking the desired version on the Releases page. Once the zip is downloaded, the steps are as above.

Notes and Issues

If you encounter an issue, please search the Issues page to see if there is already a resolution, and if you don't find one then please report it as a new issue.

There are a few issues worth calling out here:

  • Sky solutions such as Azure[Sky] requires some code to be added to the ocean shader for the fogging/scattering to work. This is a requirement of these products which typically come with instructions for what needs to be added. See the wiki for examples.
  • Crest does not support OpenGL or WebGL backends
  • Unity 2018 support - There is a [legacy branch] for 2018.4 support. A direct download to an archive is available here. It is not actively developed.

Donations

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

https://github.com/sponsors/wave-harmonic

Sponsors

Diamond

<table> <tbody> <tr> <td align="center" valign="middle"> <a href="https://www.okomotive.ch/" target="_blank"> <img width="222px" src="https://cdn.discordapp.com/attachments/849200677301125123/849271975746601030/okomotive_logo_rgb_color_transparent_512px.png"> </a> </td> </tr><tr></tr> </tbody> </table>

Gold 🥇

@ipthgil

Board Members 🚀

@celeronpm @Bartolomeus755 @holdingjason @NeistH2o

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net5.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0 1 7/31/2021