playkit-sdk
v1.2.1-beta.1
Published
PlayKit SDK for JavaScript
Downloads
2,112
Maintainers
cnqdztpReadme
PlayKit SDK for JavaScript
JavaScript/TypeScript SDK for integrating AI capabilities into web-based games.
Features
- AI-powered text generation using GPT models
- Image generation using DALL-E models
- NPC conversation management with automatic history tracking
- JWT-based authentication and token management
- Real-time streaming responses
- Framework-agnostic design (compatible with P5.js, Phaser, PixiJS, etc.)
- Multiple bundle formats (ESM, CJS, UMD)
- Encrypted token storage using Web Crypto API
- Full TypeScript support with type definitions
- Player balance management and recharge functionality
Installation
npm install playkit-sdkQuick Start
Basic Setup
import { PlayKitSDK } from 'playkit-sdk';
const sdk = new PlayKitSDK({
gameId: 'your-game-id',
developerToken: 'your-dev-token', // For development
});
await sdk.initialize();Text Generation
const chat = sdk.createChatClient('gpt-4o-mini');
// Simple chat
const response = await chat.chat('Hello, introduce yourself');
console.log(response);
// With system prompt
const response = await chat.chat(
'How should I explore this dungeon?',
'You are a wise dungeon guide.'
);Streaming Text
await chat.chatStream(
'Tell a story about a brave knight',
(chunk) => {
process.stdout.write(chunk);
},
(fullText) => {
console.log('\nComplete:', fullText);
}
);Image Generation
const imageClient = sdk.createImageClient('dall-e-3');
const image = await imageClient.generate('A futuristic cyberpunk city at night');
console.log('Base64:', image.base64);
console.log('Data URL:', image.toDataURL());
// Display in browser
const imgElement = await image.toHTMLImage();
document.body.appendChild(imgElement);NPC Conversations
const npc = sdk.createNPCClient({
systemPrompt: 'You are a mysterious wizard who speaks in riddles.',
temperature: 0.8,
maxHistoryLength: 20,
});
const reply1 = await npc.talk('Who are you?');
console.log('Wizard:', reply1);
const reply2 = await npc.talk('What is your quest?');
console.log('Wizard:', reply2);
// Save/load history
const savedHistory = npc.saveHistory();
localStorage.setItem('npc_history', savedHistory);
// Later...
npc.loadHistory(localStorage.getItem('npc_history'));Player Balance Management
// Get player info and balance
const playerInfo = await sdk.getPlayerInfo();
console.log('Player ID:', playerInfo.userId);
console.log('Credits:', playerInfo.credits);
// Open recharge window
sdk.openRechargeWindow();
// Show insufficient balance modal
await sdk.showInsufficientBalanceModal();
// Enable automatic balance checking
sdk.enableAutoBalanceCheck(30000); // Check every 30 seconds
// Listen to balance events
sdk.on('balance_updated', (credits) => {
console.log('New balance:', credits);
});
sdk.on('insufficient_credits', (error) => {
console.log('User needs to recharge');
});Usage with P5.js
let sdk, npc, generatedImage;
async function setup() {
createCanvas(800, 600);
sdk = new PlayKitSDK({
gameId: 'your-game-id',
developerToken: 'your-dev-token'
});
await sdk.initialize();
npc = sdk.createNPCClient({
systemPrompt: 'You are a friendly game character.'
});
}
async function mousePressed() {
const reply = await npc.talk('Hello!');
console.log(reply);
const imageClient = sdk.createImageClient();
const img = await imageClient.generate('A magical forest');
const htmlImg = await img.toHTMLImage();
generatedImage = loadImage(htmlImg.src);
}
function draw() {
background(220);
if (generatedImage) {
image(generatedImage, 0, 0, 400, 400);
}
text('Click to talk to NPC or generate image', 10, height - 20);
}Usage with Vanilla JavaScript
<!DOCTYPE html>
<html>
<head>
<script src="https://unpkg.com/playkit-sdk@latest/dist/index.umd.js"></script>
</head>
<body>
<div id="output"></div>
<input id="userInput" type="text" placeholder="Type a message...">
<button onclick="sendMessage()">Send</button>
<script>
let sdk, chat;
async function init() {
sdk = new PlayKitSDK.PlayKitSDK({
gameId: 'your-game-id',
developerToken: 'your-dev-token'
});
await sdk.initialize();
chat = sdk.createChatClient();
}
async function sendMessage() {
const input = document.getElementById('userInput').value;
const output = document.getElementById('output');
output.innerHTML += `<p><strong>You:</strong> ${input}</p>`;
output.innerHTML += `<p><strong>AI:</strong> <span id="aiReply"></span></p>`;
const replyElement = document.getElementById('aiReply');
await chat.chatStream(
input,
(chunk) => { replyElement.innerHTML += chunk; }
);
document.getElementById('userInput').value = '';
}
init();
</script>
</body>
</html>License
Proprietary License - see LICENSE file for details.
This SDK is proprietary software owned by Agentland Lab. Use of this SDK is subject to the terms and conditions of the license agreement.
Support
- Email: [email protected]
- Issues: GitHub Issues
Changelog
1.0.0-beta.1
- Initial public beta release
- AI chat support (text generation)
- Image generation support
- NPC conversation management
- Authentication and player management
- Streaming response support
- Player balance management and recharge functionality