Nightshade Template

A template for creating applications with the Nightshade game engine.

Quickstart

# native
just run

# wasm (webgpu)
just run-wasm

# steam deck
just build-steamdeck
just deploy-steamdeck        # copies binary to ~/Downloads on deck
just deploy-steamdeck-quick  # copies as 'game' for quick launching

All chromium-based browsers like Brave, Vivaldi, Chrome, etc support WebGPU. Firefox also supports WebGPU now starting with version 141.

Prerequisites

• just
• trunk (for web builds)
• cross (for Steam Deck builds)
  • Requires Docker (macOS/Linux) or Docker Desktop (Windows)

Run just with no arguments to list all commands

Optional Features

Enable features with cargo run --features <feature>:

Feature	Description	Docs
tracing	File logging to logs/nightshade.log	Profiling

For Steamworks (achievements, stats, friends, P2P), add the nightshade-steam crate and compose its SteamPlugin. See Steam and Steam Deck Deployment.

License

Licensed under either of:

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.