Q
Q-OSprotocol
For BusinessesFor EngineersRegistryPricing
Read the Docs ↗Start Building
Q
Q-OS
Docsv0.1.0
Search docs...⌘K
IntroductionQuick StartInstallationYour First Module
System OverviewEdge Node (Rust Daemon)Sled State StoreWebSocket TelemetryCRDT Sync Protocol
Overviewqos_abi::read_inputqos_abi::write_outputqos_abi::state_getqos_abi::state_setError Handling
›OverviewGuest Check-In ModuleMenu & OrderingVIP ValidationInventory SyncCustom Broadcast Logic
⬡ GitHub ↗▶ API Reference
Docs›WASM Module Guides
WASM Guides

WASM Module Guides

Each guide walks you through a complete, production-ready WASM module from scratch. Start with the Guestbook to understand the Q-OS ABI, then explore the more advanced guides to build real venue logic.

📋

Guest Check-In Module

Beginner

The canonical Q-OS module. Collect a guest alias, persist a check-in counter, return a receipt with their check-in number.

→
🍽️

Menu & Ordering

Intermediate

Render a dynamic menu from state, accept item selections, and write order objects to the Sled store for kitchen display.

→
🎟️

VIP Validation

Intermediate

Pre-load a list of valid tokens into state, validate guest tokens on scan, and grant/deny access — zero cloud round-trips.

→
📦

Inventory Sync

Advanced

Maintain a local SKU inventory in Sled. Decrement stock on scan, broadcast low-stock warnings, and sync across peer nodes.

→
📡

Custom Broadcast Logic

Advanced

Trigger SYSTEM_BROADCAST events from within WASM module logic — for flash promotions, last-call alerts, and staff notifications.

→

New to Q-OS?

If this is your first time here, start with the Quick Start guide to get a live node running before diving into specific module patterns.

Read Quick Start →

On this page

OverviewPrerequisitesStep 1 — InstallStep 2 — Write ModuleStep 3 — Build & DeployStep 4 — VerifyNext Steps
Q-OSv0.1.0-alpha

© 2026 Q-OS Protocol. Built on Rust. Open Source.

FeaturesDevelopersPricingGitHub