Skip to content

kilogold/Metasave

Repository files navigation

Metasave

Video Intro

(click to play) image

Product Presentation

(click to play) image

Video Tutorial

(click to play) image

The following are the resources illustrated in the video:

Concept

Metasave is a data storage protocol for game worlds. It is a back-end service for game developers to manage player data in a decentralized, platform-agnostic way. The main goal of Metasave is to provide a mechanism where the consequences of one game carry over to any other game in real-time. Using permissionless read access, any game can react to events ocurring in any other game world irrespective of genre, platform, or hardware. To illustrate the concept, we will explore a hypothetical implementation of Metasave involving two popular games at the time of writing:

image

Architecture

World Data Map (StorageDoubleMap)

image
DataEntry Keys and Values can be stored as any arbitrary data by virtue of a byte vector. This allows developers to choose and optimize world data to their desired use case. We could use a simple character string as a key, or we could use any arbitrary complex object represented in binary format.

Authority Map (StorageMap)

image
An account is tied to a Permission which is evaluated with every storage update transaction. Game world data can only be modified by an authority (an account with permissions for said game). Each world data is partitioned into two categories:

  • External
  • Internal

The difference between the two are purely semantic. These categories act as a means to distinguish which accounts have Write-Access to world data. Read-Access is available to everyone.

Route vs Access

The similarity between Access and Route enums is intentional. The operative difference is that Access designates permission, whereas Route indicates intent. You can think of is as:

"I want to update [internal] data for GAME1, but I only have [external] access."

Example Usage

Here's what the order of events look like to begin using Metasave:
image
After this sequence of events, AccountA & AccountB may update the World1 calendar at any time. World2 will automatically receive this update and respond accordingly. Neither developer was required to implement custom logic for interoperability. Everyone can publicly see the data and freely subscribe to changes from their own world and anyone else's.

Note AccountC has no authority to modify World1 data, thus World1 is protected. AccountA/AccountB (dev team) may grant External access to AccountC in order to write save data on World1's game, while still protecting World1's Internal data from anyone outside the dev team.

WIP Features

Individual On-Chain User Data

image
User data is leveraged in a similar manner as world data, except it pertains to each individual user. This opens up novel use cases, such as anti-cheat & verifiable game progress. Other extraordinary implementations may include IoT.

Vending Machine IoT Example

In the diagram below, we explore how to bring Final Fantasy VII Remake's vending machines into real life. image Why not just tokenize GIL (like an ERC-20)?
While tokenization is a valid (and sometimes ideal) strategy, it needs to be carefully considered...
Tokenization often leads to relinquishing control of asset utility, which can adversely affect game design & balance. By restricting the data to a player's save file, the game designer is able to retain the quality control of their game's experience (the token asset doesn't run rampant through DeFi protocols). Furthermore, tokens alone are not enough to provide bespoke verification. In the example above, it is not enough to be able to afford the item. As a player, you must also progress far enough into the game in order to qualify by defeating Bahamut. The only way to accomplish this in a tokenized world is to mint yet another token (like an achievement) to track the progress. Ultimately, we end up juggling many tokens for a single game, which may be costly to transfer to other wallets/accounts, and/or also introduce many game-explot vectors (or even facilitate an unintended pay-2-win model via trading achievement tokens).

Tech Specs

Demo Usage

There is a hosted demo node for evaluation purposes. The node is running in temporary dev mode, so default accounts (Alice/Bob/Charlie/Dave/Eve/Ferdie) are accessible. For a thorough walkthrough of usage, please refer to the video tutorial linked at the top of this readme.

General steps are outlined as follows:

  • Visit deployment node's extrinsics page.
  • Select templateModule from the modules dropdown to expose extrinsics.
  • Register a game/world.
  • Add an authority (optional, since the account registering the game is an authority by default).
  • Update world data record to introduce any data to be parsed by a game client (optional, games clients/servers can do this on runtime).

Tech Stack

Deployment

The Substrate node & game templates are preconfigured for local networking. You can redirect either game template's endpoint to the hosted demo node as well. Changing endpoints requires modifications only on the game clients.

Notes

  • If you are unable to connect to the node via Polkadot.js, you are probably getting an invalid certificate error. Please follow the official Polkadot instructions to resolve this.
  • Metasave is preconfigured to have default Alice & Bob accounts registered with their respective games (see video for Alice & Bob setup). You may find the preconfiguration in the pallet's lib.rs.
  • Metasave pallet introduces custom data types that Polkadot.js is now aware of. Paste the provided definitions into the developer settings page.