Skip to content

Commit 2128d65

Browse files
Updated links on documentation website
1 parent f154714 commit 2128d65

File tree

9 files changed

+16
-30
lines changed

9 files changed

+16
-30
lines changed

docs/content/docs/help/contact.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ weight: 320
1313
toc: true
1414
---
1515

16-
> 🆘 Do you need help with the package? [Please see here](/docs/help/support/)
16+
> 🆘 Do you need help with the package? [Please see here](/Unity_Geometry_Sequence_Player/docs/help/support/)
1717
1818
For anything besides support, like Pull Requests, collaborations, or special feature requests, please contact us here:
1919

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ toc: true
2727

2828
![The converter](Converter_Start_Threads.png)
2929

30-
[More infos](/docs/tutorials/preparing-your-sequences/)
30+
[More infos](/Unity_Geometry_Sequence_Player/docs/tutorials/preparing-your-sequences/)
3131

3232
## Playback your sequence
3333

@@ -39,4 +39,4 @@ toc: true
3939

4040
4. Click on Play in Unity.
4141

42-
[More infos](/docs/tutorials/playback/)
42+
[More infos](/Unity_Geometry_Sequence_Player/docs/tutorials/playback/)

docs/content/docs/quickstart/quick-start/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ If you still have the old version, we recommend to remove it and then reinstall
2626

2727
3. Copy and paste the following URL into the field and click **Add**: `https://github.com/BuildingVolumes/Geometry_Sequence_Player_Package.git`
2828

29-
[More info](/docs/tutorials/installation/)
29+
[More info](/Unity_Geometry_Sequence_Player/docs/tutorials/installation/)
3030

3131
### Install the package (From Unity Store)
3232

@@ -36,7 +36,7 @@ If you still have the old version, we recommend to remove it and then reinstall
3636

3737
3. Click on the **Install** Button.
3838

39-
[More info](/docs/tutorials/installation/#package-installation-unity-store-version)
39+
[More info](/Unity_Geometry_Sequence_Player/docs/tutorials/installation/#package-installation-unity-store-version)
4040

4141
## Play a sample sequence
4242

@@ -48,4 +48,4 @@ If you still have the old version, we recommend to remove it and then reinstall
4848

4949
![Blob](https://media3.giphy.com/media/v1.Y2lkPTc5MGI3NjExYmVvbXVpazdyanR0dmxyNDhjazNkM3owcnV3NHlwMWFseDRpemoyeiZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/XuN1lmgwobrU8eWgsb/giphy.gif)
5050

51-
[More info](/docs/tutorials/installation/#importing-the-samples)
51+
[More info](/Unity_Geometry_Sequence_Player/docs/tutorials/installation/#importing-the-samples)

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ toc: true
1818

1919
After you've prepared and converted your sequence, you can now play them back in Unity! This section shows you how to use the streaming and playback components inside of the editor and how to setup a simple playback scene.
2020

21-
> 💡 All of the features explained here in this tutorial can also be found in the Sample Scene [01_Basic_Sample](/docs/tutorials/installation/#importing-the-samples)
21+
> 💡 All of the features explained here in this tutorial can also be found in the Sample Scene [01_Basic_Sample](/Unity_Geometry_Sequence_Player/docs/tutorials/installation/#importing-the-samples)
2222
2323
## Playback
2424

@@ -29,7 +29,7 @@ After you've prepared and converted your sequence, you can now play them back in
2929
![Add component](editor_playback_add_component.png)
3030

3131
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 open the **sequence.json** from the folder in which your converted sequence is stored. It is strongly recommended to store your sequence on the fastest drive available, preferably an SSD.
32-
> ⚠️ When you're just testing, or you don't intent to distribute your app to other PCs than your own, 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-platforms/)!
32+
> ⚠️ When you're just testing, or you don't intent to distribute your app to other PCs than your own, it's fine to store the sequence anywhere on disk. However, if you plan to distribute your application, [please take a look here](/Unity_Geometry_Sequence_Player/docs/tutorials/distribution-platforms/)!
3333
3434
![Open Sequence](editor_playback_open_sequence.png)
3535

@@ -60,7 +60,7 @@ Detailed explanation of all the settings and controls inside of the player and s
6060

6161
**Loop playback:** If activated, repeats the animation indefinitely
6262

63-
**Events:** With this Unity Event control, you can assign scripts that should receive events from the player. [More on Events](/docs/tutorials/scripting-api/#events)
63+
**Events:** With this Unity Event control, you can assign scripts that should receive events from the player. [More on Events](/Unity_Geometry_Sequence_Player/docs/tutorials/scripting-api/#events)
6464

6565
**Playback controls:** Use the slider to skip to any time in the sequence, just like in a regular video player. On the right, you can see at which frame the playback is right now, and how many frames there are in total in the sequence. Use the **|<** Button to go back to the start of the sequence, the **<<** and **>>** to scroll forwards/backwards for a few frames, the **Stop** Button to stop playback and the **Play/Pause** button to pause/resume the playback. These controls are only available in the editor.
6666

docs/content/docs/tutorials/installation/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ If you still have the old version, we recommend to remove it and then reinstall
2626

2727
3. Copy and paste the following URL and click **Add**: `https://github.com/BuildingVolumes/Geometry_Sequence_Player_Package.git` ![Installing a package](package_manager_add.png)
2828

29-
4. Unity now installs the package, and after a short time it should show up in your manager. Done! We strongly recommend that you also install the [Samples](/docs/tutorials/unity-package-installation/#importing-the-samples)
29+
4. Unity now installs the package, and after a short time it should show up in your manager. Done! We strongly recommend that you also install the [Samples](/Unity_Geometry_Sequence_Player/docs/tutorials/unity-package-installation/#importing-the-samples)
3030

3131
## Package Installation (Unity Store Version)
3232

3333
1. Open your Unity project, and in the toolbar, go to **Windows --> Package Manager**.
3434

3535
2. In the Package Manager window, go to **My Assets**, select the **Geometry Sequence Player Package** and click on **Install** ![Select Unity Store Version](package_manager_install_storebought.png)
3636

37-
3. Unity now installs the package, and after a short time it should show up in your manager. Done! We strongly recommend that you also install the [Samples](/docs/tutorials/unity-package-installation/#importing-the-samples)
37+
3. Unity now installs the package, and after a short time it should show up in your manager. Done! We strongly recommend that you also install the [Samples](/Unity_Geometry_Sequence_Player/docs/tutorials/unity-package-installation/#importing-the-samples)
3838

3939
## Importing the samples
4040

docs/content/docs/tutorials/scripting-api/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ toc: true
1717

1818
Besides playback from the timeline and the editor controls, this package also features a API, so that you can control playback from your own scripts. This is for example useful, if you want to let the user control playback via UI buttons, or you want to interactively integrate the player into your experience!
1919

20-
> 💡 All of the features explained here in this tutorial can also be found in the Sample Scene [04_API_Example](/docs/tutorials/installation/#importing-the-samples)
20+
> 💡 All of the features explained here in this tutorial can also be found in the Sample Scene [04_API_Example](/Unity_Geometry_Sequence_Player/docs/tutorials/installation/#importing-the-samples)
2121
2222
## Setup
2323

@@ -65,7 +65,7 @@ You can the load your sequence with the **OpenSequence()** function at any point
6565
player.OpenSequence("C:\MySequences\MyOwnSequence\", GeometrySequencePlayer.PathType.AbsolutePath, 30, true);
6666
```
6767

68-
👉 For an overview about the API Features, take a look at the [Scripting Reference](/docs/tutorials/scripting-api/#scripting-reference)
68+
👉 For an overview about the API Features, take a look at the [Scripting Reference](/Unity_Geometry_Sequence_Player/docs/tutorials/scripting-api/#scripting-reference)
6969

7070
## Events
7171

docs/content/docs/tutorials/timeline-integration/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ toc: true
1717

1818
For playback scenarios, where a precise control of the playback, or cohesive animation with other objects is needed, the package also supports the playback from the Unity Timeline.
1919

20-
> 💡 All of the features explained here in this tutorial can also be found in the Sample Scene [03_Timeline_Example](/docs/tutorials/installation/#importing-the-samples)
20+
> 💡 All of the features explained here in this tutorial can also be found in the Sample Scene [03_Timeline_Example](/Unity_Geometry_Sequence_Player/docs/tutorials/installation/#importing-the-samples)
2121
2222
## Setting up a timeline clip
2323

docs/hugo_stats.json

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -240,12 +240,8 @@
240240
"wrap"
241241
],
242242
"ids": [
243-
"--when-youre-just-trying-out-playback-on-your-machine-or-you-dont-intent-to-distribute-your-app-to-other-pcs-its-fine-to-store-the-sequence-anywhere-on-disk-however-if-you-plan-to-distribute-your-application-please-take-a-look-hereunity_geometry_sequence_playerdocstutorialsdistribution",
244-
"-for-an-overview-about-the-api-features-take-a-look-at-the-scripting-referenceunity_geometry_sequence_playerdocstutorialsscripting-apiscripting-reference",
245243
"-priority-support-unity-asset-store-version",
246-
"3-copy-and-paste-the-following-url-into-the-field-and-click-add-httpsgithubcombuildingvolumesgeometry_sequence_player_packagegit",
247244
"TableOfContents",
248-
"actual-fps--frame-drop-8",
249245
"android",
250246
"apple-vision-pro",
251247
"bounded-mode",
@@ -257,7 +253,6 @@
257253
"credits",
258254
"doks-docs-nav",
259255
"events",
260-
"events-7",
261256
"for-developers-format-specification",
262257
"general-support",
263258
"getabsolutesequencepath",
@@ -283,10 +278,8 @@
283278
"h-rh-i-7",
284279
"h-rh-i-8",
285280
"hide",
286-
"if-you-encounter-any-bugs-eorrs-or-issues-please-report-them-here-in-the-main-github-repositoryhttpsgithubcombuildingvolumesunity_geometry_sequence_playerissues-",
287281
"immersive-mode",
288282
"importing-the-samples",
289-
"in-unity-you-need-to-store-all-assets-loaded-at-runtime-in-a-streamingassetshttpsdocsunity3dcommanualstreamingassetshtml-folder-exept-for-android-buildsunity_geometry_sequence_playerdocstutorialsdistributionandroid-located-inside-of-the-asset-path-root-and-store-all-geometry-sequences-in-there-this-folder-will-be-copied-into-your-build-as-is",
290283
"install-the-package",
291284
"install-the-package-from-unity-store",
292285
"installing-the-converter",
@@ -295,10 +288,7 @@
295288
"isinitialized",
296289
"isplaying",
297290
"loadcurrentsequence",
298-
"loop-playback-6",
299291
"mesh-ply-files",
300-
"more-infounity_geometry_sequence_playerdocstutorialsbasic-playback",
301-
"more-infounity_geometry_sequence_playerdocstutorialsunity-package-installation",
302292
"naming",
303293
"offcanvasNavMain",
304294
"offcanvasNavMainLabel",
@@ -308,13 +298,10 @@
308298
"opensequence",
309299
"package-installation",
310300
"package-installation-unity-store-version",
311-
"package-release-v101httpsgithubcombuildingvolumesgeometry_sequence_player_packagereleasestagv100",
312301
"pause",
313302
"play",
314303
"play-a-sample-sequence",
315-
"play-at-start-5",
316304
"playback",
317-
"playback-controls-9",
318305
"playback-your-sequence",
319306
"player-component",
320307
"playfromstart",
@@ -345,7 +332,6 @@
345332
"texturesimages",
346333
"toc",
347334
"unity-asset-store-license",
348-
"use-the--button-to-go-back-to-the-start-of-the-sequence-the--and--to-scroll-forwardsbackwards-for-a-few-frames-the-stop-button-to-stop-playback-and-the-playpause-button-to-pauseresume-the-playback-these-buttons-are-only-available-in-the-editor",
349335
"using-the-converter",
350336
"version-100",
351337
"version-101-package-only",

docs/layouts/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ <h1>{{ "Geometry Sequence Player" }}</h1>
88
<p class="lead">{{ "Pointcloud and mesh sequence playback for the Unity game engine" | safeHTML }}</p>
99
<iframe width="560" height="315" src="https://www.youtube.com/embed/5HA_HwtjIu0?si=jABu90IDcO-Vn3Hx" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
1010
<p class="meta"> This package is provided <b>open-source and free</b> for non-commercial projects. If you want to use the package in a <b>commercial project</b>, or <b>support the development</b>, you can buy also the package in the Unity Asset Store. </p>
11-
<a class="btn btn-primary btn-cta rounded-pill btn-lg my-3" href="/docs/quickstart/quick-start/" role="button">Get Started now</a>
11+
<a class="btn btn-primary btn-cta rounded-pill btn-lg my-3" href="/Unity_Geometry_Sequence_Player/docs/quickstart/quick-start/" role="button">Get Started now</a>
1212
<p class="meta"> ______________________________________ </p>
1313

1414
<a class="btn btn-primary btn-cta rounded-pill btn-lg my-3" href="https://assetstore.unity.com/packages/slug/307918" role="button">Buy in Unity Asset Store</a>
@@ -55,7 +55,7 @@ <h2 class="h4">Textured Meshes</h2>
5555
<div class="row justify-content-center text-center">
5656
<div class="col-lg-7">
5757
<h2 class="mt-2">Start building with Doks today</h2>
58-
<a class="btn btn-primary rounded-pill px-4 my-2" href="/docs/{{ if site.Params.doks.docsVersioning }}{{ site.Params.doks.docsVersion }}/{{ end }}prologue/introduction/" role="button">{{ i18n "get-started" }}</a>
58+
<a class="btn btn-primary rounded-pill px-4 my-2" href="/Unity_Geometry_Sequence_Player/docs/{{ if site.Params.doks.docsVersioning }}{{ site.Params.doks.docsVersion }}/{{ end }}prologue/introduction/" role="button">{{ i18n "get-started" }}</a>
5959
</div>
6060
</div>
6161
</section>

0 commit comments

Comments
 (0)