Integrate the Corona Plugin for GameCircle


Game developers using the Corona Labs SDK can now integrate GameCircle into their Android games using the Corona plugin. The Corona SDK enables developers to build mobile apps and games for multiple platforms including Amazon Fire, Android, and iOS devices. Developers program in Lua and call the Corona SDK, which is built on a C++/OpenGL platform to optimize for graphic applications.

Corona's GameCircle plugin implements all of the current GameCircle APIs, including submitting the local player's scores & achievement progress, displaying GameCircle overlays, getting achievement and leaderboard data using Whispersync for Games to synchronize game progress across multiple devices, and getting social data for GameCircle Friends.

Get the Corona Plugin

Corona's GameCircle plugin is part of the Corona SDK product, so if you already have the Corona SDK, you just need to get a recent release or daily build.

Integrate GameCircle into Corona Projects

For Corona users, this overview shows the steps to integrate GameCircle into your Corona project.

  1. Create your GameCircle assets. Set up draft versions of GameCircle leaderboards and achievements for your game. You'll do this in Amazon's GameCircle Developer Console by creating a new configuration for your game. (If you don't already have an Amazon developer account, you'll need to create one–it's quick and easy.) See the GameCircle documentation Creating a GameCircle Configuration for more info.

    • Describe your game: Provide some basic game details and save your new configuration. This step automatically sets up a security profile, which you'll need if you choose to publish on Amazon Appstore.
    • Add leaderboards: Define what leaderboards you want to use in your game. You'll set the leaderboard title and score details, add an icon to display in your game, and add multiple language versions as needed.
    • Add achievements: Define what achievements you want to use in your game. You'll set the achievement title and experience points (XP), add icons and descriptions to display before and after a player earns the achievement, and add multiple language versions as needed.
  2. Add GameCircle components into your game code: Use the Corona GameCircle plugin APIs to enable your game to interact with the GameCircle service, submit and retrieve player game progress, etc. You'll need to use information from your game configuration, which you can access in the GameCircle Developer Console.

    • Include the GameCircle plugin into your game code.
    • Generate an API key for your game. Add the API key to your project:
    • Use the plugin to:
      • Enable a player to sign into their GameCircle accounts.
      • Display a player's GameCircle profile (nickname & avatar image).
      • Submit a player's high scores to your game's leaderboards.
      • Submit a player's achievement status.
      • Display GameCircle overlays showing your game's leaderboards & achievements.
      • Get a player's raw game progress data to use in custom features.
      • Get GameCircle Friends data to use in custom features.

      • Use Whispersync for Games to synchronize a player's game progress across multiple devices.
  3. Build and test your game before publishing.

  4. Prepare your game for release: Once you're ready to release your game, you need to "publish" the GameCircle assets you want players to see. You'll do this in Amazon's GameCircle Developer Console. Players can only view published leaderboards and achievements. It's a good idea to keep leaderboards and achievements in draft mode until they've been finalized, since published assets can't be changed.

  5. Maintain and track your GameCircle assets. Use the GameCircle Developer Console to monitor top scores on your leaderboards, get achievement reports showing player earning rates, etc. Continue to develop and publish new assets throughout the life of your game.