From EncyclopAtys

Jump to: navigation, search
Translation to review
Don't blame the contributors, but come and help them 😎

Reference text ( Maintained text, used as reference ) :
Notes: (Craftjenn, 2021-02-13)

Patch creation

Installation packages

External Tools :

  1. lzma
  2. xdelta
 sudo aptitude install lzma xdelta

Tools Nel

  1. make_bnp
  2. patch_gen

They were created with the compilation of the shard. For make_bnp : Compilation of the .bnp.

Implementation of the data hierarchy

It must first be placed in a place in which we generate patches. One of these areas will be opened by the Apache server to serve the web clients. We will place us in the patch_service in our directory home :

  mkdir ~/patch_service
  cd ~/patch_service

Generate New Product :

  ~/patch_service$ patch_gen createNewProduct patch_game/ryzom.xml

Directory Layout:

  • patch_service/
    • bnp/
    • patch/
    • ref/
    • ryzom.xml

We will then copy our bnp files in the directory assigned to them (which we assume they are stored in a directory ~ / bnp :

 ~/patch_service$ cp ~/bnp/*.bnp patch_game/bnp/

You must then create an empty file, which will be used for indexing patches. It consists of the name of the shard (we will Lirria as an example here, as this is the name of the shard development kaganate) followed .version, and will be placed in the patch_game :

 ~/patch_service$ touch patch_game/Example.version

Configuring the patch server

You must then edit the file patch_service/ryzom.xml :

 ~/patch_service$ nano patch_game/ryzom.xml

Detailed explanation of the syntax of this file is given in another article ( The syntax of the xml file of the patch server), and we will simply create here the establishment of the single patch_example.bnp , planned to copy in the client subdirectory '/ user' data for testing.

Our configuration file will look like this:

 			<_Name type="STRING" value="khanat_lirria"/>
 			<_IsOptional type="SINT32" value="0"/>
 			<_UnpackTo type="STRING" value="./user/"/>
 			<_IsIncremental type="SINT32" value="1"/>
 			<_Files type="STRING" value="patch_example.bnp"/>
 	<_IndexFileName type="STRING" value="ryzom.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/Example.version"/>
 	<_ClientIndexFileName type="STRING" value="ryzom"/>

The specified parameters will gradually increment the content of our .bnp, adding new files, and the file bnp after being downloaded by the client, will be unpacked in / user to be taken account last (to overwrite older versions of files such as handy for testing).

Patch server activation at the database

The system based on a database, you must let him know that we activate the patch server. For this we will use commands in MySQL.

We assume that your domain number is 12, if not, change the value. First activate the patch server (by setting the value of patch_version to 1 instead of 0, default)

 USE nel;
 UPDATE domain SET patch_version=1 WHERE domain_id=12;

Then specify the server address in the fields patch_urls :

 USE nel;
 UPDATE domain SET patch_urls='' WHERE domain_id=12;

Creation of the first Patch

We must now create the first patch, which will provide the bnp in its original state at client.Nous reuse the same command, but with a different statement this time:

 ~/patch_service$ patch_gen updateProduct patch_game/ryzom.xml

It is possible that you have a warning during this operation, but this seems not serious.

 WRN a8ded740 patch_gen_common.cpp 59 GeneratePatch <Unknown> : 'xdelta delta patch_game/empty patch_game/bnp/patch_example.bnp patch_game/patch/00001/patch_v1_00001.patch' failed with error code 256

The key is to get to the end: Generating client index: patch_game/patch/00001/ryzom.idx...

Création de la Release Note

You can create a file in the root patch that will serve to disseminate information on the patched data. This may be a php file, which can receive from the customer more information:

  • version : the version of the patch ;
  • lang : the customer's language ;
  • ca : the connection Shard ;
  • startPage : <wrap tip>to define</wrap>

Suppose we create a simple html file.

 ~/patch_service$ nano patch_game/patch/index.php
  <meta http-equiv="content-type" content="text/html; charset=UTF-8"></head><body>
  <h1>Saturday, october 28 2016</h1>


  <p>After much work and a few years we are proud to present the first official release .</p>


The content is now ready for release, remains to know the customers.

Apache server configuration

We are assuming that you already have a working Apache server, and that it is just to create a new VirtualHost. If the directory home of the user who manages the server is named gameserver , it must have these parameters (otherwise adjust according to your settings):

Our wish is to have a single address, without port to the patch server, which will be of the form .

So we must first install some modules for Apache (if not already done in advance):

 ~/patch_service$ sudo a2enmod proxy
 ~/patch_service$ sudo a2enmod proxy_http

We then add in the VirtualHost listening on port 80 the line:

 ProxyPass       /patch/

Then we define our dedicated and Virtual Host:

 <VirtualHost *:43435>
 DocumentRoot /home/gameserver/patch_service/patch_game/patch/
 <Directory "/home/gameserver/patch_service/patch_game/patch">
    Options -Indexes 
    AllowOverride All
    Require all granted

The Option -Indexes blocks the display of default directories for security reasons.

Open the 43435 port in Apache.

 Listen 43435

Once this is done, we restart the Apache service:

 ~/patch_service$ sudo service apache2 restart

Announce the availability of the patch

It must then warn customers that this patch number 1 is ready to be distributed, we will do with a new file Exemple.version (there will be two to one previously created) in directory patch served by Apache:

 ~/patch_service$ nano patch_game/patch/Lirria.version

It is enough to indicate just (1 - space 1 ):

 1 1

to say that the patch number 1 is ready. In the future, it will be enough to put 2 to serve the patch 2 etc.

The second number is the one that is passed to the php page for version , we change simultaneously so.

Client Configuration

For the client to access the patches, there are two cases.

Client DEV

It is better to indicate the parameters in its client_default.cfg. should therefore be taken to the presence of these lines:

 PatchWanted          = 1;
 PatchUrl = "";
 RingReleaseNotePath = "";

It is now well PatchUrl and not PatchServer , which is obsolete.

The last refers to the file we created for Release Notes.

Client FV

The FV client must be compiled with the WITH_RYZOM_PATCH to access the patch server. Without any other option specified, it will automatically connect to the patch server specified by the server (noted above in the MySQL database).

It will seek the release notes on these hardcodées Address:

 RingReleaseNotePath = "http:" + WebIgMainDomain + "/releasenotes_ring/index.php";
 ReleaseNotePath = "http:" + WebIgMainDomain + "/releasenotes/index.php";

This will require careful to ensure that the address WebIgMainDomain is correctly filled in client_defaut.cfg

IF the customer FV also received the WITH_RYZOM_CUSTOM_PATCH_SERVER , it will act as the client DEV and will be provided with the necessary lines in his client_default.cfg:

 PatchWanted          = 1;
 PatchUrl = "";
 RingReleaseNotePath = "";

Enjoy !

With this configuration, be sure that your unpack is empty of any file .version or .idx for the first patch. Thereafter, the system will keep track of patches received in this directory, so be sure to keep these files (under penalty of having to re-patch your client 0). With our example, new elements will be automatically unpacked in your user at the client restart after downloading.

It'll just launch your game client and see if patch!


For wiki pages about Patch, see the French page fr:Conventions Patches & Updates (to translate in En).