Saving User Data

Use userData to remember things about a player between plays. The most common use case is skipping the tutorial on their second visit.

The Single-Slot Model#

Each Game can optionally declare one userData key in the Minit Games console. That key identifies a single per-player storage slot. Your game can read the slot on startup and write to it when the game ends.

Enabling userData in the Console#

1. Open your Game in console.minit.games.
2. Click Edit and check the Store User Data checkbox.
3. Enter a 1–64 character key, for example tutorial-seen or player-progress.
4. Save. The slot is now active.

To disable it, uncheck Store User Data and save. New plays stop reading or writing the slot. Existing data is not deleted; re-enabling with the same key surfaces it again.

You can change the key. Data stored under the old key becomes dormant: players will not see it via the new key. Reverting to the old key surfaces it again.

Mods: the userData setting is inherited from the base Game and cannot be changed in the mod editor. If the base Game has a key, all its mods share the same slot.

SDK API#

import { getUserData, reportResult } from '@minit-games/sdk'

const value = getUserData() // returns string | undefined

reportResult(score, { userData: 'done' })

Worked Example: Tutorial-Skip Flag#

import { getUserData, reportResult } from '@minit-games/sdk'

// On game start: check the "Store User Data" box in the console and set the key to "tutorial-seen"
const seen = getUserData()

if (seen === undefined) {
  showTutorial()   // First time: slot not yet written
} else {
  skipTutorial()   // Returning player: skip straight to the game
}

// When the game ends
function handleGameOver(score) {
  reportResult(score, { userData: 'done' })
}

Cross-Game Sharing#

Two Games by the same creator that declare the same key share a slot, by design, and across engines. Use it for cross-game continuity (e.g. unlocking a character across your catalogue once any of your games is completed); use a unique key per Game (towerDefense-highScore, not highScore) when each Game needs its own slot.

Limits#

Keep values compact: store flags and small state, not full game replays. If you need to persist multiple values, encode them into a single string:

function handleGameOver(score, level, darkMode) {
  const value = JSON.stringify({ level, darkMode })
  reportResult(score, { userData: value })
}

function loadPlayerState() {
  const raw = getUserData()
  if (raw === undefined || raw === '') return { level: 1, darkMode: false }
  try {
    return JSON.parse(raw)
  } catch {
    return { level: 1, darkMode: false }
  }
}

Testing Locally#

http://localhost:5173/?userData=done

const value = JSON.stringify({ level: 3, darkMode: true })
const encoded = encodeURIComponent(value)
// Open: http://localhost:5173/?userData=<encoded>

Local only. URL params are used as a fallback when no host has injected real player data. In the Minit Games mobile app, the host always provides real data and URL params are ignored.

Data Persists Across Game Updates#

The slot is identified by the console key, not the ZIP, so player data survives re-uploading a new version.

Note: userData is only persisted in the Minit Games mobile app. The web preview in the Creator Console does not store userData between sessions.

Deeper Dives#