Welcome to the VoidRush Documentation

Voidrush is a web game platform that accepts HTML5 and WebAssembly bundles (Unity WebGL/Godot), featuring a developer portal, an upload/extraction pipeline, and a real-time SDK for multiplayer via WebSocket. This documentation guides you from *upload* to publishing, including quality requirements and SDK integration.

What You Can Build

Quick Architecture Overview

Where to Start

  1. Create a Developer Account puis add a game depuis le portail. Provide a title, a bundle (ZIP/HTML/JS), and choose the engine.
  2. Upload your Build : we extract your archive, detect the index.html, and expose a raw route to serve the game in an iframe.
  3. Enable Multiplayer (Optional) : use the auto-join API to generate a token and a ws_url, then connect with the UMD SDK.
  4. Meet Quality Requirements : launch checklist, browser checks, cover assets, etc.
  5. Publish : fill out age rating, privacy policy, icon, video, etc.

SDK in 60 Seconds

Include the UMD bundle client-side and join a room directly from the current URL:

<script src="/static/games/js/voidrush-sdk.umd.js"></script>
<script>
// Ultra-simple variant (auto-join)
const client = new VoidrushSDK.AutoJoinClient({ gameId: "YOUR_GAME_ID" });
client.quickJoin().then(() => {
  console.log("✅ connected to room:", client.roomId);
});

// Turn-based variant
const tbg = new VoidrushSDK.TurnBasedGameClient({ gameId: "YOUR_GAME_ID" });
tbg.sendMove({ from: "a2", to: "a4" });
</script>

The backend exposes an auto-join endpoint which returns token and ws_url. The SDK can also reconstruct the WebSocket URL from the page if necessary.

Everything else is in the following sections