Skip to content
sz.sahaj edited this page Dec 1, 2022 · 1 revision

? NFTPort Gaming

๐ŸŽฎ ๐Ÿ•น ๐ŸŽฒ Unity3D SDK to integrate everything NFTs cross-chain at lightning speed!

star this repo Join Discord Follow Twitter

Getting Started

  • Your API requests are authenticated using API keys. You can get your free API key by signing up for an NFTPort account.

  • Get Unity.

    The NFTPort Unity SDK is made using Unity 2021 LTS and also tested on Unity 2020. We recommend using the latest Unity 2021 LTS. However, the SDK should be compatible with other Unity versions as well. If you've found any incompatibilities or errors on import, please open an issue on Github.


Get NFTPort Unity extension

  • Option 1: Import as a package using Git URL: In Unity's Package Manager, click the '+' on the top left corner and select 'Add package from git URL.'
https://github.com/nftport/nftport-unity.git

Add package from git URL.
  • Option 2: download the latest release and import the folder in your project.

On Import, additional packages will be installed automatically. In case its not, you may install dependencies via NFTPort/Install Dependencies. In case you already have dependencies ( for eg: JSON.net in Assets folder instead of via newtonsoft in packages) and is conflicting you may remove the newtonsoft package via UPM, or delete the JSON.net from assets folder as it'll be imported via UPM. Add package from git URL.


The best way to learn is by doing! We've provided a number of examples for play, view importing samples.

First steps inside Unity

Set your API Key at NFTPort / Home.
Add package from git URL.

You may add Assets/NFTPort/Resources/UserPrefs to your .gitignore to avoid exposing your API keys.


Explore features, examples, usage and more under the Unity SDK tab on left on this page.


Features

Add package from git URL. NFTPort's Unity SDK features are highly composable and can be used in editor or runtime modes.

Features can be spawned via NFTPort/Spawner or using any of the Unity's default add game object / add component menus. They are available at Packages/NFTPort/Runtime/.

You do not need to spawn features if you do not wish to refrence or use the feature components in editor, you can just call Initialise() for each feature class from your own scripts. View individual feature documentation for more.

Reporting bugs and requesting features

Join the NFTPort discord to engage in discussions and explore if the game mechanic you are trying to implement can already be achieved by existing features. To report a bug/issue/help - Use Github Issues. To request features may also use Product Board.

Unity Extension Feature list:

โœ… - Supported
โŒ - Not supported as of now
๐Ÿงญ - Planned
๐Ÿ›  - In consideration according to requests

Multi-Chain NFT Data

Get fast and reliable data.

API Feature Ethereum Goerli Polygon Solana
Contracts, Metadata & Assets
Retrieve NFT details โœ… โœ… โœ… โœ…
Retrieve contract-collection NFTs โœ… โœ… โœ… โœ…
Ownership including NFT metadata and details:
Retrieve NFTs owned by an account โœ… โœ… โœ… โœ…
Retrieve NFTs owned by an account in a particular collection โœ… โœ… โœ… ๐Ÿ› 

Easy minting

Easy mint NFTs with single component.

API Feature Ethereum Goerli Polygon Solana
Easy Minting
Via URL ๐Ÿ›  โœ… โœ… ๐Ÿงญ
Via File ๐Ÿ›  โœ… โœ… ๐Ÿงญ

Storage, contracts and customizable minting

Deploy fully customizable NFTs and contracts with industry standards - decentralized web3 storage, metadata, custom attributes and more.

API Feature
Storage
List all your IPFS uploads Via dashboard
Upload a file to IPFS โœ…
Create and upload advanced industry standard metadata to IPFS โœ…
Upload metadata directory to IPFS ๐Ÿงญ
API Feature Ethereum Goerli Polygon Solana
Product
ERC 721 โœ… โœ… โœ… โœ…
ERC 1155 ๐Ÿงญ ๐Ÿงญ ๐Ÿงญ โŒ
SPL โŒ โŒ โŒ ๐Ÿงญ
Deploy a contract for NFT products ๐Ÿงญ ๐Ÿงญ via API ๐Ÿงญ
Customizable minting : Mint NFTs of your contract to any wallet โœ… โœ… โœ… ๐Ÿงญ
Update a minted NFT / Dynamic NFTs โœ… โœ… โœ… ๐Ÿงญ
Burn a minted NFT โœ… โœ… โœ… ๐Ÿ› 
Transfer a minted NFT โœ… โœ… โœ… ๐Ÿ› 

Transactions

Get multichain transaction data.

API Feature Ethereum Goerli Polygon Solana
Retrieve transactions by NFT โœ… โŒ โŒ โœ…
Retrieve transactions by collection โœ… โŒ โŒ โœ…
Retrieve transactions by an account โœ… โŒ โŒ โœ…
Retrieve contract sales statistics ๐Ÿ›  โŒ โŒ ๐Ÿ› 

Tools and Utilities

Tools
Connect Player Wallet : WebGL โœ…
Asset Downloader:
Determine URL Content Type โœ…
Fetch Image asset from IPFS / web cached image โœ…
Fetch Audio file from IPFS / web ๐Ÿงญ
Fetch 3D object from IPFS / web โœ… Use determine content type with gltFast , View Example
NFT collection reader (bulk) ๐Ÿงญ
NFT Product Minting Suite ๐Ÿงญ


Clone this wiki locally