Added Framework Documentation.

astro.config.mjs

@@ -27,26 +27,29 @@ export default defineConfig({
 					items: [
 						// Each item here is one entry in the navigation menu.
 						{ label: 'Getting started', link: '/framework/intro/' },
+						{ label: 'Installation', link: '/framework/setup/' },
+						{ label: 'Menu Structure', link: '/framework/structure-menu/' },
+						{ label: 'FX Structure', link: '/framework/structure-fx/' },
+
 					],
 				},
 				{
 					label: 'Avatar Scene',
 					items: [
 						// Each item here is one entry in the navigation menu.
 						{ label: 'Getting started', link: '/scene/intro/' },
+						{ label: 'Installation', link: '/scene/setup/' },
+						{ label: 'Tester Prefabs', link: '/scene/testers/' },
 					],
 				},
 				{
 					label: 'Poses Extension',
 					items: [
 						// Each item here is one entry in the navigation menu.
 						{ label: 'Getting started', link: '/posesextension/intro/' },
+						{ label: 'Installation', link: '/posesextension/setup/' },
 					],
 				},
-				{
-					label: 'Reference',
-					autogenerate: { directory: 'reference' },
-				},
 			],
 		}),
 	],

src/content/docs/framework/doc2.md

@@ -0,0 +1,63 @@
+---
+title: BUDDYWORKS Avatar Framework
+description: Quick-start your creation process, every time!
+---
+
+BUDDYWORKS Avatar Framework v2.0
+by Buddy_DE
+
+PLEASE INCLUDE THIS DOCUMENT INSIDE THE AVATARS UNITY PACKAGE OR ALONGSIDE IT BY OTHER MEANS.
+
+0. Notes and "License"
+Usage of the framework is free of charge, the included icons can be used for private and commercial use, including using them for commission work or the production of a prefabricated avatar. (free/nitro/sale)
+The Icons can also be used in a free public avatar, but please make sure that so can everything else.
+The framework comes as is, the author is not to be made responsible for any damage it may induce in any way. Purpose is to be a quickstart point and a general recommendation around most best practices, it will however not do the thinking for you. This is a template, adjust it to your needs.
+Crediting me is optional, along the lines of "BUDDYWORKS Avatar Framework v5 by Buddy_DE"
+
+Icons not from the SDK are from Carbon-Copy, graciously provided by Dreadrith and JustSleightly.
+
+USE OF VRCSDK+ FROM DREADRITH IS EXTREMELY RECOMMENDED WHEN WORKING WITH THIS MENU, SO IS CONTROLLER EDITOR FOR EDITING THE FX CONTROLLER.
+
+0. Menu
+Leave the GoGoLoco Placeholder in, VRCFury will overwrite it with the Prefab, it will not create a new menu entry. Means the Framework assumes you adopt GoGoLoco, if you dont, just adjust it.
+
+1. Expressions
+Setting up the expressions should be straightforward if you have done that before already.
+The logic is included, you just need to insert the expressions you want in the corresponding slots.
+If you want the gestures to mix, you could set up the animations for mouth at one hand and for the rest of the face on the other. How you end up designing it is up to you. Make use of the "Idle" state to neutralize all modified blendshapes on each hand. The expressions should be animated with at least two frames for transitioning, the logic uses a weight float to smoothly animate it.
+
+2. Exclusive Switches
+The premade layers Tops, Pants and Shoes are written as exclusive INT toggles, meaning that only one option of each layer can be active at once. This is useful for things you don't want to let conflict with each other. Adapt and duplicate as you seem fit. 
+IMPORTANT: This system assumes WD On workflow, make sure that the animations other than default disable whatever default enables, else you will see the default outfit stuck below the selected other outfit.
+Means: Animate Default properties OFF in the other outfit clips.
+
+3. Presets
+This layer is exclusively working with parameter drivers, allowing you to specify parameters to change on each of the states. This gives you a simple way to create outfit presets which involve multiple pieces, maybe including some toggles as well. Use as you see fit, or don't, up to you.
+Keep the Parameter Driver for "Clothing/Preset" at 0, so it can return back to its idle state properly.
+
+4. Toggles and Sliders
+What I like to call "The Master Blendtree", here you create non-exclusive toggles and also sliders/radials like hue shifts or bodypart compensati... shaping. Using a direct blendtree not only makes creating toggles easier, it is also extremely efficient. All parts of the blendtree can work independent from each other, meaning you can toggle and slide everything independently.
+Double click on "Blend Tree" to open the forest, most of it is already set up in a way that needs you to just slot the animation clips in.
+Note: Blendtrees can only work with float parameters, we make use of a technique called "parameter mismatch" to work around this. Essentially, you create a parameter as bool in your parameter list, but in the FX you instead create it as a float. This gets translated, false being 0 and true being 1.
+
+Please note the following limitations:
+- The Blendtree itself can not have any kind of logic, however you can drive its parameters by parameter drivers on a different layer.
+- Things with a constant animation, like image slideshows or tail-wags, are really janky in a blendtree. Prefer keeping those in a separate layer if they misbehave.
+- THERE IS NO SUCH THING AS DISSOLVE ANIMATIONS IN A DIRECT BLENDTREE TOGGLE! Since we use parameter mismatch, every animation's state will fling directly to off or on, you don't get to see the inbetweens. You would need a very convoluted logic and parameter smoothing system to circumvent that, but at that point you might as well run the thing outside the blendtree.
+
+ The tree is written in the Write Defaults ON workflow, using WD Off at any point in your avatar will break its behavior. If you need WD Off, you need to rewrite the toggles to account for that.
+
+ If you want a throughout guide on how to write and maintain a blendtree, I highly recommend this resource: https://notes.sleightly.dev/dbt-combining/
+ Please note that this guide shows you how to write Direct BlendTree toggles in the WD Off workflow, the tree provided by me is written in the WD On workflow.
+
+5. Relief
+That should be it, anything else is just a matter of exploration, the menu structure should be self explanatory, examples are included.
+
+If you have any questions, don't fear to ask in the BUDDYWORKS Discord, we happily help with anything avatar and worlds related and you are very welcome to jump in.
+
+https://discord.gg/g7u2qJRc6x
+https://buddyworks.wtf/ 
+
+Thank you for choosing BUDDYWORKS assets for your project, cheers!
+
+-Buddy

src/content/docs/framework/intro.md

@@ -3,9 +3,10 @@ title: BUDDYWORKS Avatar Framework
 description: Quick-start your creation process, every time!
 ---
 
-Quick-start your creation process, every time!
+*Quick-start your creation process, every time!*
 
-Welcome to the Avatar Framework docs.  
+### Welcome to the Avatar Framework docs.  
 This page will explain various aspects of the framework, from its usage to more advanced applications.  
 
-## WIP
+> **Note:** This page refers to Framework v2, but this should mostly apply to v1 as well.
+

src/content/docs/framework/setup.md

@@ -0,0 +1,24 @@
+---
+title: BUDDYWORKS Avatar Framework - Setup
+description: Quick-start your creation process, every time!
+---
+
+**Installation Instructions**  
+Getting started is simple, just grab the package from our <a href="https://repo.buddyworks.wtf">VCC Repository</a> and import it into your project.  
+
+After import, you can add the resource data into your /Assets/ folder using the new Toolbar Menu:  
+
+![Toolbar menu import.](./img/001.png)  
+
+Clicking those will open a prompt which asks you to choose a directory to add the files to.  
+
+By default, this can be the root directory. Note that if there is already a Directory called "BUDDYWORKS" at your target, the new folder will be called "BUDDYWORKS 1" to avoid overwriting data by accident.
+
+After that is done, you are good to go. Proceed to use the new template files for your new project.
+
+**Important Files**
+- **\_BW_FX:** The FX Animator used for the avatars logic.
+- **\_BW_Main Menu:** The root menu file.
+- **\_BW_Parameters:** A list of parameters used inside the FX.
+
+You will learn about the structure of the menu and FX on the following pages.

src/content/docs/framework/structure-FX.md

@@ -0,0 +1,29 @@
+---
+title: BUDDYWORKS Avatar Framework - FX Structure
+description: Quick-start your creation process, every time!
+---
+
+**The FX-Template**
+
+The FX template is named "\_BW_FX".  
+It contains the essential layers commonly used by avatars, you can duplicate and expand as you see fit.  
+
+> **Note:** v1 and v2 almost have the same FX Controller, the only difference is a slightly different approach with the Presets Layer. 
+
+
+
+### FX Animator
+
+![Menu preview](./img/003.png)  
+
+> **Note:** The animator is written in full WriteDefaults ON workflow, please keep that in mind.
+
+- **Base:** Obligatory, make sure it is empty at all times.
+- **Left/Right Hand**: Layers for face expressions made with your hands.
+- **Tops/Pants/Shoes:** INT switches that allow you to write exclusive toggles.
+- **Presets:** You can use the Presets layer to drive multiple parameter drivers at once, allowing for preset sets of your toggles.
+- **Toggles and Sliders:** The heart of operation, this is a premade DirectBlendTree ready to use.
+
+To learn more about DirectBlendTrees, we can recommend this writeup: <a href="https://notes.sleightly.dev/dbt-combining/">Combining Layers Using Direct Blend Trees</a>
+
+This is the gist, you will find more fine-grained detail in the text document provided inside the Avatar Framework folder or <a href="../doc2">here</a>.

src/content/docs/framework/structure-menu.md

@@ -0,0 +1,25 @@
+---
+title: BUDDYWORKS Avatar Framework - Menu Structure
+description: Quick-start your creation process, every time!
+---
+
+**Overall Menu Layout**
+
+BUDDYWORKS Menus are prefixed with "\_BW".  
+The menu comes with my lovely programmer-art as substitute icons, you probably want to replace those for your own icons.
+
+> **Note:** The structure for v2 is heavily slimmed down compared to v1, which used to be a bit convoluted. v2 prefers speedy use, while v1 prefers a fully fledged folder structure.   
+Both are fine when used correctly.
+
+### Main Menu
+
+![Menu preview](./img/002.png)  
+
+- **Settings:** Any kind of general settings, like contact toggles or other low-frequency options.
+- **Shifts:** All your shifts, be it hue shifts or other sliders, go here.
+- **Logo Menu:** Used as a quick menu for features you expect people to use often.
+- **Stuff:** Props, funky features, any kind of toggles that don't belong elsewhere.
+- **Clothing:** Contains all clothing options of the avatar.
+- **GoGo Loco:** A placeholder for GoGO Locomotion. When using the VRCFury Prefab for GGL, this menu gets overwritten.
+
+All these menus contain sub menu which should be self explainatory.

src/content/docs/index.mdx

@@ -3,11 +3,11 @@ title: BUDDYWORKS Docs
 description: All the details you could ever need.
 template: splash
 hero:
-  tagline: Welcome to our documentation page.
+  tagline: Welcome to our documentation page. Here you will find various documentations of our assets to reference.
   image:
     file: ../../assets/Logo_2.png
   actions:
-    - text: Browse...
+    - text: Browse
       link: /welcome/intro/
       icon: right-arrow
       variant: primary

src/content/docs/welcome/intro.md

@@ -3,9 +3,14 @@ title: BUDDYWORKS Docs
 description: All the details you could ever need.
 ---
 
-Welcome to our documentation page.
+## Welcome to our documentation page.
 
-You find the docs for each of our assets in the left sidebar. 
+*You find the docs for each of our assets in the left sidebar.*
 
-Questions? Contact me in my Discord!  
+#### Supported assets:  
+- <a href="/framework/intro">BUDDYWORKS Avatar Framework v2</a>  
+- <a href="/scene/intro">BUDDYWORKS Avatar Scene</a>
+- <a href="/posesextension/intro">BUDDYWORKS Poses Extension</a>
+
+**Questions? Contact me in my Discord!**  
 https://discord.buddyworks.wtf