How readyplayerme/rpm-react-avatar-creator works
This React library embeds Ready Player Me’s avatar editor in an iframe and delivers its events to the host application. The main path is a host rendering AvatarCreator, which delegates to the raw iframe component; that component builds the editor URL, subscribes to iframe events, and forwards them through typed callbacks. The raw component also supports a single custom event callback. The event contracts are shown individually; source excerpts do not establish further behavior for them.
Main entry points: avatar-creator-raw.tsx AvatarCreatorRaw · index.ts Event union · avatar-creator.tsx AvatarCreator · types.ts Shared event types
Components 13
React components
- AvatarCreator
src/components/avatar-creator.tsx - AvatarCreatorRaw
src/components/avatar-creator-raw.tsx
Editor URL
- URL hook
src/hooks/use-avatar-creator-url.ts
Event contracts
- Event union
src/events/index.ts - Asset unlocked
src/events/asset-unlocked.event.ts - Avatar exported
src/events/avatar-exported.event.ts - User authorized
src/events/user-authorized.event.ts - User set
src/events/user-set.event.ts
Parsing and API
- JSON parser
src/utils.ts - Shared event types
src/types.ts - Public exports
src/index.tsx
Other components
- Host application
- Ready Player Me editor
Connections 18
- Host application → AvatarCreator: renders
README.md - AvatarCreator → AvatarCreatorRaw: renders
src/components/avatar-creator.tsx - AvatarCreator → Host application: calls callbacks
src/components/avatar-creator.tsx - AvatarCreatorRaw → URL hook: builds URL
src/components/avatar-creator-raw.tsx - AvatarCreatorRaw → JSON parser: parses messages
src/components/avatar-creator-raw.tsx - AvatarCreatorRaw → Ready Player Me editor: embeds iframe
src/components/avatar-creator-raw.tsx - Ready Player Me editor → AvatarCreatorRaw: posts events
src/components/avatar-creator-raw.tsx - AvatarCreatorRaw → Event union: forwards events
src/components/avatar-creator-raw.tsx - AvatarCreator → Event union: routes events
src/components/avatar-creator.tsx - Event union → Asset unlocked: includes type
src/events/index.ts - Event union → Avatar exported: includes type
src/events/index.ts - Event union → User authorized: includes type
src/events/index.ts - Event union → User set: includes type
src/events/index.ts - Asset unlocked → Shared event types: uses event shape
src/events/asset-unlocked.event.ts - Avatar exported → Shared event types: uses event shape
src/events/avatar-exported.event.ts - User authorized → Shared event types: uses event shape
src/events/user-authorized.event.ts - User set → Shared event types: uses event shape
src/events/user-set.event.ts - Public exports → AvatarCreator: exports
src/index.tsx