Ma/ueblueprint
1
0
Fork 0
mirror of https://github.com/barsdeveloper/ueblueprint.git synced 2026-05-14 07:47:29 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
barsdeveloper
2024-09-12 10:32:09 +03:00
committed by GitHub
parent 5d4f020a85
commit c03d0c8355
1 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -2,6 +2,8 @@
A stand alone editor implementation of the UE's Blueprint visual language. A stand alone editor implementation of the UE's Blueprint visual language.
https://www.npmjs.com/package/ueblueprint
## Features: ## Features:
- Intercommunicates with UE (can copy nodes both ways). - Intercommunicates with UE (can copy nodes both ways).
@@ -12,10 +14,10 @@ A stand alone editor implementation of the UE's Blueprint visual language.
- All the information shown in he graph is just the one embedded in the serialized text. - All the information shown in he graph is just the one embedded in the serialized text.
## Demo: ## Demo:
[Try it!](https://barsdeveloper.github.io/ueblueprint/) [Try it!](https://barsdeveloper.github.io/ueblueprint/)
![img1](https://github.com/barsdeveloper/ueblueprint/assets/84736467/022704e7-2c9f-4595-9513-cd7770961e0d) [![img1](https://github.com/barsdeveloper/ueblueprint/assets/84736467/022704e7-2c9f-4595-9513-cd7770961e0d)](https://barsdeveloper.github.io/ueblueprint/)
## Getting started: ## Getting started:
@@ -32,8 +34,9 @@ npx http-server
### Use in a web page ### Use in a web page
You can check `index.html` for a working example, the main steps are the following: You can check `index.html` for a working example, the main steps are the following:
1. Include `dist/css/ueb-style.css` stylesheet in your page. 1. Make the `dist` directory available in your website by copying it or installing through npm `npm i ueblueprint`.
2. Define eventual CSS variables. 2. Include `dist/css/ueb-style.css` stylesheet in your page.
3. Define eventual CSS variables.
```HTML ```HTML
<style> <style>
ueb-blueprint { ueb-blueprint {
@@ -41,13 +44,13 @@ You can check `index.html` for a working example, the main steps are the followi
} }
</style> </style>
``` ```
3. Import the class Blueprint in JavaScript (this library uses modules). 4. Import the class Blueprint in JavaScript (this library uses modules).
```HTML ```HTML
<script type="module"> <script type="module">
import { Blueprint } from "./dist/ueblueprint.js" import { Blueprint } from "./dist/ueblueprint.js"
</script> </script>
``` ```
4. Define your blueprint by just writing the code inside a `ueb-blueprint`, inside a `template` element. 5. Define your blueprint by just writing the code inside a `ueb-blueprint`, inside a `template` element.
```HTML ```HTML
<ueb-blueprint> <ueb-blueprint>
<template> <template>