\n\n# Hyperverse EVM NFT-Game\n\nInitial Module for the Hyperverse EVM NFT Game Module\n\n## NFT Attributes\nStandard Attributes Len = 5\n\nSpecial Attributes Len = 2\n\n### Function - Mint / Tenant Mint (example)\n_standardChoices = [1,1,0,0,0]\n\n_standardOptions = [2,2,0,0,0]\n\n_specialChoices = [0,0]\n\n_specialOptions = [0,1]\n\n\n### Function - ModifyDynamicAttribute (Called by Admin)\nStandard Type = 0\n\nSpecial Type = 1\n\n_attrType = 0\n\n_attrOptions = [3,4,5,4,5]\n\n [3,4,5,4,5] => [3,4,5,5,5]\n\n### Function - SetDynamicAttribute (Called by player/user) \n_tokenId = 1\n\n_attrType = 0\n\n_attrOptions = [1,2,3,1,1]\n\n\n\n\n## How the project is setup\n\n1. `Contracts` - This is the first layer. Think of this as your database model and repository for how to fetch and store data\n2. `Source` - Contains your javascript interface to your contracts. \n3. `Stories` - This is your UI inteterface to your smart module that allows for documentating and testing the functionality of your smarat module\n\n\n## Contracts\nModules are primarily written in `solidity`. They utilize the `hardat` framework to assit in the compilation and deploying of your contracts\n\n## Source\nThe javascript source connects to the smart module using `ethers` by default. The format of a Hyperverse smart module is broken down into further sub sections\n\n1. `Library` - Lib folder contains the detailed functions that read & write to the blockchain. \n2. `useHook` - React hook that exposes your library to the react ecosystem. You'll want to rename this export to better help identify your module\n3. `Provider` - Hyperverse modules use the React Context to expose state to child components\n4. `Environment` - Simple component that will identify which blockchain and network your module is being used under. This allows EVM modules to easily work with any supported EVM module\n\n# Server\nIn order to call write functions from a server side API you will need to provider and ethers wallet signer using a secure private key. See example with Next.js API Handler\n\n```typescript\nimport { NextApiRequest, NextApiResponse } from \"next\";\nimport { NFTGameLibrary, NFTGame } from '@decentology/hyperverse-evm-nft-game'\nimport { Network, initialize } from '@decentology/hyperverse';\nimport { ethers } from 'ethers';\nimport { Ethereum, Localhost } from '@decentology/hyperverse-ethereum';\n\nconst hyperverse = initialize({\n\tblockchain: Localhost, // Switch to Ethereum when testing on Testnet\n\tnetwork: Network.Testnet,\n\tmodules: [\n\t\t{\n\t\t\tbundle: NFTGame,\n\t\t\ttenantId: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',\n\t\t},\n\t],\n});\n\n// Get default provider for localhost when developing against storybook\nconst provider = ethers.getDefaultProvider('http://localhost:8545');\n\n// Storybook Private key Account #0\nconst signer = new ethers.Wallet(\"0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80\", provider);\n\nexport default async function handler(req: NextApiRequest, res: NextApiResponse<{}>\n) {\n\tconst lib = await NFTGameLibrary(hyperverse, signer);\n\tconst name = await lib.getName();\n\t// await lib.setMintPermissions(true);\n\tconst mintTx = await lib.mint({\n\t\tto: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',\n\t\ttokenName: 'Test Name',\n\t\teyeId: 1,\n\t\tmouthId: 2,\n\t\tbodyId: 3,\n\t\tlevel: 0,\n\t\tstandardChoices: [1, 1, 0, 0, 0],\n\t\tstandardOptions: [1, 1, 0, 0, 0],\n\t\tspecialChoices: [0, 0],\n\t\tspecialOptions: [0, 0]\n\t});\n\treturn res.status(200).json({\n\t\thello: name,\n\t\ttx: mintTx.transactionHash\n\t});\n}\n\n```\n\n# Documentation\nFor more information and learn about Hyperverse checkout the resources below\n\n- [Hyperverse Documentation](https://docs.hyperverse.dev/)\n- [Decentology YouTube Channel](https://www.youtube.com/c/Decentology)\n","readmeFilename":"README.md"}