Install it

Your game needs a listing on Alldle first, but it does not have to be live yet. A game’s own SDK page, under its entry in My games, gives you this code already filled in, and shows results as they arrive.

Script tag

<script src="https://www.alldle.net/sdk.js" data-game="your-game-slug"></script>

The tag creates a ready instance named alldle. You only call it when a round ends:

alldle.completeMode('classic', { won: true, attempts: 3, maxAttempts: 6 });

This address always serves the current version, so you can leave it as it is.

Think twice before pinning a version

A fixed address exists, /sdk/0.2.0/sdk.js, but only the current version is served. When a new one ships, the old address returns a 404 and your game stops reporting, so pin only if you will update the tag on each release.

npm

npm i @alldle/sdk

import { Alldle } from '@alldle/sdk';

const alldle = new Alldle({ gameSlug: 'your-game-slug' });

alldle.completeMode('classic', { won: true, attempts: 3, maxAttempts: 6 });

The package comes with types. Call alldle.connect() when the page loads, so that a player sent by Alldle is recognized and their token leaves the address bar. The script tag does this by itself.

Your game’s slug

data-game is the end of your Alldle address: alldle.net/game/your-game-slug.

Before your game is approved

A game has no slug until it is live, so the code on its SDK page uses the game’s id instead. The id works for testing. Switch to the slug once the game is live, or signed-in players inside Alldle’s frame will not be linked. Renaming a live game changes its slug, and an old slug is refused, so update data-game then too.

Where it goes

Anywhere on the page where the game runs. In a single-page app with the script tag, add it to your HTML template, and call alldle from the code that ends a round.

In TypeScript with the script tag, declare the global yourself, or use the npm package for types:

declare const alldle: {
  completeMode(mode: string, data: { won: boolean; attempts?: number; maxAttempts?: number }): Promise<unknown>;
};

See what it does

Add data-debug to the script tag, or debug: true with npm. Every call is then logged in the browser console. A wrong slug or domain is always reported there, even without it.

<script src="https://www.alldle.net/sdk.js" data-game="your-game-slug" data-debug></script>

From an older version

Coming from 0.1? If you load /sdk.js, you are already on 0.2, and AllDle and AllDleSDK.AllDle still work. If you bundled 0.1, upgrade the package: until you do, your own site reports nothing. Your game’s SDK page tells you if the game is still on the old version.

Next

Report rounds, then check that it works.