Skip to content
This repository has been archived by the owner on Jul 23, 2019. It is now read-only.

Commit

Permalink
Update README & screenshot
Browse files Browse the repository at this point in the history
  • Loading branch information
valryon committed Jan 30, 2017
1 parent 109a333 commit c1b9345
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 44 deletions.
21 changes: 0 additions & 21 deletions Assets/Water2D Surface/LICENCE.md

This file was deleted.

8 changes: 0 additions & 8 deletions Assets/Water2D Surface/LICENCE.md.meta

This file was deleted.

2 changes: 0 additions & 2 deletions Assets/Water2D Surface/README.md

This file was deleted.

8 changes: 0 additions & 8 deletions Assets/Water2D Surface/README.md.meta

This file was deleted.

30 changes: 25 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,29 @@
# Water 2D Surface for Unity
# 2D Water surface in Unity3D

A simple shader + example of a water surface with reflection in 2D.
![screenshot](screenshot.gif)

![Screenshot](screenshot.gif)
## Description

See the [blog post with more info](TODO).
A 2D water surface that will deform what is "underwater".

Made with Unity 5.2.4f1.
More details in [my blog post](http://dmayance.com/water-surface-2d-unity/).

Made with Unity 5.4.3f1 but should work on all Unity 5 versions.

*Not enough tested on mobile and not tested at all on consoles*

## Usage

1. Clone this repository or download the latest [release package available](https://github.com/valryon/water2d-unity/releases).

2. Add the "Water2D Surface" prefab in your scene. This is now your water.

3. Tweak the sprite order/layer of the surface

4. Add a `WaterReflectableScript` to any object you want to be reflected in the water

Enjoy! You can also simply place sprites under water using sprite layers/order.

## Credits

Demo assets made by the [Superpower team](https://github.com/sparklinlabs/superpowers-asset-packs).
Binary file modified screenshot.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c1b9345

Please sign in to comment.