@primitiv/client

Status: Prototype - API is unstable and may change between minor versions.

Browser-side runtime for the Primitiv engine. Provides rendering (Canvas 2D & WebGL), audio, input handling and networking for multiplayer games.

Installation

pnpm add @primitiv/engine @primitiv/client

Quick start

import { ClientRuntime } from '@primitiv/client';

Subpath exports

import { Engine, Display, User }  from '@primitiv/client/core';
import { Vector2, ScalingMode }   from '@primitiv/client/types';
import { NetworkClient }          from '@primitiv/client/network';
import { AudioEngine, SoundBank } from '@primitiv/client/audio';
import { Inputs, KeyboardInputs } from '@primitiv/client/input';
import { Terminal2D, TerminalGL } from '@primitiv/client/render';

Bundle size

Full client runtime (import { ClientRuntime } from "@primitiv/client"):

| Format | Minified | Gzip | Brotli | |--------|----------|------|--------| | ESM | 253.7 KB | 70.0 KB | 58.7 KB | | CJS | 254.2 KB | 70.3 KB | 58.9 KB |

📄 License

Apache-2.0 - See LICENSE.txt.