Introduction
@icraft/player-react
@icraft/player-react is a React frontend component that allows you to easily integrate scenes edited in iCraft Editor into your project, and provides rich interaction events and methods.
Quick Start
Installation
Install the @icraft/player-react
package using npm or pnpm:
# Using npm
npm install @icraft/player-react --save
# Or using pnpm
pnpm install @icraft/player-react --save
Note: Some package managers may not automatically install the @icraft/engine
package. If it's missing, please install it manually:
pnpm install @icraft/engine --save
Basic Usage
Import and use the ICraftPlayer
component in your project:
import { ICraftPlayer } from "@icraft/player-react";
export default function MyScene() {
return <ICraftPlayer src='your-scene.iplayer' />;
}
Where src
is the path to the .iplayer
file exported from iCraft Editor.
If you encounter font issues, please refer to the Font section.
License
For iCraft Player, it's free for personal use. Commercial license is $299 USD per year for enterprises (including remote technical support). For commercial licensing, please contact yukg@gantsoftware.com