Skip to content

Getting started

Welcome to the Y8 SDK Documentation.

This documentation explains how to integrate the Y8 SDK into your game and use Y8 services.

Before You Begin

The first step is to create an account on the Y8 Developer Portal.

After creating your account, you will be asked to create a Studio. Once your Studio is created, you can create and manage your games through the Developer Portal.

For the complete setup process, see the Developer Portal section.

Install the SDK

The SDK is one JavaScript library, reachable from four platforms — JavaScript, Unity, Construct 3 and Haxe. See Platforms to install it for yours, then Getting started to initialize it.

Code samples throughout this site carry a tab for each platform. Pick yours once and the whole site follows.

SDK features

  • Advertising — Integrate Y8 advertising.
  • Authentication — Authenticate and identify players.
  • Leaderboards — Add competitive leaderboards.
  • Achievements — Add achievements and progression.
  • Cloud Storage — Store player data.
  • Images — Work with Y8 images.
  • Player Profile — Access player information.
  • Protection — Protect your game integration.
  • Localization — Support different languages.
  • Analytics — Measure game activity and player events.

If your game has a backend of its own, also read Verifying Players — it is the one page where getting it wrong lets a player claim someone else's identity.

Tip

Already have a Y8 Developer Portal account, Studio, and game? Continue directly to the SDK → Introduction guide to integrate the Y8 SDK.

New to publishing on Y8? Best Practices covers what tends to separate a smooth integration from a frustrating one.