Package your game

The package

Add the manifest and shim

Keep index.html at the ZIP root. Beside it, add cli-games.json and the unchanged cli-games-embed-v3.js file linked above.

{
  "schema": "cli-games.embed-manifest.v1",
  "protocol": 3,
  "title": "Keyboard Check",
  "command": "keyboard-check",
  "description": "A minimal keyboard-capable browser game prepared for review.",
  "category": "arcade",
  "keys": [
    { "key": "ArrowLeft", "label": "LEFT", "aria": "Move left", "hold": true },
    { "key": "ArrowRight", "label": "RIGHT", "aria": "Move right", "hold": true },
    { "key": " ", "label": "ACT", "aria": "Use the main action" },
    { "key": "Escape", "label": "MENU", "aria": "Return to the menu" }
  ],
  "scoring": {
    "maxScore": 30,
    "minDurationMs": 0,
    "maxDurationMs": 1800000,
    "scoreMayDecrease": false
  }
}

• The manifest is the source of truth. Title, command, description, category, keys, and scoring are read-only in the workspace.
• Declare every playable key. Labels and descriptions become terminal and phone controls; held movement keys should set hold: true.
• Keyboard input is required. Pointer-only and gamepad-only games are outside V3.0.
• Keep creator credit separate. Your name, bio, and optional website stay in the account-bound workspace, not the manifest.

One enclosing folder is accepted. Symlinks, unsafe paths, absolute URLs, other origins, missing local assets, and <base> tags are rejected.

The controls

Keep your keyboard listeners

The host shim redispatches ordinary KeyboardEvents.Your existing key down and key up handlers remain the game’s input path.

const embed = window.CliGamesEmbed

embed.onStart(({ runId, seed }) => {
  resetGame({ runId, seed })
})

window.addEventListener('keydown', (event) => {
  if (event.key === 'ArrowLeft') moveLeft()
  if (event.key === 'ArrowRight') moveRight()
  if (event.key === ' ') useMainAction()
  if (event.key === 'Escape') finishRun()
})

window.addEventListener('keyup', (event) => {
  releaseHeldKey(event.key)
})

function showPlayableMenu() {
  renderMenu()
  // Required after every completed run or return to the playable menu.
  embed.ready()
}

• Reset on host start. onStart supplies the run ID and unsigned 32-bit seed.
• Use the host seed for any gameplay or scoring randomness.
• Return ready every time. The shim announces the initial DOM-ready state; call ready() after every finished run or return to a playable menu.
• Match the manifest. Every listed key must appear in the shipped game code and do what its label says.

Optional reporting

Add progress or scoring

An unscored game may skip reporting. If the manifest includes scoring, report scores within its declared bounds and end each run once.

// Optional progress snapshot. Send after start and meaningful changes.
embed.state({ status: 'playing', level: 2, levelCount: 6, moves: 19, score: 20 })

// Required when cli-games.json includes scoring.
embed.score(20)

// Send once when a scored run ends, then return to the menu and call ready().
embed.gameOver(30)
showPlayableMenu()

Embedded scores are creator-reported and isolated from CLI-Games’ verified competitive economy. This protocol does not promise replay-grade verification.

The release

Upload, play, submit

Your upload stays private until review passes. You inspect the exact saved build before submitting its immutable fingerprint.

1. 1
   Upload the ZIPFile, manifest, security, control, and score checks run together.
2. 2
   Review package factsThe workspace shows the manifest title, command, copy, category, keys, and scoring read-only.
3. 3
   Play the private previewYou see the exact saved bytes before authorizing publication.
4. 4
   Accept and submitTerms, creator credit, manifest, and ZIP fingerprint become one candidate.
5. 5
   CLI-Games reviewsIndependent internal review checks safety, rights, controls, scoring, credit, and catalog fit.
6. 6
   Approved build goes liveSubmission authorizes publication only if that same fingerprint passes review.