Skip to content

Commit

Permalink
Added info to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
williambl committed Dec 14, 2017
1 parent 5654148 commit f059b3f
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
# unity-destruction

An open-source script to destroy objects realistically in Unity3D.

## Features

- Make stuff break up on impact with other stuff!
- Make stuff break up when there's nothing underneath supporting it!
- Make stuff break up for no reason whatsoever!
- Make stuff explode!
- Make stuff make sounds when it breaks up!
- Make stuff make particles when it breaks up!
- Includes an example game where you can throw a ball at a cube. It's more fun than it sounds.

## How to use

- Make an unbroken and a broken version of your object. I recommend using Blender's [cell fracture](https://duckduckgo.com/?q=blender+cell+fracture) feature.
- Add 'Destruction/Assets/Scripts/Destruction.cs' to the unbroken one.
- Mess with the settings until you get the breaking apart effect how you want it.
- For examples, see 'Destruction/main.unity'.
- Use Destruction.Break() to break things via a script, or Destruction.BreakWithExplosiveForce(float, float) to break things with explosive force via a script.

0 comments on commit f059b3f

Please sign in to comment.