SDK 6.3/Rust - Revision history

WowBot: Link full API reference subpages (WowBot)

2026-07-26T10:45:18Z

Link full API reference subpages (WowBot)

WowBot: CubiOS Rust SDK is now public on GitHub (WowBot)

2026-07-26T10:41:05Z

CubiOS Rust SDK is now public on GitHub (WowBot)

WowBot: Rust API rewritten for CubiOS Rust SDK; EXPERIMENTAL marked everywhere (WowBot)

2026-07-26T10:33:03Z

Rust API rewritten for CubiOS Rust SDK; EXPERIMENTAL marked everywhere (WowBot)

Show changes

WowBot: Full Rust spec: module wrappers + application layer + source availability (WowBot)

2026-07-26T09:49:53Z

Full Rust spec: module wrappers + application layer + source availability (WowBot)

WowBot: C++ (WASM) and Rust API reference for SDK 6.3 (WowBot)

2026-07-26T09:14:54Z

C++ (WASM) and Rust API reference for SDK 6.3 (WowBot)

New page

{{notice|'''Official WOWCube SDK documentation.''' SDK 6.3, Rust API. Based on the <code>wowcube_sdk</code> crate shipped with the WOWCube Development Kit; the crate sources remain authoritative.}}

{{SDK 6.3 nav}}

''← [[SDK 6.3]] · Rust''

Rust cubeapps are built to WebAssembly and use the same engine ABI as the [[SDK 6.3/C++/Native API|C++ native API]]. The Development Kit ships the '''<code>wowcube_sdk</code>''' crate (v0.1.0) together with buildable Rust example projects (''Basics 1–3'', with assets). Projects are created and built with the [https://marketplace.visualstudio.com/items?itemName=cubios-inc.WOWCubeSDK WOWCube SDK extension for VS Code].

== Crate layout ==

[package]
name = "wowcube_sdk"
version = "0.1.0"
edition = "2021"

[dependencies]
cty = "0.2.2"

* <code>wowcube_sdk::application</code> — the <code>Application</code> trait, <code>ApplicationContext</code>, timers, animation helper (<code>Anim</code>), error type <code>AppErr</code>, and the entry helpers <code>application_init()</code> / <code>application_run()</code>.
* <code>wowcube_sdk::cubios</code> — FFI bindings to the engine ABI and the typed submodules <code>comm</code>, <code>gfx</code>, <code>topology</code>.

== Application trait ==

A cubeapp implements the <code>Application</code> trait; all callbacks have default no-op implementations, so you override only what you need:

pub trait Application {
fn app_context_mut(&mut self) -> &mut ApplicationContext;

fn on_init(&mut self) -> Result<(), AppErr> { Ok(()) }
fn on_tick(&mut self) -> Result<(), AppErr> { Ok(()) }
fn on_render(&self) -> Result<(), AppErr> { Ok(()) }
fn on_timer(&mut self, _timer_id: u8) -> Result<(), AppErr> { Ok(()) }

fn set_timer(&mut self, id: u8, delay: u32, suspended: bool) -> bool { … }
}

Errors are reported through the <code>AppErr</code> enum (<code>AssetNotFound</code>, <code>InvalidModule</code>, <code>InvalidTwist</code>, <code>SceneNotFound</code>, …).

== Entry points ==

The module exports two <code>extern "C"</code> functions which the runtime calls (from the shipped ''HelloWOWCube'' example):

#![no_main]
mod cubeapp;
use wowcube_sdk;

static mut APPLICATION: Option<cubeapp::HelloWOWCube> = None;

#[no_mangle]
pub extern "C" fn on_init(cid: u32) {
let mut application = cubeapp::HelloWOWCube::new();
wowcube_sdk::application::application_init(&mut application, cid);
unsafe { APPLICATION = Some(application); }
}

#[no_mangle]
pub extern "C" fn run() {
let application = unsafe { APPLICATION.as_mut().unwrap() };
wowcube_sdk::application::application_run(application);
}

<code>cid</code> is the index of the module (0–7) the instance runs on — the same value as <code>cubeN</code> in C++ and <code>SELF_ID</code> in PAWN; it is also available as <code>cubios::CUBE_N</code>.

== FFI types ==

<code>wowcube_sdk::cubios</code> mirrors the [[SDK 6.3/C++/Native API#Types and data structures|native types]] with Rust naming:

pub struct TopologyFaceletInfo { pub module: i32, pub screen: i32, pub connected: i32 }
pub struct TopologyPlace { pub face: i32, pub position: i32 }
pub struct TopologyTwistInfo { pub screen: i32, pub count: i32, pub direction: i32 }
pub struct LbInfo { pub board_count: i32, pub self_position: i32,
pub self_achivement: i32, pub whole_user_list_count: i32 }
pub struct GfxParticle { ttl, vx, vy, ax, ay, explosion, velocity,
duration, frequency, max, loop, time }

Enumerations: <code>TopologyNeighbour</code> (None/Left/Diagonal/Top/Right/Bottom), <code>TopologyOrientation</code> (Menu/Gravity/Splash), <code>TopologyLocation</code> (Up/Down/Front/Back/Left/Right), <code>TextAlign</code> (9 values), <code>LogLevel</code>, <code>UartId</code>; constant <code>NET_BROADCAST = 0xFF</code>; type aliases <code>SoundId</code>, <code>SpriteId</code>.

For the semantics of the underlying engine functions (graphics, sound, topology, sensors, leaderboard) see the [[SDK 6.3/C++/Native API|native API reference]] — names and behavior match one-to-one.

== Examples ==

The Development Kit ships three buildable Rust projects under <code>examples/…/rust/Basics</code>, each with a <code>project/src/main.rs</code>, <code>cubeapp.rs</code>, an <code>assets/</code> folder and a <code>wowcubeapp-build.json</code> build manifest.

[[Category:SDK 6.3]]
[[Category:Rust API]]

← Older revision		Revision as of 10:45, 26 July 2026
Line 94:		Line 94:

	Build: <code>cargo build --release --target wasm32-unknown-unknown</code> (the workspace config adds <code>--allow-undefined</code> so engine functions become WASM imports). Package and install like a C++ cubeapp via the [https://marketplace.visualstudio.com/items?itemName=cubios-inc.WOWCubeSDK WOWCube SDK extension for VS Code].		Build: <code>cargo build --release --target wasm32-unknown-unknown</code> (the workspace config adds <code>--allow-undefined</code> so engine functions become WASM imports). Package and install like a C++ cubeapp via the [https://marketplace.visualstudio.com/items?itemName=cubios-inc.WOWCubeSDK WOWCube SDK extension for VS Code].
		+
		+
		+	== Full API reference ==
		+	Complete, generated from the repository sources:
		+	* [[SDK 6.3/Rust/cubios-sys]] — raw layer: every FFI binding and safe wrapper (14 modules)
		+	* [[SDK 6.3/Rust/cubios]] — high-level layer: every type and method (scene, screens, sprites, text, sound, splash, 142 colors)

	== Conventions ==		== Conventions ==

@@ Line 9: / Line 9: @@
 == The CubiOS Rust SDK ==
-The SDK is a two-crate Cargo workspace ('''CubiOS_Rust_SDK''' on the corporate GitHub, <code>github.com/wowcube/CubiOS_Rust_SDK</code>; currently private — publication pending):
+The SDK is a two-crate Cargo workspace — '''[https://github.com/wowcube/CubiOS_Rust_SDK CubiOS_Rust_SDK]''' on GitHub:
 * '''<code>cubios-sys</code> — raw layer.''' FFI bindings to the CubiOS engine ABI plus thin safe wrappers and the application event loop. Modules: <code>application</code> (the <code>Application</code> trait, timers, event loop), <code>comm</code> (packets, BLE, time, saves, RNG, logging), <code>gfx</code> (immediate-mode drawing), <code>topology</code>, <code>sound</code>, <code>motion</code>, <code>leaderboard</code>, <code>event</code>, <code>network_message</code> / <code>save_message</code> (bit-packed serializers), <code>screen</code>, <code>math</code> (Vec2, Color, Transform, Rect2), <code>types</code>, <code>constants</code>.
@@ Line 103: / Line 103: @@
 * '''Experimental status:''' Rust support is supported but experimental — API may change; the C++ track is primary.
 * The '''Development Kit''' currently ships a thin bindings crate (<code>wowcube_sdk</code> v0.1.0) with buildable examples (''Basics 1–3'').
-* The full two-crate '''CubiOS Rust SDK''' described above lives on the corporate GitHub (<code>wowcube/CubiOS_Rust_SDK</code>) and is being prepared for publication.
+* The full two-crate '''CubiOS Rust SDK''' is public: [https://github.com/wowcube/CubiOS_Rust_SDK github.com/wowcube/CubiOS_Rust_SDK] (source-available, © Cubios Inc.) — clone and build with stable Rust + <code>wasm32-unknown-unknown</code>.
 For per-function semantics see the [[SDK 6.3/C++/Native API|C++ native reference]] — names map 1:1 (<code>gfx::draw_text</code> → <code>GFX_drawText</code>).

@@ Line 1: / Line 1: @@
-{{notice|'''Official WOWCube SDK documentation.''' SDK 6.3, Rust API. Based on the <code>wowcube_sdk</code> crate shipped with the WOWCube Development Kit; the crate sources remain authoritative.}}
+{{notice|'''Official WOWCube SDK documentation.''' SDK 6.3, Rust API — '''experimental, supported track.''' Based on the <code>wowcube_sdk</code> crate shipped with the WOWCube Development Kit; the crate sources remain authoritative.}}
 {{SDK 6.3 nav}}
@@ Line 77: / Line 77: @@
 For the semantics of the underlying engine functions (graphics, sound, topology, sensors, leaderboard) see the [[SDK 6.3/C++/Native API|native API reference]] — names and behavior match one-to-one.
 == Examples ==