Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
getnamo authored Sep 19, 2017
1 parent a00246b commit 5464f7d
Showing 1 changed file with 64 additions and 1 deletion.
65 changes: 64 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,69 @@
[![release](https://img.shields.io/github/release/AaronShea/BLUI.svg?style=flat-square)](https://github.com/AaronShea/BLUI/releases)
[![release](https://img.shields.io/github/release/getnamo/BLUI.svg?style=flat-square)](https://github.com/getnamo/BLUI/releases)
![BLUI-logo](https://cloud.githubusercontent.com/assets/1334174/5969395/201a1202-a7f1-11e4-98a4-12bc6793f830.png)

## Getnamo Fork Notes

Made small additions and changes for certain use cases.

### Download and Fullscreen Support

Contains changes to allow downloading of files via the inbuilt browser.

Updated CEF build to support fullscreen videos.

### Convenience Blueprints

The native plugin didn't contain any self contained drag and drop examples so I've added some.

![examples](https://i.imgur.com/UOCEHM8.png)

### BluiWidget

A user widget (UMG) blueprint which embeds a BLU texture as an image brush. Contains various utility functions to allow loading and parsing urls easily. Call ```InitBluEye``` with starting url and browser window size to start this widget. See *BluiWorldWidgetActorExample* for an example of how it's used in practice.


### BluiWorldWidgetActorExample

Encapsulated *BluiWidget* user widget in an actor. Drag and drop this actor into your scene and it will auto-spawn the required *BluTickActor* to make everything work.

![example output](https://i.imgur.com/bso2ah6.png)

*3 BluiWorldWIdgetActorExample actors with "youtube.com", "blui ue4" and "local://test.html" specified as their URL respectively*


#### Url

By default the actor will check the url for *local://* prepend and load local content first if detected. This should be placed inside the following directory: *{project root}/Content/html*

![local url](https://i.imgur.com/30hk67Z.png)

*e.g. having a test.html file inside your Content/html folder*

Basic URL validity is also tested, but you can safely ignore http:// etc.

![](https://i.imgur.com/R6we4jO.png)

*just specifying youtube.com will resolve correctly*

If your URL isn't valid however, it will redirect the string as a search term e.g. typing a sentance or search term

![auto-search](https://i.imgur.com/iDoXyFy.png)

You can untick *Should Auto Search Invalid Url* to disable this behavior.

#### Resize
By default the actor has a BLUI resolution of 1000x1000, you can change this by just changing the user widget draw size.

![resize](https://i.imgur.com/kB8X4I5.png)



### BluTickActor

Instead of ticking in your level bp, I prefer to use a simple actor to do the ticking. Other convenience blueprints may spawn this as necessary so if you use those, you don 't ever need to use this directly.

## //End Fork Notes

## HTML powered UI and HUD for Unreal Engine 4
(Hit up the wiki for a quick start guide!)

Expand Down

0 comments on commit 5464f7d

Please sign in to comment.