Skip to content

Commit e5fbf18

Browse files
authored
Update README.md
1 parent ce72082 commit e5fbf18

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,18 @@
11
# FlexSharpUnity
2-
2+
An implementation of Nvidia Flex in Unity!
3+
4+
## Intro:
5+
This library should allow easy developement in Unity using NvFlex in both dots and non-dots environments! (dots currently not done yet)
6+
7+
## Current State:
8+
Currently this library is early in development, so far this is what has been done:
9+
- fluids
10+
- solver parameters
11+
- basic shape collisions (cube and sphere, no mesh support currently)
12+
- infinite planes (occasionally causes crashes though)
13+
- basic rendering (can render as spheres to a unity particle system currently)
14+
15+
## How To Use:
16+
17+
For the most basic example all you need is a flex container with planes setup for your particles to collide with, and then an emitter to emit fluid particles!
18+
I would highly recommend downloading the official NvFlex demo app and choosing the solver parameters based off of scenes from there (also check their manual, it is very helpful).

0 commit comments

Comments
 (0)