Removed lint errors from markdown files

Author: ChristopherRemde

docs/content/en/docs/about/building-volumes.md

@@ -17,4 +17,4 @@ BuildingVolumes is a global initiative by creatives, software engineers, teacher
 
 We want to create free and sustainable tools for small artists, creatives, filmographers, game artists and everyone interested in the creation of Volumetric Video.
 
-If you want to join us, or get in touch, [please head over to our community discord 🙂](https://discord.gg/BvQdJdJqu6)
+If you want to join us, or get in touch, [please head over to our community discord 🙂](https://discord.gg/BvQdJdJqu6)

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

@@ -14,7 +14,6 @@ toc: true
 ---
 
 The 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
@@ -27,7 +26,6 @@ The above copyright notice and this permission notice shall be included in all c
 
 THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-
 ## Credits
 
 The sequences in the showreel, from the landing page and on Github, were created by:

docs/content/en/docs/help/contact.md

@@ -13,12 +13,10 @@ weight: 620
 toc: true
 ---
 
-👋🏻 For cooperation proposals, contributions to the project, or anything else, please contact us here 
+👋🏻 For cooperation proposals, contributions to the project, or anything else, please contact us here:
 
-📧 [Send a mail to the author (Christopher Remde): ](mailto:[email protected]) hey@chrisrem.de
+📧 [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)
 
-<br>
-
-> ☝🏻 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!](docs/help/issues/)
+> ☝🏻 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!](docs/help/issues/)

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

@@ -23,7 +23,7 @@ toc: true
 
 3. Download the converter binaries for windows here.
 
-4. 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. 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**.
 
     ![The converter](Converter_Start_Threads.png)
 
@@ -35,4 +35,4 @@ toc: true
 
 3. Click on **Open Sequence** and open the folder with the converted sequence (the output folder).
 
-4. Click on Play in Unity. Your scene should now start with the playback/streaming.
+4. Click on Play in Unity. Your scene should now start with the playback/streaming.

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

@@ -21,7 +21,7 @@ toc: true
 
 3. Copy and paste the following URL into the field and click **Add**: `https://github.com/Elite-Volumetric-Capture-Sqad/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**. 
+4. To install the samples, select the Geometry Streaming Sequence package and open the **Sample foldout**. Then click on **Import**.
 
 [More info](docs/tutorials/installation/)
 
@@ -33,4 +33,4 @@ toc: true
 
 ![A spinning box](https://media3.giphy.com/media/v1.Y2lkPTc5MGI3NjExNDMwZTkyOTEzZjRiM2M5ZWI4ZTc1NmEyNjIzZjg2OTU4MzRlZGQ0NCZlcD12MV9pbnRlcm5hbF9naWZzX2dpZklkJmN0PWc/cxJpQmE5QeReOgx16L/giphy.gif)
 
-[More info](docs/tutorials/editor-playback/)
+[More info](docs/tutorials/editor-playback/)

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

@@ -15,31 +15,32 @@ toc: true
 
 
 ## Intro
+
 > 💡 All of the features explained here in this tutorial can also be found in the Sample Scene [01_Basic_Example](/docs/tutorials/installation/#importing-the-samples-optional)
 
 After you've prepared and converted your sequence, you can now stream them from your disk right into Unity! This section shows you how to use the streaming and playback components inside of the editor, to setup a simple playback scene.
 
-
 ## Playback
+
 1. Open your Unity scene in which you want to implement the playback. We recommend that you create a new gameobject, onto which you can attach the streaming and playback scripts/components, but you can use any gameobject of your choice. ![New gameobject](editor_playback_gameobject.png)
 
 2. In the inspector, click on **"Add Component"**, search for **"Geometry Sequence Player"** and add this component.  ![Add component](editor_playback_add_component.png)
 
-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. 
-    > ⚠️ 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)! 
+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.
+    > ⚠️ 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)!
   
     ![Open Sequence](editor_playback_open_sequence.png)
 
 4. Set the **playback framerate** of your sequence. This should be the same framerate in which your animated sequence was exported. ![Set FPS](editor_playback_fps.png)
 
 5. Click Play. You should now see your sequence playing back inside of your scene. If you don't see anything, it might simply be because your camera is not looking at the sequence. Go to the scene window, select the "Streamed Mesh" Gameobject and press **"F"** to focus on it. ![Focus Gameobject](editor_playback_focus.png)
 
-
-
 ## Controls & Settings explained
+
 Detailed explanation of all the settings and controls inside of the player and stream scripts
 
 ### Player component
+
 ![All player settings](editor_playback_player_component.png)
 
 **Path relation**
@@ -61,7 +62,7 @@ Should the playback of the sequence start directly when the scene is started/you
 If activated, repeats the animation indefinitly
 
 **Actual FPS / Frame drop**
-This is the actual framerate at which the sequence plays back. If you either see a framerate lower than your target playback FPS, or see lot's of "Frame Dropped!" warning messages, this means that your system doesn't have enough resources to playback the sequence at it's intendet speed. You can either reduce the geometric complexity of your sequence, reduce the texture size, or upgrade your system. 
+This is the actual framerate at which the sequence plays back. If you either see a framerate lower than your target playback FPS, or see lot's of "Frame Dropped!" warning messages, this means that your system doesn't have enough resources to playback the sequence at it's intendet speed. You can either reduce the geometric complexity of your sequence, reduce the texture size, or upgrade your system.
 
 **Time slider**
 Use this 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. The slider is only available in the editor.
@@ -70,12 +71,13 @@ Use this slider to skip to any time in the sequence, just like in a regular vide
 Use the **|<** Button to go back to the start of the sequence, the **<<** and **>>** to scroll forwards/backwards for a few frames, and the **Play/Pause** button to pause/resume the playback. These buttons are only available in the editor.
 
 ### Stream component
+
 ![All player settings](editor_playback_stream_component.png)
 
-These settings, expect for the materials, should usually not need to be adjusted. 
+These settings, expect for the materials, should usually not need to be adjusted.
 
 **Buffer size**
-This size sets how many frames the streaming service will load from disk and store in a buffer in advance of the playback. A larger buffer might provide a smoother playback, however it also uses more memory and skipping/restarting playback might take longer, as the buffer needs to be flushed. 
+This size sets how many frames the streaming service will load from disk and store in a buffer in advance of the playback. A larger buffer might provide a smoother playback, however it also uses more memory and skipping/restarting playback might take longer, as the buffer needs to be flushed.
 
 **Use all threads**
 Should the Unity Job system which is responsible for streaming use all available threads? If you deactive this, you can set the thread count yourself, but note that it will also effect other scripts that might use the job system!

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

@@ -35,4 +35,4 @@ To install the samples, **select** the Geometry Streaming Sequence and open the
 The sample data is now in your Unity assets folder. You can open the sample scenes to take a look how *basic playback*, *timeline playback* and the *scripting API* works.
 If you run any of the samples in play mode, you should see a box spinning! If it doesn't, please report an issue!
 
-![A spinning box](https://media3.giphy.com/media/v1.Y2lkPTc5MGI3NjExNDMwZTkyOTEzZjRiM2M5ZWI4ZTc1NmEyNjIzZjg2OTU4MzRlZGQ0NCZlcD12MV9pbnRlcm5hbF9naWZzX2dpZklkJmN0PWc/cxJpQmE5QeReOgx16L/giphy.gif)
+![A spinning box](https://media3.giphy.com/media/v1.Y2lkPTc5MGI3NjExNDMwZTkyOTEzZjRiM2M5ZWI4ZTc1NmEyNjIzZjg2OTU4MzRlZGQ0NCZlcD12MV9pbnRlcm5hbF9naWZzX2dpZklkJmN0PWc/cxJpQmE5QeReOgx16L/giphy.gif)

docs/content/en/docs/tutorials/prepare-data/index.md

@@ -13,19 +13,20 @@ weight: 110
 toc: true
 ---
 
-> 💡If you want to playback data captured with LiveScan3D, you can skip this step, as it's already in the right format 
+> 💡If you want to playback data captured with LiveScan3D, you can skip this step, as it's already in the right format.
 
 ## Intro
 
-To gurantee high realtime performance, the Geometry Sequence Streamer can only read sequences that are in special file format (.ply for models, .dds for textures). However, to support a
-broad spectrum of input formats and make the usage of this plugin as easy as possible, we provide a small converter tool which takes in almost all widely used mesh and image formats, and converts them 
-into the correct format for the plugin.
+To gurantee high realtime performance, the Geometry Sequence Streamer can only read sequences that are in special file format (.ply for models, .dds for textures). However, to support a broad spectrum of input formats and make the usage of this plugin as easy as possible, we provide a small converter tool which takes in almost all widely used mesh and image formats, and converts them into the correct format for the plugin.
 > 👉🏻 Even when your files are already in the .ply/.dds format, they might need to be run through the converter to be encoded correctly!
 
 ## Preparation for the conversion
+
 ### Naming
+
 In general, you should export your animated mesh or pointcloud sequences from your tool of choice in a way, that each frame of it is saved in a single, independent file. The files should be numbered in some kind of ascending order. This applies to both your models and also textures, if you have any. Save all files into one folder, without subfolders. Example:
-```
+
+```txt
   frame_1.obj
   frame_2.obj
   frame_3.obj
@@ -45,27 +46,30 @@ In general, you should export your animated mesh or pointcloud sequences from yo
 Ensure that the matching images and models for each frame have the same number!
 
 ### Supported file formats
-The format in which you export your sequence shouldn't matter too much, as a wide variety of the most commonly used formats is supported. 
+
+The format in which you export your sequence shouldn't matter too much, as a wide variety of the most commonly used formats is supported.
 These are all supported file formats for pointclouds/meshes:
 
-```
+```txt
 .3ds .asc .bre .ctm .dae .e57 .es .fbx .glb .gltf .obj .off .pdb .ply .pts .ptx .qobj .stl .tri vmi .wrl .x3d .xyz
 ```
 
 And for images:
-```
+
+```txt
 .dds .gif .jpg .png .psd .tga
 ```
 
-
 ## Converting your sequences
 
 ### Installing the converter
+
 1. Download the latest version of the converter tool from here: Download. Currently only windows is supported
 2. Unpack the file
 3. Open the converter. Go into the unpacked folder and open "GeometrySequenceConverter.exe". Windows might throw a warning that it prevented the app from running, in this case click on "Run anyway" or "More info" and then "Run anyway".
 
 ### Using the converter
+
 1. Click on ***Select Input Directory*** ![Converter Select Input](Converter_SelectInput.png)
 
 2. If you don't see any file structure, you may need to click on ***Drives*** ![Converter Select Drive](Converter_SelectDrive.png)
@@ -79,12 +83,14 @@ And for images:
 6. The converter will now process your files and show a progress bar. If you want to cancel the process, click on ***Cancel***. Cancelling might take a bit of time. When the process is done, you'll have the converted sequence inside of the output folder, which you can now move to another location. The files in the output folder will be used to stream the sequence inside of Unity.
 
 ## For developers: Format specification
-If you want to export your data into the correct format directly, without using the converter, you can do so! The format used here is not proprietory, but uses the open [*Stanford Polygon File Format* (.ply)](http://paulbourke.net/dataformats/ply/ ) for meshes and pointclouds and the [*DirectDraw Surface* (.dds)*](https://en.wikipedia.org/wiki/DirectDraw_Surface) file format for textures/images. However, both formats allow a large variety of encoding, and the Geometry Sequence Streamer needs to be supplemented a special encoding. The following sections assume that you are a bit familiar with both formats. 
+
+If you want to export your data into the correct format directly, without using the converter, you can do so! The format used here is not proprietory, but uses the open [*Stanford Polygon File Format* (.ply)](http://paulbourke.net/dataformats/ply/ ) for meshes and pointclouds and the [*DirectDraw Surface* (.dds)*](https://en.wikipedia.org/wiki/DirectDraw_Surface) file format for textures/images. However, both formats allow a large variety of encoding, and the Geometry Sequence Streamer needs to be supplemented a special encoding. The following sections assume that you are a bit familiar with both formats.
 
 ### Pointcloud .ply files
+
 For .ply files containing pointclouds, use the normal **little endian binary** .ply standard, but be sure to encode the **vertex positions as 32-bit floats** (not doubles), and use the **vertex colors as uchar RGBA**. You always need to provide the red, green, blue and alpha channel, even when your sequence doesn't use alpha values or colors at all. The alpha channel isn't used in the plugin right now, but it allows for faster file reads, as RGBA is the native Unity vertex color format. Don't include any vertex indices! Here is an example of how the header of a ply looks that is correctly formatted:
 
-```
+```ply
 ply
 format binary_little_endian 1.0
 comment How the header of a correctly formated .ply file with a pointcloud looks like
@@ -100,16 +106,18 @@ end_header
 ```
 
 As an example for how the data for a a single vertex (line) could look like this. Three XZY-Float values are followed by four RGBA byte/uchar values:
-```
+
+```ply
 0.323434 0.55133 1.44322 255 255 255 0 
 ```
 
 ### Mesh .ply files
+
 For .ply files containing meshes, you use the same **little endian binary** format as for the pointclouds, with the **vertex positions encoded as 32-bit floats**. Encode the **face indices as a uchar uint list**, as it is commonly done in the ply format. Only encode **faces as triangles**, so the uchar component of the face indices list should always be "3", the uInts should be 32-bit.
 If you want to use textures/UV-coordinates, include the **U and V-coordinates as additional float propertys (property s and property t)** right behind the xyz properties.
 An example header of a correctly formatted mesh ply file with UV-coordinates would look like this:
 
-```
+```ply
 ply
 format binary_little_endian 1.0
 comment Exported for use in Unity Geometry Streaming Plugin
@@ -125,14 +133,17 @@ end_header
 ```
 
 The data for a single vertex (line) would look like this. Three XYZ-float values, followed by two float values for the UV-coordinates:
-```
+
+```ply
 0.323434 0.55133 1.44322 0.231286 0.692901
 ```
 
 The data for a single indice (line) in the index list could look like this:
-```
+
+```ply
 3 56542 56543 56544
 ```
 
 ### Textures/Images
-The textures should be encoded in the .dds format with **BC1/DXT1** encoding and **no mip-maps**.
+
+The textures should be encoded in the .dds format with **BC1/DXT1** encoding and **no mip-maps**.