Building Ryzom Core on Windows (deprecated)¶

• Building Ryzom Core on Windows (deprecated)
  • Introduction
  • Paths
  • Visual C++
  • Direct X SDK
  • 64 bits support
  • Third-party libraries
  • Visual Studio Configuration
  • Configuring CMake
  • Compiling NeL, Ryzom Core Client and Server
  • Compiling NeL and Ryzom Core Client
  • Compiling Ryzom Core Tools
  • Compiling NeL libraries
  • Compiling NeL Network Service (NeLNS)
  • Compiling NeL Samples
  • Compiling NeL Tools
  • Compiling NeL 3DS Max plugins
  • Compiling Snowballs (example application)

Introduction¶

On Windows, the supported compiler is Visual Studio 2008 SP1. It also work fine with Visual C++ Express 2008 SP1 that is free (as free beer).

In our explanation, we'll use C:\ryzom as root directory where you put everything related to this project. You can use the root directory you want, just adapt the paths.

So first, create an empty directory C:\ryzom.

For easier management, we do a subst that point R:\ into C:\ryzom.

subst r: c:\ryzom

Paths¶

NeL write its DLL inside r:\code\nel\lib and r:\code\nel\lib64 so if you want the executable automatically take the latest dll, you have to add r:\code\nel\lib (or r:\code\nel\lib64) in our PATH environment variable.

Visual C++¶

You can choose one of the following methods:

- Download and install the latest version of Visual C++ Express (2008 SP1)

or

- If you prefer, Download and install the Visual Studio pro trial 90 days
- and then the Download and install the Service Pack 1 (SP1)

Direct X SDK¶

Download and install the latest DirectX SDK (February 2010).

64 bits support¶

Do this only if you want to compiled in 64 bits. If you compile in 32 bits, just skip this part.

• Visual Studio 2008 SP1 (full version)* provides 64 bits compiler but it's not the case of express version, so you need to download a recent Windows platform SDK (one of the following) if you are using the express edition.

• Download and install the latest Windows SDK (Windows 2000, XP, Vista and 7)

Because to a bug in Platform SDK installer, you need to download http://dev.ryzom.com/attachments/498/VCE64BIT_WIN7SDK.zip which will fix the bug. Then launch setup_x86.bat (if you are on a 32 bit Windows) or setup_x64.bat (if you are on a 64 bit Windows).

Now in Tools => Options => Projects and Solutions => VC++ Directories you can choose x64 for Platform. Don't forget to follow the next instructions to configure all path.

Third-party libraries¶

To simplify the installation, we created an archive with all third-party libraries. It can be downloaded from the Files tab of this website here

Extract and rename the archive in r:\ so you should have r:\code and r:\external

Visual Studio Configuration¶

Now, you have to configure Visual Studio paths.

If you are using CMake, you should skip this part because it will set all correct paths itself.

Go in menu Tools->Options...->Projects and Solutions->VC++ Directories

First you need to check if there's a Direct X entry "Include files" and "Library files" sections If not, you have to add it manually

Setup external and Nel paths :

For 32 bits platform

Section "Include"

r:\external\include\stlport (at the first position)

r:\code\nel\include

r:\external\include

Section "Executable files"

r:\external\bin

Section "Library"

r:\external\lib

r:\code\nel\lib

For 64 bits platform

Section "Include"

r:\external\include\stlport (at the first position)

r:\code\nel\include

r:\external\include

Section "Executable files"

r:\external\bin64

Section "Library"

r:\external\lib64

r:\code\nel\lib

Your include directories should look like (the include order is very important):

Make sure that the plugin 'dxcore' is NOT installed (which is part of http://www.devexpress.com/Downloads/Visual_Studio_Add-in/) before opening the project containing the client code. Else, Visual Studio might crash while loading files including luabind.hpp.

Setup debugging facilities for Qt and STLport:

Copy r:\code\tool\visual_studio_macros\autoexp.dat to C:\Program Files\Microsoft Visual Studio 9.0\Common7\Packages\Debugger or C:\Program Files (x86)\Microsoft Visual Studio 9.0\Common7\Packages\Debugger

Configuring CMake¶

If you are NOT using CMake, you should skip this part because your projects are already there.

• Download last CMake version from this page :
  http://www.cmake.org/cmake/resources/software.html

• Launch CMake (cmake-gui) from your Start Menu

TODO: insert a screenshot here

• Fill "Where is the source code" with r:/code
• Fill "Where to build the binaries" with r:/build
• Press Configure
• Choose your compiler
• If it didn't detect something, please edit the correct paths and enable/disable projects you want to compile or not
• Press Configure again until there is no more error and Generate button is enabled
• Press Generate
• Your unique solution is in r:\build and contains all projects you selected
• Double-click on RyzomCore.sln (it'll launch Visual Studio)
• Select "Release" configuration
• Press F7 to build

Compiling NeL, Ryzom Core Client and Server¶

• Go in r:\code\ryzom\server
• Double-click on server.sln (it'll launch Visual Studio)
• Select "Release" configuration
• Press F7 to build

Compiling NeL and Ryzom Core Client¶

• Go in r:\code\ryzom\client
• Double-click on client.sln (it'll launch Visual Studio)
• Select "Release" configuration
• Press F7 to build

Compiling Ryzom Core Tools¶

Ryzom tools are not required to run the server.

Warning: Ryzom Core Tools need MFC to compile, since Visual Express doesn't have MFC, you need a full version of Visual Studio.

• Go in r:\code\ryzom\tools
• Double-click on all.sln (it'll launch Visual Studio)
• Select "Release" configuration
• Press F7 to build

Compiling NeL libraries¶

• Go in r:\code\nel\
• Double-click on nel.sln (it'll launch Visual Studio)
• Select "Release" configuration
• Press F7 to build NeL

Compiling NeL Network Service (NeLNS)¶

• Go in r:\code\nelns\
• Double-click on services.sln (it'll launch Visual Studio)
• Select "Release" configuration
• Press F7 to build NeLNS

Compiling NeL Samples¶

• Go in r:\code\nel\samples\
• Double-click on all.sln (it'll launch Visual Studio)
• Select "Release" configuration
• Press F7 to build NeL Samples

Compiling NeL Tools¶

• Go in r:\code\nel\tools\
• Double-click on all.sln (it'll launch Visual Studio)
• Select "Release" configuration
• Press F7 to build NeL Tools
• Note: You will need the MFC installed to compile the NeL tools. The Express Editions of Visual C++ do not come with the MFC, nor do the trial version of Visual Studio Pro.

Compiling NeL 3DS Max plugins¶

• Be sure to have 3DS Max SDK installed and configured
• Go in r:\code\nel\tools\3d\plugin_max\
• Double-click on plugin_max_public.sln (it'll launch Visual Studio)
• Select "Release" configuration
• Press F7 to build NeL 3DS Max plugins

Compiling Snowballs (example application)¶

• Go in r:\code\snowballs2\
• Double-click on snowballs2.sln (it'll launch Visual Studio)
• Select "Release" configuration
• Press F7 to build Snowballs