Documentation
GETTING STARTED

Quick Start

Get your first game published on edu.games. The developer portal at dev.edu.games walks you through most of this with a first-login checklist — this page explains what each step actually does.

The flow: invite → register → studio profile → upload → sandbox test → submit for review → review → publish. For a tour of every screen see The Developer Portal; for what each status means and what happens after publish, see Review & Game Lifecycle.

Step 1 — Invite & register

Developer accounts currently onboard by invite. Once you have an invite (or the waitlist has opened developer signups), register at edu.games/auth/register and select the Developer role. You’ll get a confirmation email, and access to dev.edu.games once your account is approved.

Step 2 — Complete your studio profile

On first login you’ll land on the dev dashboard (Overview) with an onboarding checklist. The first item is your studio profile (Settings → Profile) — add a studio name, bio, and optional logo. This is what players, teachers, and reviewers see attached to your games, and it powers your studio page at <studio>.edu.games.

Step 3 — Package and upload your game

From My Games → Upload New, fill in the listing (title, subdomain, description, learning outcomes, subjects, age range, price), tick the Browser build slot and choose Standard HTML5 or xAPI Package, then pick your build — a .zip archive with an index.html at the root (or one folder down) — and press Save as Draft.

plaintext
mygame.zip
├── index.html          ← entry point (required)
├── game.js
├── assets/
│   ├── sprites.png
│   └── audio.mp3
└── styles.css

Under the hood the upload happens in three steps the UI handles for you: a draft game record is created, the browser gets a short-lived presigned URL and uploads the zip directly to storage, then a finalize call validates the archive (layout, size, file count, and a zip-bomb / executable-content check) before it’s attached to your game. If a validation fails you’ll get a specific error pointing at the exact rule — full details, including the 20-game / 25GB account quota, are in Packaging Your Game.

Step 4 — Test in the sandbox

Before submitting, open your game in the sandbox from the Sandbox column of All Games or its Analytics Readiness page (a draft upload is enough — no review needed) to confirm it runs end to end on edugames.dev, the same environment the production player uses. If you’ve added xAPI tracking, the sandbox also shows a live, conformance-checked statement feed — see Testing on edugames.dev.

Step 5 — Submit for review

Once your game plays correctly in the sandbox, click Submit for Review in the Review column of My Games → All Games. Our team reviews all games within 2–5 business days. You’ll get an email when the review completes; approved games are published and become playable on edu.games, teacher, and student portals immediately, while a rejection comes with written feedback and a Resubmit for Review button. The full state machine — including how updates to a live game are staged — is in Review & Game Lifecycle.

Step 6 — (Optional) Add xAPI tracking

For richer progress tracking, integrate xAPI. Inside the player your game never needs a credential: the launch context carries the endpoint, a short-lived auth token and the student’s opaque identity, and the official SDK reads all of it for you. (A key and secret for server-side use are generated when the game is approved and live under Plugins & SDKs.) You can add instrumentation before or after your first publish — see the SDK and the Emission Profile.

html
<!-- index.html: load the SDK before your game scripts -->
<script src="https://edu.games/sdk/edugames-sdk.v1.js"></script>
<script>
  (async () => {
    const client = await EduGames.init({ game: 'my-game' });   // null outside any edu.games player
    if (!client) return;
    client.launched();
    client.attempted('level-1');
    // ...when the level ends:
    client.passed('level-1', { score: 0.85, durationSeconds: 47 });
  })();
</script>
LMS Integration (LTI 1.3)The Developer Portal