PIXOUL SDK

Quick start

Quickly integrate Pixoul Account into your game project.

What you’ll achieve

  • Sign in with Pixoul Account
  • AI character interactions: state, long-term memory, and sessions
  • Monetization management
  • Publish your game on AITube

Confirm your client SDK

Select your client to see the matching installation and test-drive steps.

GodotFlutterUnrealUnity

Install prerequisites

Prepare the Godot editor, build tools, and an existing project that runs successfully.

1

Prepare your environment

Verify the Godot editor, build tools, and package manager.

2

Get project credentials

Get project_id and app_id from Create. The client also needs an active Pixoul Account session.

Install and set up the Pixoul Godot SDK

After preparing the prerequisites, add the SDK to your project.

1

Install the SDK

Add the official Pixoul Godot SDK, reload dependencies, and verify the project builds.

addons/pixoul_sdk/plugin.cfg
2

Configure project identity

Initialize the SDK with project_id and app_id, then pass the current Pixoul Account session token.

Pixoul.initialize({
  projectId: "your_project_id",
  appId: "your_app_id",
  accountToken: session.accessToken
});
3

Run a Runtime interaction

Create or read a character, send a test message, and verify state and session recovery.