Skip to content

Commit

Permalink
Added Avatar Scene Docs, more fancy formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
JustBuddy committed Mar 28, 2024
1 parent 93c160d commit e5c5349
Show file tree
Hide file tree
Showing 16 changed files with 94 additions and 27 deletions.
2 changes: 1 addition & 1 deletion astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -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/' },
],
},
{
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<Aside> We generally assume Framework v2, but this should mostly apply to v1 as well.</Aside>

File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,22 @@
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.
<Aside> v1 and v2 have almost the same FX Controller, the only difference is a slightly different approach with the Presets Layer. </Aside>



### FX Animator

![Menu preview](./img/003.png)

> **Note:** The animator is written in full WriteDefaults ON workflow, please keep that in mind.
<Aside type="caution"> The animator is written in full WriteDefaults ON workflow, please keep that in mind.</Aside>

- **Base:** Obligatory, make sure it is empty at all times.
- **Left/Right Hand**: Layers for face expressions made with your hands.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<Aside>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.**</Aside>

### Main Menu

Expand Down
10 changes: 0 additions & 10 deletions src/content/docs/posesextension/intro.md

This file was deleted.

11 changes: 11 additions & 0 deletions src/content/docs/posesextension/intro.mdx
Original file line number Diff line number Diff line change
@@ -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
11 changes: 11 additions & 0 deletions src/content/docs/posesextension/setup.mdx
Original file line number Diff line number Diff line change
@@ -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
Binary file added src/content/docs/scene/img/001.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/content/docs/scene/img/002.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/content/docs/scene/img/003.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 0 additions & 10 deletions src/content/docs/scene/intro.md

This file was deleted.

13 changes: 13 additions & 0 deletions src/content/docs/scene/intro.mdx
Original file line number Diff line number Diff line change
@@ -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.
21 changes: 21 additions & 0 deletions src/content/docs/scene/overview.mdx
Original file line number Diff line number Diff line change
@@ -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.
<Aside>When installing the VCC version, the AudioLinkAvatar and LTCGI Tester prefabs might not appear if you didn't import the packages beforehand.</Aside>

- **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)
27 changes: 27 additions & 0 deletions src/content/docs/scene/setup.mdx
Original file line number Diff line number Diff line change
@@ -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 <a href="https://repo.buddyworks.wtf">VCC Repository</a> 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.

<Aside> If there was an error or the data is already imported, the import will abort and you will get a corresponding message printed into your console.</Aside>

##### .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.

0 comments on commit e5c5349

Please sign in to comment.