User Tools

Site Tools


install

Engine SDK Installation

Here we will detail how to install the engine on your system to start creating VR applications with the Annwvyn library.

What is the Annwvyn SDK ?

The Annwvyn SDK is a package containing the Annwvyn source distribution, with compiled binaries of the last available release and a valid Git tree you can pull to update it. It also includes all the free re-distributable libraries you need to use Annwvyn. It's installation is *not* required to actually play Annwvyn developed content, but is necessary to build it.

The SDK is packaged as an installer file, compiled with the Free software InnoSetup.

The Annwvyn sub-folder is the Annwvyn Engine source code. It's also a Git working repository, with a remote “origin” pointing to the GitHub official repo. So you can git pull to get a new version of it.

If you want more information on the source package, please check out the source article.

TL;DR Get started quickly

  1. Go install Visual Studio 2015
  2. Go also install Git for windows and CMake
  3. If not done already, install your VR hardware and software (Oculus, Vive…)
  4. Download the Annwvyn SDK from here : http://annwvyn.org/index.php?static2/download
  5. Run the setup. If a terminal window open and ask you about environment variable, answer “yes”
  6. For 3D assets creation, you'll want Blender, get it there : https://www.blender.org/download/
  7. For exporting from Blender to the .mesh format, get the “Ogre Command-line Tools (1.7.2)” from this page : http://www.ogre3d.org/download/tools and stick them into your C:\ drive, then add to blender the export script located in <AnnwvynSDK>/Annwvyn/Utils
  8. To create a new Annwvyn project, just copy-paste the “template” directory of <AnnwvynSDK>/Annwvyn/ to where-ever you want, run CMake to generate Visual Studio solutions.

Prerequisites

Before installing the engine SDK, you should install Visual Studio 2015 first. This will be our development platform. The community version is freely available here: Visual Studio Download page

During the installation, please check the Visual C++ package. We kinda need a C++ compiler, right? :-P

I also encourage you to use a source control version software, like Git

You'll need the Oculus runtime if you're using a Rift, get it here

You'll need SteamVR on Steam if you're using a Vive, get Steam here (need to create an account. You'll probably already own one if you're interested in our field :-P)

Good knowledge of modern C++ and an understanding of VR systems is also recommended before starting to dive in! :-)

Automated installation

The simpler way to get Annwvyn up and running is to install the SDK package.

Get the install package

You can download the SDK package from the “download” page of Annwvyn.org, or just follow this link : http://annwvyn.org/dl/setupAnnwvynSDKx64.exe

Install it

This is a standard Windows installer. By default (for legacy reason) it will want to install the SDK in C:\Oculus\AnnwvynSDK64\. You can change this to anywhere you want in your system.

Near the end of the install process, a terminal window will open, asking you about environment variables. Just say yes. This will store the install location of the SDK to an environment variable, so that the enclosed VS project will get the path to the libraries.

Manual installation via the GitHub repository

Get the dependency package

The dependency package contains everything you need to build the engine (it's the exact content of the packaged SDK, minus the Annwvyn source directory. You can download a zipped archive from the Annwvyn.org download page

Configure the environment

You need to run the batch file “RUNME.bat” to configure an environment variable that the MSVC configurations will depend on.

Clone the repository

Navigate to the directory where you have unzipped the archive in Git bash, and run the following command

git clone https://github.com/Ybalrid/Annwvyn/

This will clone the source repository on your system. But it will not contain the needed binaries. to run the template and test applications

Build the engine via Visual Studio

In the source repository, navigate to the /Annwvyn/msvc/Annwvyn location. You'll find a Visual Studio solution file called “Annwvyn.sln”, open it.

Make sure that you're set on “Release/x64” on top on the VS window, and then hit Ctrl+Shift + B to build the entire thing.

If it's done sucessfully, you can navigate to the /Annwvyn/msvc/Test directory, and do the same.

Then, please run the /Annwvyn/example/getLibs.bat script to copy all the .dlls needed to the correct location.

Once you're done with that, you can try to launch the test.exe program in /Annwvyn/example. If you don't have a VR system setup, please use the “novr_launcher.bat” script to open it in a debug mode where the game only runs in a standard window, without head-tracking.

If you have a rift or vive setup, go along and open the right launcher ;-).

The program will default to the Oculus VR mode if you try to run it directly.

Theses launchers are only there to easily pass the right command line arguments to the engine.

The Annwvyn/template directory contains a “Game.sln” solution and a similar “getLibs” script you should launch once.

And now, what do I do?

If you have installed Annwvyn, I recommend you to check out the quickstart guide or the engine tour to understand how things works ;-)

install.txt · Last modified: 2017/08/19 22:35 by ybalrid