WavedashDocs

Quickstart

Go from zero to a published game on Wavedash in a few minutes.

You'll need a Wavedash account and a game that runs in a browser.

Install the CLI

The Wavedash CLI handles authentication, local testing, and build uploads.

brew install wvdsh/tap/wavedash

Verify the installation:

wavedash --version

Authenticate

wavedash auth login

This opens your browser for authentication. Once you approve, the CLI stores your credentials locally. You only need to do this once.

Create a game

Create a new game in the Developer Portal and copy the game ID from the game settings page. You will use this in wavedash.toml.

Set up your engine

Follow the guide for your engine. Each one covers SDK installation, build settings, and wavedash.toml configuration.

Test locally

Run wavedash dev to start a local HTTPS sandbox that serves your local build and injects the SDK. Open the URL shown in your terminal to play your game. Leaderboards, achievements, cloud saves, and other SDK features work against sandbox data, so this is the fastest way to verify your integration before you upload.

wavedash dev is still a local environment. Before publishing, smoke-test the uploaded build on Wavedash as well so you catch differences in hosting, embedding, authentication, and release state.

wavedash dev

The first time you run this, the CLI will install a self-signed certificate into your trust store. On macOS you'll see a fingerprint prompt. On Linux and Windows, sudo or administrator privileges may be required.

Upload and publish

When you are ready to upload:

wavedash build push

The CLI packages your build and uploads it to Wavedash as a new build. Uploading does not make it live. After the upload completes, open the Developer Portal, select that build, and publish it there.

Your game is published. Players can find and play it in any browser.

Next steps