Documentation
Everything you need to know about integrating and publishing your HTML5 games on Khelogy.
Getting Started
Welcome to the Khelogy Developer Documentation. Our platform supports standard HTML5 games. The integration process is designed to be as straightforward as possible, allowing you to focus on gameplay rather than complex API implementations.
Before submitting your game, ensure you have thoroughly tested it across modern desktop and mobile browsers. We only accept games that meet our quality standards.
Game Requirements
To ensure a smooth experience for our players, your game must adhere to the following technical requirements:
- Format: Must be an HTML5 game (Canvas or WebGL).
- File Structure: Must include an
index.htmlfile at the root directory. - Responsiveness: Game must automatically scale to fit the window/iframe size on both desktop and mobile devices.
- External Requests: All assets (images, sounds, scripts) should be included in the game package or loaded over HTTPS. Mixed content (HTTP) is not allowed.
- No Malicious Code: Games containing malware, crypto miners, or unauthorized redirects will be permanently banned.
API Integration (Optional)
We provide an optional SDK to handle high-score submissions and analytics. If you choose to use it, include our SDK script in your index.html:
<script src="https://api.www.khelogy.com/sdk.js"></script>
Initialize the SDK
Call the initialization method as early as possible in your game's lifecycle:
KhelogySDK.init({
gameId: 'YOUR_GAME_ID'
}).then(() => {
console.log('SDK Initialized');
});
Ads & Monetization
We handle the displaying of ads around the game container. However, if you wish to implement in-game rewarded video ads, you can use our SDK's ad functions:
// Request a rewarded ad
KhelogySDK.showAd('rewarded').then((success) => {
if (success) {
// Give player reward
player.coins += 100;
} else {
// Ad failed or skipped
}
});
Submission Process
Once your game is ready, compress the game folder into a .zip file. Then, head over to our Contact Page and reach out to our publisher team with:
- A link to your game package (e.g., via Google Drive or Dropbox).
- Game Title and Description.
- Game thumbnail (512x512 pixels).
- Any specific instructions or required controls.
Our team usually reviews submissions within 3-5 business days.