This article explains some of used terminology. You should browse it in case you are not sure about any term.
AFC / AFC Office / AFC Register |
|
AFC (Atys Filling Content) is role-play name of API. All derived collocation come from the idea of office and its bureaucracy thus AFC Office means the whole system of Ryzom API and AFC Register stands for guilds API that contains current list of guilds.
By Anonymous is called any user whose Atys character name is unknown. Such user is unable to personalize or customize the application. Sections that require authentication or any character API key are unavailable or do not provide character-specific information. Anonymous user is not part of any activity however triggers guilds database updates and guild members automatic updates.
API key gives access to selected character or guild data. Various parts (modules) could be included to provide various details. You can get (create) your character/guild API key using Ryzom API.
Different applications may require different key modules based on purpose. Open the About page (click on application name/icon in top left corner) to view which module is required and why. If an Authenticated user wants to use a feature based on character API key, he is prompted to insert a valid key which includes required modules. All guild API key modules are optional.
AppZone is Ryzom applications market that users can use to publish own tools or games related to Ryzom. It provides several services such as Authentication or Dynamic icons. You can install applications from AppZone or just use AppZone service to start the application.
By Authenticated is called every user whose character name is known and was validated against Ryzom server. You become authenticated in case you use already existing session (created by other application) or in case:
- You start the application from the AppZone using shortcut on your HOME page
- Starting the application using the AppZone service https://app.ryzom.com/index.php?action=launch_app&appid=<id>
- Starting the application using /appzone <id> command
Such user can fully personalize and customize applications. If the user is member of a guild, his presence is logged into guilds activity log every ~1 hour. Authenticated user can save own character API key and, in case updates are allowed and required API key is present, triggers own fame / level / occupation grade / inventory cache updates.
Cache / Cache update / Cache lifetime |
|
The Cache term is used to call all (user private) data that are kept in the database, including any history. It mostly covers data obtained from the Ryzom API but also all additional personalized details added by any of recognition systems. There are actually three reasons to cache data:
- Performance it is faster to query the local database cache than Ryzom server (which itself has Cache lifetime)
- With using a Cache you can prepare and customize data for user and save resources on loading string translations
- All applications running under same system may safely read user data from other applications (for example Bag App can get character's guild inventory as well as from all Alt guilds)
Cache update is triggered on demand every time when the current Cache data exceed its lifetime. Cache lifetime says how old the data in Cache might be and you can customize behavior of each application in its Customization options.
Dynamic Icon covers two features that are, in case of this application, integrated:
- In AppZone
Every application has Dynamic Icon option, turned off by default. If enabled (user has to set it manually) WebIG will periodically download the application icon. This opens a way how to deliver information to the user visually. If disabled, the icon is downloaded only once.
- On application side
The icon on this application side is generated by a script. If there are any new Operations log records, the number of new messages (usually Cache updates) is displayed in bottom-right corner with background along Operations log color codes.
Using together it also opens a way to track users activity and update guild activity log. Please note that in case you have this application installed from AppZone, the icon is downloaded as if you were Authenticated user.
Fameless is every organized group of homins to which players are unable gain or lost fame. Good example are bandit groups. Same for Neutrals and Rangers, they are groups that do not have own fame. And homin guilds and various organizations like Fortunate Gubani have no fame of course.
Fuzzy string means that the translation is not completed or not correct. It is usually marked with yellow color. These translations are saved in the database however not actually in use. Translators can mark a string as fuzzy in case they think the translation is not ready to use or to save not completed work. Also in case the string original is changed, all its translations to other languages are automatically marked as fuzzy.
By the term HOME, with all letters capital, is specifically called the title page of WebIG. The page that will appear if:
- You open https://app.ryzom.com/
- You press Shift+W in-game
- You click Home in right part of this application's main menu
- You press HOME button on any of your in-game windows (if displayed)
As Master (guild) is meant a guild to which some other (Slave) guild has declared own subordination. Master guild is able to see Slave guild inventory, in case a valid API key is saved in Slave guild profile.
Operations log is a name that covers the system of messages displayed to user (on screen, via Dynamic Icon) and its database back-end. This system was added so Dynamic Icons can share messages with the application itself and vice-versa. Logging is turned on by default however user can disable this feature in Customization options and remove all records in profile settings.
In case you turn this feature off you will be unable to see any messages related to operations performed on background. In most cases it covers Cache updates of inventory, fame or skill progress and your guild activity tracking.
A Slave guild is a guild that has declared itself as being mastered by other (Master) guild in RyGReg guild details. In case the Slave guild has a valid API key, the Master guild is allowed to browse the inventory.
This term covers all in-game web infrastructure like AppZone, calendar and integral (official) Ryzom tools you can start from your HOME page. 3rd party applications (like this one) can be a part via AppZone services.
All documents