Skip to content

Commit

Permalink
Added new banner to readme and removed the low quality example gifs
Browse files Browse the repository at this point in the history
  • Loading branch information
keenanwoodall committed Jan 23, 2020
1 parent 0f05f26 commit 46a0bcc
Show file tree
Hide file tree
Showing 6 changed files with 46 additions and 26 deletions.
25 changes: 2 additions & 23 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![Header](https://imgur.com/NpPsjQj.png)
![Header](images/banner.png)

[![Unity Version](https://img.shields.io/badge/unity-2018.3%2B-blue.svg)](https://unity3d.com/get-unity/download)
[![GitHub](https://img.shields.io/github/license/keenanwoodall/Deform.svg)](https://github.com/keenanwoodall/Deform/blob/master/LICENSE.txt)
Expand Down Expand Up @@ -65,25 +65,4 @@ Deform runs on the CPU. While it *is* incredibly fast, you should not expect to

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/KeenanWoodall)
[![Donate](https://img.shields.io/badge/Donate-Kofi-green.svg)](https://ko-fi.com/keenanwoodall)
[![Itch](https://img.shields.io/badge/Buy-Itch.io-green.svg)](https://keenanwoodall.itch.io/deform)

---

## Example GIFs
<table>
<tr>
<td><img src="https://i.imgur.com/h3ZcNEC.gif"></td>
<td><img src="https://i.imgur.com/LAzo6kT.gif"></td>
<td><img src="https://i.imgur.com/CgxWUod.gif"></td>
</tr>
<tr>
<td><img src="https://i.imgur.com/7BSjdJF.gif"></td>
<td><img src="https://i.imgur.com/uFzvAlF.gif"></td>
<td><img src="https://i.imgur.com/UoDy1ZC.gif"></td>
</tr>
<tr>
<td><img src="https://i.imgur.com/h2D0KDV.gif"></td>
<td><img src="https://i.imgur.com/Il2oGLH.gif"></td>
<td><img src="https://i.imgur.com/PQrbXrY.gif"></td>
</tr>
</table>
[![Itch](https://img.shields.io/badge/Buy-Itch.io-green.svg)](https://keenanwoodall.itch.io/deform)
Binary file added .github/images/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions EditorResources/DeformSettings.asset
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ MonoBehaviour:
m_Name: DeformSettings
m_EditorClassIdentifier:
sceneFoldoutOpen: 1
solidHandleColor: {r: 1, g: 0.40000004, b: 0, a: 1}
lightHandleColor: {r: 1, g: 0.40000004, b: 0, a: 0.5}
solidHandleColor: {r: 1, g: 0.4, b: 0, a: 1}
lightHandleColor: {r: 1, g: 0.4, b: 0, a: 0.5}
dottedLineSize: 5
screenspaceHandleCapSize: 0.0275
screenspaceAngleHandleSize: 1.25
2 changes: 1 addition & 1 deletion EditorResources/DeformSettings.asset.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

34 changes: 34 additions & 0 deletions README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
DOCUMENTATION
----------------
More extensive documentation and written/video tutorials can be found on Deform's wiki: https://github.com/keenanwoodall/Deform/wiki


INSTALLATION
----------------
Deform has dependencies on the Burst and Mathematics packages. These packages are referenced by Deform via asmdef files.
If you install Deform from the Asset Store before installing its dependencies it may lose references to the packages.

If you installed Deform before installing Burst and Mathematics install Burst and Mathematics from the Package Manager.
The references to the packages should be fixed, but if they aren't go to the asmdef file under Deform/Code/Runtime and manually assign them.


GETTING STARTED
----------------
After installing, the first thing you'll probably want to do is deform a mesh. Every mesh that you want to deform must have a Deformable component added to it.
This component is a little manager for the mesh. Once your mesh has a Deformable component you can add Deformer components to the Deformable's list of deformers to modify the mesh.

You can create these components like any other component (from the "Add Component" button in the Inspector), but an alternative way is to use the Creator window.
This window lets you create deformable meshes and add deformers much more efficiently.

You can open the Creator window from either the Tools/Deform/Creator or Window/Deform/Creator menu item.

Remember, almost every deformer operates in worldspace. Most deformers have a Transform property called Axis. If left blank, the deformer will use its own transform as the axis.
This axis is used as the position, rotation and scale of the deformer i.e. all deformation will be relative to it. For example, the Magnet deformer will push/pull vertices from its axis' position.


SUPPORT
----------------
If you run into any issues please submit them here https://github.com/keenanwoodall/Deform/issues/new
If you any questions feel free to email me at keenanwoodall@gmail.com

I'll do my best to respond and solve any issues but keep in mind that this is a free asset and I won't be able to dedicate all my time to supporting it.
7 changes: 7 additions & 0 deletions README.txt.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 46a0bcc

Please sign in to comment.