web3d/README.md

MetaEditor — ReactJS Pixel Streaming library, helps integrate Unreal Engine v.5 in the browser. Allows you to send commands and get callbacks from the stream server with launched Unreal Engine.

# MetaEditor for Pixel Streaming (Unreal Engine)

[**MetaEditor**](http://metaeditor.io/), created by the team at [UnrealOS](https://unrealos.com/) is a professional web application development solution based on ReactJS and PixelStreaming.

<p align="center">
  <img src="https://metaeditor.io/assets/video.gif?v=2" width="100%" title="Pixel Streaming">
</p>

The standard implementation of [PixelStreaming](https://docs.unrealengine.com/5.0/) greatly complicates the development of reactive web applications for Unreal Engine. Initially, PixelStreaming is a no-architecture javascript solution for interacting with reactive web frameworks. Adapting standard PixelStreaming to ReactJS is a very long and laborious process. This process significantly increases the development time, because there are a lot of technical challenges related to the peculiarities of browsers, devices and reactive technologies (like ReactJS, Angular or Vue).

**MetaEditor** streamlines PixelStreaming development to allow businesses to easily deploy and customize their ReactJS application.



[Documentation](https://metaeditor.io/docs/pixel-streaming/settings)

#### Community: [Discord App](https://discordapp.com/invite/eGHKuQ3BHM)

#### Demo:

* [CodeSandBox](https://codesandbox.io/s/pixel-streaming-xzifix)

* [With MetaEditor integration](https://ps.metaeditor.io/)



<p align="center">
  <img src="https://metaeditor.io/assets/preview.png?v=1" width="100%" title="Pixel Streaming">
</p>

---

### Installation

```bash
npm install pixel-streaming
# or
yarn add pixel-streaming
```

### Usage

```javascript
// libs
import PixelStreaming, {DebugData} from 'pixel-streaming';

function App() {
  return (
    <PixelStreaming />
  )
}
```

### Attention!

- React v.`17.0.2`

### Built With

- [React](https://reactjs.org/) - A JavaScript library for building user interfaces
- [Unreal Engine Pixel Streaming](https://docs.unrealengine.com/5.0/en-US) - Library for Unreal Engine.
- [Styled Jss](https://www.npmjs.com/package/styled-jss) - Styled Components on top of JSS