Giter Club home page Giter Club logo

lightact-ue4's Introduction

Lightact-UE4

A set of functionalities enabling integration of Unreal Engine with Lightact media server.

Installation

**This plugin has been tested with Unreal Engine 4.19 and 4.20.

Step 1: Download the plugin

Download the ZIP archive and copy the plugin folder to the Plugins folder in your UE project folder. For a more detailed help see Installing UE plugins video tutorial or Installing UE4 Plugins User Guide.

Step 2: Regenerate project files and build the plugin

When you download the plugin files you need to Regenerate Visual Studio project files. You do that by right-clicking on the .uproject file. If you don't see this option, your UE project does not contain any code. If this is the case you should add a dummy C++ class first to the project.

When you are done, double click on the .uproject file to open it in the UE Editor. Alternatively, open the project through Epic Launcher. You'll probably encounter warnings about missing plugin dll. You should click Yes to rebuild the dlls.

Step 3: Enabling the Plugin

When you are done and the UE Editor opens, make sure the Plugin is enabled. You might need to restart the UE Editor. If you are successful you'll see a new Lightact node category in your blueprints.

Usage

The plugin adds a number of new Blueprint nodes. You'll find them all inside Lightact category.

Nodes for reading from shared memory

Shared memory JSON to string map

sharedMemoryJSONToStringMap.png

This node reads from shared memory (Handle Name) of size (Handle Size). It expects the data to be in JSON format. The data is then converted to Map of Strings to Strings.

Nodes for writing to shared memory

Open shared memory

openSharedMemory.png

This node is used to create shared memory handle. It should be called once before all other nodes for writing to shared memory. In most cases you'll want to connect it to Event BeginPlay node.

Write to shared memory

writeToSharedMemory.png

This node is used to write data to shared memory handle. It takes in a Map of Strings to Strings and converts it to JSON before writing it to shared memory.

Close shared memory

closeSharedMemory.png

This node is for closing shared memory handle. It should be called once before quitting the game. The Handle Name property should be the same as in the Open shared memory node. In most cases you'll want to connect it to Event EndPlay node.

Utility nodes

String explode to Vector

stringExplodeToVector.png

This node expects a string representing a 3-component vector (standard vector variable in UE) and outputs a vector variable. It is useful if you want to transfer Vec3 variable from Lightact to vector variable in UE.

Tips

In most cases you'll use just one Handle Name throughout your project as you can send many variables through that handle at the same time. In most cases, you'll connect a single Open Shared Memory in your main level blueprint (or elsewhere) and connect it to BeginPlay node and use one Close Shared Memory and connect it to EndPlay node.

Troubleshooting

If you encounter any build errors, try opening the .sln file in Visual Studio and do a Clean solution and then Build solution. If these 2 actions succeeded you should be able to open the project.

Additional help

Additional help is available on:

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.