User Guide

Uniquitous Server

The Uniquitous server is exported as a Unity package, which you can find on Download page. The package includes an independent Uniquitous scene which contains an GameObject with six scripts attached:

• Connector.cs: Initialize the server and disconnect the connection.
• InputFlow.cs: Receive the remote input from the client and pass the input to the scripts in Unity game project. It also renders the customized GUI. On the Unity inspector, the name of the very first Unity game scene to be streamed over the server should be entered into the "Initialized Game Scene" field. In this way, the game scene in Unity game project will be automatically loaded to the Uniquitous scene when the server is started. The JPEG encoding quality factor can be adjusted through the inspector.
• ScreenTransfer.cs: Controls the game image transmission.
• StreamAudio.cs: Encode and transmit the game audio.
• CursorMovement.cs: Renders the "fake" cursor on the server

In addition to these scripts, there are other two scripts in the scripts folder which has not been attached to the GameObject:

• ImageFlow.cs: Need to be attached to the main camera in the game scene of the running Unity game project. It is used for game screen capture and compression.
• JPGEncoder.cs: No need to be attached and it is used by the ImageFlow script for image encoding

Uniquitous Client

The client is a Unity project which can be run directly in the Unity Editor. The project includes a game scene which contains a GameObject with four scripts attached:

• Connector.cs: Connect the client to the server and disconnect the connection
• InputFlow.cs: Get the local input and transmit the input to the server.
• ScreenTransfer.cs: Receive the game image from the server, load and display the image on the client.
• ReceiveAudio.cs: Receive the game audio stream from the server.

Example of integration with AngryBots

After setting the "Initialized Game Scene" field, you can start the scene in Uniquitous package directly and it can load the Unity game automatically. Then you can click the "Initialize Server" button (Figure 7) and start running the server. When the server is started, three buttons are displayed on the screen (Figure 8). "StartAudio" button is used to control if you would like to send the game audio to the client. "StartImage" button is used to send game images before the GUI rendered. "...withGUI" button is used to send game images after the GUI rendered.

Figure 7. Step 1 (on the server)

Figure 8. Step 2 (on the server)

When the client is started, the IP address of the machine the server is running on needs to be typed in on the client in order to build the connection (Figure 9). A "ReceiveAudio" button is displayed when the connection is successful (Figure 10). You can use this button to control if you would like to start receiving the game audio stream from the server.

Figure 9. Step 1 (on the client)

Figure 10. Step 2 (on the client)

Customised GUI

The interactions with the Unity build-in GUI system such as GUI.Button and GUI.TextField cannot be transferred by Uniquitous because these interactions are event based and only data on mouse positions, mouse click and keyboard strokes can be sent to the server. Instead, we developed a customized GUI system for users to use. It has a simulated mouse cursor, a simulated button and a simulated text field. More implementation details are specified in the thesis on Download page. The GUI elements in the red rectangle in Figure 11 is the customized GUI which only interacts with the "fake" cursor. In AngryBots, the customized GUI can be activated by pressing the "space" key on the client.

Figure 11. GUI of the server