Install

Install using npm or yarn

We recommend development using npm or yarn , not only in the development environment that is easily debugged but also in the production environment that can be packaged for use and benefit from the entire ecosphere and toolchain.

caution

Five is based on Three.js, so you need to install dependencies at the same time.Currently dependent on Three.js is version 115 - 117.

npm

npm install @realsee/five three@0.117.1

Yarn

yarn add @realsee/five three@0.117.1

pnpm

pnpm add @realsee/five three@0.117.1

If you use React Hooks APIthen install the associated dependencies of React.

npm

npm install @realsee/five three@0.117.1 react

Yarn

yarn add @realsee/five three@0.117.1 react

pnpm

pnpm add @realsee/five three@0.117.1 react

If you use the Vue Composition APIthen install the associated dependencies of Vue.

npm

npm install @realsee/five three@0.117.1 vue

Yarn

yarn add @realsee/five three@0.117.1 vue

pnpm

pnpm add @realsee/five three@0.117.1 vue

Then you can use the Five engine in your project.

import { Five } from "@realsee/five";

// if you use React Hooks API
import { useFiveState } from "@realsee/five/react";

// if you use the Vue Composition API
import { useFiveState } from "@realsee/five/vue";

Skypack

You can also refer directly to the package Five.For example, for a browser that supports ESS modules, you can install Skypack directly Five dependency：