Ryzom
ARK, présentation

De EncyclopAtys


en:ARK, quick guide
es:ARK, guía rápida
fr:ARK, présentation
 
UnderConstruction.png
Traduction à revoir !
Ne blâmez pas les contributeurs, mais venez les aider 😎
Texte de référence (original utilisé comme référence) :
Notes :
Important.png
Under Construction Panel.png !!! En travaux !!! Under Construction Panel.png
Il reste actuellement encore 72 articles en préparation dans la catégorie «WIP»
Article en préparation. Laissez l'auteur le terminer avant de le modifier.
La dernière édition était de Bepock le 05.03.2020.


Guide de l'utilisateur pour Ark, abréviation de Ryzom Arkitect.

Remarque de traduction: toutes les images sont des copies d'écran. Pour éviter de surcharger les données du Common, ces images sont faites de manière quasi aléatoire dans l'une des 5 langues du Wiki Ryzom.

L’ARK

ARK se lance à partir d'un navigateur (https://app.ryzom.com/app_arcc/) , éventuellement directement dans le jeu pour ceux qui sont autorisés.

Ce guide a pour but d’indiquer comment se servir de l’ARK, le Ryzom Arkitect. L’ARK est un outil permettant de créer des scripts qui seront interprétés par un ser­veur web et qui pourront interagir avec le serveur de Ryzom

Accès

Login

Login ARK

En haut, à gauche, des drapeaux permettent de choisir la langue de l’interface (ici, dans la vue, le français). Cette fenêtre de connexion est identique partout dans Ryzom. Il faut renseigner le premier champ avec son nom de PJ. Attention, pour les animateurs, c’est le nom de l’animateur et non le nom des personnages qu’il aurait pu créer dans le jeu (il a droit à 5 PJ dans le jeu, comme tous les joueurs).

Fenêtre d'accueil

Accueil ARK

La fenêtre présente un ensemble de zones d'activités qui seront détaillées par la suite.

Les dossiers

Mes events

My Events

L’ARK présente des ensembles de scripts, d'events et de dossiers rassemblés dans des dossiers. Dans l'exemple affiché ici, on peut voir que Mes events contient un sous dossier dans la première ligne nommé {* MY SPACE *}

Mon espace

MySpaceARK

Mon espace est un endroit où l'on peut stocker ses propres créations et ouitls.

Tous les éléments

All in ARK

Les deux dossiers précédents sont particulièrement utiles pour s'y retrouver aisément dans Tous les éléments développés par la communauté.

Les autres dossiers

Les autres dossiers catégorisent plus finement les scripts/events/dossiers en fonction de leur emploi. Ce sont:

À lancer après le reboot
Sripts à relancer obligatoirement après un reboot
Script admin
Spécifique admin système
Events actifs
scripts utilisés ou utilisables
Ryzhome
Patchlet
Encyclopédie
L'encyclopédie interne du jeu
Titres
Boutiques
Tags

Ouverture

1st page window

L’ARK se présente comme un ensemble d’events rassemblés dans des dossiers, nommé en haut à gauche de leur fenêtre respective.

Chaque dossier peut contenir des events, des scénarios, ou d'autres dossiers, ce qui peut donner une arborescence plus ou moins profonde. Ces éléments s'ajoute dans le dossier à partir du bouton en haut à droite. Le champ qui le précède contiendra le nom de l'objet sélectionné dans le menu qui lui est accolé à gauche (dossier, event ou scénario).

Le contenu de chaque élément est détaillé dans des lignes, découpées en colonnes détaillées ci-après:

Nom

Nom de l'élément appartenant au dossier.

Sur sa gauche les icônes de caractéristiques de l'objet.
User suit.png Personnel
event_on_yubo.png Sur Yubo
Sur sa droite, les icônes d'action possibles.
add_edit_16.png Traduisible, par défaut avec Deepl

Actions

tag_blue_edit.png Renommer
folder_go.png Déplacer
key.png Mettre les droits
delete.png Supprimer

Propriétaire

Propriétaire ou responsable du script

Auteurs

Ensemble des développeurs, scénaristes,...

Lecteurs

Lecteurs et testeurs

Rédacteurs

?

Exécuteurs

Qui peut lancer le script

Navigation

Navigation
  • Cliquer sur le nom de l'objet, permet de naviguer à l'intérieur de cet objet pour y voir ses éléments, dossiertag_blue_edit.png, scripttag_blue_edit.png...
  • Cliquer sur le chemin en en-tête de la fenêtre (ALL >> etc.) permet de remonter l'arborescence.

L'event

Event window

La fenêtre de l'event permet de gérer les scripts et les bases de données internes à cet event. Elle est divisée en trois zones verticales, et la dernière est divisée en sept colonnes.

La barre de navigation et ajout déléments(Zone 1)

À gauche, elle affiche l’emplacement de l'objet dans l’arborescence des dossiers/ensembles. Chaque lien cliquable permet de remonter dans le dossier désiré.

À droite, un ensemble de champs/boutons permet de créer un nouveau script, une nouvelle base de données, etc.

  • Le premier champ est une liste de choix. La valeur par défaut est Script.
  • Le second champ contiendra le nom de l’objet, de préférence en anglais pour les don­nées communes et de préférence sans caractères accentués ou spécifiques (â, ñ, ß...)
  • Le troisième est un bouton. Cliquer dessus lance la créa­tion de l’objet. À noter que la touche <Entrée> est équivalente au bouton add.

Utilitaires (Zone 2)

Paramètres de l'event

Table edit.png Le paramétrage

Traductions automatisées

Langs.png Les traductions

Les base de données

Script Liste des bases de données de l’event .

Les scripts (Zone 3)

La zone est divisée en 7 colonnes.

Nom

Cette colonne affiche le noms des commandes ARK utilisée dans le script . À chaque script est associé un ensemble d’indicateurs et d’actions. Listés ici dans l’ordre d’affichage de gauche à droite.

Le type de script
Script Un script simple
Linked Script un script lié, c'est-à-dire, attribué à un PNJ
Le statut du script

Il est représenté par une petite pastille colorée dont la signification est indiquée dans la partie inférieure de la fenêtre.

Red Orange Green Black
Le nom du script
WeADeleteItems
Cliquer sur le nom du script permet , selon les droits de l’utilisateur, d’en visualiser et modifier le contenu avec l'outil de commande ARK décrit dans Volume II : Guide d'utilisation à réécrire. Par exemple, WeADeleteItems.

Exécution

 
Uncompleted.png
Cette page est inachevée.
Ce qui suit est est en construction ou à compléter. Pour aider l'Encyclopatys, Discutez-en ou améliorez-la !.


Édition

Script_code code source
tag_blue_edit renommer
arrow_right déplacer
arrow_branch {clone}

Visualisation

Auteur

{Vouchers}

Désactiver

La partie inférieure contient la signification des pastilles colorées qui sont accolées aux scripts.

La partie médiane contient la liste des scripts associés à l’event.

  • Le nom de l’auteur de la création du script.
  • Les actions possibles sur les scripts.
Control_play Key Status_online Basket_put

Le script

Script window

Pour créer un script, il suffit de donner son nom dans le champ texte de la zone 2 de la page d’event et de taper <entrée> ou de cliquer sur le bouton « add ». La création du script ouvre la fenêtre suivante composée de cinq zones.

  • La zone 1 affiche l’emplacement de l’event dans l’arborescence des dossiers jusqu’à l’event qui contient les scripts en cours.

Chaque lien cliquable permet de remonter dans le dossier désiré.

  • La zone 2 permet de tester script.
  • La zone 3 permet de gérer le code source et l’historique des modifications.
  • La zone 4 affiche des informations complémentaires pour l’exécution du script.
  • La zone 5 gère la création proprement dite du script.

La méthode la plus rapide et la moins fatigante pour créer un script est de le copier à partir d’un autre qui ressemble à ce que l’on souhaite. Cette méthode est très pratique pour rapidement créer un script qui ressemble à un autre, mais il faudra apprendre à le modifier tôt ou tard... sinon à quoi serviraient deux scripts identiques au nom près ? Ce sera le volume II de ce manuel d'utilisation de l'ARK.

Event window

Commencer par créer le nouveau script avec les valeurs par défaut.

  • 1) Écrire le nom du nouveau script (« script1 » dans l’exemple) ;
  • 2) s’assurer qu’il s’agit d’un script (valeur par défaut) ;
  • 3) cliquer sur « add » ou taper <enter>.
Event window
  • 4) et 5) Le nouveau script est ajouté à la liste.
  • 6) Pour l’exemple, imaginons que l’on veuille recopier « Script2 » dans « Script1 ».

Ouvrir le script que l’on souhaite copier.

Il suffit de cliquer sur le lien « Script2 », de l’exemple, ce qui ouvre la fenêtre de script.

Script window

Ce qui apparaît n’est pas des plus exploitables pour un copié/collé.

  • 7) Cliquer sur « View Source Code » pour afficher le code source.
Script window

C'est mieux mais...

  • 8) Cliquer sur « Base64 » pour avoir un affichage compact du code généré.
Script window

L’affichage correspond à un fichier aisément copiable (Jeu de caractères ASCII impri­mables). Pour le copier il suffit de le stocker dans un presse-papier par une méthode quelconque, par exemple : cliquer dans le texte (pour positionner le focus), puis taper <Ctrl>+A, <Ctrl>+C sur Windows et la majorité des Unices (Unix, Linux, BSD, Androïd...). Attention ! Si vous ne cliquez pas sur le texte, vous risquez de sauvegarder la fenêtre en entier avec ses icônes... ce qui n’est pas utile. Remplacez <Ctrl> par <Pomme> sur Mac.

  • 9) Une fois la copie faite, cliquer dans le chemin pour retrouver le script fraîche­ment créé (« Script1 » stocké dans « Event0 » de notre exemple)

Remplir le nouveau script.

On rejoue les séquences 6 à 8 avec « Script1 »

  • 6) ouverture du script
  • 7) affichage du source
  • 8) affichage du source en Base64

À ce niveau, cliquez dans le texte déjà présent (pour positionner le focus) et sélection­nez-le complètement (par exemple : en tapant <Ctrl>+A sur Windows et Unices) pour le remplacer par le texte mémorisé dans le presse-papier (par exemple, en tapant <Ctrl>+V). Quand le texte a été remplacé ; le sauvegarder :

Script window
  • 10) Enregistrer son travail en cliquant sur le bouton Envoyer (Submit).

Le « Script1 » est maintenant une copie du « Script2 »

Les bases de données

Event window

Les bases de données de l’ARK servent à stocker des informations comme le nombre de MP d’un certain type récupéré par un certain joueur. Ce sont en quelque sorte des ta­bleaux simples et dénués de fonctions et de relations complexes comme dans les ta­bleurs ou les bases de données relationnelles.

DB window

Si aucun nom n’est donné lors de la création de la DB, celle-ci est néanmoins préparée (icône de DB sans nom à droite). Il est toujours possible de renommer une DB. Atten­tion ! Ce renommage n’est pas répercuté dans les scripts qui font appel à cette base.

DB window

Initialement, la création d'une base de données se présente comme suit :

  • 1) Name : Nom ré-éditable de la base de données.
  • 2) Use View :Contexte de la base de donnée. Ce contexte peut être:
    • Player
    • Global
    • Civ
    • Cult
    • Organization (Faction)
    • Other
  • 3) Number of Rows :Nombre de données ??? (colonnes???)
  • 4) Le contenu (vide à la création).
DB window

L'exemple courant donnera la DB suivante, où:

  • 1) Le nom est donné, ici TestDB.
  • 2) La vue à utiliser, ici Global.
  • 3) Le nombre de données, ici 10.
  • 4) Cette valeur fait apparaître le nombre correspondant de champs (10).

Ces champs peuvent être nommés pour en facilité l'exploitation dans les scripts qui feront appel à ces données.

  • 5) Les modifications doivent être soumises pour être mémorisées.
Script window

Le remplissage de la base se fait par un script, comme montré ici sur l'image de gauche. L'écriture d'un tel script sera détaillée dans le « Volume II : Manuel du joueur ».

Script window

Lorsque cette fonction a été activée, la base de données affiche le contenu comme celui-ci.

  • 6) Une ligne de données (n° 1) a été créée.
  • 7) Une valeur (64) a été attribuée à une colonne (Psi).
  • 8)
Script Une icône en bas indique que l'on peut modifier manuellement les données.

L’exécution

Script window

Nous décrirons tout d'abord les paramètres qui influencent l'exécution du script (de 7 à 16).

Les paramètres d'exécution

Event window
  • 7) Nom du script tel qu'il apparaît dans l'event (ici : « ResidentMaduck »).
IG window
  • 8) {WindowTitle} Titre de la fe­nêtre WebIG (ici : « Unit test: May the Force be with you. »)
  • 9) Hide during launch : Masquer au lancement (Oui/Non)
  • 10) Require validation : Néces­site une validation (Oui/Non)
  • 11) {singleInstance} (Oui/Non)
  • 12) {resetAtStart} (Oui/Non)
  • 13) {updateStagesInDb} (Oui/non)
  • 14) {missionTimeout} (Unités)
  • 15) {replayTimer} (Unités)
In Game
  • 16) Name of action of NPC : Nom de l'action du PNJ

Test dans le navigateur

Top Left Creation Window
Script On peut commencer à tester le script dans le navigateur en cliquant sur (1) dans le navigateur.

Cela permet de tester en grande partie le déroulement du script surtout en ce qui concerne les algorithmes et les affichages. Il faut néanmoins faire attention à l'affichage qui ne correspond pas nécessairement entre le Web et le WebIG. En effet, certaines balises html ne passent pas dans ce dernier. Par exemple, la balise <hr/> (horizontal rule) n'apparaît pas en WebIG, ou le <br/> (line break). C'est pourquoi, il est préférable d'utiliser le bbcode.

En conclusion, le lancement du script dans un navigateur ne doit pas servir pour vérifier la présentation des affichages.

Le pas à pas

Bug go.png Si un problème d'exécution apparaît, il peut être utile de tester le déroulement. Dans ce cas on clique sur (2). L'image suivante montre le résultat de l'exemple en cours :
Web
  • 17) À partir d'une exécution lancée sur le Web, il est possible
Script edit.png soit d'éditer le script,
Arrow refresh.png soit de le relancer.
  • 18) Chaque étape est avancée manuellement
Resultset next.png
soit simplement, en cliquant sur l'icone d'avancement,
Pazapa 1.png
soit en sélectionnant le choix proposé lorsqu'il y a branchement multiple.
  • 19) Les colonnes de droite indiquent le statut de chaque fonction du script.

Le Yubo

Pour tester le script en grandeur nature, il faut le lancer sur le serveur de test au petit nom de « Yubo ». Il faut pour cela se connecter sur le « Yubo » avec un compte autorisé, choisir un PNJ de préférence statique (pour ne pas courir derrière pour les tests) et, évidement libre (donc ne pas réutiliser un PNJ de missions pour ne pas se compliquer la vie).

Top Right Creation Window
In Game

Ici, nous avons sélectionné un garde en poste. Il affiche son mode d’interaction dans un cartouche : (« ATTAQUER » en français).

User go.png On lui assigne le script courant (ici, Unit_Test) en cliquant sur l'icone (3).

Le résultat de cette assignation n'est pas visible instantanément, même s'il elle est déjà effective. Pour la rendre visible rapidement, il suffit d'aller cliquer sur un autre PNJ, et de revenir ensuite sur celui-ci. On doit voir le cartouche qui a changé (ici : « Live long and prosper »). Le script peut être maintenant exécuté par le PNJ.

Modification et suppression

Top Right Create window
Script code.png Nous avons déjà vu comment utiliser la vue du code source (5) dans le chapitre 4, lorsqu'il s'agissait de copier/coller le contenu d'un script dans un autre.
Time.png Lorsque la modification est un échec, il est toujours possible de revenir à une version précédente en cliquant sur (6).
Script window

La manière la plus standard pour éditer un script reste en cliquant sur le titre du script (ici : « jumping »),

Add.png puis en ajoutant,
Delete.png en retranchant,
Arrow down.png en déplaçant les fonctions,
Arrow up.png et évidement, en modifiant le contenu des fonctions elles-même (ici : « weVMessage_v3_True ») ce qui sera l'objet du volume II.


Function part of script window

Remarque : l'icône d'effacement d'une fonction se trouve à droite de la fonction. L'effacement est instantané, sans fenêtre d'avertissement ou de confirmation. Mais rassurez-vous ! Vous avez l'historique qui vous permet de revenir en arrière.

Autres outils de l'Event

Le statut

Bullet red.png Édition
Bullet orange.png En test
Bullet green.png Actif sur Atys et Yubo
Bullet blue.png Opérationnel et verrouillé
Bullet black.png Désactivé (à effacer)

Les droits et raccourcis associés

Control play.png Exécuter le script
Script code.png Visualiser et éditer le script en langage humain ou machine.
Key.png Visualiser et éditer les droits d’accès et exécution.
Status online.png Affiche qui utilise le script
Basket put.png Demande de destruction du script.
Delete.png Destruction du script.


Last version 2020-03-05•