Page Comparison

...

1. Add new virtual host to Apache. This file may be httpd-vhosts.conf, default or a new file in the appropriate to your distribution.
   

   Panel
   borderStyle borderStyle dashed title Patch Server Configuration dashed
   Listen 43435 <VirtualHost *:43435> <Directory "/home/username/ryzom/code/ryzom/tools/server/patch"> AllowOverride All Order allow,deny Allow from all </Directory> DocumentRoot "/home/username/ryzom/code/ryzom/tools/server/patch" ServerName localhost </VirtualHost>

    

2. Copy generated patches to the DocumentRoot you specified.
    
3. Create or update the Ryzom version file:
   1. Create a new file in the patch directory called: ryzom_open.version
      
   2. Inside the new file put current version in this format: currentVersionNumber currentVersionNumber

       

      Panel
      borderStyle dashed
      1 1

   3. Ensure that all patch files (.idx and _debug.xml) have the 5 digit patch number:

      Panel
      borderStyle dashed title Example borderStyle dashed
      ryzom_00001.idx ryzom_00001_debug.xml

4. Update the domain(s) database entries:
   1. Determine the domain ID that you will be updating. The default ID is 12.

   2. Update the nel.domain table's patch_version field to the new version:

      Code Block
      language sql
      USE nel; UPDATE domain SET patch_version=1 WHERE domain_id=12;

   3. If initially configuring your patch server you will also need to modify the patch_urls field:

      Code Block
      language sql
      USE nel; UPDATE domain SET patch_urls='http://127.0.0.1:43435/patch' WHERE domain_id=12;

       

5. Add or update the URL of patching web server to the client_default.cfg file, located in the client directory:

   Panel
   borderStyle dashed title Example Config Changes borderStyle dashed
   PatchServer = "http://127.0.0.1:43435/patch"; PatchWanted = 1;

6. Start client and login. Patching should commence.

...

• patch_game/ 
  • bnp - put your .bnp files here
  • patch - this will have generated patch files. copy these to web server
  • ref - patch_gen work files
  • game.hist
  • game.xml

Generate Patch

Copy updated .bnp files to patch_game/bnp and run:

patch_gen updateProduct patch_game/game.xml 

Example XML

<xml>
    <_Categories>
      <_Category>
          <_Name type="STRING" value="main"/>
          <_IsOptional type="SINT32" value="0"/>
          <_IsIncremental type="SINT32" value="0"/>
          <_Files type="STRING" value="main.bnp"/>
          <_Files type="STRING" value="sound.bnp"/>
          <_Files type="STRING" value="textures.bnp"/>
      </_Category>
      <_Category>
          <_Name type="STRING" value="unpacked"/>
          <_IsOptional type="SINT32" value="0"/>
          <_UnpackTo type="STRING" value="./"/>
          <_IsIncremental type="SINT32" value="1"/>
          <_Files type="STRING" value="exedll.bnp"/>
      </_Category>
      <_Category>
          <_Name type="STRING" value="optional"/>
      </_Category>
 </_Categories>
 <_IndexFileName type="STRING" value="game.hist"/>
 <_PatchDirectory type="STRING" value="patch_game/patch/"/>
 <_BnpDirectory type="STRING" value="patch_game/bnp/"/>
 <_RefDirectory type="STRING" value="patch_game/ref/"/>
 <_NextVersionFile type="STRING" value="patch_game/ryzom_open.version"/>
</xml>

...

Patch Generated

1. Create a folder inside the client directory and name it "unpack".
2. Place the ryzom_00000.idx inside the "unpack" folder created in step number one.
The 5 digits is the server version, if your server version is 1 you will have to replace 000000 to 00001
3. Open your favorite database editor and click on "nel" then click the table "domain".
4. There's a domain with the id of 12, click to edit the fields patch_version.
5. replace "patch_version" with the version of your server version, in this case it would be 0, click save.

6. Make sure to change your client cfg file to "PatchWanted = 1;" 
7. Open the client and watch it patch your client files!

Build Client for patching

...

1. Edit code/ryzom/client/src/client_cfg.cpp
   

2. And add the following:

   Code Block
   READ_STRING_FV(RingReleaseNotePath) READ_STRING_FV(ReleaseNotePath)

3. Configure the client_default.cfg with the appropriate URLs:

   Tip
   PatchServer should be the URL to the patch_game directory.

   Panel
   borderStyle dashed
   PatchServer = "http://127.0.0.1:43435/patch"; RingReleaseNotePath = "http://127.0.0.1:43435/patch/index.php";

4. RingReleaseNotePath is the URL to your release notes file. The client does pass a $ver value so you can use that to have different notes per version for example in a PHP file. Here's an example:

   Code Block
   language html/xml title Release Notes: index.php
   <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> </head> <body> <h1>Saturday, Febuary 25 2012</h1> <h2>RELEASE</h2> <p>After much work and a few years we are proud to present the first official release of Ryzom Core.</p> <br> </body> </html>