From 74153f945206ea4901db2afc7d54d378a9b42d5a Mon Sep 17 00:00:00 2001 From: loliwut Date: Wed, 18 Sep 2024 05:16:19 -0400 Subject: [PATCH 01/16] Renames and link fixes Renamed community contributions to be inline with current naming convention (as it appears in code). also updated links to match new filenames. --- docs/cck/avatar/whitelisted-components.md | 2 +- docs/cck/components/{pointer.md => CVRPointer.md} | 0 .../components/{Combat System.md => CombatSystem.md} | 0 .../components/{Control Point.md => ControlPoint.md} | 0 ...nstance Controller.md => GameInstanceController.md} | 0 .../components/{Gun Controller.md => GunController.md} | 0 .../components/{Object Health.md => ObjectHealth.md} | 0 ...ore Board Controller.md => ScoreBoardController.md} | 0 docs/cck/components/aas-trigger.md | 10 +++++----- docs/cck/components/state-trigger.md | 2 +- 10 files changed, 7 insertions(+), 7 deletions(-) rename docs/cck/components/{pointer.md => CVRPointer.md} (100%) rename docs/cck/components/{Combat System.md => CombatSystem.md} (100%) rename docs/cck/components/{Control Point.md => ControlPoint.md} (100%) rename docs/cck/components/{Game Instance Controller.md => GameInstanceController.md} (100%) rename docs/cck/components/{Gun Controller.md => GunController.md} (100%) rename docs/cck/components/{Object Health.md => ObjectHealth.md} (100%) rename docs/cck/components/{Score Board Controller.md => ScoreBoardController.md} (100%) diff --git a/docs/cck/avatar/whitelisted-components.md b/docs/cck/avatar/whitelisted-components.md index 4ba98ef..389a2e1 100644 --- a/docs/cck/avatar/whitelisted-components.md +++ b/docs/cck/avatar/whitelisted-components.md @@ -72,6 +72,6 @@ A list of all whitelisted components for avatars. + [CVR Haptic Chest Area](../components/haptic-chest-area.md) + [CVR Toggle State Trigger](../components/state-trigger.md) + [CVR Advanced Avatar Trigger](../components/aas-trigger.md) -+ [CVR Pointer](../components/pointer.md) ++ [CVR Pointer](../components/CVRPointer.md) + [CVR Avatar](../components/avatar.md) + [CVR Asset Info](../components/asset-info.md) \ No newline at end of file diff --git a/docs/cck/components/pointer.md b/docs/cck/components/CVRPointer.md similarity index 100% rename from docs/cck/components/pointer.md rename to docs/cck/components/CVRPointer.md diff --git a/docs/cck/components/Combat System.md b/docs/cck/components/CombatSystem.md similarity index 100% rename from docs/cck/components/Combat System.md rename to docs/cck/components/CombatSystem.md diff --git a/docs/cck/components/Control Point.md b/docs/cck/components/ControlPoint.md similarity index 100% rename from docs/cck/components/Control Point.md rename to docs/cck/components/ControlPoint.md diff --git a/docs/cck/components/Game Instance Controller.md b/docs/cck/components/GameInstanceController.md similarity index 100% rename from docs/cck/components/Game Instance Controller.md rename to docs/cck/components/GameInstanceController.md diff --git a/docs/cck/components/Gun Controller.md b/docs/cck/components/GunController.md similarity index 100% rename from docs/cck/components/Gun Controller.md rename to docs/cck/components/GunController.md diff --git a/docs/cck/components/Object Health.md b/docs/cck/components/ObjectHealth.md similarity index 100% rename from docs/cck/components/Object Health.md rename to docs/cck/components/ObjectHealth.md diff --git a/docs/cck/components/Score Board Controller.md b/docs/cck/components/ScoreBoardController.md similarity index 100% rename from docs/cck/components/Score Board Controller.md rename to docs/cck/components/ScoreBoardController.md diff --git a/docs/cck/components/aas-trigger.md b/docs/cck/components/aas-trigger.md index 10b0fcf..5acbc19 100644 --- a/docs/cck/components/aas-trigger.md +++ b/docs/cck/components/aas-trigger.md @@ -1,5 +1,5 @@ # CVR Advanced Avatar Trigger
-With this component you can modify your advanced avatar settings parameter values when a **[CVR Pointer](pointer.md)** +With this component you can modify your advanced avatar settings parameter values when a **[CVR Pointer](CVRPointer.md)** enters the indicated trigger area. Size and placement can be adjusted with the settings bellow. The trigger area will move together with its parented armature bone or game object. @@ -34,11 +34,11 @@ Allow only pointers having this type set. Parameter name of the setting to be modified. ##### Enabled Particle Interaction -Enabling this option will allow particle systems to activate this trigger. You need a [CVR Pointer](pointer.md) on the same game object +Enabling this option will allow particle systems to activate this trigger. You need a [CVR Pointer](CVRPointer.md) on the same game object as the trigger for it to work. Particle can only trigger **On Enter Trigger**. #### On Enter Trigger -Actions when [CVR Pointer](pointer.md) enters the trigger area. +Actions when [CVR Pointer](CVRPointer.md) enters the trigger area. ##### Setting Value Set value that will override, added to or subtracted from the current parameter value. @@ -55,7 +55,7 @@ The time the pointer needs to stay in the trigger area, until the trigger gets e + **Subtract** (Subtracts the settings value from the parameters value) #### On Exit Trigger -Actions when [CVR Pointer](pointer.md) exits the trigger area. +Actions when [CVR Pointer](CVRPointer.md) exits the trigger area. ##### Setting Value Set value that will override, added to or subtracted from the current parameter value. @@ -69,7 +69,7 @@ Delay before the execution of the trigger + **Subtract** (Subtracts the settings value from the parameters value) #### On Stay Trigger -Actions when [CVR Pointer](pointer.md) stays in the trigger area. +Actions when [CVR Pointer](CVRPointer.md) stays in the trigger area. ##### Update Method + **Set From Position** () diff --git a/docs/cck/components/state-trigger.md b/docs/cck/components/state-trigger.md index 29f76ee..683d7db 100644 --- a/docs/cck/components/state-trigger.md +++ b/docs/cck/components/state-trigger.md @@ -1,5 +1,5 @@ # CVR Toggle State Trigger
-With this component you can modify the toggle state of your avatar when a **[CVR Pointer](pointer.md)** +With this component you can modify the toggle state of your avatar when a **[CVR Pointer](CVRPointer.md)** enters the indicated trigger area. Size and placement can be adjusted with the settings bellow. The trigger area will move together with its parented armature bone or game object. From cbf08996b1c0fa49811ff624bd04a8ba452e6680 Mon Sep 17 00:00:00 2001 From: SketchFoxsky <109103755+SketchFoxsky@users.noreply.github.com> Date: Wed, 2 Oct 2024 00:14:28 -0400 Subject: [PATCH 02/16] Update CombatSystem.md Updated formatting for Live website. (Nested bulletin points cannot use *, use + or - depending on parent bulletin ) --- docs/cck/components/CombatSystem.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/cck/components/CombatSystem.md b/docs/cck/components/CombatSystem.md index 85c8873..bb167b2 100644 --- a/docs/cck/components/CombatSystem.md +++ b/docs/cck/components/CombatSystem.md @@ -38,9 +38,9 @@ Adding this component enables PvP and PVE style gamemodes in your world. Best us ##### Respawn Behavior Choose how the player will respawn upon being downed. + **Respawn Behavior** - * **Respawn On World:** Uses the CVRWorld Spawn Point. - * **Respawn On Point:** Uses the transform of the Respawn Point Property. - * **Respawn In Place:** Will respawn the player at the point they were downed. + - **Respawn On World:** Uses the CVRWorld Spawn Point. + - **Respawn On Point:** Uses the transform of the Respawn Point Property. + - **Respawn In Place:** Will respawn the player at the point they were downed. + **Respawn Point:** The GameObject Transform property the player will respawn at when using the **Respawn On Point** Respawn Behavior. + **Respawn Time:** The time after being down the player will respawn. From 96cf58a125f9616c88f111358e896ca702ce3b2e Mon Sep 17 00:00:00 2001 From: SketchFoxsky <109103755+SketchFoxsky@users.noreply.github.com> Date: Wed, 2 Oct 2024 14:13:34 -0400 Subject: [PATCH 03/16] Hyperlink Fixes Renamed the following files: avatar.md -> CVR-Avatar.md spawnable.md -> CVR-Spawnable.md world.md -> CVR-World.md Corrected the Hyperlinks in the following files: CVRAssetInfo.md --- docs/cck/components/{avatar.md => CVR-Avatar.md} | 0 docs/cck/components/{spawnable.md => CVR-Spawnable.md} | 0 docs/cck/components/{world.md => CVR-World.md} | 0 docs/cck/components/CVRAssetInfo.md | 2 +- 4 files changed, 1 insertion(+), 1 deletion(-) rename docs/cck/components/{avatar.md => CVR-Avatar.md} (100%) rename docs/cck/components/{spawnable.md => CVR-Spawnable.md} (100%) rename docs/cck/components/{world.md => CVR-World.md} (100%) diff --git a/docs/cck/components/avatar.md b/docs/cck/components/CVR-Avatar.md similarity index 100% rename from docs/cck/components/avatar.md rename to docs/cck/components/CVR-Avatar.md diff --git a/docs/cck/components/spawnable.md b/docs/cck/components/CVR-Spawnable.md similarity index 100% rename from docs/cck/components/spawnable.md rename to docs/cck/components/CVR-Spawnable.md diff --git a/docs/cck/components/world.md b/docs/cck/components/CVR-World.md similarity index 100% rename from docs/cck/components/world.md rename to docs/cck/components/CVR-World.md diff --git a/docs/cck/components/CVRAssetInfo.md b/docs/cck/components/CVRAssetInfo.md index 934eaf5..09d441e 100644 --- a/docs/cck/components/CVRAssetInfo.md +++ b/docs/cck/components/CVRAssetInfo.md @@ -1,6 +1,6 @@ # CVR Asset Info
-The CVR Asset Info component is the component that defines the ownership and ID of an uploaded asset such as Avatars, Worlds, or Spawnables (also known as props) in our backend infrastructure. It is automatically generated as a subcomponent to the [CVR Avatar](Avatar.md), [CVR World](World.md), and [CVR Spawnable](Spawnable.md) components. +The CVR Asset Info component is the component that defines the ownership and ID of an uploaded asset such as Avatars, Worlds, or Spawnables (also known as props) in our backend infrastructure. It is automatically generated as a subcomponent to the [CVR Avatar](CVR-Avatar.md), [CVR World](CVR-World.md), and [CVR Spawnable](CVR-Spawnable.md) components. ## UI From a79020a8f00c61a3712ac23612c4803f625dd228 Mon Sep 17 00:00:00 2001 From: SketchFoxsky <109103755+SketchFoxsky@users.noreply.github.com> Date: Wed, 2 Oct 2024 23:11:30 -0400 Subject: [PATCH 04/16] Added Hyperlinks Added Hyperlinks to the following Components: CombatSystem ControlPoint Damage GameInstanceController GunController ObjectHealth ScoreBoardController --- docs/cck/components/CombatSystem.md | 2 +- docs/cck/components/ControlPoint.md | 2 +- docs/cck/components/Damage.md | 2 +- docs/cck/components/GameInstanceController.md | 6 +++--- docs/cck/components/GunController.md | 2 +- docs/cck/components/ObjectHealth.md | 2 +- docs/cck/components/ScoreBoardController.md | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/cck/components/CombatSystem.md b/docs/cck/components/CombatSystem.md index bb167b2..8eceb87 100644 --- a/docs/cck/components/CombatSystem.md +++ b/docs/cck/components/CombatSystem.md @@ -1,5 +1,5 @@ # Combat System
-Adding this component enables PvP and PVE style gamemodes in your world. Best used alongside the **Damage** Component and the **Game Instance Controller** Component +Adding this component enables PvP and PVE style gamemodes in your world. Best used alongside the [Damage](Damage.md) Component and the [GameInstanceController](GameInstanceController.md) Component ### Properties diff --git a/docs/cck/components/ControlPoint.md b/docs/cck/components/ControlPoint.md index 162b41f..57febe7 100644 --- a/docs/cck/components/ControlPoint.md +++ b/docs/cck/components/ControlPoint.md @@ -1,5 +1,5 @@ # Control Point
-Adding this component to a GameObject with an IsTrigger collider will allow the player to obtain a score with the Game Instance Controller by being in the volume. +Adding this component to a GameObject with an IsTrigger collider will allow the player to obtain a score with the [GameInstanceController](GameInstanceController.md) by being in the volume. > As of 2024r176 this component is not functional. ### Properties diff --git a/docs/cck/components/Damage.md b/docs/cck/components/Damage.md index aa833ec..9f7a82f 100644 --- a/docs/cck/components/Damage.md +++ b/docs/cck/components/Damage.md @@ -1,5 +1,5 @@ # Damage
-Adding this component will allow the GameObject's collider or Particle system to inflict damage to the player; if the Combat System is present in your scene. +Adding this component will allow the GameObject's collider or Particle system to inflict damage to the player; if the [CombatSystem](CombatSystem.md) is present in your scene. ### Properties diff --git a/docs/cck/components/GameInstanceController.md b/docs/cck/components/GameInstanceController.md index 4627613..4f901a1 100644 --- a/docs/cck/components/GameInstanceController.md +++ b/docs/cck/components/GameInstanceController.md @@ -28,7 +28,7 @@ These are properties that control all teams and game conditions. + **Ready Timer** After the ready percentage has been met, this is the time in seconds before the game starts. + **Game Controller Type** - **Default** Score based gamemode - - **Combat System** Elimination based gamemode + - **[Combat System](CombatSystem.md)** Elimination based gamemode + **Game Type** - **Single** Each game is one round, as of game version 2024r176, Round Start and Round End Events will trigger alongside Game Start and Game End Events. - **Rounds** Each game will consist of the amount of rounds specified in the Rounds To Win property. @@ -37,8 +37,8 @@ These are properties that control all teams and game conditions. - **Score** When a Team accumulates a score defined by the End Score property, the game or round will end. - **Time** When the time in seconds defined in the End Time property is reached, the game or round will end. - **Time or Score** When the Time or Score end condition is met, the game or round will end. - - **Elimination** A combat system only Game Type end condition. When only 1 team is remaining, the game or round will end. - - **Time or Elimination** A combat system only Game Type end condition. When the Time or Elimination end condition is met, the game or round will end. + - **Elimination** A [Combat System](CombatSystem.md) only Game Type end condition. When only 1 team is remaining, the game or round will end. + - **Time or Elimination** A [Combat System](CombatSystem.md) only Game Type end condition. When the Time or Elimination end condition is met, the game or round will end. + **End Score** The score required to win a round or game. + **End Time** The amount of time in seconds before a round or game ends. diff --git a/docs/cck/components/GunController.md b/docs/cck/components/GunController.md index fb4f444..c312964 100644 --- a/docs/cck/components/GunController.md +++ b/docs/cck/components/GunController.md @@ -1,5 +1,5 @@ # Gun Controller
-This component is used as a quick way to make a ranged weapon for the Combat System. +This component is used as a quick way to make a ranged weapon for the [Combat System](CombatSystem.md). ### Properties diff --git a/docs/cck/components/ObjectHealth.md b/docs/cck/components/ObjectHealth.md index 420c831..fd6dd73 100644 --- a/docs/cck/components/ObjectHealth.md +++ b/docs/cck/components/ObjectHealth.md @@ -1,5 +1,5 @@ # Object Health
-Adding this component gives the GameObject properites for the Combat System. Best used alongside the **Damage** and **Game Instance Controller** components. +Adding this component gives the GameObject properites for the Combat System. Best used alongside the [Damage](Damage.md) and [GameInstanceController](GameInstanceController.md) components. ### Properties diff --git a/docs/cck/components/ScoreBoardController.md b/docs/cck/components/ScoreBoardController.md index df11793..ec06b36 100644 --- a/docs/cck/components/ScoreBoardController.md +++ b/docs/cck/components/ScoreBoardController.md @@ -1,5 +1,5 @@ # Score Board Controller
-Adding this component will allow you to display information about the Game Instance Controller in a Unity UI Canvas. +Adding this component will allow you to display information about the [GameInstanceController](GameInstanceController.md) in a Unity UI Canvas. > As of 2024r176 Text UI is limited to Unity's legacy Text UI components. This may change in the future. ### Properties From 21b63c4eb1d80695e9c7b3aa92d01a12ca5d9525 Mon Sep 17 00:00:00 2001 From: SketchFoxsky <109103755+SketchFoxsky@users.noreply.github.com> Date: Thu, 3 Oct 2024 21:59:33 -0400 Subject: [PATCH 05/16] renamed files Removed Hyphens --- docs/cck/components/{CVR-Avatar.md => CVRAvatar.md} | 0 docs/cck/components/{CVR-Spawnable.md => CVRSpawnable.md} | 0 docs/cck/components/{CVR-World.md => CVRWorld.md} | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename docs/cck/components/{CVR-Avatar.md => CVRAvatar.md} (100%) rename docs/cck/components/{CVR-Spawnable.md => CVRSpawnable.md} (100%) rename docs/cck/components/{CVR-World.md => CVRWorld.md} (100%) diff --git a/docs/cck/components/CVR-Avatar.md b/docs/cck/components/CVRAvatar.md similarity index 100% rename from docs/cck/components/CVR-Avatar.md rename to docs/cck/components/CVRAvatar.md diff --git a/docs/cck/components/CVR-Spawnable.md b/docs/cck/components/CVRSpawnable.md similarity index 100% rename from docs/cck/components/CVR-Spawnable.md rename to docs/cck/components/CVRSpawnable.md diff --git a/docs/cck/components/CVR-World.md b/docs/cck/components/CVRWorld.md similarity index 100% rename from docs/cck/components/CVR-World.md rename to docs/cck/components/CVRWorld.md From ebe700d9a9f8d958ce211702c5d9f24c7ba18e23 Mon Sep 17 00:00:00 2001 From: SketchFoxsky <109103755+SketchFoxsky@users.noreply.github.com> Date: Thu, 3 Oct 2024 23:46:29 -0400 Subject: [PATCH 06/16] Update CVRAssetInfo.md --- docs/cck/components/CVRAssetInfo.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cck/components/CVRAssetInfo.md b/docs/cck/components/CVRAssetInfo.md index 09d441e..512c58b 100644 --- a/docs/cck/components/CVRAssetInfo.md +++ b/docs/cck/components/CVRAssetInfo.md @@ -1,6 +1,6 @@ # CVR Asset Info
-The CVR Asset Info component is the component that defines the ownership and ID of an uploaded asset such as Avatars, Worlds, or Spawnables (also known as props) in our backend infrastructure. It is automatically generated as a subcomponent to the [CVR Avatar](CVR-Avatar.md), [CVR World](CVR-World.md), and [CVR Spawnable](CVR-Spawnable.md) components. +The CVR Asset Info component is the component that defines the ownership and ID of an uploaded asset such as Avatars, Worlds, or Spawnables (also known as props) in our backend infrastructure. It is automatically generated as a subcomponent to the [CVR Avatar](CVRAvatar.md), [CVR World](CVRWorld.md), and [CVR Spawnable](CVRSpawnable.md) components. ## UI From 28d537db0f95f1775bfd8f183a3c6d827216c334 Mon Sep 17 00:00:00 2001 From: Luca Date: Fri, 4 Oct 2024 18:20:02 +0200 Subject: [PATCH 07/16] Webhook Test From d56cf19e6d9912af97e91bd5ce607f839192a3e3 Mon Sep 17 00:00:00 2001 From: Rob Nelson Date: Thu, 10 Oct 2024 20:21:07 -0700 Subject: [PATCH 08/16] Deps bump --- poetry.lock | 2 +- pyproject.toml | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/poetry.lock b/poetry.lock index b0c244b..adfeb4a 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1045,4 +1045,4 @@ bracex = ">=2.1.1" [metadata] lock-version = "2.0" python-versions = "^3.11" -content-hash = "99e7f3aa7688fa00ca303d1a226f2bf44b0f28a75f002452ce69caea1975a7b0" +content-hash = "a9fc624a2451c4ca4a38648c707149b5519edfb45339d861cf96112262f9844b" diff --git a/pyproject.toml b/pyproject.toml index 790ede4..8ea1607 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,17 +7,17 @@ readme = "README.md" [tool.poetry.dependencies] python = "^3.11" -mkdocs = "^1.6.0" +mkdocs = "^1.6.1" mkdocs-minify-plugin = "^0.8.0" mkdocs-redirects = "^1.2.1" -livereload = "^2.6.3" +livereload = "^2.7.0" mkdocs-awesome-pages-plugin = "^2.9.3" mkdocs-extra-sass-plugin = "^0.1.0" mkdocs-static-i18n = "^1.2.3" mkdocs-markdownextradata-plugin = "^0.2.5" -materialx = "^1.38.10" +materialx = "^1.39.1" mkdocs-material-extensions = "^1.3.1" -mkdocs-material = "^9.5.23" +mkdocs-material = "^9.5.40" [build-system] From 4d9e56c3c9f0647c93679ae159f2ab044a18bd8b Mon Sep 17 00:00:00 2001 From: Rob Nelson Date: Thu, 10 Oct 2024 20:23:07 -0700 Subject: [PATCH 09/16] Update build docs --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4fa8531..307a468 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,8 @@ We recommend previewing the site before submitting your PR. To preview the site ### Install python, dependencies and mkdocs 1. Install [CPython](https://python.org) -1. `pip install -U poetry` +1. Install [pipx](https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx) +1. `pipx install poetry` 1. `cd path/to/docs` 1. `poetry install --no-root` 1. `mkdocs serve` From e70b6a9555413073031e11e727da71aead7df605 Mon Sep 17 00:00:00 2001 From: Rob Nelson Date: Thu, 10 Oct 2024 20:26:24 -0700 Subject: [PATCH 10/16] Because Luc asked for one. --- requirements.txt | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 requirements.txt diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..dbef50e --- /dev/null +++ b/requirements.txt @@ -0,0 +1,47 @@ +babel==2.16.0 ; python_version >= "3.11" and python_version < "4.0" +beautifulsoup4==4.12.3 ; python_version >= "3.11" and python_version < "4.0" +bracex==2.5.post1 ; python_version >= "3.11" and python_version < "4.0" +certifi==2024.8.30 ; python_version >= "3.11" and python_version < "4.0" +charset-normalizer==3.4.0 ; python_version >= "3.11" and python_version < "4.0" +click==8.1.7 ; python_version >= "3.11" and python_version < "4.0" +colorama==0.4.6 ; python_version >= "3.11" and python_version < "4.0" +csscompressor==0.9.5 ; python_version >= "3.11" and python_version < "4.0" +ghp-import==2.1.0 ; python_version >= "3.11" and python_version < "4.0" +htmlmin2==0.1.13 ; python_version >= "3.11" and python_version < "4.0" +idna==3.10 ; python_version >= "3.11" and python_version < "4.0" +jinja2==3.1.4 ; python_version >= "3.11" and python_version < "4.0" +jsmin==3.0.1 ; python_version >= "3.11" and python_version < "4.0" +libsass==0.23.0 ; python_version >= "3.11" and python_version < "4.0" +livereload==2.7.0 ; python_version >= "3.11" and python_version < "4.0" +markdown==3.7 ; python_version >= "3.11" and python_version < "4.0" +markupsafe==3.0.1 ; python_version >= "3.11" and python_version < "4.0" +materialx==1.39.1 ; python_version >= "3.11" and python_version < "4.0" +mergedeep==1.3.4 ; python_version >= "3.11" and python_version < "4.0" +mkdocs-awesome-pages-plugin==2.9.3 ; python_version >= "3.11" and python_version < "4.0" +mkdocs-extra-sass-plugin==0.1.0 ; python_version >= "3.11" and python_version < "4.0" +mkdocs-get-deps==0.2.0 ; python_version >= "3.11" and python_version < "4.0" +mkdocs-markdownextradata-plugin==0.2.6 ; python_version >= "3.11" and python_version < "4.0" +mkdocs-material-extensions==1.3.1 ; python_version >= "3.11" and python_version < "4.0" +mkdocs-material==9.5.40 ; python_version >= "3.11" and python_version < "4.0" +mkdocs-minify-plugin==0.8.0 ; python_version >= "3.11" and python_version < "4.0" +mkdocs-redirects==1.2.1 ; python_version >= "3.11" and python_version < "4.0" +mkdocs-static-i18n==1.2.3 ; python_version >= "3.11" and python_version < "4.0" +mkdocs==1.6.1 ; python_version >= "3.11" and python_version < "4.0" +natsort==8.4.0 ; python_version >= "3.11" and python_version < "4.0" +packaging==24.1 ; python_version >= "3.11" and python_version < "4.0" +paginate==0.5.7 ; python_version >= "3.11" and python_version < "4.0" +pathspec==0.12.1 ; python_version >= "3.11" and python_version < "4.0" +platformdirs==4.3.6 ; python_version >= "3.11" and python_version < "4.0" +pygments==2.18.0 ; python_version >= "3.11" and python_version < "4.0" +pymdown-extensions==10.11.2 ; python_version >= "3.11" and python_version < "4.0" +python-dateutil==2.9.0.post0 ; python_version >= "3.11" and python_version < "4.0" +pyyaml-env-tag==0.1 ; python_version >= "3.11" and python_version < "4.0" +pyyaml==6.0.2 ; python_version >= "3.11" and python_version < "4.0" +regex==2024.9.11 ; python_version >= "3.11" and python_version < "4.0" +requests==2.32.3 ; python_version >= "3.11" and python_version < "4.0" +six==1.16.0 ; python_version >= "3.11" and python_version < "4.0" +soupsieve==2.6 ; python_version >= "3.11" and python_version < "4.0" +tornado==6.4.1 ; python_version >= "3.11" and python_version < "4.0" +urllib3==2.2.3 ; python_version >= "3.11" and python_version < "4.0" +watchdog==5.0.3 ; python_version >= "3.11" and python_version < "4.0" +wcmatch==10.0 ; python_version >= "3.11" and python_version < "4.0" From ebd8ca9e9278a9f53733389fdfbac43d4f7d1d21 Mon Sep 17 00:00:00 2001 From: Luca Date: Fri, 11 Oct 2024 05:37:50 +0200 Subject: [PATCH 11/16] Add venv stuff to gitignore --- .gitignore | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 01caa28..969fec1 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,8 @@ site/ .pre-commit-config.yaml .selid-hooks/ .check-identity -.obsidian \ No newline at end of file +.obsidian +pyvenv.cfg +scripts/ +Lib/ +Include/ \ No newline at end of file From 326ea826b2b628c8022df6047ff7fe698bd37852 Mon Sep 17 00:00:00 2001 From: Luca Date: Fri, 11 Oct 2024 05:48:58 +0200 Subject: [PATCH 12/16] Update local dev steps --- .gitignore | 5 +---- README.md | 24 +++++++++++++++++++----- scripts/run.ps1 | 1 - serve.bat | 2 ++ setup.bat | 4 ++++ 5 files changed, 26 insertions(+), 10 deletions(-) delete mode 100644 scripts/run.ps1 create mode 100644 serve.bat create mode 100644 setup.bat diff --git a/.gitignore b/.gitignore index 969fec1..66abceb 100644 --- a/.gitignore +++ b/.gitignore @@ -4,7 +4,4 @@ site/ .selid-hooks/ .check-identity .obsidian -pyvenv.cfg -scripts/ -Lib/ -Include/ \ No newline at end of file +venv/ \ No newline at end of file diff --git a/README.md b/README.md index 307a468..52fd480 100644 --- a/README.md +++ b/README.md @@ -33,9 +33,23 @@ We recommend previewing the site before submitting your PR. To preview the site ### Install python, dependencies and mkdocs +#### Windows + 1. Install [CPython](https://python.org) -1. Install [pipx](https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx) -1. `pipx install poetry` -1. `cd path/to/docs` -1. `poetry install --no-root` -1. `mkdocs serve` +2. Open a Terminal (cmd or powershell) in the docs folder +3. Run `.\setup.bat` + +#### Linux + +1. Install python3 +2. Create a python venv & activate it +3. `pip install -U poetry` +4. `poetry install --no-root` + + +### Run local development server + +To run a local development server now, just run `.\serve.bat` +or `mkdocs serve` if your directly within your venv + +You now have a development server running at [http://127.0.0.1:8000/](http://127.0.0.1:8000/) \ No newline at end of file diff --git a/scripts/run.ps1 b/scripts/run.ps1 deleted file mode 100644 index ac41338..0000000 --- a/scripts/run.ps1 +++ /dev/null @@ -1 +0,0 @@ -mkdocs serve \ No newline at end of file diff --git a/serve.bat b/serve.bat new file mode 100644 index 0000000..486f4b5 --- /dev/null +++ b/serve.bat @@ -0,0 +1,2 @@ +call scripts/activate +mkdocs serve \ No newline at end of file diff --git a/setup.bat b/setup.bat new file mode 100644 index 0000000..33469f9 --- /dev/null +++ b/setup.bat @@ -0,0 +1,4 @@ +python -m venv ./venv +call scripts/activate +pip install -U poetry +poetry install --no-root \ No newline at end of file From f2aa38dcb30aa064eca350ccb2200b46cf88c3de Mon Sep 17 00:00:00 2001 From: Luca Date: Fri, 11 Oct 2024 06:13:28 +0200 Subject: [PATCH 13/16] Fix paths --- serve.bat | 2 +- setup.bat | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/serve.bat b/serve.bat index 486f4b5..70fa832 100644 --- a/serve.bat +++ b/serve.bat @@ -1,2 +1,2 @@ -call scripts/activate +call venv/scripts/activate mkdocs serve \ No newline at end of file diff --git a/setup.bat b/setup.bat index 33469f9..0922eae 100644 --- a/setup.bat +++ b/setup.bat @@ -1,4 +1,4 @@ python -m venv ./venv -call scripts/activate +call venv/scripts/activate pip install -U poetry poetry install --no-root \ No newline at end of file From 224f3a0f4fa85f52757ba6279ec26cbb24fc04fb Mon Sep 17 00:00:00 2001 From: loliwut Date: Fri, 1 Nov 2024 12:52:55 -0400 Subject: [PATCH 14/16] Create CONTRIBUTING.md --- CONTRIBUTING.md | 141 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 141 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..aadca77 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,141 @@ +# Contributing + +## Notification Boxes +For inserting notification fields, always keep in mind that they stand out from the body of text and will typically be read first. as a result, they should be **before** a section unless they refer to something between two paragraphs. +All info fields can be titled with the following formatting: + +``` +!!! NotifType "Field Title" + Follow this for an info box with a title rather than it's type +``` + +Use notifications to reiterate points about a singular topic that can be addressed directly. Additionally, try to keep the titles of titled notifications 6 words or less. + +Additionally, you can add a notification at the end of a statement with the following: +``` +!!! NotifType inline end + Follow this for an info box that is inlined on the right-hand side of the text above it. +``` + +When creating a Notification, keep the following rule of thumb in mind: +"A note can go anywhere." +"Info goes somewhere specific." +"Not following a tip won't break anything." +"Not following a hint *might* break something" +"Not following a warning *WILL* break something" +### Note + +``` +!!! note + follow this for a note box +``` + +Notes are the lowest importance message box in most cases. Anything that could go in the notes section in the CCK docs is eligible for one of these boxes, however it is suggested to only make these when the information is relevant to the section. These are mostly things that a creator should be aware of when working with a component that is generalized enough that it may not necessarily refer to any specific part of the relevant component, or that component at all (for example, something that must be done in blender for the component to behave as expected) + +### Info + +``` +!!! info + follow this for a info box +``` + +Use info when describing a feature, behavior, or concept specific to that component, article, or component/article subsection. This should be information the user should know about but doesn't necessarily affect outcomes. +### Tip + +``` +!!! tip + follow this for a tip box +``` + +Use a tip when describing something about a component or subsection that may not always be the intended use, but is important for one of the most common use-cases. +This should always be for something the user has direct control over. Not following a tip should never result in unsupported behavior. +### Hint +``` +!!! hint + follow this for a hint box +``` + +Use hints when describing something that may not fit elsewhere in the documentation or when addressing a single topic that may easily lead to errors or unsupported behavior. +### Warning + +``` +!!! warning + Use this format for a warning, which has bolded letters and a different color +``` + +Use warnings when misuse of a component, field, etc. will directly lead to either an error or broken functionality. Good examples of this are adding multiple full blinks to the blink blendshapes or using animations with the viseme blendshapes in the avatar component. +## Embeds + +### Images + +For images in directories *ABOVE* the current folder (IE: in the assets folder), you need to use a relative link with the following format: +``` +![](../../Folder/with/the/image.png) +``` + +a functional example is in the asset info doc as : +``` +![](../../assets/images/compdoc/Asset Info Detatched.png) +``` + +For images in the same directory or lower, you can link to it directly as: +``` +![](image.png) +or +![](subfolder/image.png) +``` +however, avoid leaving assets in the same directory or a subdirectory as this will make them navigable in the left-hand sidebar. + +### Videos + +needs to be in HTML, will update this when relevant + +## Linking + +You can replace any link in markdown with custom text (also known as aliasing) with the following: ``[address.com](replaced text)`` + +For linking so a section within an article, use: +``[Section Name](Article.md#section-name-in-lowercase)`` +# Style Guidelines + +## General Rules + +All articles should be written with American English with exceptions where they exist in Unity or the CVR CCK itself. + +The general layout of a CCK documentation page should be as follows: +``` +# Title +overview, with links to related components +## UI +include at least one image of the UI when first placed in a GameObject. try to make seperate images of subsections, or context-specific versions of the component UI +## Examples +images or videos +## Notes/Special Information +``` + +- The first sentence should always refer directly to the component by name. (EG: "The CVR Translatable component does blah blah blah") +- in the abstract, describe what the component enables, not what happens in game. +- Follow Wikipedia's "first link" rule. When a linkable item appears in a document, only link the first instance not in an info box. this does not apply to link lists (EG: "see also" lists) + +MKDocs does not support space-indenting or asterisk (\*) bullet points. When making indented lists, *ALWAYS* use tab-indents, and preferably with hyphen (-) or numerical bullets. Dropdown lists (+) are also supported, but are not currently used in officially submitted content. + +### Title HTML + +Add ```
``` after the name of the component in the header. Remove the "A" (avatars) "W" (worlds) and "P" (props) as needed to match the whitelisting. This will display the appropriate compatibility icons in the header. + +## Addressing the User + +Always refer to the user as "players" or "player", we are making a game. If direct addressing is required, use "you" or "your". Otherwise, use generally semi-formal writing styles. Try to be succinct and clear without being cold, but avoid exclamatory statements, cheekiness, or "twittery", "just-like-you" language using memes or emojis. +## Addressing the Game + +Use the proper full name "ChilloutVR" when addressing the game. The abbreviation "CVR" is also acceptable under certain circumstances such as unavoidable repetition, or referencing things that exist in-game or within the CCK already using it. + +### Addressing ABI + +When addressing Alpha Blend Interactive, please use first-person plural pronouns, such as "we", "our", and "us". There shouldn't be any instances where the full company name is used, but if needed, use the full proper company name: "Alpha Blend Interactive, Inc.". + +## Embed Rules + +This section is incomplete and will be added to over time. + *You may not:* + - Add files or assets for use directly within Unity From c53c1066e6691934ebea97d984a996406494a3d8 Mon Sep 17 00:00:00 2001 From: loliwut <77616595+loliwut@users.noreply.github.com> Date: Fri, 1 Nov 2024 17:21:42 +0000 Subject: [PATCH 15/16] Update CONTRIBUTING.md some formatting and wording cleanup --- CONTRIBUTING.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aadca77..80e2fcd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing +# Contributing to CCK Docs ## Notification Boxes For inserting notification fields, always keep in mind that they stand out from the body of text and will typically be read first. as a result, they should be **before** a section unless they refer to something between two paragraphs. @@ -137,5 +137,7 @@ When addressing Alpha Blend Interactive, please use first-person plural pronouns ## Embed Rules This section is incomplete and will be added to over time. - *You may not:* - - Add files or assets for use directly within Unity + +*You may not:* + + - Add files or assets for use directly within Unity From 79cafba65eded7bf190d22ec27895e825074f771 Mon Sep 17 00:00:00 2001 From: loliwut <77616595+loliwut@users.noreply.github.com> Date: Fri, 1 Nov 2024 17:24:50 +0000 Subject: [PATCH 16/16] Update README.md Include link to CONTRIBUTING.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 52fd480..0fbee51 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,8 @@ This repository contains the source files for the Alpha Blend Interactive Docume Please contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Create a fork, add commits, and [open a pull request](https://github.com/Alpha-Blend-Interactive/docs/compare). +For guidance writing new documents for CCK components, please follow our [style guide](https://github.com/Alpha-Blend-Interactive/docs/blob/master/CONTRIBUTING.md). + ### ABI employee's / ABI internal contributors For any changes, make a feature branch. @@ -52,4 +54,4 @@ We recommend previewing the site before submitting your PR. To preview the site To run a local development server now, just run `.\serve.bat` or `mkdocs serve` if your directly within your venv -You now have a development server running at [http://127.0.0.1:8000/](http://127.0.0.1:8000/) \ No newline at end of file +You now have a development server running at [http://127.0.0.1:8000/](http://127.0.0.1:8000/)