Skip to content

Commit

Permalink
Doc and Style adjustments.
Browse files Browse the repository at this point in the history
  • Loading branch information
JustBuddy committed Apr 2, 2024
1 parent b226474 commit bd6019e
Show file tree
Hide file tree
Showing 12 changed files with 43 additions and 23 deletions.
Binary file added src/content/docs/framework/img/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions src/content/docs/framework/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Quick-start your creation process, every time!
---
import { Aside } from '@astrojs/starlight/components';

![Product Banner.](./img/banner.png)

*Quick-start your creation process, every time!*

#### Welcome to the Avatar Framework docs.
Expand Down
4 changes: 3 additions & 1 deletion src/content/docs/framework/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ title: BUDDYWORKS Avatar Framework - Setup
description: Quick-start your creation process, every time!
---

**Installation Instructions**
![Product Banner.](./img/banner.png)

## 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:
Expand Down
4 changes: 3 additions & 1 deletion src/content/docs/framework/structure-FX.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ description: Quick-start your creation process, every time!
---
import { Aside } from '@astrojs/starlight/components';

**The FX-Template**
![Product Banner.](./img/banner.png)

## 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.
Expand Down
4 changes: 3 additions & 1 deletion src/content/docs/framework/structure-menu.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ description: Quick-start your creation process, every time!
---
import { Aside } from '@astrojs/starlight/components';

**Overall Menu Layout**
![Product Banner.](./img/banner.png)

## 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.
Expand Down
Binary file added src/content/docs/posesextension/img/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions src/content/docs/posesextension/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Locomotion-agnostic pose framework.
---
import { Aside } from '@astrojs/starlight/components';

![Product Banner.](./img/banner.png)

*Locomotion-agnostic pose framework.*

#### Welcome to the Poses Extension Docs
Expand Down
Binary file added src/content/docs/scene/img/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions src/content/docs/scene/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: BUDDYWORKS Avatar Scene
description: Ready to go Scene for fancy avatar deployments.
---

![Product Banner.](./img/banner.png)

*Ready to go Scene for fancy deployments.*

#### Welcome to the Avatar Scene docs.
Expand Down
2 changes: 2 additions & 0 deletions src/content/docs/scene/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Ready to go Scene for fancy avatar deployments.
---
import { Aside } from '@astrojs/starlight/components';

![Product Banner.](./img/banner.png)

#### About the Scene

![The scene's hierarchy.](./img/002.png)
Expand Down
44 changes: 25 additions & 19 deletions src/content/docs/scene/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,31 @@ title: BUDDYWORKS Avatar Scene - Setup
description: Ready to go Scene for fancy avatar deployments.
---
import { Aside } from '@astrojs/starlight/components';
import { Tabs, TabItem } from '@astrojs/starlight/components';
import { Steps } from '@astrojs/starlight/components';

#### Installing the Template
![Product Banner.](./img/banner.png)

### 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.
You need to import AudioLink and LTCGI beforehand if you plan to use them.

## Installation
<Tabs>
<TabItem label="VCC Package">
<Steps>
1. 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.
2. After that, you can copy the data into your */Assets/* directory by using the toolbar menu:
![Toolbar menu import.](./img/001.png)
3. 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.
4. 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>
</Steps>
</TabItem>
<TabItem label=".unitypackage">
> Importing 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.
</TabItem>
</Tabs>
2 changes: 1 addition & 1 deletion src/styles/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@
text-decoration: none;
display: inline-flex;
margin-top: 1rem;
}
}

0 comments on commit bd6019e

Please sign in to comment.