Skip to main content

đŸ› ī¸ Installation & Libraries

To start using the Game Jolt API, you first need to install the library or plugin appropriate for your game engine or programming language.

📚 Supported Libraries & Plugins​

Members of the Game Jolt community have developed libraries for almost every major game engine and platform.

Platform / LanguageLibrary Link
UnityUnity API Plugin
Game MakerGM Legacy API
Game Maker: StudioGMS Achievement API
Construct 2Construct 2 API Demo
Construct ClassicConstruct Plugin Forum
C / C++C-Library
ActionScript 3AS3 API
BlitzBlitzMax API
C#C# API Forum
Clickteam Fusion 2.5 / MMF2Clickteam/MMF2 API
HaxeHaxe API Forum
HaxeFlixelHaxeFlixel Integration
ImpactJSImpactJS Plugin
JavaJava API Forum
JavaScript (Wrapper)JS API Forum
JavaScript (Library)JS Library
libGDXlibGDX API (Exp)
Love2dLove2d API Forum
LuaLua GJ API Forum
.NetJoltNet (.Net)
PHPPHP API Forum
PythonPython Module
RPG Maker VX AceRPG Maker VX Ace API
RPG Maker XPRPG Maker XP API
RubyRuby API Forum
Visual BasicVB API Forum

âš™ī¸ Generic Installation Steps​

Most libraries follow this general workflow:

1. Download​

Visit the links above and download the latest release for your platform.

2. Initialization​

In your code, you must initialize the API using your Game ID and Private Key (found in your Game Jolt Dashboard).

// Example for Unity
using GameJolt.API;

void Start() {
// Usually handled by the GameJoltAPI Prefab in Unity
// But manual init looks like this:
bool success = GameJoltAPI.Instance.Initialize(myGameID, myPrivateKey);
}

3. Verify Connection​

Always call the Sessions.Ping or Users.Fetch method to ensure your credentials are correct before proceeding to trophies or scores.

Missing your platform?

If you don't see your engine here, you can always build a custom wrapper using our URL Construction guide!