Latest revision as of 15:50, 7 June 2018

À revérifier par rapport à la version anglaise maintenue à jour

Remarque importante

Pour avancer la documentation et permettre une rapide traduction et maintenance, car ARK est en toujours en évolution, la référence est désormais en anglais et la partie française n'est momentanément plus suivie.

Manuel d’utilisation de l' A.R.C.C.

• Volume I : Guide de démarrage rapide (Quick Start Guide)
• Volume II : Guide d'utilisation
• Volume III: Guide d'utilisation avancée

L’A.R.C.C.

Ce guide a pour but d’indiquer comment se servir de l’A.R.C.C., l’Advanced Ryzom Content Creator. L’A.R.C.C. 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

ARCC Loggin window

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 anima­teurs, 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).

Dossiers et events

Ouverture

Dès la connexion, l’utilisateur se trouve sur une page offrant l’accès aux différents élé­ments de l’ARCC.

1st page window

L’ARCC se présente comme un ensemble d’events rassemblés dans des dossiers.

Chaque dossier peut contenir des events ou des dossiers, ce qui peut donner une ar­borescence plus ou moins profonde.

• La zone 1 permet de naviguer dans cette profondeur.

	La racine est représentée par une petite icône de « maison » . La « maison » est le premier dossier, qui contient tout les autres éléments, events et dossiers.
	En général, les dossiers sont représentés par des icônes de classeurs (les deux derniers dans l’exemple ci-dessus). Certains dossiers importants sont dotés d’une icône spécifique.
	Les events sont représentés par l’icône de gauche.

• La zone 2 permet de créer un nouveau dossier ou un nouvel event.
  • Le premier 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 second champ est une liste de choix :
    • La valeur par défaut est Folder (Dossier).
    • Le second choix, en déroulant la liste, est Event.
  • Le troisième et dernier champ, add, est en fait un bouton. Cliquer dessus lance la créa­tion de l’objet. À noter que la touche <Entrée> est équivalente au bouton add.

• La zone 3 contient les objets, dossiers ou events, créés dans le dossier affiché dans la zone 1 (ici « maison »).

La navigation

Navigation successive windows

Cette zone 3 permet de naviguer dans l’arborescence. Dans l’exemple suivant, le dossier « TESTS » contient le dossier « bepock » qui à son tour contient le dossier « test ». Ce dernier contient un event « Event0 » qui se compose de plusieurs scripts. L'event est une «feuille» de l'arborescence parcourue par la navigation.

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 cinq zones.

La barre de navigation (Zone 1)

La zone 1 affiche l’emplacement de l’event dans l’arborescence des dossiers. Chaque lien cliquable permet de remonter dans le dossier désiré.

Le champ de création (Zone 2)

La zone 2 permet de créer un nouveau script ou une nouvelle base de données.

• Le premier 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 second champ est une liste de choix :
  • La valeur par défaut est Script.
  • Le second choix, en déroulant la liste, est Database.
• Le troisième et dernier champ, add, est en fait 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 3)

La zone 3 a deux utilitaires :

Paramètres de l'event

Le paramétrage

Traductions automatisées

Les traductions automatiques

Les scripts (Zone 4)

La zone 4 contient les scripts créés dans l'event affiché dans la zone 1 (ici « New Event »).

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.

À 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:

	Un script simple
	un script lié, c'est-à-dire, attribué à un PNJ

• Le statut du script représenté par une petite pastille colorée dont la signification est indiquée dans la partie inférieure de la fenêtre.

• Le nom du script. Cliquer sur le nom du script permet d’en visualiser et modifier le contenu selon les droits de l’utilisateur.
• Le nom de l’auteur de la création du script.
• Les actions possibles sur les scripts.

Les base de données (Zone 5)

La zone 5 affiche la liste des bases de données de l’event .

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'ARCC.

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’ARCC 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)

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

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

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

	soit d'éditer le script,
	soit de le relancer.

• 18) Chaque étape est avancée manuellement

	soit simplement, en cliquant sur l'icone d'avancement,
	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).

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

	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.
	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 »),

	puis en ajoutant,
	en retranchant,
	en déplaçant les fonctions,
	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

	Édition
	En test
	Actif sur Atys et Yubo
	Opérationnel et verrouillé
	Désactivé (à effacer)

Les droits et raccourcis associés

	Exécuter le script
	Visualiser et éditer le script en langage humain ou machine.
	Visualiser et éditer les droits d’accès et exécution.
	Affiche qui utilise le script
	Demande de destruction du script.
	Destruction du script.