diff --git a/astro.config.mjs b/astro.config.mjs index 8b47936..2660268 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -39,7 +39,7 @@ export default defineConfig({ // 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: 'Scene Overview', link: '/scene/overview/' }, ], }, { diff --git a/src/content/docs/framework/doc2.md b/src/content/docs/framework/doc2.mdx similarity index 100% rename from src/content/docs/framework/doc2.md rename to src/content/docs/framework/doc2.mdx diff --git a/src/content/docs/framework/intro.md b/src/content/docs/framework/intro.mdx similarity index 57% rename from src/content/docs/framework/intro.md rename to src/content/docs/framework/intro.mdx index d9019de..0a10214 100644 --- a/src/content/docs/framework/intro.md +++ b/src/content/docs/framework/intro.mdx @@ -2,11 +2,12 @@ title: BUDDYWORKS Avatar Framework description: Quick-start your creation process, every time! --- +import { Aside } from '@astrojs/starlight/components'; *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. -> **Note:** This page refers to Framework v2, but this should mostly apply to v1 as well. + diff --git a/src/content/docs/framework/setup.md b/src/content/docs/framework/setup.mdx similarity index 100% rename from src/content/docs/framework/setup.md rename to src/content/docs/framework/setup.mdx diff --git a/src/content/docs/framework/structure-FX.md b/src/content/docs/framework/structure-FX.mdx similarity index 78% rename from src/content/docs/framework/structure-FX.md rename to src/content/docs/framework/structure-FX.mdx index 6c25fd0..7cf6f47 100644 --- a/src/content/docs/framework/structure-FX.md +++ b/src/content/docs/framework/structure-FX.mdx @@ -2,13 +2,14 @@ title: BUDDYWORKS Avatar Framework - FX Structure description: Quick-start your creation process, every time! --- +import { Aside } from '@astrojs/starlight/components'; **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. + @@ -16,7 +17,7 @@ It contains the essential layers commonly used by avatars, you can duplicate and ![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. diff --git a/src/content/docs/framework/structure-menu.md b/src/content/docs/framework/structure-menu.mdx similarity index 77% rename from src/content/docs/framework/structure-menu.md rename to src/content/docs/framework/structure-menu.mdx index 41cb65c..d8603c7 100644 --- a/src/content/docs/framework/structure-menu.md +++ b/src/content/docs/framework/structure-menu.mdx @@ -2,14 +2,16 @@ title: BUDDYWORKS Avatar Framework - Menu Structure description: Quick-start your creation process, every time! --- +import { Aside } from '@astrojs/starlight/components'; **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 diff --git a/src/content/docs/posesextension/intro.md b/src/content/docs/posesextension/intro.md deleted file mode 100644 index 59695e4..0000000 --- a/src/content/docs/posesextension/intro.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: BUDDYWORKS Avatar Scene -description: Ready to go Scene for fancy deployments. ---- - -Ready to go Scene for fancy deployments. - -Welcome to the Avatar Scene docs. - -## WIP diff --git a/src/content/docs/posesextension/intro.mdx b/src/content/docs/posesextension/intro.mdx new file mode 100644 index 0000000..b1e4590 --- /dev/null +++ b/src/content/docs/posesextension/intro.mdx @@ -0,0 +1,11 @@ +--- +title: BUDDYWORKS Poses Extension +description: Locomotion-agnostic pose framework. +--- +import { Aside } from '@astrojs/starlight/components'; + +*Locomotion-agnostic pose framework.* + +#### Welcome to the Poses Extension Docs + +## WIP diff --git a/src/content/docs/posesextension/setup.mdx b/src/content/docs/posesextension/setup.mdx new file mode 100644 index 0000000..b1e4590 --- /dev/null +++ b/src/content/docs/posesextension/setup.mdx @@ -0,0 +1,11 @@ +--- +title: BUDDYWORKS Poses Extension +description: Locomotion-agnostic pose framework. +--- +import { Aside } from '@astrojs/starlight/components'; + +*Locomotion-agnostic pose framework.* + +#### Welcome to the Poses Extension Docs + +## WIP diff --git a/src/content/docs/scene/img/001.png b/src/content/docs/scene/img/001.png new file mode 100644 index 0000000..9de7bb4 Binary files /dev/null and b/src/content/docs/scene/img/001.png differ diff --git a/src/content/docs/scene/img/002.png b/src/content/docs/scene/img/002.png new file mode 100644 index 0000000..2168c50 Binary files /dev/null and b/src/content/docs/scene/img/002.png differ diff --git a/src/content/docs/scene/img/003.png b/src/content/docs/scene/img/003.png new file mode 100644 index 0000000..36028d9 Binary files /dev/null and b/src/content/docs/scene/img/003.png differ diff --git a/src/content/docs/scene/intro.md b/src/content/docs/scene/intro.md deleted file mode 100644 index 59695e4..0000000 --- a/src/content/docs/scene/intro.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: BUDDYWORKS Avatar Scene -description: Ready to go Scene for fancy deployments. ---- - -Ready to go Scene for fancy deployments. - -Welcome to the Avatar Scene docs. - -## WIP diff --git a/src/content/docs/scene/intro.mdx b/src/content/docs/scene/intro.mdx new file mode 100644 index 0000000..58e5450 --- /dev/null +++ b/src/content/docs/scene/intro.mdx @@ -0,0 +1,13 @@ +--- +title: BUDDYWORKS Avatar Scene +description: Ready to go Scene for fancy avatar deployments. +--- + +*Ready to go Scene for fancy deployments.* + +#### Welcome to the Avatar Scene docs. + +The BUDDYWORKS Avatar Scene is a premade scene made with avatar editing in mind. +It contains various prefabs and other neat things. + +The following pages will tell you a bit about everything there is to say. \ No newline at end of file diff --git a/src/content/docs/scene/overview.mdx b/src/content/docs/scene/overview.mdx new file mode 100644 index 0000000..a4a8d43 --- /dev/null +++ b/src/content/docs/scene/overview.mdx @@ -0,0 +1,21 @@ +--- +title: BUDDYWORKS Avatar Scene - Overview +description: Ready to go Scene for fancy avatar deployments. +--- +import { Aside } from '@astrojs/starlight/components'; + +#### About the Scene + +![The scene's hierarchy.](./img/002.png) + +The scene structure is rather simple. The object "\_System" contains all scene elements and assets. + + +- **Floorplane:** A simple plane your work stands on, looks like a 3D Print plate. +- **Directional Light:** A neutral light suitable for good color reproduction in ideal conditions. +- **Main Camera:** A orthographic camera, as seen as in the game view. Used to check symetry. +- **AudioLinkAvatar:** When enabled, will start a YouTube Video as audio. If your materials use AudioLink, they will react to that. +- **LTCGI Tester:** A tester for LTCGI effects. Note that this only works for materials that support it. + + +![Scene- and Gameview.](./img/003.png) \ No newline at end of file diff --git a/src/content/docs/scene/setup.mdx b/src/content/docs/scene/setup.mdx new file mode 100644 index 0000000..661f7cc --- /dev/null +++ b/src/content/docs/scene/setup.mdx @@ -0,0 +1,27 @@ +--- +title: BUDDYWORKS Avatar Scene - Setup +description: Ready to go Scene for fancy avatar deployments. +--- +import { Aside } from '@astrojs/starlight/components'; + +#### Installing the Template + +The installation process depends on which distribution you use. +You need to import AudioLink and LTCGI beforehand if you plan to use them. + +##### VCC Package +Getting started is simple, just grab the package from our VCC Repository and import it into your project. + +After that, you can copy the data into your */Assets/* directory by using the toolbar menu: +![Toolbar menu import.](./img/001.png) + +This might open a save dialogue, this is for your current scene if you have an unsaved scene open. +If the scene in question is the default scene, just close the save dialogue. + +Once done, you will find the data in */Assets/BUDDYWORKS/Avatar Scene* +The script will open the scene for you. + + + +##### .unitypackage +Installing the Unitypackage will directly give you all data inside */Assets/BUDDYWORKS/Avatar Scene*, you will need to open the scene yourself. That is basically it. \ No newline at end of file