shinygen
v4.6.4
Published
Shiny Gen Engine — a WebGPU game engine for the browser, with a WebGL2 fallback engine. One script tag; ShinyGen.start() boots the engine on your canvas and runs inline gds scripts.
Maintainers
Readme
Shiny Gen Engine
A game engine for the browser. One script tag, one call — the engine boots on
your canvas and runs the text/gdscript scripts on your page. WebGPU-rendered
by default, with a WebGL2 engine included for browsers without WebGPU.
Quick start
<!doctype html>
<canvas id="canvas"></canvas>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/shinygen.js"></script>
<script type="text/gdscript" name="Main">
extends Node3D
func _ready():
var light = DirectionalLight3D.new()
light.rotation_degrees = Vector3(-45, 30, 0)
add_child(light)
</script>
<script>
ShinyGen.start({ canvas: "#canvas" });
</script>The engine ships brotli-compressed (~8.7 MB over the wire for the WebGPU
engine, ~6.6 MB for the WebGL engine; decompressed in the browser) and
resolves all of its files relative to shinygen.js — serve the package files
from any static host, CDN, or bundler; no configuration needed. Only the
engine your page boots is downloaded.
Requirements
- Default (WebGPU engine): a WebGPU-capable browser (Chrome/Edge 113+ on
desktop; recent Safari and Firefox).
ShinyGen.start()reports a clear on-canvas message when WebGPU is unavailable. - WebGL engine (
renderer: "webgl"): any WebGL2 browser — effectively all modern browsers. Renders with the engine's Compatibility renderer: full 2D and core 3D (PBR forward rendering, shadows), without the WebGPU-only effects (volumetric fog, SDFGI/VoxelGI and most screen-space effects).
Options
ShinyGen.start({
canvas: "#canvas", // selector or element (required)
renderer: "webgpu", // "webgpu" (default) or "webgl" (the WebGL2 engine at webgl/)
i18n: true, // opt-in: fetch ICU data (~2.2 MB) for complex-script text
brotliWasm: false, // opt-out of the .br engine fetch (default: on)
});After boot, ShinyGen.renderer reports which engine is running
("webgpu" or "webgl").
License
Proprietary, closed source. Free to use — including commercially — to make
games, provided you keep the "Made with Shiny Gen" notice visible (it shows
at boot by default). You may not use it to build a competing game maker,
engine, asset editor/generator, or game catalog, or to train an AI model,
without a separate enterprise license (contact [email protected]). The full
terms in LICENSE.txt govern. Embedded third-party components (including a
modified Godot Engine, MIT) are listed in THIRD_PARTY_NOTICES.txt.
— shinygen.ai · Docs
