Skip to content

Commit e73ce7c

Browse files
loliwutloliwut
committed
Merge branch 'develop' into DocsTeam-CCK-Rewrite
2 parents a8c3ffa + de6cbbe commit e73ce7c

110 files changed

Lines changed: 1842 additions & 378 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ Please contribute using [GitHub Flow](https://guides.github.com/introduction/flo
1717

1818
For guidance writing new documents for CCK components, please follow our [style guide](https://github.com/ChilloutVR-Team/docs/blob/master/CONTRIBUTING.md).
1919

20-
### ABI employee's / ABI internal contributors
20+
### CVR employee's / CVR internal contributors
2121

2222
For any changes, make a feature branch.
2323
This means a branch named like `feature/add-cvravatar-feature-docs` with a reasonable short name of the changes you are doing there.
2424
When you are done with your changes, merge them into develop.
2525

2626
### Releases
27-
Release are made by ABI staff.
27+
Release are made by CVR staff.
2828

2929
Additional notes:
3030
For deploying to production merge develop into master, and grab the latest build artifact from teamcity after it has been built.
@@ -33,25 +33,40 @@ For deploying to production merge develop into master, and grab the latest build
3333

3434
We recommend previewing the site before submitting your PR. To preview the site, follow the instructions below:
3535

36-
### Install python, dependencies and mkdocs
36+
### Install python, poetry, and project dependencies
3737

3838
#### Windows
3939

40-
1. Install [CPython](https://python.org)
41-
2. Open a Terminal (cmd or powershell) in the docs folder
42-
3. Run `.\setup.bat`
40+
**Automatic:**
4341

44-
#### Linux
42+
1. Right-click the file `setup.ps1` and pick `Run with PowerShell`
43+
2. Look at the console to see if there were errors, if not, we're good :)
44+
45+
---
46+
47+
**Manual:**
48+
49+
1. Install [Python](https://www.python.org/) `3.11`
50+
2. Install [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer)
51+
3. Install/Update the project packages by opening a Terminal in the repository's root folder, and running:
52+
`poetry install --no-root`
4553

46-
1. Install python3
47-
2. Create a python venv & activate it
48-
3. `pip install -U poetry`
49-
4. `poetry install --no-root`
54+
#### Linux
5055

56+
1. Install python 3.11
57+
2. Install [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer)
58+
3. Run `poetry install --no-root` to install/update the packages
5159

5260
### Run local development server
5361

54-
To run a local development server now, just run `.\serve.bat`
55-
or `mkdocs serve` if your directly within your venv
62+
**Windows**
63+
64+
1. Run the [Windows Setup](#windows)
65+
2. Right-click the file `serve.ps1` and pick `Run with PowerShell`
66+
67+
**Linux**
68+
69+
1. Run the [Linux Setup](#linux)
70+
2. Run `poetry run mkdocs serve` on a Terminal in the project's root
5671

5772
You now have a development server running at [http://127.0.0.1:8000/](http://127.0.0.1:8000/)

‎docs/cck/.pages‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@ title: CCK
22
nav:
33
- CCK: index.md
44
- setup.md
5-
- third-party-assets.md
65
- Content Tags: content-tags.md
7-
- Avatar: avatar
8-
- World: world
9-
- Spawnable: spawnable
6+
- Avatars: avatar
7+
- Worlds: world
8+
- Props: spawnable
109
- Components: components
10+
- State Behaviours: state-behaviours
1111
- Lua Scripting: lua
12-
- Examples: examples
12+
- Shader Globals: shader-globals.md
13+
- Validations: validations.md
1314
- FAQ: faq.md

‎docs/cck/avatar/.pages‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
title: Avatar
2+
nav:
3+
- index: index.md
4+
- Core Parameters: animator-core-parameters.md
5+
- Face Tracking: face-tracking.md
6+
- Whitelisted Components: whitelisted-components.md

‎docs/cck/avatar/animator-core-parameters.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Avatar Animator Core Parameters
2+
3+
Core Parameters are special Animator Parameters that are set automatically by the game. These parameters offer a quick
4+
way to make your avatar react to game information without needing anything beyond adding and using them in the animator.
5+
6+
If you're looking for more parameters, there is a component dedicated to write game information into animator
7+
parameters. The name of the component is [CVRParameterStream](../components/cvr-parameter-stream.md).
8+
9+
---
10+
11+
## Core Parameters
12+
13+
| Name | Type | Range | Description |
14+
|-----------------|---------|---------------|-----------------------------------------------------------------------------------------------------------------------------------|
15+
| GestureLeft | Float | [-1.0 … 6.0] | Current gesture state of the left hand<br>Fist uses analog weighting in [0.0 … 1.0]<br>[Gesture Values Mapping](#gesture-values) |
16+
| GestureRight | Float | [-1.0 … 6.0] | Current gesture state of the right hand<br>Fist uses analog weighting in [0.0 … 1.0]<br>[Gesture Values Mapping](#gesture-values) |
17+
| GestureLeftIdx | Int | [-1 … 6] | Discrete left-hand gesture value without analog weighting<br>[Gesture Values Mapping](#gesture-values) |
18+
| GestureRightIdx | Int | [-1 … 6] | Discrete right-hand gesture value without analog weighting<br>[Gesture Values Mapping](#gesture-values) |
19+
| MovementX | Float | [-1.0 … 1.0] | Horizontal movement input value |
20+
| MovementY | Float | [-1.0 … 1.0] | Vertical movement input value |
21+
| Grounded | Bool | [false, true] | Indicates if the player is on the ground |
22+
| Emote | Float | [0.0 … 8.0] | Target emote to play. Resets to `0.0` within `0.1 second of being set |
23+
| CancelEmote | Trigger | — | Trigger to cancel the current emote |
24+
| Toggle | Float | [0.0 … 7.0] | Currently selected toggle state |
25+
| Sitting | Bool | [false, true] | Indicates if the player is sitting |
26+
| Crouching | Bool | [false, true] | Indicates if the player is crouching |
27+
| Prone | Bool | [false, true] | Indicates if the player is prone |
28+
| Flying | Bool | [false, true] | Indicates if the player is flying |
29+
| Swimming | Bool | [false, true] | Indicates if the player is swimming |
30+
| IsLocal | Bool | [false, true] | Indicates if the avatar is the local player |
31+
| DistanceTo | Float | [0.0 … ∞] | Distance to the local player in meters. Defaults to `-1.0` until updated |
32+
| VisemeIdx | Int | [0 … 14] | Index value representing the current viseme<br>[Viseme Values Mapping](#viseme-index-values) |
33+
| VisemeLoudness | Float | [0.0 … 1.0] | Loudness level for the current viseme |
34+
| IsFriend | Bool | [false, true] | Indicates if the observed avatar is a friend |
35+
| VelocityX | Float | [0.0 … ∞] | Velocity along the `X` axis |
36+
| VelocityY | Float | [0.0 … ∞] | Velocity along the `Y` axis |
37+
| VelocityZ | Float | [0.0 … ∞] | Velocity along the `Z` axis |
38+
| AFK | Bool | [false, true] | Indicates if the player is AFK.<br>*Only available in nightly builds atm* |
39+
40+
---
41+
42+
## Gesture Values
43+
44+
| Gesture | Float Value | Int Value |
45+
|-------------|-------------|-----------|
46+
| Open Hand | -1.0 | -1 |
47+
| Fist | [0.0 … 1.0] | 0 |
48+
| Thumbs Up | 2.0 | 2 |
49+
| Gun | 3.0 | 3 |
50+
| Point | 4.0 | 4 |
51+
| Peace | 5.0 | 5 |
52+
| Rock n Roll | 6.0 | 6 |
53+
54+
---
55+
56+
## Viseme Index Values
57+
58+
| Viseme | Integer Value |
59+
|--------|---------------|
60+
| Sil | 0 |
61+
| PP | 1 |
62+
| FF | 2 |
63+
| TH | 3 |
64+
| DD | 4 |
65+
| KK | 5 |
66+
| CH | 6 |
67+
| SS | 7 |
68+
| NN | 8 |
69+
| RR | 9 |
70+
| AA | 10 |
71+
| E | 11 |
72+
| I | 12 |
73+
| O | 13 |
74+
| U | 14 |
75+
76+
You can get a reference for each viseme at:
77+
<https://developers.meta.com/horizon/documentation/unity/audio-ovrlipsync-viseme-reference/#reference-images>{:target="_blank"}
78+
79+
---
80+
81+
## Notes
82+
83+
- Fist is analog (range from `0.0` to `1.0` depending on trigger press)
84+
- Rock n Roll also includes the flip-off gesture (flipping the bird)
85+
- Parameters are **case-sensitive**
86+
- You are unable to write to these parameters using any CCK component as they are considered readonly, but you can read them using the Animator Driver or Scripting API
87+
- Core Parameter types can be mismatched, e.g., you can define `AFK` as an int parameter instead of a bool in your animator, and it will be 0 or 1 depending on the AFK state

‎docs/cck/avatar/face-tracking.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ A GUI that features utilities for face tracking on avatars. This can be found as
33
(**Alpha Blend Interactive** / **Modules** / **Face Tracking Utilities**)
44

55
##### Avatar
6-
Select your [CVR Avatar](../components/avatar.md) here.
6+
Select your [CVR Avatar](../components/cvr-avatar.md) here.
77

88
##### Add Face Tracking (Button)
9-
This will add a [CVR Face Tracking](../components/face-tracking.md) component to your avatar.
9+
This will add a [CVR Face Tracking](../components/cvr-face-tracking.md) component to your avatar.
1010

1111
## Blendshape Generator
1212
With this tab, you can generate face tracking blendshapes from existing ones.

‎docs/cck/avatar/index.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
# Avatar Creation
2-
Thanks for your interest in avatar creation. Here you will find documentation about all features and components we offer by default.
2+
3+
Thanks for your interest in avatar creation. Here you will find documentation about all features and components we offer
4+
by default.
5+
6+
## Avatar Animator Core Parameters
7+
8+
The game allows you to add certain parameters type and names that will have their values automatically set by the game.
9+
These are called Core Parameters, for more information you can check [Here](animator-core-parameters.md)
310

411
## CCK Avatar components
12+
513
We offer a wide range of default features along with CCK components that can be used on avatars.
614
For a full list of whitelisted components on avatars, [Click Here](whitelisted-components.md).
715

‎docs/cck/avatar/whitelisted-components.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,10 @@ List of whitelisted components and link to their corresponding Unity documentati
6969
## CVR Components
7070
A list of all whitelisted components for avatars.
7171

72-
+ [CVR Haptic Chest Area](../components/haptic-chest-area.md)
73-
+ [CVR Toggle State Trigger](../components/state-trigger.md)
74-
+ [CVR Advanced Avatar Trigger](../components/aas-trigger.md)
75-
+ [CVR Pointer](../components/CVRPointer.md)
76-
+ [CVR Skybox Manipulator](../components/skybox-manipulator.md)
77-
+ [CVR Avatar](../components/CVRAvatar.md)
78-
+ [CVR Asset Info](../components/CVRAssetInfo.md)
72+
+ [CVR Avatar](../components/cvr-avatar.md)
73+
+ [CVR Asset Info](../components/cvr-asset-info.md)
74+
+ [CVR Haptic Area Chest](../components/cvr-haptic-area-chest.md)
75+
+ [CVR Toggle State Trigger](../components/cvr-toggle-state-trigger.md)
76+
+ [CVR Advanced Avatar Trigger](../components/cvr-advanced-avatar-settings-trigger.md)
77+
+ [CVR Pointer](../components/cvr-pointer.md)
78+
+ [CVR Skybox Manipulator](../components/cvr-skybox-manipulator.md)

‎docs/cck/components/.pages‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
nav:
2+
- Combat System: combat-system.md
3+
- Control Point: control-point.md
4+
- CVR AAS Trigger: cvr-advanced-avatar-settings-trigger.md
5+
- CVR Animator Driver: cvr-animator-driver.md
6+
- CVR Asset Info: cvr-asset-info.md
7+
- CVR Attachment: cvr-attachment.md
8+
- CVR Audio Driver: cvr-audio-driver.md
9+
- CVR Audio Material Parser: cvr-audio-material-parser.md
10+
- CVR Avatar: cvr-avatar.md
11+
- CVR Avatar Pickup Marker: cvr-avatar-pickup-marker.md
12+
- CVR Blitter: cvr-blitter.md
13+
- CVR Blitter Controller: cvr-blitter-controller.md
14+
- CVR Camera Helper: cvr-camera-helper.md
15+
- CVR Canvas Wrapper: cvr-canvas-wrapper.md
16+
- CVR Custom Render Texture Updater: cvr-custom-render-texture-updater.md
17+
- CVR Damage Raycaster: cvr-damage-raycaster.md
18+
- CVR Distance Constrain: cvr-distance-constrain.md
19+
- CVR Distance LOD: cvr-distance-lod.md
20+
- CVR Face Tracking: cvr-face-tracking.md
21+
- CVR GI Material Updater: cvr-gi-material-updater.md
22+
- CVR Global Material Property Updater: cvr-global-material-property-updater.md
23+
- CVR Global Shader Updater: cvr-global-shader-updater.md
24+
- CVR Haptic Area Chest: cvr-haptic-area-chest.md
25+
- CVR Haptic Zone: cvr-haptic-zone.md
26+
- CVR IK Angle Limit: cvr-ik-angle-limit.md
27+
- CVR IK Hinge Limit: cvr-ik-hinge-limit.md
28+
- CVR Input Field Keyboard Handler: cvr-input-field-keyboard-handler.md
29+
- CVR Interactable: cvr-interactable.md
30+
- CVR Leg: cvr-leg.md
31+
- CVR Line Renderer Helper: cvr-line-renderer-helper.md
32+
- CVR LTCGI Adapter: cvr-ltcgi-adapter.md
33+
- CVR Lua Client Behaviour: cvr-lua-client-behaviour.md
34+
- CVR Material Driver: cvr-material-driver.md
35+
- CVR Material Updater: cvr-material-updater.md
36+
- CVR Mirror: cvr-mirror.md
37+
- CVR Movement Driver: cvr-movement-driver.md
38+
- CVR Movement Parent: cvr-movement-parent.md
39+
- CVR Nav Controller: cvr-nav-controller.md
40+
- CVR Object Sync: cvr-object-sync.md
41+
- CVR Parameter Stream: cvr-parameter-stream.md
42+
- CVR Particle Sound: cvr-particle-sound.md
43+
- CVR Pickup Object: cvr-pickup-object.md
44+
- CVR Pointer: cvr-pointer.md
45+
- CVR Portal Marker: cvr-portal-marker.md
46+
- CVR Shared Physics Controller: cvr-shared-physics-controller.md
47+
- CVR Skybox Manipulator: cvr-skybox-manipulator.md
48+
- CVR Snapping Point: cvr-snapping-point.md
49+
- CVR Spawnable: cvr-spawnable.md
50+
- CVR Spawnable Trigger: cvr-spawnable-trigger.md
51+
- CVR Texture Property Parser: cvr-texture-property-parser.md
52+
- CVR Toggle State Trigger: cvr-toggle-state-trigger.md
53+
- CVR Variable Buffer: cvr-variable-buffer.md
54+
- CVR Video Player: cvr-video-player.md
55+
- CVR Wheel Controller: cvr-wheel-controller.md
56+
- CVR Wheel Hub Controller: cvr-wheel-hub-controller.md
57+
- CVR World: cvr-world.md
58+
- Damage: damage.md
59+
- Fluid Volume: fluid-volume.md
60+
- Force Applicator: force-applicator.md
61+
- FPR Exclusion: fpr-exclusion.md
62+
- Game Instance Controller: game-instance-controller.md
63+
- Gravity Zone: gravity-zone.md
64+
- Gun Controller: gun-controller.md
65+
- Object Health: object-health.md
66+
- Physics Influencer: physics-influencer.md
67+
- Score Board Controller: score-board-controller.md
68+
- Spawnable Pickup Marker: spawnable-pickup-marker.md
69+
- Deprecated Components:
70+
- CVR Action: cvr-action.md
71+
- CVR AAS Pointer: cvr-advanced-avatar-settings-pointer.md
72+
- CVR Builder Spawnable: cvr-builder-spawnable.md
73+
- CVR Object Library: cvr-object-library.md
74+
- CVR Timeline Sync: cvr-timeline-sync.md
75+
- CVR Toggle State Pointer: cvr-toggle-state-pointer.md
76+
- CVR Warp Point: cvr-warp-point.md
77+
- CVR World Modifiers: cvr-world-modifiers.md
78+
- Player Material Parser: player-material-parser.md

‎docs/cck/components/aas-trigger-helper.md‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎docs/cck/components/blitter.md‎

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)