0.0.4 • Published 2 years ago

@avatarconnect/sdk v0.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

@avatarconnect/sdk npm.io

The JavaScript sdk for integrating AvatarConnect into your web-based metaverse

Installing

Via CDN:

<script src="https://cdn.jsdelivr.net/npm/@avatarconnect/sdk/dist/index.js"></script>

Using npm:

$ npm install @avatarconnect/sdk

Using bower:

$ bower install @avatarconnect/sdk

Using yarn:

$ yarn add @avatarconnect/sdk

Usage

import AvatarConnect from '@avatarconnect/sdk'

const connector = new AvatarConnect([
  ['ready-player-me', { gateway: 'mona' }],
  'crypto-avatars',
  'meebits',
])

// Display the AvatarConnect modal
connector.enable()

connector.on('close', handleClose)
connector.on('error', handleError)

// Pass the result into the AvatarConnect plugin for your game engine
connector.on('result', handleResult)

// Hide the AvatarConnect modal
connector.disable()

API

new AvatarConnect(<providers>[, <options>])

Providers

Check out our docs for more info on provider configurations

Options

OptionDescriptionDefault
bridgeUrlPass in a custom url for your own hosted version of @avatarconnect/bridgehttps://v0.avatarconnect.org
maxHeightMax height of the modal's content (in pixels)600
maxWidthMax width of the modal's content (in pixels)800
paddingThe padding on the sides of the modal at full width (in pixels)6