Creating a Client

Owned by Matthew Lagoe
Last updated: Jan 26, 2014

 

Config File Edits

After you have compiled your client you will need to make some changes to the network settings, this can be accomplished in 3 ways.

Simple Method

Add additional lines to your client.cfg located in the ryzom client folder.

You do not have to add all the below lines just the ones you want to change.

For example if you want your client to connect to myurl.ryzomcore.org you would add that line as a StartupHost

StartupHost = "myurl.ryzomcore.org:40916";
CreateAccountURL = "http://shard.ryzomcore.org/ams/?page=register";
EditAccountURL = "http://shard.ryzomcore.org/ams/?page=settings";
ConditionsTermsURL = "http://www.gnu.org/licenses/agpl-3.0.html";
ForgetPwdURL = "http://shard.ryzomcore.org/ams/?page=forgot_password";
LoginSupportURL = "https://plus.google.com/u/0/communities/103798956862568269036";

 

Advantages of this method:

  • Simple to configure
  • Doesn't require recompiling the client to make edits

Disadvantages of this method:

  • A malicious application can change your settings in a plain text file to anything they want potentially stealing passwords etc
  • You are not able to have users remove the client.cfg if they input bad settings without them connecting to the wrong server but the client will still run potentially causing confusion

Changing Defaults Method

Change the lines to your client_default.cfg located in the ryzom client folder.

You do not have to add all the below lines just the ones you want to change.

For example if you want your client to connect to myurl.ryzomcore.org you would add that line as a StartupHost

StartupHost = "myurl.ryzomcore.org:40916";
CreateAccountURL = "http://shard.ryzomcore.org/ams/?page=register";
EditAccountURL = "http://shard.ryzomcore.org/ams/?page=settings";
ConditionsTermsURL = "http://www.gnu.org/licenses/agpl-3.0.html";
ForgetPwdURL = "http://shard.ryzomcore.org/ams/?page=forgot_password";
LoginSupportURL = "https://plus.google.com/u/0/communities/103798956862568269036";

 

Advantages of this method:

  • The client will always use these settings even if the client.cfg is erased
  • Simple to configure
  • Doesn't require recompiling the client to make edits
  • You are able to have users remove the client.cfg to fix bad settings

Disadvantages of this method:

  • A malicious application can change your settings in a plain text file to anything they want potentially stealing passwords etc

Edit Defaults in the Code (For Advanced Users)

Edit the config in the cpp code located in "code/ryzom/client/src/client_cfg.cpp"

You will want to edit the configuration based on the values you want to change for example to hardset the CreateAccountURL you will edit the following line:


CreateAccountURL        = "https://secure.ryzom.com/signup/from_client.php";


Then you will set which versions of the client you want to read from the config.cfg file this is useful so developers can use a "dev" version and edit values in the cfg for testing without having to recompile.

To read from the cfg file always you would use
READ_STRING( CreateAccountURL)

To only read when compiled in "dev" mode you would add
READ_STRING_DEV( CreateAccountURL)

To read the cfg only when compiled in "Final Version" mode you would add
READ_STRING_FV(CreateAccountURL)


Advantages of this method:

  • The client will always use these settings even if the client.cfg is erased
  • A malicious application cant change your settings
  • You are able to have users remove the client.cfg to fix bad settings

Disadvantages of this method:

  • Requires recompiling the client to make edits
  • Required editing code
  • May cause merge issues when Ryzom Core code is updated


 

 

Patch Server


PatchServer = "";
PatchWanted = 0;
SignUpURL = "";