Getting Started

Getting Started

This release is only targeting Windows. Since the most popular supported operating system for Unity servers is Windows we have made uStream primarily for Windows. It is well tested on Linux but Windows support is most important at the moment.
We will do a Linux release too, but we also believe that running the game server on Windows and running uStream on a separate Linux machine comes with two costs, latency increase and the administrative overhead of hosting a server side solution on two different operating systems. This is why the Windows release has a higher priority.

Installation on Windows

  1. Install Erlang. We recommend version 5.8.5 (same as OTP R14B04) http://www.erlang.org/download/otp_win32_R14B04.exe
    Choose the default location on disk (C:
    Program Files (x86)
    erl5.8.5
    ) This makes the start.bat script work without any changes...
  2. Download uStream.zip and unpack it.
  3. Done.

Start uStream

Run start.bat from a CMD window in Windows.
The server log files are available in the folder “.log”. Two new log files are created every time uStream is started.
uStream stops automatically when the game server (the cell server) is stopped.

Configuration

There is a configuration file that uStream reads at startup. It is named ustream.config.
These are the configurable properties in this release.
Parameter Default value
area_of_interest_radius 30
aoi_calculation_interval_ms 250 (ms)
cell_server_port 4002
main_socket_port 4001