diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..6046ba0 --- /dev/null +++ b/README.txt @@ -0,0 +1,17 @@ +# Cellulo in Unity 3D + +Installation: +1. Need Qt and access to `cellulo-qml-plugin` on c4science through ssh +2. `git submodule init; git submodule update` +3. Using qt, build the project `cellulo-unity.pro` for your architecture +4. Add the resulting file `libcellulo-unity.so` as a Unity asset to your project +5. Use the C# class `EscapeTheGhost/Assets/Cellulo.cs` in your project to wrap the C calls to Cellulo + + +Example (in progress...) + +The project EscapeTheGhost is a simple demo with two Cellulos where one of them is a ghost and is dangerous when is red. +The other Cellulo is the player and it must be moved to the goal while avoiding the ghost and other obstacles. +When the robot hits the obstacle, it vibrates and returns to start of the level (level failed). + +2D GUI interface shows some info.