Merge pull request #92 from lolatron/develop-general-fixes

General Formating, Sorting, and Wording, Changes to Avatars, Props, and Worlds Sections.

Author: loliwut

docs/cck/avatar/.pages

@@ -1,6 +1,6 @@
-title: Avatar
+title: Avatars
 nav:
     - index: index.md
     - Core Parameters: animator-core-parameters.md
     - Face Tracking: face-tracking.md
-    - Whitelisted Components: whitelisted-components.md
+    - Avatar Components Whitelist: avatar-component-whitelist.md

docs/cck/avatar/avatar-component-whitelist.md

@@ -0,0 +1,188 @@
+# Avatar Component Whitelist
+This page lists all components that are whitelisted for use on avatars.
+
+## CVR Components
+A list of all whitelisted components for avatars.
+
++ [CVR Advanced Avatar Trigger](../components/cvr-advanced-avatar-settings-trigger.md)
++ [CVR Advanced Avatar Settings Pointer](../components/cvr-advanced-avatar-settings-pointer.md)
++ [CVR Advanced Avatar Settings Trigger](../components/cvr-advanced-avatar-settings-trigger.md)
++ [CVR Animator Driver](../components/cvr-animator-driver.md)
++ [CVR Asset Info](../components/cvr-asset-info.md)
++ [CVR Audio Driver](../components/cvr-audio-driver.md)
++ [CVR Avatar](../components/cvr-avatar.md)
++ [CVR Blitter](../components/cvr-blitter.md)
++ [CVR Blitter Controller](../components/cvr-blitter-controller.md)
++ [CVR Custom Render Texture Updater](../components/cvr-custom-render-texture-updater.md)
++ [CVR Distance Constrain](../components/cvr-distance-constrain.md)
++ [CVR Face Tracking](../components/cvr-face-tracking.md)
++ [CVR Haptic Area Chest](../components/cvr-haptic-area-chest.md)
++ [CVR Leg](../components/cvr-leg.md)
++ [CVR Lua Client Behaviour](../components/cvr-lua-client-behaviour.md)
++ [CVR Material Driver](../components/cvr-material-driver.md)
++ [CVR Material Updater](../components/cvr-material-updater.md)
++ [CVR Movement Parent](../components/cvr-movement-parent.md)
++ [CVR Parameter Stream](../components/cvr-parameter-stream.md)
++ [CVR Particle Sound](../components/cvr-particle-sound.md)
++ [CVR Pointer](../components/cvr-pointer.md)
++ [CVR Snapping Point](../components/cvr-snapping-point.md)
++ [CVR Texture Property Parser](../components/cvr-texture-property-parser.md)
++ [CVR Toggle State Trigger](../components/cvr-toggle-state-trigger.md)
++ [First Person Exclusion](../components/first-person-exclusion.md)
+
+## CCK State Behaviours
+All the state behaviours that are usable Spawnables.
+
+- [Animator Driver](../state-behaviours/animator-driver.md)
+- [State Machine Callback Sender](../state-behaviours/state-machine-callback-sender.md)
+
+## Unity Components
+Components included as part of the Unity Engine.
+
+- [AimConstraint](https://docs.unity3d.com/Manual/class-AimConstraint.html)
+- [Animator](https://docs.unity3d.com/Manual/class-Animator.html)
+- [AudioSource](https://docs.unity3d.com/Manual/class-AudioSource.html)
+- [BoxCollider](https://docs.unity3d.com/Manual/class-BoxCollider.html)
+- [Camera](https://docs.unity3d.com/Manual/class-Camera.html)
+- [CapsuleCollider](https://docs.unity3d.com/Manual/class-CapsuleCollider.html)
+- [Cloth](https://docs.unity3d.com/Manual/class-Cloth.html)
+- [Collider](https://docs.unity3d.com/Manual/class-Collider.html)
+- [ConstantForce](https://docs.unity3d.com/Manual/class-ConstantForce.html)
+- [Light](https://docs.unity3d.com/Manual/class-Light.html)
+- [LineRenderer](https://docs.unity3d.com/Manual/class-LineRenderer.html)
+- [LookAtConstraint](https://docs.unity3d.com/Manual/class-LookAtConstraint.html)
+- [MeshCollider](https://docs.unity3d.com/Manual/class-MeshCollider.html)
+- [MeshRenderer](https://docs.unity3d.com/Manual/class-MeshRenderer.html)
+- [OffMeshLink](https://docs.unity3d.com/2021.3/Documentation/Manual/class-OffMeshLink.html)
+- [ParentConstraint](https://docs.unity3d.com/Manual/class-ParentConstraint.html)
+- [ParticleSystem](https://docs.unity3d.com/Manual/class-ParticleSystem.html)
+- [ParticleSystemForceField](https://docs.unity3d.com/Manual/class-ParticleSystemForceField.html)
+- [ParticleSystemRenderer](https://docs.unity3d.com/Manual/class-ParticleSystemRenderer.html)
+- [PositionConstraint](https://docs.unity3d.com/Manual/class-PositionConstraint.html)
+- [RotationConstraint](https://docs.unity3d.com/Manual/class-RotationConstraint.html)
+- [ScaleConstraint](https://docs.unity3d.com/Manual/class-ScaleConstraint.html)
+- [Skybox](https://docs.unity3d.com/Manual/class-Skybox.html)
+- [SkinnedMeshRenderer](https://docs.unity3d.com/Manual/class-SkinnedMeshRenderer.html)
+- [SphereCollider](https://docs.unity3d.com/Manual/class-SphereCollider.html)
+- [TrailRenderer](https://docs.unity3d.com/Manual/class-TrailRenderer.html)
+- [Transform](https://docs.unity3d.com/Manual/class-Transform.html)
+- [Rigidbody](https://docs.unity3d.com/Manual/class-Rigidbody.html)
+- [WheelCollider](https://docs.unity3d.com/Manual/class-WheelCollider.html)
+
+## Third Party Assets
+The following components are third party assets that are available in the Unity Asset Store or from other sources. You must first purchase/download and import these assets into your project if you wish to use them in ChilloutVR.
+
+When using third-party assets, you are not uploading them with your content, but rather referencing them in your project. 
+The same asset version must be shipped within the ChilloutVR client for it to work correctly. 
+If you are using a different version of the asset, it may not work as expected.
+
+!!! info
+    Third-party assets are not included in the ChilloutVR Content Creation Kit (CCK) and are not maintained by ChilloutVR. 
+    If an asset is updated by the original developer, functionality may change or break, or may become unobtainable.
+    Be aware that we may lock or freeze versions as needed.
+
+### [Dynamic Bone](https://assetstore.unity.com/packages/tools/animation/dynamic-bone-16743)
+Dynamic Bone applies physics to character's bones or joints. With simple setup, your character's hair, cloth, breasts or any part will move realistically.
+
+!!! warning
+    ChilloutVR uses a high-performance rewrite of Dynamic Bones v1.31, powered by the Unity Jobs System. Functionality is intended to match the original, but may differ in specific setups due to implementation details.
+
+- **Dynamic Bone:** Adds a dynamic bone to the component.
+- **Dynamic Bone Collider:** Adds a collider that collides/interacts with dynamic bones.
+- **Dynamic Bone Collider Base:** Base class for dynamic bone colliders
+- **Dynamic Bone Plane Collider:** Adds a collider plane that collides with dynamic bones.
+
+### [Magica Cloth 2](https://assetstore.unity.com/packages/tools/physics/magica-cloth-2-242307)
+MagicaCloth2 is a cloth simulation system that can be used with both Transform and Mesh. With this asset you can swing anything on your character!
+
+- [Magica Cloth](https://magicasoft.jp/en/mc2_magicaclothcomponent/)
+- [Magica Sphere Collider](https://magicasoft.jp/en/mc2_spherecollidercomponent/)
+- [Magica Capsule Collider](https://magicasoft.jp/en/mc2_capsulecollidercomponent/)
+- [Magica Plane Collider](https://magicasoft.jp/en/mc2_planecollidercomponent/)
+
+### [Final IK](https://assetstore.unity.com/packages/tools/animation/final-ik-14290)
+The final Inverse Kinematics solution for Unity.
+
+!!! warning
+    ChilloutVR utilizes a modified version of FinalIK v1.9. Some functionality may behave differently than the original asset.
+
++ [Aim IK](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_aim_i_k.html)
++ [Arm IK](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_arm_i_k.html)
++ [CCD IK](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_c_c_d_i_k.html)
++ [FABRIK](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_f_a_b_r_i_k.html)
++ [FABRIK Root](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_f_a_b_r_i_k_root.html)
++ [Limb IK](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_limb_i_k.html)
++ [Trigonometric IK](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_trigonometric_i_k.html)
++ [LookAt IK](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_look_at_i_k.html)
++ [Biped IK](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_biped_i_k.html)
++ [Full Body Biped IK](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_full_body_biped_i_k.html)
++ [Grounder IK](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_grounder_i_k.html)
++ [Grounder Biped IK](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_grounder_biped_i_k.html)
++ [Grounder FBBIK](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_grounder_f_b_b_i_k.html)
++ [Grounder IK (Generic)](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_grounder_i_k.html)
++ [Grounder VRIK](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_grounder_v_r_i_k.html)
++ [Grounder Quadruped](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_grounder_quadruped.html)
++ [Rotation Limit](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_rotation_limit.html)
++ [Rotation Limit Angle](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_rotation_limit_angle.html)
++ [Rotation Limit Hinge](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_rotation_limit_hinge.html)
++ [Rotation Limit Polygonal](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_rotation_limit_polygonal.html)
++ [Rotation Limit Spline](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_rotation_limit_spline.html)
++ [VRIK](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_v_r_i_k.html)
++ [VRIK LOD Controller](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_v_r_i_k_l_o_d_controller.html)
++ [VRIK Root Controller](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_v_r_i_k_root_controller.html)
++ [Hit Reaction](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_hit_reaction.html)
++ [Hit Reaction VRIK](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_hit_reaction_v_r_i_k.html)
++ [Inertia](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_inertia.html)
++ [Interaction System](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_interaction_system.html)
++ [Interaction Trigger](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_interaction_trigger.html)
++ [Interaction Target](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_interaction_target.html)
++ [Generic Poser](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_generic_poser.html)
++ [Hand Poser](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_hand_poser.html)
++ [Poser](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_poser.html)
++ [Ragdoll Utility](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_ragdoll_utility.html)
++ [Twist Relaxer](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_twist_relaxer.html)
++ [Recoil](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_recoil.html)
++ [Amplifier](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_amplifier.html)
++ [Shoulder Rotator](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_shoulder_rotator.html)
++ [Offset Modifier VRIK](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_offset_modifier_v_r_i_k.html)
++ [Offset Modifier](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_offset_modifier.html)
++ [Offset Pose](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_offset_pose.html)
++ [Penetration Avoidance](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_penetration_avoidance.html)
++ [LookAt Controller](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_look_at_controller.html)
++ [Body Tilt](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_body_tilt.html)
++ [Aim Controller](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_aim_controller.html)
++ [Aim Poser](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_aim_poser.html)
++ [Editor IK](http://www.root-motion.com/finalikdox/html/class_root_motion_1_1_final_i_k_1_1_editor_i_k.html)
+
+### [Steam Audio](https://valvesoftware.github.io/steam-audio/)
+**Steam Audio** is a third party asset. Whitelisted components listed below.
+
+!!! note
+    Changing the steam audio project settings can alter how a avatar sound sounds during testing. Those changes will not be reflected in game after upload.
+
+- [Steam Audio Ambisonic Source](https://valvesoftware.github.io/steam-audio/doc/unity/ambisonic-source.html)
+- [Steam Audio Source](https://valvesoftware.github.io/steam-audio/doc/unity/source.html)
+
+## Deprecated Thrid Party Components
+
+!!! warning
+    The following components or assets are deprecated from the Unity Asset Store and should not be used in new projects. 
+    You may be able to obtain them if you purchased them before, but they are no longer maintained or recommended for use.
+    These assets may be removed in future versions of ChilloutVR.
+
+### [Magica Cloth](https://assetstore.unity.com/packages/tools/physics/magica-cloth-160144)
+
+!!! warning
+    It is recommended to use Magica Cloth 2 instead of the original Magica Cloth.
+    New uploads using this version may not be allowed in the future.
+
+- [Magica Bone Cloth](https://magicasoft.jp/en/magica-cloth-bone-cloth-2/)
+- [Magica Bone Spring](https://magicasoft.jp/en/magica-cloth-bone-spring-2/)
+- [Magica Mesh Cloth](https://magicasoft.jp/en/magica-cloth-mesh-cloth-2/)
+- [Magica Mesh Spring](https://magicasoft.jp/en/magica-cloth-mesh-spring-2/)
+- [Magica Render Deformer](https://magicasoft.jp/en/magica-cloth-render-deformer-2/)
+- [Magica Virtual Deformer](https://magicasoft.jp/en/magica-cloth-virtual-deformer-2/)
+- [Magica Plane Collider](https://magicasoft.jp/en/magica-cloth-plane-collider-2/)
+- [Magica Sphere Collider](https://magicasoft.jp/en/magica-cloth-sphere-collider-2/)
+- [Magica Capsule Collider](https://magicasoft.jp/en/magica-cloth-capsule-collider-2/)
+

docs/cck/avatar/index.md

@@ -1,16 +1,26 @@
 # Avatar Creation
-
-Thanks for your interest in avatar creation. Here you will find documentation about all features and components we offer
-by default.
+Welcome to the avatar documention. Here you will find documentation about avatar features, avalible components, and short guides to help get started.
 
 ## Avatar Animator Core Parameters
-
 The game allows you to add certain parameters type and names that will have their values automatically set by the game.
 These are called Core Parameters, for more information you can check [Here](animator-core-parameters.md)
 
-## CCK Avatar components
+## Face Tracking
+Avatars allow for full face tracking from external devices using some components and [setup](face-tracking.md).
+
+## Required Components
+Avatars use these required components to define asset info and behaviour and settings.
+!!! note
+    CVR Asset Info is automatically added when CVR Avatar is added if asset info is not present.
+
+- [CVR Asset Info](../components/cvr-asset-info.md)
+- [CVR Avatar](../components/cvr-avatar.md)
+
+## Whitelisted Components
 
-We offer a wide range of default features along with CCK components that can be used on avatars.  
-For a full list of whitelisted components on avatars, [Click Here](whitelisted-components.md).
+- [CCK Components](avatar-component-whitelist.md#cck-components)
+- [CCK State Behaviours](avatar-component-whitelist.md#cck-state-behaviours)
+- [Unity Components](avatar-component-whitelist.md#unity-components)
+- [Third Party Assets](avatar-component-whitelist.md#third-party-assets)
 
 For any questions, refer to the [FAQ](../faq.md) for help.