Developer Hub

Build for RQBBOX

SDK tools, API documentation, tutorials, and open-code projects. Create games, apps, themes, and plugins for RQBBOX OS. Supported languages: Rust, C++, JavaScript, Python.

🦀 Rust ⚡ C++ 🌐 JavaScript 🐍 Python

SDK Downloads

Download the RQBBOX SDK for your language of choice.

🦀

Rust SDK

Rust

Build native RQBBOX applications with Rust. Includes crate, bindings, and examples.

⚡

C++ SDK

C++

Create high-performance games and tools with C++. Headers, libraries, and templates included.

🌐

JavaScript SDK

JavaScript

Build plugins, apps, and themes using web technologies. Includes framework and examples.

🐍

Python SDK

Python

Rapidly prototype tools and scripts. Python bindings, helpers, and documentation.

📘

Theme SDK

Theme

Create custom themes with CSS variables. JSON-based theme packaging and preview tools.

🧩

Plugin SDK

Plugin

Build plugins with the Plugin Engine. JavaScript API, manifest system, and distribution.

API Reference

Full API documentation for RQBBOX OS backend and runtime APIs.

Backend API

The RQBBOX server runs on port 19777. All endpoints prefixed with /api/.

GET/api/storageGet USB storage info (total, free, used)
GET/api/configGet system configuration
POST/api/configSave system configuration
GET/api/profilesGet all user profiles
POST/api/profilesSave profiles data
GET/api/storeGet store catalog (games + apps)
GET/api/files?path=List files at path on USB
GET/api/file/read?path=Read file contents
POST/api/file/writeWrite content or base64 to file
POST/api/file/deleteDelete a file
POST/api/file/copyCopy file from path to path
POST/api/file/moveMove/rename file
GET/api/batteryGet battery/power status
GET/api/networkGet network/WiFi info
GET/api/bluetoothGet Bluetooth status
GET/api/controllerGet gamepad/controller status
GET/api/status/allCombined system status (all above + storage)
GET/api/deviceGet registered USB devices
POST/api/deviceRegister or update a device
POST/api/authSign in with username/password
POST/api/registerCreate new account
GET/api/me?token=Get current user profile
POST/api/auth/refreshRefresh auth token
POST/api/auth/2faEnable/disable 2FA PIN
POST/api/installInstall a game or app from store
GET/api/screenshotsList saved screenshots
POST/api/screenshotSave a screenshot
POST/api/notifySend notification
POST/api/db/backupBackup profiles database
POST/api/db/restoreRestore profiles from backup
POST/api/db/validateValidate profiles database
GET/api/cdn/file?path=CDN-cached file with ETag

Runtime API

Available inside RQBBOX runtime apps and plugins.

GETRQB.toast(msg)Show a toast notification
GETRQB.navigate(page)Navigate to a launcher page
GETRQB.playSound(id)Play a UI sound effect
GETRQBApi.get(path)Make GET request to backend
GETRQBApi.post(path, data)Make POST request to backend
GETStats.track(action)Track a user action for analytics

Tutorials

Get started building for RQBBOX with step-by-step tutorials.

Beginner

Your First RQBBOX App

Build a simple app using the JavaScript SDK. Learn manifest format, runtime API, and deployment.

🌐 JavaScript — 20 min
Beginner

Creating a Custom Theme

Design and package a custom theme using CSS variables. Preview in real-time and share with the community.

🎨 CSS — 15 min
Intermediate

Building a Plugin

Create a plugin with the Plugin Engine. Learn the lifecycle, manifest, and runtime API.

🧩 JavaScript — 30 min
Intermediate

Native Game in C++

Port a C++ game to RQBBOX using the C++ SDK. Window creation, input handling, and file I/O.

⚡ C++ — 45 min
Advanced

Rust Game Engine Integration

Integrate a Rust game engine with RQBBOX. Bindings, performance optimization, and packaging.

🦀 Rust — 60 min
Beginner

Publishing to the Store

Submit your game, app, theme, or plugin to the RQBBOX Store. Format, metadata, and review process.

📦 General — 10 min

Open-Code Projects

Explore open-source projects built for RQBBOX. Fork, contribute, and learn.

🎯 Neon Drift

High-speed racing game. C++ with RQBBOX SDK. Features: drift mechanics, track editor, leaderboards.

C++ ⭐ Featured

🌐 RQB Browser

Portable web browser built with the JavaScript SDK. Tabbed browsing, bookmarks, history.

JavaScript

🏗️ RQBBOX Toolkit

Developer utility suite in Python. Build, package, and publish tools. Theme validator included.

Python

📊 FPS Overlay Plugin

Real-time FPS counter plugin. Uses the Plugin Engine runtime API. Configurable position and style.

JavaScript Plugin

⚡ RQBBOX Performance Tools

RAM cleaner, FPS boost, background limiter. Rust native performance tools for gaming.

Rust

🎨 Cyber Dark Theme

Dark cyberpunk theme. CSS variables, custom fonts, and animated backgrounds.

Theme

Plugin API

Build plugins for RQBBOX using the Plugin & Theme Engine.

Plugin Manifest

Every plugin needs a plugin.json manifest in its root directory:

{
  "name": "my-plugin",
  "version": "1.0.0",
  "author": "Your Name",
  "description": "My awesome plugin",
  "type": "plugin",
  "main": "index.js",
  "icon": "🧩",
  "permissions": ["storage", "notifications"]
}

Plugin Lifecycle

The Plugin Engine calls the following lifecycle methods on your plugin:

GETonLoad()Called when the plugin is loaded
GETonEnable()Called when the plugin is enabled
GETonDisable()Called when the plugin is disabled
GETonUnload()Called when the plugin is unloaded
GETonSettings()Returns HTML for plugin settings UI

Plugin Runtime API

Plugins have access to the full RQBBOX runtime API:

GETPluginAPI.toast(msg)Show a toast
GETPluginAPI.getConfig(key)Get a config value
GETPluginAPI.setConfig(key, val)Set a config value
GETPluginAPI.fetch(path)Make an API request
GETPluginAPI.addWidget(html)Add a UI widget
GETPluginAPI.emit(event, data)Emit a custom event
GETPluginAPI.on(event, cb)Listen for a custom event

Theme Format

Themes are CSS variable overrides packaged in a manifest:

{
  "name": "cyber-dark",
  "version": "1.0.0",
  "author": "Your Name",
  "description": "Dark cyberpunk theme",
  "type": "theme",
  "main": "theme.css",
  "icon": "🌙"
}

Theme CSS files override CSS custom properties (--neon-blue, --bg-primary, etc.) to customize the entire RQBBOX look and feel.

Packages

GitHub Packages

Install RQBBOX components via npm from GitHub Packages.

🔧 Setup

Authenticate with your GitHub token:

npm login --registry=https://npm.pkg.github.com/ --scope=@rtech-rqbbox-os

📦 rqbbox-os

Root metapackage

npm i @rtech-rqbbox-os/rqbbox-os

⚡ rqbbox-server

USB HTTP server

npm i @rtech-rqbbox-os/rqbbox-server

🧪 rqbbox-sdk

Developer SDK docs

npm i @rtech-rqbbox-os/rqbbox-sdk

Auto-published from GitHub Actions on every release. View all packages →