| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273 |
- # World Builder Sample Scene
- This a sample scene for the "World Builder" feature. This feature is still in
- experimental status, so use it with care!
- The basic idea of the "World Builder" is that you can add, place and adjust
- objects at runtime, and save the session so that it persists when the app is
- closed.
- This can be used to provide final users to create persistent experiences, or for
- developers to create experiences by manipulating objects "on-site", saving the
- resulting data to be loaded when the final user runs the app.
- In this sample, each time the app is closed, the World Session is serialized and
- saved on local storage; and each time opens, it loads the saved session and
- restores it. This is regulated by the "UseLocalStorege" option in the
- "WorldBuilder" component. If this is enabled, the session will be saved in local
- storage to a file named $"{id}.json". If you disable this option the session
- won't be saved or loaded automatically. In this case, you can use the `ToJson`
- and `FromJson` methods to serialize/deserialize the "World Session" manually.
- That way you can, for instance, save the session on a server via network
- requests, allowing for persistent world sessions in the cloud.
- The "World Builder Application Controller" is an implementation of a simple
- application that uses the World Builder to position and adjust objects. It can
- serve as a base for you to modify and customize it to your needs.
- This controller has a very simple UI. In the main view, you choose which one of
- the 3 prefabs you want to place in the world. To place them, just touch the
- screen on the location.
- After an object is placed, you can select it by touching the object. That will
- change the UI, which will now display buttons for object adjustment; you can
- adjust the y-axis rotation by dragging horizontally, move the object to another
- location by touching the screen, or change its height by dragging vertically.
- # Using a Web Server
- As it is, the scene is fully usable, and the session will be persistent via
- local storage.
- There is support for primitive server/network persistency in the
- `WorldBuilderApplicationController`. To use it, check the "Save To Server"
- option, and set the URLs for the save and load endpoints.
- There is an example server in this repository: https://github.com/dmbfm/unity-ar-gps-location-world-builder-server
- To use it on the field, you need to set up a live server running this as https.
- To test it locally, clone the repository, run:
- > npm install
- > npm start
- That will start a server on `http://localhost:3000` by default, but you can
- change the hostname and port by editing the `server.js` file.
- But you also need to tunell this server to a https endpoint. The easiest way to
- do that is to use ngrok (https://ngrok.com/). After downloading and settinup
- ngrok according to their instructions, run:
- > ngrok http 3000
- And that should create a tunnell with an adress like
- 'https://{some_id}.ngrok.io'. Then all you need to do is set "Save World URL"
- to:
- 'https://{some_id}.ngrok.io/save/'
- and "Restore World URL" to
- 'https://{some_id}.ngrok.io/world/'
|
