Skip to content
This repository has been archived by the owner on Mar 19, 2019. It is now read-only.

Home

Jump to bottom
Vladimir Alyamkin edited this page Aug 2, 2016 · 24 revisions

Welcome to the VaQuoleUI wiki!

UNFORTUNATELY PLUGIN DEVELOPMENT HAS BEEN STOPPED (SORRY, GUYS)

Overview

VaQuoleUI is the cross-platform plugin that designed to integrate web user interfaces directly into your game. You can use it to create complex menus for lobby, dynamic HUD elements, place UIs to the scene and even embed Google or any other website to the scene.

Key Features:

  • Use the power of HTML5, CSS and JavaScript to create beautiful and interactive game UIs
  • No C++ coding required, everything can be managed via blueprints
  • Full control of web application using JavaScript commands and callbacks
  • Pretty simple and easy to use - no excess classes and complicated schemes
  • Highly optimized to work on complex scenes with a lot of dynamic data

Moreover, plugin is completely free and available under MIT open-source license. You can use it in commercial projects, you can modify anything, etc. In other words, you're in charge.

Why to use Web UI with UE4?

There are few key ideas of using Web UI approach:

  1. Web application development uses a natural, designer-oriented workflow, proved by thousands of developers.
  2. It has very fast iteration times with live editing and testing independently from the game engine. No "game core" programming required while you're working on UI, and it's cool because you can work in parallel without "race conditions".
  3. Shorten time-to-market because of time-tested pipeline and lots of existing tools, WYSIWYG editors, libraries, frameworks and templates.

Personally I find web UI perfect for lobby-like interfaces as hangar from World of Tanks.

Navigator

I've splited notes into few pages:

  • Using VaQuoleUI - general plugin usage principles and usage FAQ
  • Game project setup - how to configure your game project properly to use the plugin
  • Game packaging - preparation of end-user (shipping) build requires some additional steps. Don't miss it to prepare your game for players!
  • Plugin support - check if you have any issues or futher development questions

Also, please take a look on the right sidebar to find additional pages with useful information and plugin usage examples.

Clone this wiki locally