forked from MystenLabs/sui
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create prototypes.md (MystenLabs#767)
* Create prototypes.md Start draft conversion for previewing by Marketing and PM * Update prototypes.md Convert Prototypes draft to Markdown for inclusion in Dev Portal Convert all section headings to sentence case * Update prototypes.md Include missing images being uploaded in PR MystenLabs#855
- Loading branch information
1 parent
0d2032d
commit ccccb5e
Showing
1 changed file
with
239 additions
and
0 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,239 @@ | ||
| --- | ||
| title: Sui Prototypes | ||
| --- | ||
|
|
||
| Here are two short gaming prototypes that demonstrate the speed, scalability, and rich interactions made possible with mutable, expressive NFTs: [Sui Monstar and Sui Battler](https://sui.io/sui_monstar). | ||
|
|
||
|
|
||
| ## Sui and gaming | ||
|
|
||
| Gaming as one of the first verticals for rapid web3 adoption is a popular talking point. However, existing web3 games are arguably regarded more as investments than games, with user retention impacted by market conditions rather than the games themselves. | ||
|
|
||
| So what is missing from existing web3 games? Firstly, a successful web3 game must offer an experience wholly different from any web1 or web2 games. To truly shine, web3 games must, in a meaningful way, take advantage of the benefits of fully on-chain, dynamic and composable digital assets with verifiable ownership. These features can power incredible and imaginative gameplay and ecosystems, creating immense value and engagement. | ||
|
|
||
| Secondly, great games require experienced game developers and builders–people who know how to build games and create fun, user-centric experiences. There is a wealth of talent eager to build in web3, but its creativity has been hindered by platform limitations and the pains of learning a new programming language. | ||
|
|
||
| With Sui, we believe game developers should not be limited by the platform performance or fees, and they should be able to create whatever experience they imagine. Importantly, developing great games should not require game developers to also be experts in writing smart contracts. Rather they should focus on what they are good at, building cool games for gamers. | ||
|
|
||
|
|
||
| ## Smart contracts optional | ||
|
|
||
| [Move](https://github.com/MystenLabs/awesome-move/blob/main/README.md) is simply awesome: it’s safe, expressive and immune from reentrancy; but move expertise is not required to build meaningful experiences on Sui. To make it easy for developers and creators to start using Sui for gaming, we will be releasing gaming SDKs that address common use cases and game asset-related features. | ||
|
|
||
|
|
||
| ## How we did it | ||
|
|
||
| To create these prototypes, we worked with game development studio Geniteam, who built the prototypes with the Unity SDK along with Sui [APIs](https://app.swaggerhub.com/apis/MystenLabs/sui-api/0.1). | ||
|
|
||
| Geniteam developers that worked on this collaboration are not smart contract or move developers. With this project, we started gathering data on what is the best way to design SDKs that make it easy to start building on Sui. | ||
|
|
||
| Once Geniteam communicated their idea with us, we created the proposed data model and shared simple APIs. With these APIs, Geniteam was able to mint fully on-chain NFTs that are able to mutate, own other on-chain assets, and freely transfer to other applications. Gameplay is then powered by APIs calls that allow them to read and write to update the NFTs. \ | ||
|
|
||
|
|
||
| Here are the three APIs Geniteam used, along with the smart contracts to create and update monster (named MonStars in the prototype). | ||
|
|
||
|
|
||
| ### API Move call - Create Monster | ||
|
|
||
| POST `/call` with body: | ||
|
|
||
| ``` | ||
| { | ||
| "sender": "{{owner}}", | ||
| "packageObjectId": "0x2", | ||
| "module": "Geniteam", | ||
| "function": "create_monster", | ||
| "args": [ | ||
| "0x{{player_id}}", | ||
| "0x{{farm_id}}", | ||
| "0x{{pet_monsters}}", | ||
| {{monster_name}}, | ||
| {{monster_img_index}}, | ||
| {{breed}}, | ||
| {{monster_affinity}}, | ||
| {{monster_description}} | ||
| ], | ||
| "gasObjectId": "{{gas_object_id}}", | ||
| "gasBudget": 2000 | ||
| ``` | ||
|
|
||
|
|
||
| ### API Move call - Update Monster | ||
|
|
||
| POST `/call` with body: | ||
|
|
||
| ``` | ||
| { | ||
| "sender": "{{owner}}", | ||
| "packageObjectId": "0x2", | ||
| "module": "Geniteam", | ||
| "function": "update_monster_stats", | ||
| "args": [ | ||
| "0x{{player_id}}", | ||
| "0x{{farm_id}}", | ||
| "0x{{pet_monsters}}", | ||
| "0x{{monster_id}}", | ||
| {{monster_level}}, | ||
| {{hunger_level}}, | ||
| {{affection_level}}, | ||
| {{buddy_level}} | ||
| ], | ||
| "gasObjectId": "{{gas_object_id}}", | ||
| "gasBudget": 2000 | ||
| ``` | ||
|
|
||
| ### API Move call - Read Monster Data | ||
|
|
||
| ``` | ||
| GET /object_info?objectId={{monster_id}} | ||
| ``` | ||
|
|
||
|
|
||
| ### Smart contract: Create Monster | ||
|
|
||
| ``` | ||
| struct Monster has key, store { | ||
| id: VersionedID, | ||
| monster_name: String, | ||
| monster_img_index: u64, | ||
| breed: u8, | ||
| monster_affinity: u8, | ||
| monster_description: String, | ||
| monster_level: u64, | ||
| monster_xp: u64, | ||
| hunger_level: u64, | ||
| affection_level: u64, | ||
| buddy_level: u8, | ||
| // ID of the applied cosmetic at this slot | ||
| applied_monster_cosmetic_0_id: Option<ID>, | ||
| // ID of the applied cosmetic at this slot | ||
| applied_monster_cosmetic_1_id: Option<ID>, | ||
| } | ||
| // Create a Monster and add it to the Farm's collection of Monsters | ||
| public fun create_monster(_player: &mut Player, | ||
| farm: &mut Farm, | ||
| pet_monsters_c: &mut Collection::Collection, | ||
| monster_name: vector<u8>, | ||
| monster_img_index: u64, | ||
| breed: u8, | ||
| monster_affinity: u8, | ||
| monster_description: vector<u8>, | ||
| ctx: &mut TxContext | ||
| ) { | ||
| let monster = create_monster_( | ||
| monster_name, | ||
| monster_img_index, | ||
| breed, | ||
| monster_affinity, | ||
| monster_description, | ||
| ctx | ||
| ); | ||
| // Check if this is the right collection | ||
| assert!(*&farm.pet_monsters_id == *ID::id(pet_monsters_c), EMONSTER_COLLECTION_NOT_OWNED_BY_FARM); | ||
| // Add it to the collection | ||
| Collection::add(pet_monsters_c, monster); | ||
| } | ||
| // Creates a basic Monster object | ||
| public fun create_monster_( | ||
| monster_name: vector<u8>, | ||
| monster_img_index: u64, | ||
| breed: u8, | ||
| monster_affinity: u8, | ||
| monster_description: vector<u8>, | ||
| ctx: &mut TxContext | ||
| ): Monster { | ||
| Monster { | ||
| id: TxContext::new_id(ctx), | ||
| monster_name: ASCII::string(monster_name), | ||
| monster_img_index, | ||
| breed, | ||
| monster_affinity, | ||
| monster_description: ASCII::string(monster_description), | ||
| monster_level: 0, | ||
| monster_xp: 0, | ||
| hunger_level: 0, | ||
| affection_level: 0, | ||
| buddy_level: 0, | ||
| applied_monster_cosmetic_0_id: Option::none(), | ||
| applied_monster_cosmetic_1_id: Option::none(), | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Smart contract: Update Monster | ||
|
|
||
| ``` | ||
| // Update the attributes of a monster | ||
| public fun update_monster_stats( | ||
| _player: &mut Player, | ||
| _farm: &mut Farm, | ||
| _pet_monsters: &mut Collection::Collection, | ||
| self: &mut Monster, | ||
| monster_level: u64, | ||
| hunger_level: u64, | ||
| affection_level: u64, | ||
| buddy_level: u8, | ||
| _ctx: &mut TxContext | ||
| ) { | ||
| self.monster_level = monster_level; | ||
| self.hunger_level = hunger_level; | ||
| self.affection_level = affection_level; | ||
| self.buddy_level = buddy_level; | ||
| } | ||
| ``` | ||
|
|
||
| ## Protype 1 Sui Monstar | ||
|
|
||
| The first prototype is [Sui Monstar](https://sui.io/sui_monstar), a pet simulation game. | ||
|
|
||
| Gameplay: | ||
|
|
||
| * Play, feed and dress up your canine and feline friends. | ||
| * Evolve your pets with affinity runes! | ||
| * Decorate your farm. | ||
| * Raise your farm and pet levels through gameplay and interactions. | ||
|
|
||
| In Sui Monstar, capture cute monstars and watch them get closer to you as you feed and interact with them. These monstars, your farm, and accessories are all NFTs on-chain. As you play through the game, attributes such as health, friendliness, and accessories are all updated live. | ||
|
|
||
|  | ||
| *Equip elemental runes to your Monstar and watch your NFT evolve with updated properties* | ||
|
|
||
| That’s not all, as your Monstar become stronger, you can use them to help you battle…in the next prototype>>> | ||
|
|
||
| ## Prototype 2 Sui Battler | ||
|
|
||
| Welcome to [Sui Battler](https://sui.io/sui_monstar), where your cute monstars transform into warriors! | ||
|
|
||
| Gameplay: | ||
|
|
||
| * Battle waves of enemies and gain experience and power-ups. | ||
| * Get help from your own pet in Sui Monstar. | ||
| * Evolve your pet in Sui Monstar and unlock special battle abilities. | ||
| * Your monstars record the history of your battle on-chain! | ||
|
|
||
|  | ||
| *Evolve your Monstars to unlock special abilities* | ||
|
|
||
| ## Why this matters | ||
|
|
||
| * Mutable NFTs means richer and more creative gameplay. No more complicated workarounds or burning NFTs, losing all your data and history, in order to “modify” NFTs. | ||
| * Usability-focused APIs make building on Sui easy. | ||
| * Unparalleled scalability and instant settlement mean changes, asset status, balance and ownerships can happen instantly live along with gameplay. No more lag or workarounds. | ||
| * Creativity is the limit. Creators can freely use their assets across various applications and games. | ||
| * Fully on-chain, composable NFTs with rich history make possible the next generation of game economies. | ||
|
|
||
| ## Further reading | ||
|
|
||
| * See the entire Unity project here [link to github]. | ||
| * Check out Sui [APIs](https://app.swaggerhub.com/apis/MystenLabs/sui-api/0.1). | ||
| * Learn about Sui [objects](https://github.com/MystenLabs/sui/blob/main/doc/src/build/objects.md). | ||
|
|
||
| TODO: Fix Unity link above. |