/Blueprint-Framework

A simple framework for building interactive Unreal Engine like blueprint editors in the browser.

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

Blueprint-Framework

A simple framework for building interactive Unreal Engine like blueprint editors in the browser.

Features

  • Serliaztion and deserialization
  • Clean and easy to use API
  • 100% Customizable and extensible

Installation

npm install blueprint-framework

Or

# Clone the repository
git clone https://github.com/webtacular/Blueprint-Framework.git

# Navigate to the directory
cd Blueprint-Framework

# Install the dependencies
npm install

# Build the project
npm run build

Examples

You can find a set of examples here, if you spot an issue or just need help dont hesitate to contribute or open a support ticket, I would be more than happy to help you!

  • Konva - A simple example of a simple blueprint implementation using the Konva framework.

Usage

Import dependencies.

import manager, { GUID } from 'blueprint-framework';
// OR //
const manager = require('blueprint-framework');

Set up the manager, The manager is responsible for verifying, maintaining, modifying, serializing nodes.

Manager - Parameters

const man = new manager({
	// -- All the manager needs to function is a have a 
	// 	  Function passed into it that returns the current
	// 	  Position of the mouse. { x: number, y: number }
	mousePositionHook: () => layer.getRelativePointerPosition()
});