Arcade.fun

Every approved experience currently playable on arcade.fun, with the origin games are served from. Needs no credentials.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Register a new experience and get its manage key. Returns game, key and the first version id. The key is shown only here and controls the listing forever — save it. This creates a draft; upload_build is what sends it for review.

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "maxLength": 60,
      "description": "What the experience is called, 2 to 60 characters."
    },
    "author": {
      "type": "string",
      "maxLength": 30,
      "description": "The creator name players see, 2 to 30 characters."
    },
    "email": {
      "type": "string",
      "maxLength": 254,
      "description": "Reviewer contact address. Players never see it."
    },
    "wallet": {
      "type": "string",
      "maxLength": 44,
      "description": "Solana address that receives this listing's creator trading fees. Every public listing launches with its own coin."
    },
    "tagline": {
      "type": "string",
      "maxLength": 140,
      "description": "One line for the cabinet."
    },
    "how": {
      "type": "string",
      "maxLength": 1200,
      "description": "How to take part: the controls and how to begin."
    },
    "inputs": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "voice",
          "camera",
          "keyboard",
          "mouse",
          "touch",
          "gamepad"
        ]
      },
      "description": "How people interact. At least one."
    },
    "devices": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "mobile",
          "desktop"
        ]
      },
      "description": "Devices actually tested. Mobile requires touch, voice or camera among inputs."
    },
    "aspect": {
      "type": "string",
      "enum": [
        "",
        "16:9",
        "4:3",
        "1:1",
        "3:4",
        "9:16"
      ],
      "description": "Shape on screen. Empty fills the screen."
    },
    "kind": {
      "type": "string",
      "enum": [
        "web",
        "sdk"
      ],
      "description": "'sdk' if the entry page calls arcade.ready(), otherwise 'web'. Detected from the build too."
    },
    "rights": {
      "type": "boolean",
      "description": "Confirm the experience is yours to share, including its art, music and code."
    },
    "terms": {
      "type": "boolean",
      "description": "Confirm you agree to the arcade.fun terms and community guidelines."
    }
  },
  "required": [
    "title",
    "author",
    "email",
    "wallet",
    "inputs",
    "rights",
    "terms"
  ],
  "additionalProperties": false
}

Open a new version slot for an experience you already own. The live approved version keeps playing until the new one is reviewed.

{
  "type": "object",
  "properties": {
    "game": {
      "type": "string",
      "description": "The 12-character game id."
    },
    "key": {
      "type": "string",
      "description": "That game's manage key."
    }
  },
  "required": [
    "game",
    "key"
  ],
  "additionalProperties": false
}

Send the browser build for a version and publish it. One HTML file, or a zip with index.html at its root. A build that passes the sandbox checks goes live immediately: the result has `live: true` and the play URL. Otherwise `live: false` and `waiting` says why, either a list of things to fix or that this arcade reviews that upload by hand. Also returns file count, size, engine and whether the arcade SDK was detected. If the zip has several pages and no index.html, the result asks which page starts it — answer with set_entry.

{
  "type": "object",
  "properties": {
    "version": {
      "type": "string",
      "description": "Version id from create_experience or start_version."
    },
    "key": {
      "type": "string",
      "description": "The game's manage key."
    },
    "content_base64": {
      "type": "string",
      "description": "The .html or .zip file, base64 encoded. Up to 24 MB decoded."
    },
    "filename": {
      "type": "string",
      "description": "The file's name, so the type is read correctly: e.g. index.html or build.zip."
    },
    "entry": {
      "type": "string",
      "maxLength": 300,
      "description": "Start page inside a zip, if it is not index.html."
    },
    "threads": {
      "type": "boolean",
      "description": "True if the build needs SharedArrayBuffer. Threaded builds open in their own tab and cannot use the SDK bridge. Omit to work it out from the files."
    }
  },
  "required": [
    "version",
    "key",
    "content_base64",
    "filename"
  ],
  "additionalProperties": false
}

Name the page that starts the experience, when a zip had several and no index.html.

{
  "type": "object",
  "properties": {
    "version": {
      "type": "string"
    },
    "key": {
      "type": "string"
    },
    "entry": {
      "type": "string",
      "maxLength": 300,
      "description": "A path the upload result offered, e.g. game/play.html."
    }
  },
  "required": [
    "version",
    "key",
    "entry"
  ],
  "additionalProperties": false
}

Upload the square cover used for the cabinet, the sharing card and the coin image. PNG, JPEG, WebP or GIF up to 4 MB.

{
  "type": "object",
  "properties": {
    "game": {
      "type": "string"
    },
    "key": {
      "type": "string"
    },
    "image_base64": {
      "type": "string",
      "description": "The image, base64 encoded."
    }
  },
  "required": [
    "game",
    "key",
    "image_base64"
  ],
  "additionalProperties": false
}

Upload the MP4 played when the experience's link is shared. Without one the platform builds an animated title card from the cover instead.

{
  "type": "object",
  "properties": {
    "game": {
      "type": "string"
    },
    "key": {
      "type": "string"
    },
    "video_base64": {
      "type": "string",
      "description": "The MP4, base64 encoded."
    }
  },
  "required": [
    "game",
    "key",
    "video_base64"
  ],
  "additionalProperties": false
}

Where an experience stands: its details, its coin plan, any note from the reviewers, and every version with its status.

{
  "type": "object",
  "properties": {
    "game": {
      "type": "string"
    },
    "key": {
      "type": "string"
    }
  },
  "required": [
    "game",
    "key"
  ],
  "additionalProperties": false
}