View source for The Test Team Handbook/3 - Setting up connection to non-public Ryzom servers

<noinclude>{{WIP}}{{Trad
|DE=Das Test-Team-Handbuch/3 - Verbindung zu nicht-öffentlichen Ryzom-Servern einrichten |DEs=4
|EN=The Test Team Handbook/3 - Setting up connection to non-public Ryzom servers |ENs=0
}}</noinclude>
=Setting up connection to non-public Ryzom servers <ref>Setting up connection to non-public Ryzom servers @cloud.ryzom.com https://cloud.ryzom.com/f/34233</ref>=

This document describes how to configure a Ryzom client for connection to other Ryzom servers used by Ryzom Teams. It is expected that you are familiar with either using and configuration of the Ryzom Installer and/or capable to do advanced file system management as copying and editing files. The main concern of this document is to describe all necessary steps you need to set up connection to either Yubo or Gingo server.

==Yubo and Gingo (and Atys)==
Yubo and Gingo are names of two not public servers that are used by various teams to review and test the game. Yubo has status of development server and it is the main target where all new changes arrive for the first review. It can easily happen that some parts or the whole server is unstable or broken. Things are under development there. On the other hand, the server Gingo is a clone of Atys server. It is a place where everything supposed to be working and final testing of changes is being made there. We use this server for final testing, to see how will changes in future patch really impact the Live game server and game clients. This document also operates with the term "Live server" or just "Live" which are just other (internal) names of the Atys server. Beta testing on Atys, alias Atys BETA, is a testing on server Atys with beta updates enabled.

==Combinations==
There exist several combinations of your platform and ways of your Ryzom client installation. This document describes as many as possible of them, however the basic is same in all cases. You need to create a copy of your client files for each server and then adjust its configuration a bit for each server.

===Using Steam===
Steam platform is one of ways how to install the Ryzom client. It is possible to configure such client to access Yubo or Gingo server, however updates are distributed via Steam. That means such client will never get frequent updates directly from testing servers and you will not be able to perform any tests, along with possible other issues.
It is possible to add clients for Yubo and Gingo directly to Steam and this feature is planned, however it will require time and resources that the Ryzom team does not have at this moment. Your only current option is to install another non-steam client, static or using Ryzom Installer. Please choose one way and then continue with appropriate configuration details described in this document.

====Running the client with Steam====
After you complete configuration of your clients, static or installed with Ryzom Installer, you can use the Steam ability to become a launcher of non-steam games. You need to perform following steps for both clients:

*Start the Steam platform client if not running already
* Find and click "+ ADD A GAME" in bottom-left corner of the window
* Choose "Add a Non-Steam Game" from its context menu
* Ignore the list of applications and click "BROWSE..." button below
*Navigate to folder with desired client files and change the "File type" option on bottom to "All files"
*Choose the Ryzom client binary (for example "ryzom_client_r2.exe" on Windows or "ryzom_client" on unix-like systems) and click "OPEN" button
* A new line has been added and pre-selected in the list of applications, click "ADD SELECTED PROGRAMS"

A new record was created in your games Library. Right-click it and select Properities to change its details like name or icon.

===Using App Store===
App Store is one of ways how to install Ryzom client on macOS operating system. It is possible to configure such client to access Yubo or Gingo server, however updates are distributed via App Store. That means such client will never get frequent updates directly from testing servers and you will not be able to perform any tests, along with possible other issues. Your only current option is to install another client in different way, static or using Ryzom Installer. Please choose one way and then continue with appropriate configuration details described in this document.

===Using Ryzom Installer===
If you are not using the Ryzom Installer or you are going to configure testing servers manually, you can skip this chapter. To see your Ryzom Installer version, start the application and select Help > About… from the application main menu. Ryzom Installer version older than 3.5.0.9665 do not include settings for testing servers by default.
Before you continue you should update your Ryzom Installer to latest version. You can download its current binary from download.ryzom.com or check if there is any newer version along with your Live client, in the default profile sub-folder, usually at <path_to_ryzom_root>/0/, see default installation paths described in chapter about manual installation. Other option is to combine instructions described in Using Ryzom Installer with GUI and Manual installation with Ryzom Installer or simply follow just instructions for manual installation.

===Using Ryzom Installer with GUI===
Ryzom Installer is a small tool that helps you to install and manage your Ryzom clients. This chapter describes how to setup Yubo and Gingo clients using its user interface. It is expected that you have installed Live client on your system already. Please make sure you are using latest version of the Ryzom installer (>= 3.5.0.9665) that has testing servers configuration included already. Otherwise you need to update your Ryzom Installer version first or define those servers manually in the installer configuration, as described in Manual installation with Ryzom Installer.

====New profiles and separated clients====
It is recommended to have separate clients for each server while mixing patches between more servers might cause troubles. The Ryzom installer will do the most of work automatically for you. Start the Ryzom Installer tool, open Settings from main window menu. There is a list of current profiles on left and selected profile options on right. Click the Add button below the list of profiles to create new and you can start editing its configuration. You will need to create three new profiles, one for Yubo, one for Gingo and one for Atys BETA, along with the normal Atys one you already have there by default. Following list describes each of configuration options.

====Atys BETA client files====
There is no support for beta updates in the current version of Ryzom Installer. You need to create a separated copy manually. Create Yubo and Gingo profiles first, save changes and quit Ryzom Installer. Then go into <code><path_to_ryzom_root></code> and copy "ryzom_live" to "ryzom_beta". Then Start the Ryzom Installer again and create 4th profile for Atys BETA.

:'''Profile''': This option can't be changed. It is a profile ID and is used as a profile subdirectory name.
:'''Name''': Enter any name that will help you identify the profile. This name will be displayed as one of items in the drop-down menu of the main Ryzom Installer window.
:'''Server''': Here you will select the server type. This option will cause that the profile will contain all necessary options for specific server. Choose "Atys" for Atys BETA client profile.
:'''Executable''': This option points to the client executable file and is optional for those who will use non-default client installation location, otherwise just leave it as it is. For the Atys BETA client locate its binary in the <path_to_ryzom_root>/ryzom_beta/ manually using Browse button.
:'''Arguments''': This field can be used to pass arguments to the game client like your login, password and character slot number to use. This is optional and you can leave it blank.
:'''Comments''': You can insert any profile comments you wish here.
:'''Directory''': Displays the path to specific installer profile settings. It was set and subdirectory created along with new profile and its name is based on Profile ID.
:'''Language''': Here you can specify which translation will be used for the client when starting from this profile. If not set, English will be used.
:'''Create shortcuts''': These are additional installer profile options that are not important for the client setup itself.

Once you are done with profiles configuration, click Ok button on bottom right to save changes. It might take some time because the Ryzom Installer will create and configure two new profiles. Those will appear in the drop-down menu on main Ryzom installer window after it is completed.

====Atys BETA options====
Option to adjust Atys BETA client is not available to manage using the Ryzom Installer and you need to edit the profile config file manually. Start Atys BETA client first using the Ryzom installer, this will actually create profile files. Close the Ryzom Installer. Open client.cfg file in <path_to_ryzom_root>/3/ folder to edit and add following code at the end of the file:
Application = { "ryzom_beta", "./client_ryzom_r.exe", "./" };
Now look for RootConfigFilename optionand replace "ryzom_live" with "ryzom_beta" in the path. Save the file. The 4th profile will now accept beta updates for server Atys.

====Running the client====
Now you should have three clients set up, one for the Yubo server, one for the Gingo server and one for Atys BETA, along the default Atys profile. Start the Ryzom Installer and use the drop-down selection on bottom of the main window to choose which profile (and client) you wish to use.

===Manual installation with Ryzom Installer===
Ryzom Installer is a small tool that helps you to install and manage your Ryzom clients. This document describes how to setup '''Yubo''' and '''Gingo''' clients without user interface. It is expected you have installed Live client on your system already.

====Client files====
First step you need to do is to create a copy of your Live client files. It is recommended to have separate clients for each server while mixing patches between more servers might cause troubles. Close the Ryzom installer and Ryzom client, in case it is running, open the installation folder and copy the sub-folder "ryzom_live" to "ryzom_dev" to use as a client of the Yubo server. Then create another copy called "ryzom_test" to use as a client of the Gingo server. Then create the last copy called "ryzom_beta" to use as a client of the Atys server with beta updates enabled. 

Following list contains default installation paths of all three supported platforms as well as paths where Ryzom Installer profiles are stored. <br />
The "~" path prefix is an unix alias for user home directory, for example "<code>/home/user</code>". <br />
<code>%AppData%</code> is the variable name for the application data directory under modern Windows systems, for example "<code>C:\Users\%username%\AppData</code>". More detailed information about system paths is described by the [[Ryzom location]] article on the Ryzom Wiki.
{| class="wikitable"
|-
! System !! Default client installation !! Ryzom Installer profiles location
|-
| Windows XP || <small><code>C:\Documents&nbsp;and&nbsp;Settings\{user}\Local&nbsp;Settings\Application&nbsp;Data\Ryzom\</code></small> || <small><code>C:\Documents&nbsp;and&nbsp;Settings\{user}\Local&nbsp;Settings\Application&nbsp;Data\Ryzom\</code></small>
|-
| Windows Vista/7/8/10 || <small><code>%AppData%\Local\Ryzom\</code></small> || <small><code>%AppData%\Roaming\Ryzom\</code></small>
|-
| Linux || <small><code>~/.local/share/Ryzom/</code></small> || <small><code>~/.local/share/Ryzom/</code></small>
|-
| MacOS || <small><code>~/Library/Application Support/Ryzom/</code></small> || <small><code>~/Library/Application Support/Ryzom/</code></small>
|}

====Server connection====
This step applies only when you are using older version of the Ryzom installer. With version 3.5.0.9692 or newer, both testing servers are already part of installer configuration, however not for Atys with beta updates. In case you want or must use the older installer, you need to define two new servers in the <code>ryzom_installer.ini</code> file which is stored along your client installations. <br />
Open the file in a text editor, locate end of section <code>[server_0]</code> and insert following block right after end of the the section, before the <code>[servers]</code> section:
 [server_1]
 client_download_filename=ryzom_live_client_$ARCH.7z
 client_download_url="http://download.ryzom.com/ryzom_live_client_$ARCH.7z?r=&ts=$TIMESTAMP"
 client_filename_linux=ryzom_client
 client_filename_old_linux=
 client_filename_old_windows=client_ryzom_rd.exe
 client_filename_osx=Ryzom.app/Contents/MacOS/Ryzom
 client_filename_windows=ryzom_client_r.exe
 comments=Dev server
 configuration_filename_linux=ryzom_configuration_qt
 configuration_filename_osx=Ryzom.app/Contents/MacOS/RyzomConfiguration
 configuration_filename_windows=ryzom_configuration_qt_r.exe
 data_compressed_size=1500000000
 data_download_filename=ryzom_live_data.7z
 data_download_url="http://download.ryzom.com/ryzom_live_data.7z?r=&ts=$TIMESTAMP"
 data_uncompressed_size=7000000000
 display_url="http://app.ryzom.com/app_releasenotes/index.php?lang=$LANG"
 files_list_url="https://sourceforge.net/projects/ryzom/rss?path=/installer"
 id=ryzom_dev
 name=Yubo
 
 [server_2]
 client_download_filename=ryzom_live_client_$ARCH.7z
 client_download_url="http://download.ryzom.com/ryzom_live_client_$ARCH.7z?r=&ts=$TIMESTAMP"
 client_filename_linux=ryzom_client
 client_filename_old_linux=
 client_filename_old_windows=client_ryzom_rd.exe
 client_filename_osx=Ryzom.app/Contents/MacOS/Ryzom
 client_filename_windows=ryzom_client_r.exe
 comments=Test server
 configuration_filename_linux=ryzom_configuration_qt
 configuration_filename_osx=Ryzom.app/Contents/MacOS/RyzomConfiguration
 configuration_filename_windows=ryzom_configuration_qt_r.exe
 data_compressed_size=1500000000
 data_download_filename=ryzom_live_data.7z
 data_download_url="http://download.ryzom.com/ryzom_live_data.7z?r=&ts=$TIMESTAMP"
 data_uncompressed_size=7000000000
 display_url="http://app.ryzom.com/app_releasenotes/index.php?lang=$LANG"
 files_list_url="https://sourceforge.net/projects/ryzom/rss?path=/installer"
 id=ryzom_test
 name=Gingo

As you can see, the configurations are almost the same. Server one operates with "ryzom_dev" (Yubo),  Server 2 with "ryzom_test" (Gingo) and the last one  (server 0) with "ryzom_live" (Atys BETA). Also server names differ. Next go to [servers] section and change the value of size to number 3. It will look like this:
 [servers]
 default=0
 size=3

====Profile configuration====
You have two exactly same copies of the ryzom client now, one for each server. You also have new servers defined in installer configuration. Now you need to create two new installer profiles. These steps will lead to same results as when using the GUI, however you will create new profiles, one for Yubo and one for Gingo, manually. <br />
Open the folder with Ryzom Installer profiles. You will find a folder called "<code>0</code>" there. Create a copy with name "<code>1</code>" for your Yubo client and another with name "<code>2</code>" for your Gingo client. Then create the last one "<code>3</code>" for the client of Atys with beta updates. The next step is to create configuration for all three new profiles, "1", "2" and "3", so the installer can find them.

Open <code>ryzom_installer.ini</code> file for editing, it is located in the same folder, and scroll to locate end of section <code>[profile_0]</code> . Then insert following block of text right after it, before the section <code>[profiles]</code>:
 [profile_1]
 arguments=
 comments=Development server
 desktop_shortcut=false
 executable=
 id=1
 menu_shortcut=false
 name=Ryzom (Yubo)
 server=ryzom_dev
 
 [profile_2]
 arguments=
 comments=Testing server
 desktop_shortcut=false
 executable=
 id=2
 menu_shortcut=false
 name=Ryzom (Gingo)
 server=ryzom_test
 
 [profile_3]
 arguments=
 comments=Atys with beta updates
 desktop_shortcut=false
 executable=
 id=3
 menu_shortcut=false
 name=Ryzom (Atys BETA)
 server=ryzom_live

In case your client files are not saved in default path, you need to insert full path to client binary into the executable option. For Yubo client in <code>[profile_1]</code> section (with client located in ''ryzom_'''dev''' folder''), for Gingo client in <code>[profile_2]</code> (with client located in ''ryzom_'''test''' folder'').

As next go to [profiles] section and change the value of size to number 3. This says how many profiles is present. It should look like this now:
 [profiles]
 default=0
 size=3

====Special client option====
The last thing you need to do is to edit each client configuration file and add special option so the client knows you wish to connect to a specific non-public server. Configuration of clients using the Ryzom installer is pre-configured to have custom configuration file included. Additional client configuration is stored in Ryzom Installer profiles location.

=====Yubo client configuration=====
Navigate to the Yubo profile folder "<code>1</code>" in Ryzom Installer profiles location and open <code>client.cfg</code> file for editing. Then add following block to the end of the file:
 Application          = {
      <span style="color: red;">"ryzom_dev", "./client_ryzom_r.exe", "./" </span>
 };

=====Gingo client configuration=====
Navigate to the Gingo profile folder "<code>2</code>" in Ryzom Installer profiles location and open <code>client.cfg</code> file for editing. Then add following block to the end of the file:
 Application          = {
     <span style="color: red;">"ryzom_test", "./client_ryzom_r.exe", "./" </span>
 };

=====Atys BETA client configuration=====
Navigate to the Atys BETA profile folder "<code>3</code>" in Ryzom Installer profiles location and open <code>client.cfg</code> file for editing. Then add following block to the end of the file:
 Application          = {
     <span style="color: red;">"ryzom_beta", "./client_ryzom_r.exe", "./" </span>
 };

====Running the client====
Now you should have two client set up, one for the Yubo server, one for the Gingo server. Start the Ryzom Installer and use the drop-down selection on bottom of the main window to choose which profile (and client) you wish to use.

===Static client===
It is not required to use the Ryzom Installer to use the Ryzom client. This document describes how to setup both testing servers manually without any use of the Installer. It is expected that you have a static Live client installed on your system already.

====Client files====
The first step you need to do is to create a copy of your Live client files. It is recommended to have ''separate'' clients for each server while mixing patches between more servers might cause troubles. There is no default installation path for the static client.

Find the folder where is your Live client installed (for example "<code>C:\Games</code>" or "<code>/opt</code>") and copy the whole game folder (for example "<code>C:\Games\Ryzom</code>" or "<code>/opt/ryzom</code>") to "<code>ryzom_dev</code>" in same folder. This installation will be used to connect to the '''Yubo''' server. Then create another copy in same folder called "ryzom_test", this one will be used fot the '''Gingo''' server.

====Special client option====
The next thing you need to do is to edit each client configuration file and add special option so the client knows you wish to connect to a specific non-public server.

Yubo client configuration
Navigate to the root folder of your Yubo client installation, for example "<code>C:\Games\ryzom_dev</code>" or "<code>/opt/ryzom_dev</code>" and open the <code>client.cfg</code> file for editing. Scroll to the end of the file and add following block of text:
 Application          = {
     <span style="color: red;">"ryzom_dev", "./client_ryzom_r.exe", "./" </span>
 };

=====Gingo client configuration=====
Navigate to the root folder of your Gingo client installation, for example "<code>C:\Games\ryzom_test</code>" or "<code>/opt/ryzom_test</code>" and open the <code>client.cfg</code> file for editing. Scroll to the end of the file and add following block of text:
 Application          = {
     <span style="color: red;">"ryzom_test", "./client_ryzom_r.exe", "./" </span>
 };

=====Atys BETA client configuration=====
Navigate to the root folder of your Atys BETA client installation, for example "<code>C:\Games\ryzom_beta</code>" or "<code>/opt/ryzom_test</code>" and open the <code>client.cfg</code> file for editing. Scroll to the end of the file and add following block of text:
 Application          = {
     <span style="color: red;">"ryzom_beta", "./client_ryzom_r.exe", "./" </span>
 };

====Running the client====
Now you should have two client set up, one for the Yubo server, one for the Gingo server. To start the Yubo client, navigate to your "ryzom_dev" folder and start the client binary, for example "<code>C:\Games\ryzom_dev\ryzom_client_r.exe</code>" or "<code>/opt/ryzom_dev/ryzom_client</code>".
To start the Gingo client, navigate to your "<code>ryzom_test</code>" folder and start the client binary, for example "<code>C:\Games\ryzom_test\ryzom_client_r.exe</code>" or "<code>/opt/ryzom_test/ryzom_client</code>".
Another option is to create main menu / desktop shortcuts to start the right binary from the right folder for each client.

==Closing tips==
It is recommended to use separate clients for each server. It is possible to configure one client to be able to access all three servers, however different updates for each server might break your client or bring other troubles.

Yubo and Gingo are getting non-production client updates and things might go wrong time to time. A good practice is to keep one another separated copy with fresh Ryzom Installation (along Atys, Yubo and Gingo server) that you can use to quickly restore a broken client. Just make sure you back-up your configuration and character-related files before you replace the broken copy. The Ryzom installer makes things easier.
<br />
<br />
<br />
————————
<references/>
<br />
<br />
{{Portal|Forge}}
[[Category:Test|Test team]]
[[Category:Tutorials|Test team]]
[[Category:Testing Team]]
[[Category:Ryzom Team]]
[[Category:Test]]
[[Category:Tutorials]]