Switch branches/tags
Nothing to show
Find file History
Latest commit 9221df8 May 8, 2014
Permalink
..
Failed to load latest commit information.
KongregateAPI.cs First commit May 7, 2014
README.md Fixed misspellings May 7, 2014

README.md

Kongregate API

A pure code implementation of the Kongregate statistics API for Unity as a single C# file. The statistics API is used for counting items (such as level completions, enemies killed, high score, etc) on Kongregate games. Games implementing the API also get a bigger share of ad revenue from the website, where eligible.

While the Kongregate API is relatively simple to implement, most of the implementation examples out there use JavaScript or require you to manually create GameObjects. This implementation minimizes the amount of work needed for setup and use.

Usage

  1. Copy the KongregateAPI.cs file to your Unity project's "Scripts" folder
  2. Anywhere in your code (e.g. your Main game class), create an instance of the KongregateAPI:
KongregateAPI kongregate = KongregateAPI.Create();
  1. Whenever you need to submit statistics, do:
kongregate.SubmitStats(name, value);

For example:

kongregate.SubmitStats("high-score", 1000);
kongregate.SubmitStats("tanks-destroyed", 1);

Full Interface

  • Create() (Static): creates a KongregateAPI instance and returns it (automatically creating a GameObject for itself so it can receive events).
  • SubmitStats(string name, int value): submit statistics to the Kongregate API.
  • bool isConnected: returns whether the user is properly connected to the Kongregate site API. Read-only.
  • int userId: id of the current user. Read-only.
  • string userName: name of the current user. Read-only.
  • string gameAuthToken: game authorization token. Read-only.

Debugging

In general, you don't need to do anything special for your code to work on Kongregate. Just implement the above code and you're good.

Notice, however, that:

  • This won't work when testing your game inside Unity; the Kongregate API depends on JavaScript located on their website.
  • Testing on the pre-publish screen won't work either (the kongregate object is not instantiated). The API only works after your game is properly published.
  • If you want to make sure your game is working with the API, go to its published page, add ?debug_level=4 to the URL of the game, and reload the page. This makes the JavaScript console (F12 on Chrome) output what the API is receiving from your game.

Caveats

  • This implementation doesn't support callbacks.

More information