You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Basis stores user-generated content as a .BEE file which contains your compiled asset and metadata about it. Each generated .BEE file comes with a randomly generated password used to access it, both of which can be found in the root directory of your Unity project at: `Basis\Basis\AssetBundles`.
10
+
7
11
## Avoid Duplicate GameObjects
8
12
9
-
- Basis Avatar will by default rename all duplicate name GameObjects within the avatar's hierarchy.
13
+
- By default, the BasisAvatar component will rename all duplicate name GameObjects within the avatar's hierarchy.
14
+
10
15
<Callouttype="warning">
11
16
If you enable `Do not auto-rename bones` in the Processing Options. Ensure that there are **NO** duplicate named GameObjects within the hierarchy of your avatar, including the armature, as this will cause your avatar to fail to load after building the AssetBundle.
12
17
</Callout>
13
18
14
19
## Build the AssetBundle
15
20
16
-
- At the bottom of the Basis Avatar component on your Avatar, check that the appropriate build targets for your content are enabled (Windows, Mac, Linux etc) (NOTE: If building for Basis Framework public testing please use all possible build targets)
21
+
- At the bottom of the Basis Avatar component on your Avatar, check that the appropriate build targets for your content are enabled. Basis supports various target platforms, including: Windows, Android, Mac, Linux and IOS.
17
22
- Press the 'Create Avatar Bee File' button and wait for this process to complete.
18
23
19
24

@@ -22,24 +27,22 @@ If you enable `Do not auto-rename bones` in the Processing Options. Ensure that
22
27
23
28

24
29
30
+
- Depending on your hardware, each platform may take an average of a minute or two to build the first time. Subsequent builds should take less time due to caching. Building for all platforms will likely take additional time and increase the overall file size.
31
+
25
32
<Callouttype="info">
26
-
Basis uses the .BEE file extension, which contains your compiled asset and meta data, in order to simplify user generated content.
33
+
Nice to know:
27
34
28
-
The .BEE file, along with a randomly generated password to access it, is created under your Unity Project path /AssetBundles/ directory and is hidden from Unity by default.
35
+
- You can conveniently use a custom password for your generated BEE file instead. This can make things easier to remember if you prefer a single password to use for different BEE files.
29
36
30
-
If you prefer, you can also replace the generated .BEE file name with something more easily memorable. Keep in mind that reusing the same name will result in any previous version being replaced by the new one!
31
-
</Callout>
37
+
- If you prefer, you can also replace the generated .BEE file name with something more easily memorable. Keep in mind that reusing the same name will result in any previous version being replaced by the new one!
32
38
33
-
- Each platform takes on average 2 minutes from cold/no cache build. Building for all platforms will take some time. Likely more than 10 minutes for all platforms. Hot build/cached took little over 2 mins on same avatar and specs.
34
39
35
-
<Callouttype="info">
36
-
An avatar with 18 materials using Poiyomi URP with 120K polygons, with package size 45MB per platform, took 9m 43s on a Ryzen 7 9800x3D. Jan, 2026
40
+

37
41
</Callout>
38
42
39
-
40
-
## Locally Test the Avatar
41
-
42
-
Testing the .BEE file locally is not yet supported and will be implemented in the near future, please proceed to [Uploading Your Avatar](/docs/avatar/uploading).
43
+
<Callouttype="info">
44
+
January 2026 Anecdote: An avatar with 18 materials using Poiyomi URP with 120K polygons, with package size 45MB per platform, took 9m 43s on a Ryzen 7 9800x3D to build for all target platforms.
45
+
</Callout>
43
46
44
47
{/* - Once the .BEE file has been created, you can load this via the `BootManager` prefab found at `Packages > Basis SDK > Prefabs > Boot`.
Copy file name to clipboardExpand all lines: content/docs/avatar/setup.mdx
+24-11Lines changed: 24 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,6 +46,15 @@ If you place your content within a new directory "Assets > _UserContent" the def
46
46
47
47

48
48
49
+
<Callouttype="info">
50
+
In some cases, the Unity inspector might mention that your avatar's bone mappings aren't properly assigned, or that the avatar isn't T-posed properly. To fix this, you can click on the Mapping and Pose dropdowns and select Automap or Enforce T-Pose.
51
+
52
+

53
+
54
+

55
+
56
+
</Callout>
57
+
49
58
## Skinned Mesh Setup
50
59
51
60
- There are currently no requirements to name your Avatar's Skinned Mesh as `Body` or other variation used on Virtual Platforms.
@@ -67,21 +76,25 @@ If you place your content within a new directory "Assets > _UserContent" the def
67
76
68
77
- The steps above should automatically add an Animator component to your Avatar prefab when you pull it into the Scene.
69
78
- On the Parent GameObject of the Avatar, click `Add Component`, and add `Basis Avatar`.
79
+
- Enter your preferred Avatar Name and Description.
80
+
- In `Assigned Input`, ensure an Animator is assigned. Usually, this will automatically be done for you. Additionally, assign the Skinned Mesh Renderers which contain the face and blink blendshapes for your avatar. You can also add an optional thumbnail icon for your avatar if you like.
81
+
- In `Viseme Setup`, assign the relevant visemes and blinking for your avatars. You can also use the automatic detection buttons which will try to automatically do this for you.
82
+
- Optionally, you can test your avatar in the editor by first entering play mode and then selecting the `Test in Editor` option.
83
+
- Before selecting `Create Avatar Bee File`, ensure that all your shaders are compatible. The BEE file will not generate if there are incompatible shader errors on your avatar (this includes clothing and attachments). If there are any issues, the inspector will report about it so make sure to resolve them!
70
84
71
-
If you're struggling to find the view ball or indicator for the Eye Position, follow these steps:
85
+

86
+
87
+

88
+
89
+
<Callouttype="info">
90
+
In case you're new to Skinned Mesh Renderer blendshapes or uploading avatars in general, they're basically just sliders that you can control to change the morphs on your avatar.
91
+
92
+

93
+
</Callout>
72
94
73
-
- Top Right next to XYZ, click the Eye.
74
-
- Enable "Eye Position Gizmo" inside of the `Basis Avatar` component.
75
95
76
-
You should now see a green Gizmo for your eyes; move this up between your eyes and on the same plane as your eyes.
77
96
78
-
**Ensure you have assigned each of the following:**
79
-
- Animator
80
-
- Face Viseme
81
-
- Face Blink
82
-
- Avatar Name
83
-
- Avatar Description
84
97
85
98
## Constraints Setup
86
99
87
-
Basis does not use the built-in Unity Constraints system, instead it uses Animation Rigging. You can find the setup guide [here](/docs/avatar/animation-rigging#setup-for-animation-rigging-packages).
100
+
Basis does not use the built-in Unity Constraints system, instead it uses Animation Rigging. You can find the setup guide [here](/docs/avatar/animation-rigging#setup-for-animation-rigging-packages).
0 commit comments