Quickstart

Learn how to register and manage games, fetch data from the API, and submit points for players.

0. Prerequisites

This guide assume you've followed the setup guide from the previous page.

1. Register a Game

First, we will register a new game on the OGP Platform

try {
    const game = await ogp.games.register({
        name: "My Game Name",
        description: "A description of more than 10 characters",
        gameUrl: "https://mygame.com",
        // Platform Options:
        // web | ios | android | steam | itch | epic
        platform: "web",
        isHTMLGame: true,                       // Optional: Defaults to True
        iframable: true,                        // Optional: Defaults to True
        twitter: "https://x.com/mytwitter",     // Optional
        discord: "https://discord.gg/invite",   // Optional
        telegram: "https://t.me/mychannel",     // Optional
        maxScorePerSession: 0,                  // Optional: 0 = Unlimited
        maxSessionsPerDay: 0,                   // Optional: 0 = Unlimited
        maxCumulativePointsPerDay: 0,           // Optional: 0 = Unlimited
        base64Image: "...",                     // Required if not passing image
        base64CoverImage: "...",                // Required if not passing coverImage
        // Optional: Define rewards allocation, must add up to 10,000 basis points.
        orgRewardsSplit: { 
            "solana_address_1": 5_000,
            "solana_address_2": 5_000,
        },
    });
} catch (e) {
    throw e;
}

Interacting with the Game API

/** Fetch a game by ID */
const game = await ogp.games.getById({ gameId });

/** Batch fetch games by ID */
const games = await ogp.games.getManyByIds({ gameIds });

/** Update a game */
const result = await ogp.games.update({
    gameId: game.id,
    ...gameUpdates
});

/** Get your games */
const myGames = await ogp.games.getAuthedGames({
    limit,
    cursor,
    sort,
});

/** Find games by token ID */
const games = await ogp.games.getByTokenId({ tokenId });

/** Find games by batch token IDs */
const games = await ogp.games.getByBatchTokenIds({ tokenIds: ['token1', 'token2'] });

/** Fetch games from OGP */
const games = await ogp.games.get({
    query: '',
    limit: 50,
    sort: 'desc',
    sortBy: 'totalRewardsAllocatedUsd',
});

Verify Game Ownership

Without claiming game ownership, you will only earn 5% of allocated creator rewards. By claiming ownership, you gain access to the full creator rewards allocation.

To verify game ownership, you will need to embed the following meta tag in the head of your game URL webpage:

<meta name="x-ogp-key" content="your-creator-api-key" id="ogp-key-meta" />

Once this is in your webpage head, call the following via the client:

const result = await ogp.games.claimOwnership({ gameId });
if (result.success) {
    console.log('Game ownership claimed!');
} else {
    console.error('Failed to verify game ownership');
}

2. Submit Points for a Game

To submit points for users use the client and include points record data

const pointsRecord = {
    playerId: 1000,
    playerId2: 2000,
};
// Points records can also be arrays of points objects
const pointsRecord = [
    { player: 1000 },
    { player1: 2000 },
];

// Save points for a single player
const result = await ogp.play.savePoints({ gameId, playerId, points });

// Save points for multiple players
const result = await ogp.play.batchSavePoints(gameId, pointsRecord);

Interacting with the Play API

/** Fetch User Points */
const points = await ogp.play.getPoints({ gameId, playerId });

/** Fetch leaderboard for game */
const leaderboard = await ogp.play.getLeaderboard({ gameId });