Game Ready Signal

Use the game-ready signal when your game needs time to initialise before it is ready to play.

The Problem#

By default, the platform starts revealing your game as soon as its view is ready. If your game does heavy startup work (a large spritesheet, procedural generation, an engine runtime), players may see a half-loaded game before it is usable.

The Solution#

import { loadingDone } from '@minit-games/sdk';

// Example: call after all assets are loaded and the game is ready
async function init() {
  await loadAssets();
  buildLevel();
  loadingDone();
}

init();

How It Works#

1. You call the ready-signal function when initialisation is complete.
2. The platform detects the call in your uploaded build and flags the game as using it.
3. In the app, the platform holds its transition animation until it receives the signal.
4. If the signal does not arrive within 5 seconds, the platform reveals the game anyway.

No Precise Readiness Point? Use MinitReady#

// No code needed; just add the component in the Inspector:
// Add Component > Minit Ready

When to Use It#

Use the ready signal if your game, before it can be played:

• Loads assets asynchronously rather than having everything ready at start
• Generates content procedurally at startup
• Performs any async work (an await, a timer, a background thread) before the first frame is interactive

If your game is ready to play as soon as it loads, you don't need it. It only affects games that opt in.

Placement#

Call the ready signal as late as possible: just before the first frame where a player can interact.

// Good: called after everything is ready
async function setup() {
  await loadSpritesheets();
  await loadAudio();
  initGameState();
  loadingDone(); // Ready now
  startGameLoop();
}

// Bad: called before assets have loaded
loadingDone();
loadSpritesheets(); // Still loading

Outside the Host#

Note: the game-ready signal has no effect on the web preview in the Creator Console; it only affects the Minit Games app.

Deeper Dives#