Three.js works with any JavaScript bundler — Vite, Webpack, Rollup, esbuild, Parcel, and others. This page covers the generic setup. The example repo uses Vite and demonstrates cloud save (userfs) and UGC publish/import alongside a cannon-es physics sandbox.
Install dependencies
npm install three
npm install @wvdsh/sdk-js
@wvdsh/sdk-js's default export is the live, fully-typed Wavedash SDK singleton.
Wire up Wavedash.init()
In the file where you set up your scene and renderer, import Wavedash and call init() once your game is ready.
Calling Wavedash.init() is required. Your game stays hidden behind the Wavedash loading screen until you do. Call it once your game is ready to play.
import Wavedash from "@wvdsh/sdk-js";
import * as THREE from 'three';
Wavedash.updateLoadProgressZeroToOne(1);
Wavedash.init({ debug: true });
Call updateLoadProgressZeroToOne(...) during async asset loading; init() automatically signals load completion, so call it last.
wavedash.toml
Point upload_dir at your bundler's output directory. For Vite and most other bundlers that's ./dist.
game_id = "YOUR_GAME_ID_HERE"
upload_dir = "./dist"
Local development
Produce a build, then run wavedash dev to serve it through the Wavedash sandbox.
SDK features
Once initialized, Wavedash exposes leaderboards, achievements, stats, user data, cloud save (userfs), and UGC:
const user = Wavedash.getUser();
const lb = await Wavedash.getLeaderboard("high-scores");
await Wavedash.uploadLeaderboardScore(lb.data.id, score, true);
Wavedash.setAchievement("first_win", true);
// Cloud save (userfs) — private per-user storage
await Wavedash.writeLocalFile("scenes/main.json", bytes);
await Wavedash.uploadRemoteFile("scenes/main.json");
const { success } = await Wavedash.downloadRemoteFile("scenes/main.json");
const bytes = await Wavedash.readLocalFile("scenes/main.json");
// UGC — shareable community content
const response = await Wavedash.createUGCItem(type, title, description, visibility, filePath);
if (response.success) {
const ugcId = response.data;
await Wavedash.updateUGCItem(ugcId, title, description, visibility, filePath);
}