This document shortly describes all necessary steps you need to perform to make all supported applications fully work. Consider reading of the Terminology document to understand some terms that are used in the following text.
All following applications are available in the AppZone and share some of your user settings as well as your API key:
- Book of Guilds, a role-play interface to RyGReg database
- BagApp, an application to work with your inventories using the Ryzom API
- DeepList, a tool to manage database of terms that are used to correct DeepL translation in-game
- Fame Tracker, an application to track progress of your character fame using the Ryzom API
- Lang App, a tool to manage localisation of all these tools
- Letter App, a tool to create letter for role-play purposes, build up on BagApp and Level Tracker data
- Level Tracker, an application to track progress of your character skills
- My Guild, an application to help with guild management, build up on BagApp, Level Tracker and RyGReg data
- RyGReg, a tool to manage database of Atys guilds using the Ryzom API
- Watchdog, small tool to verify your authentication
Step 1: Install the application |
|
As first you need to navigate to the AppZone and install desired application. It can be done via installation script which is usually linked in the application thread on Ryzom forum.
Your other option is to use the AppZone list where you can use checkboxes to enable the application in-game and out-game.
- WEB - check this to show the application on HOME when used in regular browser
- IG - check this to show the application on HOME / AppZone bar in-game
- Dynamic Icon - check this to allow application icon being updated, this way can applications notify you about updates
More about the Dynamic Icon |
|
Consider to enable this feature so BagApp can notify you about inventory cache updates, Fame Tracker about your fame progress, Level Tracker about your skill progress and My Guild about Guild Watchdog updates. Otherwise the dispalyed information might be outdated.
The Dynamic Icon will show you number of notifications in right bottom corner of the application icon. Its background follows usual Color codes:
- Green represents successfully performed updates, for example inventory cache, fame, skill level, database of guilds.
- Blue represents new detected changes in case an automatic update is locked, for example expired inventory cache, fame update, skill level update, watchdog tracking updates.
- Yellow represents that there were some warnings and you should read the Operations log, in case it is enabled (see later). This is not common situation.
- Red represents that there were an error and you should read the Operations log, in case it is enabled (see later). This is not common situation.
Step 2: Run the application |
|
Once you enabled/installed the application from the AppZone, you can run it from your HOME / AppZone bar by clicking on its icon. Other way is to use the command /appzone followed by application AppZone ID, for example /appzone 2594 command will start My Guild application.
If you run one of supported applications for the very first time, you will see the Your first run page. It is sort of welcome screen from where you can set some of your preferences. Set your preferences and save the data to create your character profile. You can return to this page any time in the future, however full settings will give you more power. The only exception is the Book of Guilds which is using just a limited set of profile options.
All supported applications have a wide set of options in attempt of large customization. There are basically two types of options, character profile settings that are shared between all applications and Form/Filter options that store various customisations and are used only when needed. Please read the User Interface document to learn basics about application workspace organization. Profile settings are shared for all supported application and allow you to also purge stored private data. Navigate to your character profile by clicking on Me in User menu. Then click ⚒ Settings link in the Right section menu. Please read User settings document to learn more about all available settings.
Step 4: Application customization |
|
The general Customization set of Form/Filter options for each application is accessible either from your character profile page or application About page.
- Navigate to your character profile by clicking on Me in User menu. Then click ☑ Customization link in the Right section menu.
- Navigate to application About page and click ☑ Customization link in the Right section menu.
Customization options are used only by its application. Specific set of options might differ between applications, however all groups are similar:
- Start options affect the application start and allow you to enable or disable selected automatic functions. Some of these options are also available in your profile settings to make it more accessible.
- Cache options contain options related to data cache managements. It is possible to set inventory cache lifetime here, however not all applications have such options.
- Operations log allows you to set options related to notifications sent by the application. In case you disable saving log messages you will be unable to see history like Dynamic Icon notifications.
Various scripts and functions are customizable via own local options. Link to those options is usually in the Right section menu and marked with icon ☑. To see all existing sets visit ☑ Forms and filters page. All Form/Filter options are managed automatically by the system and in case you remove them along with your private data, the options with its default setting will be created in the moment when it is requested.
Some nice features can be done based on data available using an API key. To create your character API key that you can use in supported applications please open your HOME and run Ryzom API application. Click the Add new key button, set new key options and enable desired modules and then click to Add button. Please consider to enable following modules to make all supported applications fully work:
- A01 so BagApp and MyGuild can see your animal details
- A03 so BagApp and MyGuild can see your animal inventory
- C01 so Fame Tracker and Letter App can see your character allegiance
- C04 so BagApp, Letter App and MyGuild can see your character inventory
- C06 so BagApp and MyGuild can see your character resale
- P01 so Fame Tracker and Letter App can see your character fame
- P02 so Level Tracker, Letter App and My Guild can see your character skill levels
- P06 so Level Tracker and Letter App can see your character occupation levels
When you have a character API key, a 41 characters long string starting with the letter c, copy it into clipboard using Ctrl+C shortcut. Open your profile ⚒ Settings and insert the key into the proper input field using Ctrl+V shortcut. Another way to insert your key appears when you try to use application feature that works with API data. In case the key or required module is missing, the system will ask you to insert a valid API key.
All documents