Ryzom

h1. *BuildConfRunWindows*

h1. Building, Configuring and Running the Ryzom Core for Windows(x86)

_This guide is intended to give a step by step process for setting up and running the Ryzom Core for those that may not be as technically gifted as others, This is being written assuming that the reader isn't familiar with the tools and software used here._

h2. *The following is a list of everything you will need to download.*

TortoiseHg - http://tortoisehg.bitbucket.org/download/index.html

DirectX SDK (February 2010) - http://www.microsoft.com/downloads/details.aspx?FamilyID=2c7da5fb-ffbb-4af6-8c66-651cbd28ca15&displaylang=en

External_stlport - http://dev.ryzom.com/attachments/download/593/external_stlport_lua51.7z

Qt - http://qt.nokia.com/downloads/windows-cpp-vs2008

XAMPP - http://www.apachefriends.org/download.php?xampplite-win32-1.7.3.exe

Apache - http://apache.mirrors.hoobly.com/httpd/binaries/win32/httpd-2.2.15-win32-x86-no_ssl.msi

MySQL - http://www.mysql.com/downloads/mysql/

Visual C++ 2008 (90 Day Trial) - http://download.microsoft.com/download/8/1/d/81d3f35e-fa03-485b-953b-ff952e402520/VS2008ProEdition90dayTrialENUX1435622.iso

Visual C++ 2008 SP1 - http://www.microsoft.com/downloads/thankyou.aspx?familyId=27673c47-b3b5-4c67-bd99-84e525b5ce61&displayLang=en

PHP - http://windows.php.net/downloads/releases/php-5.3.2-Win32-VC6-x86.zip

h2. *1. Getting the source code*

Download and install TortoiseHg - http://tortoisehg.bitbucket.org/download/index.html

Create a folder on your computer and name it whatever you want (choose something easy to remember and easy to get to because you will be referring to this a lot).

_Example: x:/ryzom_

> !http://dev.ryzom.com/attachments/648/1.jpg!

Navigate to this directory and right click on the folder that you just made.

Highlight *TortoiseHg* in the menu and select *Clone* from the list that appears to the side.

> !http://dev.ryzom.com/attachments/649/clone.jpg!

In the TortoiseHg Clone window, in the *Source path:* box put in

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

For destination path, you want the path to the folder you just right clicked on, which it should default to.

Leave everything else the default (unchecked) and hit *Clone* at the bottom.

> !http://dev.ryzom.com/attachments/650/tortoisehg_clone.jpg!

h2. *2a. Configuring Visual C++ 2008*

First install the DirectX SDK (February 2010)- http://www.microsoft.com/downloads/details.aspx?FamilyID=2c7da5fb-ffbb-4af6-8c66-651cbd28ca15&displaylang=en

Second install Visual C++ 2008 (90 Day Trial) - http://download.microsoft.com/download/8/1/d/81d3f35e-fa03-485b-953b-ff952e402520/VS2008ProEdition90dayTrialENUX1435622.iso

Third install Visual C++ 2008 SP1 - http://www.microsoft.com/downloads/thankyou.aspx?familyId=27673c47-b3b5-4c67-bd99-84e525b5ce61&displayLang=en

The first time installing Visual C++ 2008 can take a while.

Now create a new folder. This can go wherever you want and can be called anything you want, Example x:/external (Replace "x" with your drive letter).

> !http://dev.ryzom.com/attachments/651/external.jpg! 

Download this file

http://dev.ryzom.com/attachments/download/593/external_stlport_lua51.7z

Extract the contents to the folder you just created. _This comes with both x86 and x64 folders, you only *need* "bin", "include", and "lib" for the x86 build._

> !http://dev.ryzom.com/attachments/652/stlport.jpg!

Copy _code\tool\visual_studio_macros\autoexp.dat_ into the following directory: 

C:\Program Files\Microsoft Visual Studio 9.0\Common7\Packages\Debugger

> !http://dev.ryzom.com/attachments/653/autoexp.jpg!

> !http://dev.ryzom.com/attachments/654/autoexp2.jpg!

Download and install this file

http://qt.nokia.com/downloads/windows-cpp-vs2008

On your desktop or in your start menu, right click on My Computer and go to Properties. On the left side go to *Advanced System Settings* and in that window click on *Environment Variables…* at the bottom.

> !http://dev.ryzom.com/attachments/655/properties.jpg!

> !http://dev.ryzom.com/attachments/656/systemsettings.jpg!

> !http://dev.ryzom.com/attachments/657/evironment.jpg!

Under the second box labeled System variables click the *New…* button. In the box that pops up type in *QTLIB* for the variable name and put in the directory where Qt installed and \lib after that. So it should look something like _C:\QT\4.6.2\lib_ in the Variable value: field.

> !http://dev.ryzom.com/attachments/658/qtlib.jpg!

> !http://dev.ryzom.com/attachments/659/qtlib2.jpg!

h1. *_Note: You will need to restart your computer at this point._*

h2. *2b. Configuring Visual C++ 2008*

Now navigate to the directory we created at the beginning where all the source code is.

Go into _code\nel\_ and double click on *nel.sln*. This should open up the project in Visual V++ 2008.

Once that opens, go to the Tools drop down menu at the top and select Options at the bottom. On the left side of that window, expand *Projects and Solutions* and then select *VC++ Directories*.

On the right side where it says Show directories for: click on the drop down list there and select Include files. Below that click on the icon that looks like a yellow folder (when you hover over it, it says New Line. A new line pops up at the top of the list down below. You want to hit the *…* button to the right of that whitespace. Browse to the include directory where the DirectX SDK installed. By default, it installs to C:\Program Files\Microsoft DirectX SDK (February 2010)\Include.

Now you want to add a few more lines with the following directories:

_(Note: Your drive letters and folder names may be different than shown here.)_

x:\external\include\stlport

x:\external\include

x:\external\bin

x:\ryzom\code\nel\src

x:\ryzom\code\nel\include

Now go back to the drop down box under *Show directories for:* and select *Library files*.

Add the following lines:

_(Once again your drive letters and the name of your directories may be different than shown here.)_

C:\Program Files\Microsoft DirectX SDK (February 2010)\Lib\x86

x:\external\lib

x:\ryzom\code\nel\lib

This finishes this part. Go ahead and hit OK at the bottom.

h2. *3. Compiling NeL, Client/Server, and Tools.*

If you don’t already have *nel.sln* open, navigate to _code\nel\_ directory in the source code we downloaded earlier and open it.

Along the top of your Visual C++ 2008 window below the Help drop down menu click on the arrow next to where it says *Debug* and select *Release*.

Now hit F7 and wait. You are now compiling, and this could take awhile…

When that’s done, hopefully you will get a message along the bottom saying that everything was successful.

Now let’s move on to the Client/Server. 

Navigate to the directory you have the source code and go to _code\ryzom\server_. Double click on *server.sln*. Make sure to change *Debug* to *Release* like we did before in this project and then press F7 once again to compile. This will take even longer than when you compiled NeL.

When that’s done, go ahead and exit out and navigate once again to your source code directory and browse to _code\ryzom\tools_. Double click on *all.sln*. Once again change *Debug* to *Release* and hit F7. Once again wait and it should all compile successfully.

h2. *4. Setting up Apache/MySQL/PHP*

To make things less complicated, we're going to use a piece of software called XAMPP Lite that comes pre-configured with Apache, MySQL, and PHP with phpMyAdmin that gives you a web interface to your MySQL server.

Download and install this:

http://www.apachefriends.org/download.php?xampplite-win32-1.7.3.exe

After it's installed I want you to run XAMPP Lite. With the control panel open you want to click on the *Explore* button on the right side. This should open up the XAMPP directory. Navigate to:

_xampplite -> apache -> conf -> extra_

Open the file called *httpd-vhosts.conf* with your favorite text editor. At the very bottom of that document I want you to copy and paste these lines into it:

_Note: The drive letter and directory may be different then mine so you may need to change the the directory and documentroot lines to match what you have._

Listen 40916

<VirtualHost *:40916>

  <Directory "x:/source/code/ryzom/tools/server/">

     Options -Indexes FollowSymLinks MultiViews

     IndexOptions FancyIndexing FoldersFirst NameWidth=*

     AllowOverride All

     Order allow,deny

     Allow from all

  </Directory> 

  ServerAdmin admin@localhost

  DocumentRoot "x:/source/code/ryzom/tools/server/www"

  ServerName localhost

</VirtualHost>

<VirtualHost *:80>

  <Directory "x:/source/code/ryzom/tools/server/">

     Options -Indexes FollowSymLinks MultiViews

     IndexOptions FancyIndexing FoldersFirst NameWidth=*

     AllowOverride All

     Order allow,deny

     Allow from all

  </Directory> 

  ServerAdmin admin@localhost

  DocumentRoot "x:/source/code/ryzom/tools/server/admin"

  ServerName localhost

</VirtualHost>

Save that file and you are done configuring Apache. Now I want you to open up the XAMPP Control Panel again (there should be an icon for it down by your clock).

This time click on the *Start* button to the right of where it says *Apache*.

When that is done hit the *Start* button next to MySQL. Now you should be able to click on the *Admin* button next to that Start button you just clicked on for MySQL. A web browser should open up taking you to your phpMyAdmin website.

On that main screen in phpMyAdmin underneath where it says *MySQL localhost* you should see something that says *Create new database*. In the box below that type in _nel_ and hit the *Create* button over to the right. Now go to the top of the screen and click on *Server: localhost* and it will take you back to the main screen. In the Create new database field put in _nel_tool_. Once again go back to the main screen and this time create _ring_open_.

Minimize your browser now and navigate to your source code folder and go to _code/ryzom/tools/server/sql_. Open up *ryzom_admin_default_data.sql* in a text editor. Do a search for _/home/nevrax/code/ryzom/server/save_shard/rrd_graphs_ and change that so it matches your source code directory. I changed mine to: _x:/source/code/ryzom/server/save_shard/rrd_graphs_. Save and close out of that file.

Now go to your source code directory and navigate to _code/ryzom/server/save_shard_ and create a new folder in there and call it _rrd_graphs_.

Open back up your browser that you minimized earlier that is open to phpMyAdmin. On the left pane click on where it says _nel_ click on that. Along the top now you will see a bunch of tabs. You want to click on the Import tab. Under *File to import* click on the *Choose File* button. In the window that pops up browse to your source code directory and to _code/ryzom/tools/server/sql_ and select the one called *ryzom_tables.sql* and hit *Open* at the bottom. Now at the bottom right of that screen hit the *Go* button and it will import the file. Now go back to the Import tab once again under the *nel* database and do the same process but this time import *ryzom_default_data.sql* which is in the same directory. Now go to the nel_tool database and Import the file called _ryzom_admin_default_data.sql_.

*To be continued...*