Skip to content

Commit b85c156

Browse files
committed
Add tutorial on how to operate with the Unity Plugin
1 parent 84c6583 commit b85c156

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed
11.7 KB
Loading

docs/tuto-unity.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Peace: First steps
2+
3+
Peace is the plugin that brings World to Unity (pun intended). Here is a tutorial
4+
step by step on how to implement your first real-time endless generating world
5+
in Unity using World.
6+
7+
## Add the plugin to your project
8+
9+
Go to `Assets > Import Package > Custom Package`.
10+
Select the package in your filesystem (you have to download it first from the
11+
[release page](https://github.com/BynaryCobweb/world/releases)).
12+
A list of files will appear, tick everything if it's not, then confirm your choice.
13+
14+
## Create the scene
15+
16+
- Add a camera. Set the clipping planes to near = 1 and far = 10000. You can add
17+
a camera controller to be able to move in the scene. If you do not have a camera
18+
controller, move the camera to (0, 2500, 0) and point it downward.
19+
- Add empty at (0, 0, 0). You can name it `World`, or anything else that please
20+
you.
21+
- Add a RealTimeWorld script to it. <!--
22+
You can pick the demo you want. Leave empty for default. Available demos are: ... -->
23+
- Drag the camera to the field `Tracking` of the RealTimeWorld component
24+
25+
![Capture of the RealTimeWorld component](images/realtimeworld-config.png)
26+
27+
- Run!
28+
29+
## Future improvements
30+
31+
At the moment the plugin is not very useful, you can only recreate the demo shipped
32+
with the project.
33+
34+
In the near future you will be able to pick a json file containing a description
35+
of your world and explore it in real time in Unity.
36+
37+
<!--
38+
Features I want to implement:
39+
- world autocompletion (interpolation): design your level, put an endlessly
40+
generated world around!
41+
- during level design:
42+
- put an empty somewhere
43+
- Attach a world script that specify: radius, maximum resolution
44+
- Click 'Regenerate' to add all the assets
45+
- Interactive generation: user modification can be returned to world
46+
-->

0 commit comments

Comments
 (0)