-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added Unreal Boilerplates, CollapsibleDetails component, added docs o…
…n parameter + return types for unreal indexer (#469) * added CollapsibleDetails component, added docs on parameter + return types for unreal indexer * added borderless options for tabbed content, used in unreal docs * fixed unreal typo * removed redundant line from unreal's write-to-blockchain * added unreal bootstrap-your-game section * unreal docs tweaks
- Loading branch information
1 parent
2d8320c
commit a8ed2b4
Showing
15 changed files
with
274 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
interface CollapsibleDetailsProps { | ||
title: string; | ||
items: { | ||
key: string; | ||
value: string; | ||
}[] | ||
} | ||
|
||
export const CollapsibleDetails = (props: CollapsibleDetailsProps) => { | ||
return ( | ||
<details> | ||
<summary style={{fontWeight: 600}}>{props.title}</summary> | ||
<div style={{padding: 15, display: 'flex', flexDirection: 'column', gap: 15}}> | ||
{props.items.map((item, index) => { | ||
return ( | ||
<div key={index}> | ||
<p style={{fontWeight: 600}}>{item.key}</p> | ||
<p>{item.value}</p> | ||
</div> | ||
) | ||
})} | ||
</div> | ||
</details> | ||
) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
--- | ||
title: Sequence - Web3 Gaming Platform - Unreal SDK Sequence API | ||
description: Documentation for Unreal SDK API for reading from the blockchain with the Sequence infrastructure stack for web3 gaming. | ||
--- | ||
|
||
import {CollapsibleDetails} from "../../../components/CollapsibleDetails.tsx"; | ||
import TabbedContent from "../../../components/TabbedContent"; | ||
|
||
# Bootstrap your Game | ||
|
||
Sequence's Unreal SDK includes a range of features to help you bootstrap your game. | ||
You can create them as shown below or duplicate the `.uasset` files from the `Plugins/SequencePlugin Content/Samples/` | ||
folder and customize them to fit your needs. | ||
|
||
## Inventory | ||
|
||
Create the `Sequence Inventory` widget to display a QR code to receive funds or send funds to other wallets. | ||
|
||
<img alt={'img'} src={'/img/unreal/feature_inventory_demo.gif'} style={{borderRadius: 15, width: '100%'}}/> | ||
<img alt={'img'} src={'/img/unreal/feature_inventory.png'} style={{borderRadius: 15}}/> | ||
|
||
<CollapsibleDetails title={'Parameters'} items={[{ | ||
key: 'Chain (ENetwork Enum)', | ||
value: "The chain type (Ethereum, Sepolia, ..) on which the specified contract is deployed." | ||
}, | ||
{ | ||
key: 'Wallet Address (FString)', | ||
value: "The wallet address of the user for whom you want to list the inventory items." | ||
}, | ||
{ | ||
key: 'Contract (FString)', | ||
value: "The address of an ERC1155 or ERC721 contract where the specified wallet address owns items." | ||
}] | ||
}/> | ||
|
||
## Primary Sale | ||
|
||
Create the `Sequence Primary Sale` widget to display a QR code to receive funds or send funds to other wallets. | ||
|
||
<img alt={'img'} src={'/img/unreal/feature_sale_demo.gif'} style={{borderRadius: 15, width: '100%'}}/> | ||
<img alt={'img'} src={'/img/unreal/feature_sale.png'} style={{borderRadius: 15}}/> | ||
|
||
<CollapsibleDetails title={'Parameters'} items={[{ | ||
key: 'Chain (ENetwork Enum)', | ||
value: "The chain type (Ethereum, Sepolia, ..) on which the specified contracts are deployed." | ||
}, | ||
{ | ||
key: 'Token Contract Address (FString)', | ||
value: "The address of the ERC1155 or ERC721 token contract you deployed using Sequence's Builder." | ||
}, | ||
{ | ||
key: 'Sale Contract Address (FString)', | ||
value: "The address of the sale contract you deployed using Sequence's Builder." | ||
}, | ||
{ | ||
key: 'Payment Token (FString)', | ||
value: "The ERC20 token address you specified on the 'Mint Access' section of your Sale contract." | ||
}, | ||
{ | ||
key: 'Price (Integer)', | ||
value: "The price for each token you specified on the 'Mint Access' section of your Sale contract." | ||
}, | ||
{ | ||
key: 'Tokens for Sale (Integer Array)', | ||
value: "A list of token IDs (e.g. [0, 1, 2]) that you display in your user interface." | ||
}] | ||
}/> | ||
|
||
## My Wallet View | ||
|
||
Create the `Sequence Profile` widget to display a QR code to receive funds or send funds to other wallets. | ||
|
||
<img alt={'img'} src={'/img/unreal/feature_wallet_demo.gif'} style={{borderRadius: 15, width: '100%'}}/> | ||
<img alt={'img'} src={'/img/unreal/feature_wallet.png'} style={{borderRadius: 15}}/> | ||
|
||
<CollapsibleDetails title={'Parameters'} items={[{ | ||
key: 'Chain (ENetwork Enum)', | ||
value: "The chain type (Ethereum, Sepolia, ..) where you want to run your game." | ||
}, | ||
{ | ||
key: 'Wallet Address (FString)', | ||
value: "The wallet address of the user for whom you want to display this view." | ||
}, | ||
{ | ||
key: 'Enable Send (Boolean)', | ||
value: "Indicates whether to enable the button to open a send view. Set this to false if you want to display the profile of another user." | ||
}] | ||
}/> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.