Skip to content
This repository has been archived by the owner on Dec 13, 2023. It is now read-only.

Install Guide

Christian Stewart edited this page Apr 5, 2014 · 4 revisions

Git Project Setup

You may want to keep your project under Git source control. In this tutorial I will be using command line git commands, to get a Git command line on windows, you should install Git Bash. You can then right click on any folder and open "Git Bash" to get the command line.

If you want to keep your project's code under source control.. Right click on your game folder and hit Git Bash.

cd Code
git init
git add -A
git commit -m "initial commit"

If you have your Code directory set up as a Git repository, use the submodule commands here instead of the clone commands or you will have strange problems later on.

Clone and Build Plugin_SDK

I do not recommend using the PluginSDK installer as it is now out of date and hard to update for newer versions of CE3. Instead you should clone and build it yourself.

In a Git Repository

cd Code
git submodule add https://github.com/hendrikp/Plugin_SDK.git

Out of a Git Repository

cd Code
git clone https://github.com/hendrikp/Plugin_SDK.git

Open CryEngine_GameCodeOnly.sln. Make a new folder called Plugins. Right click on the folder (filter) and add the Plugin_SDK project file (under Plugin_SDK/project) to your solution. Right click Manager (the project you added) and hit build. You've just compiled the PluginSDK for CryEngine!

You can see the structure of the solution here: (by folder I mean filter - right cilck on the solution in Visual Studio and click Add->New Solution Folder)

After you compile PluginSDK you need to integrate it with your GameSDK code.

https://github.com/hendrikp/Plugin_SDK/wiki/GameDLL-Integration

Install Direct3D Plugin

In a Git Repository

cd Code
git submodule add https://github.com/hendrikp/Plugin_D3D

Out of a Git Repository

cd Code
git clone https://github.com/hendrikp/Plugin_D3D

Next, add it to your Solution in the same way as the Plugin_SDK and compile it.

Install Awesomium plugin

Unlike other UI plugins, AwesomiumCE3 does not require any external third party software to be installed.

In a Git Repo

cd Code
git submodule add https://github.com/kidovate/AwesomiumCE3

Out of a Git Repository

cd Code
git clone https://github.com/kidovate/AwesomiumCE3

Now, add the project to your solution and compile it.

Done!

Folder Structure

When you have finished this guide, your folder structure should look like this: