@futureverse/swappable-viewer-react

Hooks/components for "swappable" parents — e.g. an avatar collection where you swap which child is currently equipped.

Futureverse winddown

Futureverse (the publisher of @futureverse/*) is in winddown. The hosted services this package talked to (auth.futureverse.app, pass-api.futureverse.app, signer.futureverse.app) have been re-hosted by gen3labs at futurepass.gen3labs.tech (issuer) and fpsigner.gen3labs.tech (signer). For new projects, switch to the matching @gen3labs/* package — drop-in surface, default URLs already point at the gen3labs infra. The Asset Register API has no community replacement yet; see the Migration playbook for the per-package map.

Version

1.5.8

Published

2025-09-16

License

n/a

Status

fv-winddown

npm

https://www.npmjs.com/package/@futureverse/swappable-viewer-react

Types

./index.d.ts

Maintainers

admin-futureverse, garethdainesnpm, jcsanpedro

Depends on

zustand · react-unity-webgl · @futureverse/asset-register-react

Peer deps

react

Recent versions

1.5.2 · 1.5.4 · 1.5.5 · 1.5.6 · 1.5.7 · 1.6.0-beta.2 · 1.6.0-beta.3 · 1.5.8

## Technical notes

Why use it

Specifically for collections that model wearable/equippable accessory composition via AR.

When to skip it

Your NFTs are not swappable parents (most NFTs).

Pairs with

• @futureverse/asset-register-react — data source

Upstream README

Futureverse Swappable Viewer React

Provides a wrapper around the Futureverse Asset Register. It exposes hooks to query what is currently equipped/linked to the parent collection along with token metadata and other information.

Installation

npm:

npm install @futureverse/swappable-viewer-react --save

yarn:

yarn add @futureverse/swappable-viewer-react

pnpm:

pnpm add @futureverse/swappable-viewer-react

bun:

bun add @futureverse/swappable-viewer-react

Providers

SwappableEngineProvider

Provides hooks and utility for querying collections, metadata, and what is equipped to your swappable. This is not strictly required; if you are just looking to implement the 3D viewer, then the ViewerProvider is all that is required.

Queries use react-query. To use the provider, you must make sure it is a child of a QueryClientProvider.

Setup

environment

When using testnets such as Porcini, use development otherwise production.

<SwappableEngineProvider
  environment="production"
  config={swappableConfig}
>

Swappable Config Example

This config provides the SwappableProvider with context as to which on-chain collections you are interested in retrieving data for. Locations are on-chain destinations, and you are free to specify multiple locations.

type CollectionParts = 'Chasis' | 'Engines' | 'Wheels' | 'Exhausts' | 'Accessories';

const swappableConfig: SwappableCollectionConfig<CollectionParts> = {
  parent: {
    name: 'Chasis',
    locations: ['7672:root:<chasis_root_collection_id>'],
  },
  linked: [
    { name: 'Engines', locations: ['7672:root:<engines_root_collection_id>'] },
    { name: 'Wheels', locations: ['7672:root:<wheels_root_collection_id>'] },
    {
      name: 'Exhausts',
      locations: ['7672:root:<exhausts_root_collection_id>'],
    },
    {
      name: 'Accessories',
      locations: ['7672:root:<accessories_root_collection_id>'],
    },
  ],
};

Hooks

useQueryEquipped

Query what is equipped for FuturePass address and token.

import { useQueryEquipped } from '@futureverse/swappable-viewer-react';
const { data: equipped } = useQueryEquipped<CollectionParts>(['<FuturePassAddress>'], '<token_id>');

useQueryCollection

Query all parts owned by this address for "Engines".

import { useQueryCollection } from '@futureverse/swappable-viewer-react';

// You can pass multiples addresses
const addresses = ['metamask-eoa', 'futurepass', 'xaman-eoa', ...];
const { data: engines } = useQueryCollection<RaicersParts>('Engines', addresses);

ViewerProvider

Renders the Unity application in the client. It is recommended that you use this provider where you would like to view your 3D model/avatar/scene. The ViewerProvider provides utility hooks to command the viewer through event messages.

const queryClient = new QueryClient({
  defaultOptions: {
    queries: {
      refetchOnMount: false,
      refetchOnWindowFocus: false,
    },
  },
});


const swappableConfig: SwappableCollectionConfig = {
....
};

export default function Index() {
  return (
    <QueryClientProvider client={queryClient}>
      <SwappableEngineProvider
        environment="development"
        config={swappableConfig}
      >
        <ViewerProvider
          buildUrl="<your-unity-3d-viewer-build-url>"
          buildDir="viewer/WebGL"
          streamingAssetsDir="StreamingAssets"
          compression="br"
          style={{ width: '100%', height: '100vh' }}
        >
          ...
        </ViewerProvider>
      </SwappableEngineProvider>
    </QueryClientProvider>
  );
}

Hooks

Sending events through the event orchestration handler: The events largely depend on what is implemented in the Unity build. It is up to the developer to decide which events they wish to support. The code below is an example of updating a 3D model to display based on metadata.

import { useViewer } from '@futureverse/swappable-viewer-react';
const { data: equipped } = useQueryEquipped<CollectionParts>(
  ['<FuturePassAddress>'],
  '<token_id>'
);
const { sendEvent } = useViewer();

...

sendEvent('update_model', equipped.engine.attributes);

Source: https://www.npmjs.com/package/@futureverse/swappable-viewer-react · captured 2026-05-02