Skip to content

Commit 3113041

Browse files
Added distribution page to documentation
1 parent 59f30f6 commit 3113041

File tree

6 files changed

+62
-2
lines changed

6 files changed

+62
-2
lines changed

docs/content/en/docs/about/changelog.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,20 @@ weight: 130
1313
toc: true
1414
---
1515

16+
### Version 1.0.1 (Package only)
17+
18+
Fixed Issues:
19+
20+
[#1 "Cannot build as AssetDatabase cannot be used outside the editor"](https://github.com/BuildingVolumes/Unity_Geometry_Sequence_Streaming/issues/1)
21+
22+
[#2 "Android /WebGL cannot load data from StreamingAssets Path"](https://github.com/BuildingVolumes/Unity_Geometry_Sequence_Streaming/issues/2)
23+
24+
Releases:
25+
[Package release v1.0.1](https://github.com/BuildingVolumes/Geometry_Sequence_Streaming_Package/releases/tag/v1.0.1)
26+
1627
### Version 1.0.0
1728

1829
Initial Release, this plugin supersedes the [Pointcloud Player Package](https://github.com/ExperimentalSurgery/Unity_Geometry_Sequence_Streaming)
1930

2031
[Converter release v1.0.0](https://github.com/BuildingVolumes/Unity_Geometry_Sequence_Streaming/releases/tag/v1.0.0)
21-
[Package release v1.0.0](https://github.com/BuildingVolumes/Geometry_Sequence_Streaming_Package/releases/tag/v1.0.0)
32+
[Package release v1.0.1](https://github.com/BuildingVolumes/Geometry_Sequence_Streaming_Package/releases/tag/v1.0.0)
4.16 KB
Loading
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: "Distribution"
3+
description: "Build and playback on other devices"
4+
lead: "Build and playback on other devices"
5+
date: 2020-11-16T13:59:39+01:00
6+
lastmod: 2020-11-16T13:59:39+01:00
7+
draft: false
8+
images: []
9+
menu:
10+
docs:
11+
parent: "tutorials"
12+
weight: 160
13+
toc: true
14+
---
15+
16+
## Build and ship
17+
18+
If you intent to distribute your Application built with the Unity Geometry Sequence Streamer, you need to consider where you store your geometry sequence.
19+
In Unity, the best way is to create a [**Streamingassets**](https://docs.unity3d.com/Manual/StreamingAssets.html) folder inside of your root Asset path, and store all geometry sequences in there. This folder will be copied into your build, so that all files remain intact.
20+
21+
1. Inside of the Unity project view, go to the "Assets" folder and create a **Streamingsassets** folder there:
22+
23+
![Add Streamingassets folder in Assets directory](create_streamingassets.png)
24+
25+
2. Copy all your geometry sequences inside of this folder
26+
27+
3. In your Geometry Sequence Player, either set the sequence via **Open Sequence** and then choose the folder inside of your streamingassets path *or* set the **Path Relation** to **Relative to Streamingassets** and then enter the path to your sequence, relative to the Streamingassets folder:
28+
29+
![Set the streamingassets path relation and path](set_streamingassets_path.png)
30+
31+
4. Test your changes and path in playmode, then you can build and distribute your application as usual.
32+
33+
## Android
34+
On Android, the StreamingAssets path is a special case. Data stored into this path, will be compressed into the .apk and needs to be decompressed on load. For large files, like geometry sequences, this will make a noticable impact on playback performance, therefore the Streamingassets path is not supported. On Android, you have to use the applications [**Persistent Data Path**](https://docs.unity3d.com/ScriptReference/Application-persistentDataPath.html). The persistent data path is a special path, which stores data spefically for the appliaction. However Unity won't copy the files automatically on build, you have to **copy them manually**.
35+
36+
> ⚠️The persistent data path will only be generated on the applications first run on the device. So you need to run the application once, then copy the files and then run the application again, or download the files onto the device before the Geometry Sequence Player runs.
37+
38+
1. Inside of your Geometry Sequence Player, set the **Path Relation** to **Relative to Persisten Data Path** and enter the relative path in which you later want to store your sequence, in this example we choose *"Sequence/MySequence"*.
39+
40+
![Set the persistent data path relation and path](set_persistentdata_path.png)
41+
42+
2. Build the android app, install it on your Android device and run it, then quit the app. The Geometry Sequence won't be playing at this point.
43+
44+
3. Connect your device to your PC via USB, enable File transfer and then go to the following path on the device:
45+
*"\Android\data\com.myCompanyName.myProductName\files"*. This is your applications **Persistent Data Path**.
46+
47+
4. Copy your sequence files in the same relative path you set in the Geometry Sequence Player.
48+
49+
5. Now run your app again, you should now see the sequence streaming successfully.
9.87 KB
Loading
14.2 KB
Loading

docs/content/en/docs/tutorials/editor-playback/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ After you've prepared and converted your sequence, you can now stream them from
2727
2. In the inspector, click on **"Add Component"**, search for **"Geometry Sequence Player"** and add this component. ![Add component](editor_playback_add_component.png)
2828

2929
3. You should now see a Geometry Sequence Player and Geometry Sequence Stream component attached to your gameobject. Click on **"Open Sequence"** in the Player script, and then open the folder, in which your converted sequence is stored.
30-
> ⚠️ When you're just trying out playback on your machine, or you don't intent to distribute your app to other PCs, it's fine to store the sequence anywhere on disk. However, if you plan to distribute your application, you need to put your sequence into the [Streaming Assets folder](https://docs.unity3d.com/Manual/StreamingAssets.html)!
30+
> ⚠️ When you're just trying out playback on your machine, or you don't intent to distribute your app to other PCs, it's fine to store the sequence anywhere on disk. However, if you plan to distribute your application, [please take a look here](/docs/tutorials/distribution)!
3131
3232
![Open Sequence](editor_playback_open_sequence.png)
3333

0 commit comments

Comments
 (0)