Embedded Libraries API

Reduce your game's bundle size by using Venus embedded libraries. Supported libraries are automatically loaded from the Venus host instead of being bundled into your game.

Benefits

• Smaller bundle size: ~1.1MB savings for Phaser games

• Faster load times: Libraries are cached and pre-loaded

• No code changes: Works with your existing imports

Quick Start

1. Add the Vite Plugin

// vite.config.ts
import { defineConfig } from 'vite';
import { venusLibrariesPlugin } from '@series-inc/venus-sdk/vite';

export default defineConfig({
  plugins: [venusLibrariesPlugin()],
  build: { target: 'es2022' } // Required for top-level await
});

2. Use Libraries Normally

// Import as usual - the plugin handles the rest
import Phaser from 'phaser';
import create from 'zustand';
import * as THREE from 'three';
import React from 'react';

3. Build

# For Venus deployment (embedded libraries)
npm run build

# For standalone deployment (bundled libraries)
VENUS_DISABLE_EMBEDDED_LIBS=true npm run build

Supported Libraries

Library	Version	Package
Phaser	3.90.0	phaser
React	18.3.1	react
ReactDOM	18.3.1	react-dom
Three.js	0.170.0	three
Matter.js	0.19.0	matter-js
Ink.js	2.2.0	inkjs
Zustand	5.0.3	zustand

Troubleshooting

Build without embedded libraries

If you want to bundle all libraries into your game, you can set the VENUS_DISABLE_EMBEDDED_LIBS environment variable to true.

VENUS_DISABLE_EMBEDDED_LIBS=true npm run build

This bundles all libraries (larger size, but guaranteed to work).

Need a different library?

Contact the Venus team to request additional libraries for the embedded system.