From b940db35d301879814194c2025474d477b5b4085 Mon Sep 17 00:00:00 2001 From: Vladimir Alyamkin Date: Wed, 9 Jul 2014 03:32:11 +0400 Subject: [PATCH] Plugin readme updated --- README.md | 56 ++++++------------------------------------------------- 1 file changed, 6 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 9ad759e..972acfb 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,21 @@ Overview ======== -VaQuoleUI is the Web UI framework plugin for [Unreal Engine 4](https://www.unrealengine.com/) proudly based on [Qt framework](http://qt-project.org/). +**VaQuoleUI** is the Web UI framework plugin for [Unreal Engine 4](https://www.unrealengine.com/) proudly based on [Qt SDK](http://qt-project.org/). -The plugin includes: +With the VaQuoleUI plugin you can create interactive User Interfaces for your game using powerful pipeline of **HTML5, CSS and JavaScript** web UI creation. -* Actor component that renders website content into 2D texture -* GameViewport and PlayerController classes to help with input setup -* Simple HTML example of HUD with JavaScript callbacks -* Source of Qt-based library, that handles all under the hood +Plugin is completely **free** and available under [MIT open-source license](LICENSE). -Plugin is actively used in [SeaCraft](http://seacraft.sc) project development. +Check the [Wiki](https://github.com/ufna/VaQuoleUI/wiki) tab to know more about the VaQuoleUI. -Current version: **0.2 Alpha 7** +Current version: **1.0 Beta 8** ![SCREENSHOT](SCREENSHOT.jpg) -Features --------- - -Some key things you should know about the VaOceanUI: - -* Cross-platform in theory, tested on and pre-built for Windows only -* Can be used to integrate **any** Qt widgets -* Supports translucent backgrounds -* Can be embedded both via Texture2D and Material Instance parameter (to be used on scene) -* Custom JavaScript code can be evaluated to control the page content -* Callback from JS scripts are processed by Exec functions -* Shouldn't be used for production yet! Alpha-version, yo! - -Futher improvements are on the way. Check the [Issues](https://github.com/ufna/VaQuoleUI/issues) tab to know more. - - -HowTo ------ - -> How to open *_local_* files with UIComponent? - -You should set the link as *__vaquole://__Relative/Path/To/MyPage.html*, where the path is relative to your project dir (where .uproject file is situated). - -> How to open *_https_* links? - -To use the SSL connection (https) you have to rebuild the Qt-based project with its support. Pre-built binaries work without encryption only. - - -Installation ------------- - -1. Download the **plugin binaries** for the latest release. -1. Copy plugin binaries **exactly** to your project directory. -1. Compile your game project normally. Unreal Build Tool will detect the plugins and compile them as dependencies to your game. -1. Launch the editor (or the game). Plugin will be initially disabled, but you can turn it on in the editor UI. -1. Open the Plugins Editor (Window -> Plugins), search for VaQuoleUI plugin (you can find it in the **UI** section) and enable it by clicking the check box. -1. Restart the Editor. The plugin will be automatically loaded at startup. - - Legal info ---------- -Unreal® is a trademark or registered trademark of Epic Games, Inc. in the United States of America and elsewhere. - -Unreal® Engine, Copyright 1998 – 2014, Epic Games, Inc. All rights reserved. +Unreal® is a trademark or registered trademark of Epic Games, Inc. in the United States of America and elsewhere. Unreal® Engine, Copyright 1998 – 2014, Epic Games, Inc. All rights reserved.