Skip to content

Install

Vifu tools は npm から install します。

Vifu CLI

CLI は companion-enabled experience の create、run、test、build、generate、publish に使います。

bash
npm install -g @consenger/[email protected]
vifu --help

project-local usage:

bash
npm install --save-dev @consenger/[email protected]
npx vifu --help

Companion SDK

SDK は browser game の中で使い、safe session context、event、app-owned action を Vifu に公開します。

bash
npm install @consenger/[email protected]

bundler を使う game では SDK を import できます。

ts
import { createCompanionSDK } from "@consenger/companion-sdk";

static game では browser bundle をここからコピーできます。

txt
node_modules/@consenger/companion-sdk/dist/browser/companion-sdk.js

Next steps

  • Quickstart は最小の browser integration です。
  • Release は current tool version と compatibility を追跡します。