0.0.4 • Published 2 years ago

@make-live/toolkit-dev v0.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

@make-live/toolkit-dev

An npm module to help Make Live customers run a pixel streamed Unreal Engine application locally. It runs a simplified signalling server along with another server that emulates Make Live itself.

Reading the Unreal Engine documentation on Pixel Streaming is beneficial.

Install

You can run the module with npx without installing:

npx @make-live/toolkit-dev

To install with npm:

npm install --save-dev @make-live/toolkit-dev

To install with Yarn:

yarn add --dev @make-live/toolkit-dev

Usage

ArgumentDescriptionTypeDefault
--portPort for the Make Live emulation server to use. This is what you will connect to in your custom UI.number9000
--streamer-portPort that Unreal Engine applications connect to.number8888
--player-portPort that players will connect to. Used internally by the Make Live emulation server but changeable to avoid conflicts.number7090

The required arguments to use for your Unreal Engine application will be output to the console. You can put these in these in the Advanced Settings of Unreal Engine so that they are used when running in Standalone Game mode. The URL to use for your application will be output too. This is what you need to pass to the Make Live Toolkit when you call createInstance in the base toolkit or on the MakeLiveProvider if using the React Toolkit.