How to set up the Build Pipeline

...

• Autodesk 3ds Max (supporting version 9 to 2012)
• Assets archive http://dl.kaetemi.be/ryzom/assets/ryzom_assets_rev3.7z
• Python 2.7

Get the graphics data

Download the latest assets archive if you haven't done so yet.

http://dl.kaetemi.be/ryzom/assets/ryzom_assets_rev3.7z

Install 3ds Max plugins

Install the 3ds Max plugins, you can get them from the downloads page.

Downloads for Windows

Install Python

Download and install Python. Version 2.7 has been confirmed to work http://www.python.org/download/releases/2.7/.

Get the source code

Checkout the latest revision of the code repository.

...

W: should contain 'database'

Compile the source code

Compile the whole thing. It is recommended to always work from the virtual R: drive, when compiling the code, as this makes it easier to switch between different revisions in case you need to. We’ll need the tools from both NeL and Ryzom Core. See some other wiki page for more information on this part. While compiling, you may want to move on to the next steps.

Get some additional tools

For the client patch build pipeline you also need to download xdelta.exe version 1.1.3, which is available fromhttp://www.evanjones.ca/software/xdelta-win32.html, and lzma.exe, which you can get from the lzma sdk http://www.7-zip.org/sdk.html. Place these files either in the "bin" directory of your externals directory, or in the directory that contains your Ryzom and NeL tool executables.

Running the Build Pipeline Setup

Making a shortcut

First, we'll make a shortcut to your cmd window, just because it's useful to have. Right click where you want the shortcut. Click New > Shortcut. Type cmd. Next. Type a name. Finish.
This shortcut will now give you a plain old cmd window. In order to make it a bit more useful, you'll have to change some parameters on the shortcut. Right Click > Properties. Go to the tab Shortcut. Set "Start in" to R:\code\nel\tools\build_gamedata. Go to the Font tab. Pick a font that you can set to size 12. Then go to Layout. Set Buffer Width to 128, Height to 512, Window Width to 128, Height to 64. Hit OK.

Use this shortcut to launch a nice and big cmd window.

Running 0_setup.py

Now that you're in the cmd, and in the right directory, you can just type 0_setup.py, and hit Enter, to go trough the initial configuration.

If you're using the default directories, you'll only need to change D:/libraries/external to where you extracted your external libraries, and C:/build/dev to your CMake build environment (it should contain a bin/Release sub-directory). You'll also need to change C:\Program Files (x86\ to just C:\Program Files\ anywhere if you're using 32 bit Windows. Depending on your version of 3ds Max, you may also have to change the 3ds Max program path and user directory path.

All of the folders that are under W:\ and L:\ in the default values, and that don't exist yet, will be generated for you by the setup script after you've plugged in all your configuration values. It may also generate some configuration files for some processes.

Exporting, Building and Installing

Finally, ...

Run 1_export

- exports the animations etc

Run 2_build

- Builds the interface atlas'

...

s etc

Run 3_install

- Installs the data into a folder ready for deployment

Run 4_data_shard

-

Run 5_client_dev

-

Run 6_client_patch

-

Run 7_client_install

- Builds the final client distributable folder

*** IMPORTANT ***

...

subst R: /D
subst R: D:\source\nevrax
subst L: /D
subst L: D:\source\nevrax\code\ryzom\common\data_leveldesign
subst W: /D
subst W: C:\ryzom_core_build

And run the bat file too.

Compile the Ryzom Core source code

Compile the whole thing. It is recommended to always work from the virtual R: drive, when compiling the code, as this makes it easier to switch between different revisions in case you need to. We’ll need the tools from both NeL and Ryzom Core. See some other wiki page for more information on this part. While compiling, you may want to move on with the next three steps already. 

Download and install the 3ds Max tools

...

Follow the instructions for installing the 3ds Max plugins. It is very important that you properly set up the system unit configuration. And by that I really mean it's very important.

Install Python

Download and install Python. Version 2.7 has been confirmed to work http://www.python.org/download/releases/2.7/.

Get some additional tools

For the client patch build pipeline you also need to download xdelta.exe version 1.1.3, which is available fromhttp://www.evanjones.ca/software/xdelta-win32.html, and lzma.exe, which you can get from the lzma sdk http://www.7-zip.org/sdk.html. Place these files either in the "bin" directory of your externals directory, or in the directory that contains your Ryzom and NeL tool executables.

...

There are currently some files in the code repository that are in the ryzom_assets_rev2.7z assets W:\database already. These must be deleted in order to get the game built properly.
Erase the contents of "code\ryzom\server\data_shard\collisions" entirely, this data is generated by the build pipeline.
Delete the directory "code\ryzom\client\data_r2ed_ui", this data is already under W:\database\interfaces\r2_*.
Delete the directory "code\ryzom\client\data\gamedev\adds\interfaces", this data is also under W:\database\interfaces.
Delete the file "code\ryzom\client\data\gamedev\interfaces_v3\texture_interfaces_v3.tga", it is generated by the build pipeline to elsewhere.

Running the Build Pipeline Setup

Making a shortcut

First, we'll make a shortcut to your cmd window, just because it's useful to have. Right click where you want the shortcut. Click New > Shortcut. Type cmd. Next. Type a name. Finish.
This shortcut will now give you a plain old cmd window. In order to make it a bit more useful, you'll have to change some parameters on the shortcut. Right Click > Properties. Go to the tab Shortcut. Set "Start in" to R:\code\nel\tools\build_gamedata. Go to the Font tab. Pick a font that you can set to size 12. Then go to Layout. Set Buffer Width to 128, Height to 512, Window Width to 128, Height to 64. Hit OK.

Use this shortcut to launch a nice and big cmd window.

Running 0_setup.py

Now that you're in the cmd, and in the right directory, you can just type 0_setup.py, and hit Enter, to go trough the initial configuration.

...

All of the folders that are under W:\ and L:\ in the default values, and that don't exist yet, will be generated for you by the setup script after you've plugged in all your configuration values. It may also generate some configuration files for some processes.

Exporting, Building and Installing

Finally, ...

Run 1_export

- exports the animations etc

...