The account avatar is the player's iDos Games character: one look for every app, edited on idosgames.com. Your app decides whether to use it and what of it to show; without it the app draws its own characters.
What the player sees
- Their own avatar in the profile and in your app, when the app uses it.
- Other players' avatars in rooms, chats and leaderboards, drawn the same way.
- Change avatar in the profile opens the editor on idosgames.com.
How it works
- The look lives on the player's account, not in your app: one edit reaches every app at once.
- The server sends each look already trimmed by your rules: hidden slots taken off, the height brought into your limits.
- The looks are read by revision: an unchanged look comes back without data.
Step 01Add it to your project
Nothing to install: the profile of every new project already shows the avatar when it is on. For your game's own characters use the SDK below.
Step 02Set it up in the dashboard
Open the dashboard, pick your project and go to Live Operations → v2 → Avatar.
- Use the account avatar: off by default.
- What the app shows: untick slots to take those items off every player in this app.
- Height: limits from 0.9 to 1.1 on the standard's scale.
The AI button on the page opens an assistant: describe what you need, it proposes changes, and you review them and press Save.
Step 03Test and release
Check the avatar in the test version of your app. Settings go to the live app as a separate action: see publishing and links.
In templates
- Game constructor: in 3D genres the player's hero is drawn as their avatar, with running, jumping, attacks and a victory dance. 2D genres keep their own characters.
- Board game: the player's pawn becomes their avatar. In the “With friends” mode friends see each other's avatars on one board.
- Guests and players without a look get the game's own hero or pawn.
Avatar shop
- The starter items are free for everyone; newer items are paid and sold by the platform for Aspis.
- A bought item is the player's for good, in every app. They put it on in the editor on idosgames.com.
- The profile shows the shop under the avatar. When a player buys an item inside your app, you get a share of the price; the slots you hid are not sold in your app.
- The profile shows the newest items; All items opens the whole shop: search by name, Mine, seller and order (newest, popular, by price). More items load as you scroll.
- Buying always needs the player's confirmation on idosgames.com. In the test version of your app nothing is spent and no item is given.
Items from creators
- When the platform opens creator items, anyone with an account can make an item on idosgames.com (Avatar, then Create your own item): pick where it is worn, start from a shape, change the name, colors and picture, set a price in Aspis.
- In the editor, creator items sit in the same sections as official ones: search by name, Mine, source and order (newest, popular, by price). More items load as you scroll.
- The item is checked by the same rules as every official one, and an exact copy of an existing item is refused. The look of an item cannot be changed after publishing.
- The creator owns their item at once and gets a share of every sale. Players report bad items; an item with many open complaints is hidden by itself until a moderator decides.
- Creator items appear in the avatar shop of your app automatically, next to the platform's items. A hidden item is taken off every player.
For developers
// The player's own look (null: the app does not use the account avatar)
const mine = await client.avatar.getMine()
// Looks of other players of this app: a room, a leaderboard page
const res = await client.avatar.get(userIDs)
// Draw it with @idosgames/characters
import { AvatarActor, avatarFromServer, DEFAULT_AVATAR, renderAvatarCanvas } from '@idosgames/characters/voxel'
const look = avatarFromServer(mine.ok ? mine.data : null)
const actor = new AvatarActor(look?.spec ?? DEFAULT_AVATAR, look?.items ?? {})
const sprite = look && renderAvatarCanvas(look.spec, look.items, { frame: 'full', size: 128 })
// Buy an item for Aspis (the player confirms on idosgames.com)
const shop = await client.avatar.getShop()
const page = await client.avatar.browseShop({ slot: 'hat', query: 'crown', sort: 'price_asc' })
const r = await client.credits.pay((id) => client.avatar.buyItem('hat.crown', 250, id))- Guests and players without a look come with
hasAvatar: false: drawDEFAULT_AVATARorrandomAvatarfor them. - Redraw on the
avatar:changedevent; read held looks withclient.avatar.peek(userID). getShop()lists what is on sale, what the player owns and the item recipes; always pass the price the player saw: if it changed, nothing is spent.browseShop()reads the shop page by page for thousands of items: slot, search,ownedOnly, seller and order; passnextof the answer ascursorfor the next page.
Every field is described in the SDK, served by the SDK MCP server.
Frequently asked questions
Can the player change the avatar inside my app?
No: the player edits it on idosgames.com, and every app that uses it gets the new look.
What does a guest get?
No avatar: draw a default look for guests and players without one.
See also
- Player profile: name, settings and languageHow the ready-made iDos Games player profile works - name with the server's rules, ID, sound, volume, fewer animations, the game language and log out - part of every new project.
- Heroes and characters: stats, ranks and gearHow the ready-made iDos Games heroes system works - a roster of heroes, stat upgrades, ranks, Power counted by the server, gear slots and skins - and how to set it up in the dashboard.
- TypeScript SDK and project structureHow an iDos Games project is built - the @idosgames npm packages, a host shell with sign-in and lobby, feature modules for systems and games, and one config file for the look.
Make your own game
Describe the idea in a sentence - the AI coder builds it, and it goes live at its own link.