BlueprintUE React Components

English | 中文

English Version

This is a React component library for rendering Unreal Engine blueprints, which encapsulates BlueprintUE's rendering functionality.

Installation

npm install blueprintue-react-components

Usage

import { BlueprintViewer } from 'blueprintue-react-components';

// Regular blueprint viewer
<BlueprintViewer 
  blueprintData={blueprintJsonString} 
  height="500px" 
  bueRenderPath="./bue-render" 
/>

Component Properties

BlueprintViewer

• blueprintData: (Required) Blueprint data string
• height: (Optional) Component height, default is '643px'
• type: (Optional) Blueprint type, default is 'blueprint'
• bueRenderPath: (Optional) bue-render resource path, default is './bue-render'
• onReady: (Optional) Initialization complete callback function

Notes

This library includes the bue-render directory, which contains the JavaScript and CSS files for the BlueprintUE renderer. When deploying, ensure these resource files are accessible.

The BlueprintUE project is based on the BlueprintUE project created by Rancoud. This library is a React wrapper for the original BlueprintUE rendering functionality.

Note: The BlueprintDiffViewer component has been temporarily removed and will be added back in a future release.

Development

# Install dependencies
npm install

# Start development server
npm run dev

# Build production version
npm run build

中文版本

这是一个用于渲染 Unreal Engine 蓝图的 React 组件库，封装了 BlueprintUE 的渲染功能。

安装

npm install blueprintue-react-components

使用方法

import { BlueprintViewer } from 'blueprintue-react-components';

// 普通蓝图查看器
<BlueprintViewer 
  blueprintData={blueprintJsonString} 
  height="500px" 
  bueRenderPath="./bue-render" 
/>

组件属性

BlueprintViewer

• blueprintData: (必需) 蓝图数据字符串
• height: (可选) 组件高度，默认为 '643px'
• type: (可选) 蓝图类型，默认为 'blueprint'
• bueRenderPath: (可选) bue-render 资源路径，默认为 './bue-render'
• onReady: (可选) 初始化完成回调函数

说明

此库包含 bue-render 目录，其中包含 BlueprintUE 渲染器的 JavaScript 和 CSS 文件。在部署时，请确保这些资源文件可被访问。

BlueprintUE 项目基于 Rancoud 创建的 BlueprintUE 项目。本库是对原始 BlueprintUE 渲染功能的 React 封装。

注意: BlueprintDiffViewer 组件已被暂时移除，将在未来版本中重新加入。

开发

# 安装依赖
npm install

# 启动开发服务器
npm run dev

# 构建生产版本
npm run build

Acknowledgements

blueprintue-self-hosted-edition

This library is built upon the BlueprintUE project created by Rancoud. The riginal project provides the core rendering functionality for Unreal Engine blueprints. We are grateful for their open-source contribution.

原始 BlueprintUE 项目为本库提供了 Unreal Engine 蓝图的核心渲染功能。我们感谢原作者的开源贡献。