Updated documentation to version 1.1.0

Author: ChristopherRemde

docs/content/docs/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "cSpell.words": [
+        "autoplay",
+        "datapath",
+        "pointcloud"
+    ]
+}

docs/content/docs/about/changelog.md

@@ -13,6 +13,26 @@ weight: 420
 toc: true
 ---
 
+### Version 1.1.0
+
+Added features:
+
+- Huge overhaul of the playback system. Performance is enhanced by up to 10x-20x.
+- Pointcloud geometry shaders have been replaced by a compute shader system
+- Mac, Iphone, Ipad and VisionOS (Assets store version only) platforms are now supported
+- Compressed .astc textures for mobile devices are now supported
+- Converter Tool supports reduction of pointcloud sizes
+- More reliable playback. Lags, or low framerates don't affect the playback speed anymore
+- Added frame debugging/performance tools
+- URP and HDRP render pipelines are now supported
+- Unity 6000 is now supported
+
+Fixed Issues:
+
+[#7 "visionOS Support"](https://github.com/BuildingVolumes/Unity_Geometry_Sequence_Streaming/issues/7)
+
+[#5 "Pointcloud shader not working on Metal/OpenGL](https://github.com/BuildingVolumes/Unity_Geometry_Sequence_Streaming/issues/5)
+
 ### Version 1.0.3
 
 Added features:

docs/content/docs/about/license-credits.md

@@ -13,13 +13,14 @@ weight: 430
 toc: true
 ---
 
-The Unity package, the Converter tool, the example data and this website is licensed under the ***MIT License.***
+The open source Unity package, the Converter tool, the example data and this website is licensed under the ***MIT License.***
 **If you use this package in your project, we'd be grateful if you would credit us in your project**
 
-## MIT License
+The Unity Asset Store version of the package is licensed under the [Unity Standard Asset Store license](https://unity.com/legal/as-terms)
 
-Copyright 2023 [Christopher Remde](chrisrem.de/) @ [Charité Experimental Surgery](https://www.experimental-surgery.de/) & [Hunter Dyar](https://hdyar.com/)
+## MIT License
 
+Copyright 2025 [Christopher Remde](chrisrem.de/)
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

docs/content/docs/help/contact.md

@@ -1,5 +1,5 @@
 ---
-title: "Contact"
+title: "Contact us"
 description: ""
 lead: ""
 date: 2020-11-12T13:26:54+01:00
@@ -13,10 +13,8 @@ weight: 320
 toc: true
 ---
 
-👋🏻 For cooperation proposals, contributions to the project, or anything else, please contact us here:
+👋🏻 For feature requests, contributions to the project, or anything else, please contact us here:
 
 📧 [Send a mail to the author (Christopher Remde):](mailto:[email protected]) hey [at] chrisrem.de
 
 👾 [Join us in our BuildingVolumes community discord server](https://discord.gg/BvQdJdJqu6)
-
-> ☝🏻 If you have an issue in the project, or you encounter any bugs, please don't contact us here, but instead [open an issue on Github!](/Unity_Geometry_Sequence_Streaming/docs/help/issues/)

docs/content/docs/help/issues.md

@@ -1,5 +1,5 @@
 ---
-title: "Issues and bugs"
+title: "Support"
 description: ""
 lead: ""
 date: 2020-10-06T08:49:31+00:00
@@ -13,13 +13,14 @@ weight: 310
 toc: true
 ---
 
-#### ⁉️ Questions
+#### ⭐ Direct support (Unity Asset Store version)
 
-For any questions regarding the package, tips, or smaller issues that are occuring, please feel free to ask
-anything in our [Unity Forums thread](https://forum.unity.com/threads/released-geometry-sequence-streaming.1453765/)!
+If you've bought the package on the Unity Asset Store, you can contact us directly via email for fast and direct support. You can find the email address in the **Geometry Sequence Stream component** under the **Get Support** foldout. ![Email](support.png)
 
-#### 🪲 Bugs
+#### General support
 
-If you encounter any bugs, eorrs or issues, please report them [here in the main Github repository](https://github.com/BuildingVolumes/Unity_Geometry_Sequence_Streaming/issues) 🪲
+For any questions regarding the package, tips, or errors that are occurring, please feel free to ask anything in our [Unity Forums thread](https://forum.unity.com/threads/released-geometry-sequence-streaming.1453765/).
+
+Bugs and issues can also be reported [here in the main Github repository](https://github.com/BuildingVolumes/Unity_Geometry_Sequence_Streaming/issues) 🪲
 
 >💡 Do a quick search first, if your issue has already been reported. If not, please open a new one, and we'll get back to you!

docs/content/docs/help/support.png

@@ -13,26 +13,28 @@ weight: 30
 toc: true
 ---
 
-> 👉🏻 This is just a quick summary of the conversion process, more details can be [found here](/Unity_Geometry_Sequence_Streaming/docs/tutorials/preparing-your-sequences/)
+> ⤴️ Sequences that were created before package version 1.1.0 are not compatible with the current package. Please re-convert these files with the latest Converter.
 
 ## Conversion
 
 1. Ensure that in your input sequence, each frame file is numbered in an ascending order
 
-2. Almost all commonly used pointcloud/mesh (.fbx .obj .gltf .ply .xzy) and image (.dds .jpeg .png .tga) formats can be used as source material. Ensure that your sequence is in such a format
+2. Almost all commonly used pointcloud (.ply, .xyz), mesh (.fbx .obj .gltf) and image (.jpeg .png .tga) formats can be used as source material. Ensure that your sequence is in such a format
 
 3. Download the latest converter [binaries for windows here](https://github.com/BuildingVolumes/Unity_Geometry_Sequence_Streaming/releases) (The file named Geometry_Sequence_Converter_Win64.zip)
 
-4. Unzip, open the converter, and set the **input folder** to the folder containing your sequence. The **output folder** should be set to a different (empty) folder. Click on **Start Conversion**.
+4. Unzip, open the converter, and set the **input folder** to the folder containing your sequence. You can optionally set an output folder, otherwise a new folder will be automatically created. Click on **Start Conversion**.
 
     ![The converter](Converter_Start_Threads.png)
 
+[More infos](/Unity_Geometry_Sequence_Streaming/docs/tutorials/preparing-your-sequences/)
+
 ## Playback in Unity
 
 1. Open your project and scene in Unity.
 
 2. Add a **GeometrySequencePlayer** component to any gameobject.
 
-3. Click on **Open Sequence** and open the folder with the converted sequence (the output folder).
+3. Click on **Open Sequence** and open the ***sequence.json*** file contained in the converted sequence folder (the output folder).
 
-4. Click on Play in Unity. Your scene should now start with the playback/streaming.
+4. Click on Play in Unity.

docs/content/docs/quickstart/own-data-usage/Converter_Start_Threads.png

@@ -15,22 +15,34 @@ toc: true
 
 ## Install the package
 
-1. Open your Unity project, and in the **toolbar**, go to **Windows –> Package Manager.**
+> ⭐ For installation of the Unity Store Version, see section below
 
-2. In the **Package Manager window**, go into the upper left corner and click on the **"+" Button –> Add package from Git URL.**
+1. Open your Unity project, and in the **toolbar** go to **Windows –> Package Manager**.
+
+2. In the **Package Manager window**, go into the upper left corner and click on the **"+" Button –> Add package from Git URL**.
 
 3. Copy and paste the following URL into the field and click **Add**: `https://github.com/BuildingVolumes/Geometry_Sequence_Streaming_Package.git`
 
-4. To install the samples, select the Geometry Streaming Sequence package and open the **Sample foldout**. Then click on **Import**.
+[More info](/docs/tutorials/unity-package-installation/)
+
+## Install the package (Unity Store Version)
+
+1. Open your Unity project, and in the **toolbar** go to **Windows –> Package Manager**.
 
-[More info](/Unity_Geometry_Sequence_Streaming/docs/tutorials/unity-package-installation/)
+2. In the **Package Manager window**, go to **My Assets** and select the **Geometry Sequence Streaming** package.
+
+3. Click on the **Install** Button.
+
+[More info](/docs/tutorials/unity-package-installation/)
 
 ## Play your first sequence
 
-1. In your assets folder, go into the samples folder(s) and open the Sample scene *01_Basic_Example*
+1. Install the samples into your project by going into **Package Manager –> In Project**. Select the **Geometry Streaming Sequence package** and open the **Sample foldout**. Then click on **Import**.
+
+2. In your assets folder, go into `Samples -> Geometry Sequence Streaming -> 1.X.X -> Streaming Samples`  and open the Sample scene ***01_Basic_Example***
 
-2. Click on the **"Play"-Button** in Unity. You should now see a box with a twisting animation. This uses a sequence also found in the sample folder
+3. Click on the **"Play"-Button** in Unity. You should now see an animated blob.
 
-![A spinning box](https://media3.giphy.com/media/v1.Y2lkPTc5MGI3NjExNDMwZTkyOTEzZjRiM2M5ZWI4ZTc1NmEyNjIzZjg2OTU4MzRlZGQ0NCZlcD12MV9pbnRlcm5hbF9naWZzX2dpZklkJmN0PWc/cxJpQmE5QeReOgx16L/giphy.gif)
+[More info](/docs/tutorials/basic-playback/)
 
-[More info](/Unity_Geometry_Sequence_Streaming/docs/tutorials/basic-playback/)
+![Blob](https://media3.giphy.com/media/v1.Y2lkPTc5MGI3NjExYmVvbXVpazdyanR0dmxyNDhjazNkM3owcnV3NHlwMWFseDRpemoyeiZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/XuN1lmgwobrU8eWgsb/giphy.gif)

docs/content/docs/quickstart/own-data-usage/index.md

@@ -0,0 +1,32 @@
+---
+title: "Apple Vision Pro"
+description: "Special considerations for the Apple Vision Pro platform"
+lead: "Apple Vision Pro "
+date: 2020-11-16T13:59:39+01:00
+lastmod: 2020-11-16T13:59:39+01:00
+draft: false
+images: []
+menu:
+  docs:
+    parent: "tutorials"
+weight: 170
+toc: true
+---
+
+> ⭐ Building for the Apple Vision Pro is only supported in the Unity Asset Store version
+
+## Considerations when building for the Apple Vision Pro
+
+Unity Apps can run in three distinct modes on the Apple Vision Pro: A **flat 2D mode**, where apps appear on a virtual screen, the **bounded mode**, and the **immersive mode**.
+All modes are supported by this plugin. While the **flat mode** runs like an IPhone or IPad application, there are stark differences between the **bounded** and **immersive** mode.
+We generally recommended to use the **immersive** mode whenever you can, due to it's much higher performance capabilities.
+
+### Bounded mode
+
+The bounded mode lets the users run an app along other apps, inside a limited volume, comparable to a 3D window. Apps running in this mode face many restrictions, including not being able to render their content natively. Unity needs to translate all meshes, textures, materials and shaders to RealityKit equivalents, this is called the **PolySpatial** pipeline. Due to these restrictions, playback performance suffers and works only for smaller sequences. Pointclouds sequences should stay under **50.000 points per frame**, mesh sequences under **30.000 polygons per frame**, and textures at or under **2048x2048 texture resolution** per frame. Additionally, there might be a performance ditch when the sequence starts, especially for pointcloud sequences. These are gradually streamed in to not overload the system.
+
+Bounded mode is usually detected automatically. For this to work, you need to have a volume camera component inside your scene.
+
+### Immersive mode
+
+Immersive mode lets the application take over the full rendering on the Apple Vision Pro, which is much more comparable to how apps are run on other headsets, such as the Meta Quest. While no other content than the application can exist in the same space, this mode **increases performance** by a huge margin compared to the bounded mode. We were able to run sequences with 1.5 millions points per frame and more! Please ensure that **no volume camera exists** in your scene if you use this mode, otherwise the bounded rendering path might get erroneously activated by the Geometry Sequence Streaming package.