Installing the Engine

Installing the Engine

Clonning repository

The first thing you need in order to install the Engine is to get your hands on source code.

• In case you are using git:
  git clone --recursive https://github.com/VMormoris/GreenTea
• If you are not using git, then after downloading the Engine's source code make sure you have all it's dependecies that can be found on the 3rdParty folder.

Building Green Tea Engine

In order to build the Engine you need to run premake5 from the folder where you saved the Engine during the Clonning step:

• Open the command line and navigate to the appropriate directory.
• Run: premake5.exe vs20**._
  • Change the "**" to the version of Visual Studio you are running more info.

After premake is finishes a GreenTea.sln file has been produced. You can double click on it to build and try out the Engine. It is important to keep in mind that logic for your games is being loaded at runtime. Because of this if you want write Scripts you need to Run the Engine as a stand alone application (NOT through Visual Studio) and in Release mode.

Create shortcut (optional)

At this stage an executable name CupOfTea.exe should have produce bin/Release-windows/CupOfTea folder. I recommend you to create a shortcut on Desktop so you don't need to navigate every time you want to open The Engine on this directory.