diff --git a/README.md b/README.md index 3bb13898c1090e43638fd2ac34c23037f4f68a05..187cc5761a80835c1950f890df1809d38df373c9 100644 --- a/README.md +++ b/README.md @@ -16,13 +16,19 @@ Please set up first the path in the Unity manifest.json for the 'Unity World Sto This repo contains submodules corresponding to REST libraries used in the Unity project. Once the git repo is cloned, you need to init and update the submodules through git commands: -* `git submodule init` -* `git submodule update` + + git submodule init + git submodule update + +or clone the repo updating the submodules directly: + + git clone --recurse-submodules https://labs.etsi.org/rep/arf/world-storage-api-helpers/unity-world-storage-editor.git + +Once it's done, you can open your project from the Unity Hub, the project was coded in Unity 2021.3.0 and # Description of UI / editor functions This Unity Editor module allows the user to author the World Storage through various ways. To interact with a server hosting an implementation of the World Storage, the user first must create an Unity object "World Storage Server" via the contextual menu (Create -> ARF World Storage -> Create Server) and then fill the corresponding informations (name, URL, port...). - -<center><i><u> A Unity World Storage Object </u></i></center> +<img src="Images/WorldStorageObject.png" width=35% height=35%> ## World Storage Window @@ -32,7 +38,10 @@ Through the Unity inspector of the World Storage Server, the user can click on t TODO</mark> ## World Graph Window - -<center><i><u> The World Graph Editor Window </u></i></center> +<img src="Images/GraphEditor.png" width=60% height=60%> + +The second tool of this repo is the World Graph Window. From the top toolbar the user has access to the `ARFWolrdStorage` option, from which he can click on the `Edit Graph...` option. This will open the Graph Editor Window. The user can then select the desired World Storage server to interact with. + +After fetching all elements, The user can move them around in the graph, create new ones, modify or delete them. -The second tool of this repo is the World Graph Window. In the top toolbar the user has access to the `ARFWolrdStorage` option from which he can click on the `Edit Graph...` option. This will open the Graph Editor Window. The user can then select the desired World Storage server to interact with. After fetching all elements, The user can move them around in the graph, create new ones, modify or delete them. All changes are done locally, in order to push the modifications to the server, the user has the option to save all elements in the contextual menu or save specific elements in their custom inspectors. Each element type has its custom inspector from which you can modify their attributes and discard or save local changes. \ No newline at end of file +All changes are done locally, in order to push the modifications to the server, the user has the option to save all elements in the contextual menu or save specific elements in their custom inspectors. Each element type has its custom inspector from which you can modify their attributes and discard or save local changes.