Upload Game Asset Workflow

Overview

Prerequisites

• A game must already exist on the Remix platform (you need a game ID).
• The

  REMIX_API_KEY

  environment variable must be set.

Steps

1. Check for Existing Game ID

.remix-settings.json

gameId

.remix-settings.json

gameId

2. Upload the Asset

POST https://api.remix.gg/v1/games/{gameId}/assets
Authorization: Bearer $REMIX_API_KEY
Content-Type: multipart/form-data

Form fields:
  file       (required) — the binary file to upload
  assetName  (optional) — custom display name; defaults to the filename

.jpg

.jpeg

.png

.webp

.mp3

.wav

.hdr

.glb

.gltf

{
  "success": true,
  "data": {
    "gameId": "...",
    "asset": {
      "url": "https://..."
    }
  }
}

data.asset.url

3. Use the URL in Game HTML

<img src="https://returned-asset-url.png" width="64" height="64" />

const img = new Image();
img.src = "https://returned-asset-url.png";
img.onload = () => ctx.drawImage(img, x, y, w, h);

const audio = new Audio("https://returned-asset-url.mp3");
audio.play();

4. (Optional) List All Assets

GET https://api.remix.gg/v1/games/{gameId}/assets
Authorization: Bearer $REMIX_API_KEY

Tips

• Name files descriptively. Use clear filenames like

  player-idle.png

  or

  jump-sfx.mp3

  -- the filename becomes the default asset name.
• Preload assets before gameplay. Wait for

  onload

  /

  canplaythrough

  events before starting the game loop to avoid missing assets.
• Stay under 5 MB per file. Compress images and audio before uploading. Use

  .webp

  for images and

  .mp3

  for audio when possible.
• Repeat for each asset. Run through steps 2-3 for every file the game needs.