Code Monkey home page Code Monkey logo

crest's Introduction

ย 

Intro

Crest is a technically advanced ocean renderer implemented in Unity3D 2018.3 and later. The version hosted here targets the built-in render pipeline, a link to the LWRP version on the Asset Store is below.

Teaser

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

Twitter: @crest_ocean

LWRP asset: Crest Ocean System LWRP

URP asset: Coming soon.

HDRP asset: Coming soon.

Showcase Gallery

Your game here! We're looking for projects to showcase - if you upload a video of your work to youtube and send us a link (or create a pull request) we'll put a thumbnail here and link to it.

Hope Adrift Gameplay & Release Trailer Morild Navigator Blue Water Dev Diary - CIWS Expo Crest Ocean System - Pirate Cove Example Scene Critter Cove & Crest Trailer Of Ships & Scoundrels - Crest Demo Rogue Waves

Documentation

Refer to USERGUIDE.md for full documentation, including Initial setup steps.

There is also a getting started video here: https://www.youtube.com/watch?v=qsgeG4sSLFw&t=142s .

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 2018.3 or later is the minimum version.
  • Crest example content:
    • The content requires a layer named Terrain which should be added to your project.
    • 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
  • Direct X11 or Vulkan, other platforms targeting shader compilation target 4.5 or above may work but we cannot provide support for, or test on, other APIs ourselves.

Releases

The best way to obtain Crest is take the latest version in the master branch by forking/cloning this repository or by using the green download button above. We rely heavily on the community to help us test new features before creating releases. Once features are settled they are integrated into the SRP assets (linked above).

Releases are published irregularly and posted on the Releases page. Unity packages are uploaded with each release. The lastest release version is 8.0.0.

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:

  • Crest does not yet support HDRP. If you would find such support useful, please feel free to comment in issue #201.
  • Azure[Sky] requires some code to be added to the ocean shader for the fogging/scattering to work. This is a requirement of this product and apparently comes with instructions for what needs to be added. See issue #62.
  • Issue with LWRP and VR - refraction appears broken due to what seems to be a bug in LWRP. See issue #206.
  • Unity 2018.3 introduced significant changes to prefabs. We don't make extensive use of prefabs, but there are some for boats and others, and these may not work in earlier versions. These will need to be recreated manually.

crest's People

Contributors

huwb avatar moosichu avatar rbn3d avatar shadowteolog avatar daleeidd avatar baranpirincal avatar ajweeks avatar cowhunt avatar skaughtx0r avatar furkandinc avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.