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.

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 with an onboarding checklist. The first item is your studio profile (/dashboard/profile) — add a studio name, bio, and optional logo. This is what players, teachers, and reviewers see attached to your games.

Step 3 — Package and upload your game

From My Games → Upload New, create a draft game record, then upload your build as a .zip archive with an index.html at the root (or one folder down).

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 (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. Our team reviews all games within 2–5 business days. You’ll be notified when the review completes; approved games are published and become playable on edu.games, teacher, and student portals immediately.

Step 6 — (Optional) Add xAPI tracking

For richer progress tracking, integrate xAPI. Credentials are generated automatically for every game and visible under Plugins & SDKs — you can add instrumentation before or after your first publish.

javascript
// Example: send a completed statement
const creds = btoa('YOUR_KEY:YOUR_SECRET');

await fetch('https://lrs.edu.games/xapi/statements', {
  method: 'POST',
  headers: {
    'Authorization': `Basic ${creds}`,
    'Content-Type': 'application/json',
    'X-Experience-API-Version': '1.0.3',
  },
  body: JSON.stringify({
    actor: { mbox: 'mailto:student@school.edu', name: 'Student Name', objectType: 'Agent' },
    verb: { id: 'http://adlnet.gov/expapi/verbs/completed', display: { 'en-US': 'completed' } },
    object: { id: 'https://mygame.com/level-1', definition: { name: { 'en-US': 'Level 1' } }, objectType: 'Activity' },
    result: { score: { raw: 85, min: 0, max: 100, scaled: 0.85 }, completion: true },
  }),
});
IntroductionPackaging Your Game