Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.34 KB

README.md

File metadata and controls

46 lines (30 loc) · 1.34 KB
Raw

DCL L2 NFT Frame

This project allows you to integrate an NFT Frame with L2 nfts into decentraland.

Install

To use any of the helpers provided by this library:

  1. Install it as an npm package. Run this command in your scene's project folder:

    npm install dcl-l2-frame

    npm i @dcl/l2-scene-utils eth-connect decentraland-transactions -B

  2. Add this line at the start of your game.ts file, or any other TypeScript files that require it:

    import { l2NFTFrame } from "dcl-l2-frame";

Usage

Basic Audius Player Integration

The L2 frame requires the following parameters:

  • ui: boolean to add an on click event to the NFT Frame

  • nft type: 721 or 1155 token standard

  • contract: nft contract address

  • tokenId: nft token id

  • transform:TransformConstructorArgs for positioning in DCL world

  • color: optional Color4 parameter for the NFT Frame bg color

  • frame: optional PictureFrameStyle to style the NFT Frame

    let  nft = l2NFTFrame(true,721, "0x73b2798d287b41e69a1fc34179a1517153ac5a5b", "69", {position:  new  Vector3(8,2,8), scale:  new  Vector3(2,2,1)}, Color3.Blue(), PictureFrameStyle.Baroque_Ornament)

...

Copyright info

This scene is protected with a standard Apache 2 licence. See the terms and conditions in the LICENSE file.