Ryzom

h1. Building Ryzom Core including NeL with CMake under Windows

{{>toc}}

h1. Downloading prerequisites

First, you need to download all these files:

# "Microsoft Visual C++ 2008 Express":http://www.microsoft.com/downloads/en/details.aspx?FamilyID=f3fbb04e-92c2-4701-b4ba-92e26e408569

# "Microsoft DirectX SDK":http://www.microsoft.com/downloads/en/details.aspx?FamilyID=3021d52b-514e-41d3-ad02-438a3ba730ba

# "Tortoise Hg":http://tortoisehg.bitbucket.org

# "CMake":http://www.cmake.org/files/v2.8/cmake-2.8.2-win32-x86.exe

# "7-Zip":http://www.7-zip.org

# "External_stlport.7z (3rd party libraries)":https://sourceforge.net/projects/ryzom/files/external_stlport.7z/download

# "external.7z (3rd party libraries)":http://sourceforge.net/projects/ryzom/files/external.7z/download

h1. Installing prerequisites

Install *Microsoft Visual C++ 2008 Express*, *Microsoft DirectX SDK*, *CMake*, *Tortoise Hg* and *7-Zip* in your desired locations. If you don't use the default path, you'll have to put your specific path in the following commands.

If you have problems installing the .net framework you may have other installations of the .net framework installed

which are preventing you.Use the .net cleanup tool at the bottom of this page if this is the case.

If you plan to use CMake from command line check this option:

!cmake_path.png!

h3. From GUI

[[Getting_Source|Get the sources]]

Decompress downloaded *external_stlport.7z* and *external.7z* inside *C:\ryzom\*.

After that, you can delete *external_stlport.7z*, *external.7z*.

You should have this structure :

<pre>

C:\

|

+-- Ryzom

    |

    +-- code

    |   |

    |   +-- nel

    |   |

    |   +-- ryzom

    |   |

    |   +-- ...

    |

    +-- external_stlport

    |   |

    |   +-- bin

    |   |

    |   +-- bin64

    |   |

    |   +-- include

    |   |

    |   +-- lib

    |   |

    |   +-- lib64

    |

    +-- external

        |

        +-- bin

        |

        +-- bin64

        |

        +-- include

        |

        +-- lib

        |

        +-- lib64

</pre>

h2. From command line

h3. Open a Visual Studio command line

In *Start Menu* -> *All Programs* -> *Microsoft Visual C++ 2008 Express Edition* -> *Visual Studio Tools*, launch *Visual Studio 2008 Command Prompt*

h3. Getting the sources

In the command line, type:

<pre>

c:

cd \

md ryzom

cd ryzom

hg clone http://ryzom.hg.sourceforge.net:8000/hgroot/ryzom/ryzom .

</pre>

h3. Installing external

Put the downloaded *external_stlport.7z* inside *C:\ryzom\* and in the command line, type:

<pre>

"c:\Program Files\7-Zip\7z.exe" x external_stlport.7z -oexternal_stlport

del external_stlport.7z

"c:\Program Files\7-Zip\7z.exe" x external.7z -oexternal

del external.7z

</pre>

h3. Installing Jom (optional)

_Jom already is in external\bin._

Download *Jom* from "Nokia FTP":ftp://ftp.qt.nokia.com/jom/jom.zip.

Put the downloaded *jom.zip* inside *C:\ryzom\* and in the command line, type:

<pre>

"c:\Program Files\7-Zip\7z.exe" x jom.zip -oexternal_stlport\bin

del jom.zip

set PATH=%PATH%;C:\ryzom\external_stlport\bin

</pre>

h1. Compiling

You will need to set FINAL_VERSION to OFF to build the client and add PatchWanted = 0; in client.cfg or you would receive an error.

Alternatively, you could edit code\ryzom\client\src\client_cfg.cpp. Change PatchWanted to false where it says "only force patching under Windows by default" (around line 422).

h2. With GUI

You should launch *CMake (cmake-gui)* which is located in your *Start menu* in *CMake* sub-menu.

Fill in required fields:

* Where is the source code:  *C:/ryzom/code*

* Where to build the binaries: *C:/ryzom/code/build*

Now click on *Configure*, it will ask you to choose a generator, select *Visual Studio 9 2008* and click on *Finish*.

!cmake_generator.png!

Other generators could work too such as: *Visual Studio 9 2008 Win64 (if you installed Windows SDK 64 bits compilers)* or *other versions of Visual Studio*.

If there is any error (text in red in the text area), check it in the text area at the bottom and try to fix it, if there is no error, click again on *Configure*, the *Generate* button should be enabled now, finally click on *Generate*.

If you want to enable or disable options, you will need to click again on *Configure* and *Generate*.

!cmake_gui_options.png!

The solution *C:\ryzom\code\build\RyzomCore.sln* has been generated, you can double-click to open it in Visual C++ and press *F7* to compile all projects.

h2. With command line using nmake (installed by Visual C++)

In the command line, type:

<pre>

cd code

md build

cd build

cmake ..

nmake

</pre>

h2. With command line using jom (not installed by Visual C++)

In the command line, type:

<pre>

cd code

md build

cd build

cmake .. -G "NMake Makefiles JOM"

jom

</pre>

h2. Additional Step Necessary for Server Startup

For connecting to a running game-server you have to install apache and mysql, as in http://dev.ryzom.com/projects/Ryzom/wiki/EverythingWindows#Setting-up-ApachePHP and thereafter.

Please note that the first part of that page about compiling etc. is outdated, ignore it, until the wiki is corrected.

Please continue on to: http://dev.ryzom.com/projects/ryzom/wiki/FixingWindowsBatch

CMake Options:

http://dev.ryzom.com/projects/ryzom/wiki/CMakeOptions

h2. Additional Step for QT

install http://get.qt.nokia.com/qt/source/qt-win-opensource-4.7.0-vs2008.exe

replace c:\qt\4.7.0 with https://docs.google.com/leaf?id=0B3LX3q7MsUEGMWFkN2FlYjEtMTAwOC00YmZjLWI5Y2ItNWQ4MDFmODJlMjdl