Git Product home page Git Product logo

furioos-sdk-unreal-engine's Introduction

Furioos UE SDK

This repository is in Beta, we do not provide support for it.

Requirements

  • A Furioos Account on www.furioos.com.
  • Then choose the application you want to use with the SDK and create a SDK link.

Tested on Unreal Engine 4.25.3 and 4.26-preview

Installation

  1. Download the latest version of the Zip package.
  2. Create a folder named "Plugins" in your project folder.
  3. Extract the "FS_WebSocket" into Plugins Folder.
  4. Launch your Unreal project (if your version of UE is different from 4.25.3, you will need a development IDE installed to compile the plugin again).
  5. Put the blueprint FS_WebSocket_BP in your scene

Alt text

You'll need to have the FS_WebSocket_BP blueprint in each scene with SDK interactions.

General Usage

When the plugin is installed and enabled, you will find a scene example with Blueprint and C++ class in LexelExample (to see the folders :)

Alt text

Blueprint Usage

Alt text

To connect to the websocket server, you will have to bind your event as shown in the example above.

C++ Usage

Events

FSOnConnectComplete()

Bind an event that will be called when the application is connected and signed in to the Furioos streaming server and ready to communicate.

FSOnReceiveData(FSstring data)

Bind an event that will be called everytime data is received.

  • FString data: The parsed data

FSOnConnectError(FString error)

Bind an event that will be called each time an error is fired.

  • FString error

FSOnClosed()

Bind an event that will be called when the connection with Furioos streaming server is closed.

Methods

void Connect()

You can call this function to connect your application to the Furioos Streaming Server.

void SendSDKMessage(FString& data)

Send data to the JS client

  • FString data: The data to send

furioos-sdk-unreal-engine's People

Contributors

rouxjulien avatar

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.