Setting up
These instructions are for getting Eye Contact project up and running on your laptop/desktop.
Requirements
Game Engine: Unreal Engine 10.2 or greater
IDE: Visual Studios 15(Windows) with C++ toolchain installed, xCode(Mac)
Memory: 8 GB
Storage: At least 3 GB available space
VR headset: Occulus Rift (optional)
See the minimum required spec for running Unreal Engine and Occulus Rift for best user experience during development.
Getting the project
Please ensure that you have installed the necessary softwares before continuing.
- Pull or download the project from github repository here.
-
The main development branch will be master branch.
Note: For Mac users, as eye adaption is turned off in the project, the lighting in main level of the project will very dim. Due to this, merge all changes back to macBuild branch and develop it using that branch. - Double click on 'EyeContact.uproject'. A popup might show up to ask to compile the project. Select 'Yes'.
- After the project has successfully compiled, Unreal Engine editor will launch. There you go, you are ready to contribute to the project!
Deploying the project
Please ensure that you have installed the necessary softwares before continuing.
- In Unreal Engine Editor, Select 'File' -> 'Package'. Choose your deployment target and the build location folder of your choice.
- This will package the project for respective deployment platform you have chosen. This will take a quite while.
- Once complete, you may run the program.
Running the game
- The project can only be run over local network. Select a player to host and get the computer IP address.
- Connecting player will have to open the console command in the game. Press '`' to access it.
- Type 'open (host-ip-address)' where host-ip-address is the IP address of the host computer.
- Upon successful connection, the host game will appear in the lobby and you can join.
Problems?
Having problem developing or running the project? Feel free to raise issues in the github repository.