How It Fits Together
You add one dependency. It gives you three modules — Auth, Inventory, and Notifications — plus NAF, which renders the avatar.
NAF stands for Native Avatar Framework: the engine that loads, animates, and renders Genies avatars. It stays separate from the modules because it has its own API and its own version number.
Imports
Each module has its own package, and NAF is its own library:
import com.genies.auth.GeniesAuth // Auth
import com.genies.inventory.GeniesInventory // Inventory
import com.genies.notifications.GeniesNotifications // Notifications
import com.genies.naf.* // rendering
Auth, Inventory, and Notifications ship in a single artifact; the NAF libraries arrive transitively, so they're on your compile classpath without being declared.
Where to look for what
| If you need to… | Module |
|---|---|
| Sign a user in, or refresh their session | Auth |
| See what a user owns | Inventory |
| List a user's avatars, or get a name, icon, or identifier | Inventory |
| React when ownership changes | Notifications |
| Put an avatar on screen and animate it | NAF |
The short version: the modules tell you which avatar; NAF draws it. The avatar APIs hand back identifiers and display data, not models or textures.
Avatars and smart avatars
There are two kinds of avatar, and the difference matters when you build a picker:
- An avatar is a look — body, face, and wearables. NAF renders it and can equip wearables on it.
- A smart avatar wraps an avatar with a brain, behavior, and voice. It renders identically, and it is the only kind that can hold a conversation.
Every avatar the SDK returns carries a canChat flag, true only for smart avatars. A plain avatar can't be upgraded to a smart avatar from the SDK — that's a content-publishing step.
Handing an avatar to NAF
Avatar identifiers are opaque strings such as bm_smart-avatar_<hex>. You wrap whichever identifier you have in an avatar reference and pass it along — the SDK recognizes the format, so you never pick an endpoint or document type yourself.
That reference is the seam between the two: the Inventory module produces it, and NAF consumes it.
On iOS, NAF takes the reference directly. On Android, NAF still loads from an avatar definition — identifier-based loading hasn't reached it yet.