Installation

AUI is a paid product. Access, downloads and support all go through the Discord; if you do not have the package yet, start there.

Requirements

Unity	2022.3 (the version VRChat currently targets)
VRChat Worlds SDK	3.10.4 or newer, with UdonSharp
TextMeshPro	included with the SDK

Install the VRChat SDK before importing AUI. The package references com.vrchat.worlds and UdonSharp, and importing it into a project without them gives you a wall of missing-type errors rather than a clear message.

Import the package

You receive AUI as a .unitypackage.

1. Open your VRChat world project.
2. Assets > Import Package > Custom Package, pick the .unitypackage, and import everything. (Double-clicking the file with the project open does the same thing.)
3. Let Unity finish compiling. You should see an AUI menu appear in the menu bar.

If the AUI menu does not appear, the import did not compile. Check the console for errors, and confirm the SDK is present.

Updating

Import the new .unitypackage over the top; it replaces the package files in place. Your own .aui, .auis, .cs and language files live outside the package folder and are untouched. After a version that changes what the prefab builder emits, run AUI/Rebuild All Views once.

One-time project setup

Four steps, once per project (and two of them once per scene).

1. Create the settings asset

AUI/Create Settings creates Assets/AUI/AuiSettings.asset and an Assets/AUI/Lang/ folder. The asset holds the language folder path, the default language code, the extra folders searched for views and icons, and the font configuration. One per project, found by type.

2. Add at least one language file

Every visible string is a translation key, so a view cannot build without a default language. Create Assets/AUI/Lang/en.json:

{
  "_name": "English",
  "hello": {
    "title": "Hello",
    "greeting": "Hi {playerName}",
    "wave": "Wave"
  }
}

_name is what the language picker shows. Nesting is only for your convenience: the file is flattened, so the key above is hello.title. The default language code is on the settings asset (defaultLanguage, en out of the box).

See Languages for placeholders, fallbacks and adding more languages.

3. Bake the fonts

AUI/Bake Fonts reads every language file and bakes font atlases containing exactly the glyphs those files use, into Assets/AUI/Fonts/, then assigns the resulting AuiFontSet.asset to the settings.

Re-run it whenever a language file gains characters the atlases do not have. Boxes instead of letters in-world is the sign that you need to.

4. Create the scene services

In each scene that shows a view:

• AUI/Rebuild Language Table creates the AUI Language Service object and bakes the merged language files onto it.
• AUI/Rebuild Input Panel creates the AUI Input Panel, the invisible click target that <input> elements need to open VRChat's keyboard.

Views find both by name at start, because a prefab cannot hold a reference to a scene object.

A scene with views but no language service

Every text renders as ??. The build rebakes the table after each prefab build if the scene already has a service; if it has none, nothing creates one for you. Run AUI/Rebuild Language Table once per scene.

Editor tooling

Optional, and worth the two minutes: the VS Code extension gives diagnostics as you type, completion for translation keys, classes and icons, go to definition, rename across views and language files, and quick fixes that create a missing key or handler for you.

See the VS Code extension for how to install it.

Verify the setup

Import the Demo sample and check it builds:

1. Import the sample (it ships with the package).
2. Watch the console for [AUI] built ... lines; children build before parents.
3. AUI/Rebuild Input Panel in the scene you place it in.
4. Drop AuiGallery.prefab into the scene, about 1.2 m up and facing the player.

The gallery is also the runtime test suite. In play mode, press Run tests and every check logs [AUI gallery] PASS to the console. See the gallery.

Next: your first view.