From f059b3fdf9f891b26c56185af9dccd93631776dc Mon Sep 17 00:00:00 2001 From: williambl Date: Thu, 14 Dec 2017 16:53:25 +0000 Subject: [PATCH] Added info to README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index e095dcd..0801add 100644 --- a/README.md +++ b/README.md @@ -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.