Difference between revisions of "EN ARK basis user manual"

From Ryzom Forge Wiki

Jump to: navigation, search
m (Paragraphs 3 and 4)
 
(30 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
{{tabLang|EN|DE|{{FULLPAGENAME}}|ES|ARCC_intro_FR|RU}}
+
{{Migrated to|:en:ARK, quick guide}}
−
{{toTrad}}
+
{{tabLang|EN|ARCC_intro_DE|ARCC_intro_EN|ARCC_intro_ES|ARCC_intro_FR|ARCC_intro_RU}}
−
(Translation in progress)
 
  
−
<big>User manual for '''A.R.C.C.'''</big>
+
{{toTrad|DE}}
−
*[[ARCC intro EN|Part I: Quick Start Guide]]
+
{{toTrad|EN|To check the quality of the text itself}}
−
*[[ARCC Guide FR|Part II: User Guide]] ''(to be translated)''
+
{{toTrad|ES}}
−
*[[ARCC Expert FR|Part III: Advanced User Guide]] ''(to be translated)''
+
{{toTrad|FR|À corriger par rapport à l'anglais}}
−
==A.R.C.C.==
+
{{toTrad|RU}}
−
This guide aims at explaining how to use A.R.C.C., the Advanced Ryzom Content Creator.
+
 
−
A.R.C.C. is a tool that allows to create scripts that will be interpreted by a web server and will interact with Ryzom's server.
+
<big>'''User guide for Ark, short for Ryzom Arkitect.'''</big>
 +
 
 +
''For historical reasons, those manuals refers very often, almost always, to '''A.R.C.C.'''.
 +
''This is due to the fact that the full documentation has been started with the initial name, '''ARCC''', meaning '''A'''dvanced '''R'''yzom '''C'''ontent '''C'''reator.
 +
 
 +
*[[ARCC intro EN|Volume I : Quick Start Guide]]
 +
*[[ARCC Guide EN|Volume II : User guide]]
 +
*[[ARCC Expert EN|Volume III: Advanced user guide]]
 +
 
 +
==Ark==
 +
This guide aims at explaining how to use Ark, the Ryzom Arkitect tool that allows the creation of scripts interpreted by a web server and interacting with Ryzom's server.
  
 
== Access==
 
== Access==
 
<div style="overflow: hidden">
 
<div style="overflow: hidden">
−
[[File:ARCC Loggin.png|200px|thumb|left|ARCC Login window]]
+
[[File:Loggin_EN.png|200px|thumb|left|ARCC Login window]]
−
In the top left corner, flags allow to choose the language of the interface ''(current screenshots show French vue - to be changed whenever someone has time to do it)''.
+
In the top left corner, flags allow you to choose the language of the interface ''(current screenshots show French view - to be changed whenever someone has time to do it)''.
 
This login window is the same everywhere in Ryzom.
 
This login window is the same everywhere in Ryzom.
−
You'll have to fill the first field with your Character (PC) name. Beware, for animation team, it's the name of their animation toon, and not the one of the characters they could have created in the game (they are allowed 5 PC in game, as any player).
+
You'll have to fill in the first field with your Character (PC) name. Beware, for the animation team, it should be the name of their animation toon, and not the one of the private characters they could have created in the game (they are allowed 5 PC in game, as any player).
 
</div>
 
</div>
 +
 
==Folders and events==
 
==Folders and events==
 
===Open===
 
===Open===
−
As soon as login on, use finds a page offering access to various parts of the ARCC.
+
'''''((~This is going to have to be changed because of the selection panel that Ulukyn has made which is divided into different areas of the basic tree structure~))'''''
 +
As soon as login on, use finds a page offering access to various areas of the ARCC.
 
<div style="overflow: hidden">
 
<div style="overflow: hidden">
 
[[File:1stPage.png|200px|thumb|left|1st page window]]
 
[[File:1stPage.png|200px|thumb|left|1st page window]]
  
−
The ARCC appears like an ensemble of events gathered in folders.
+
The ARCC is laid out as an ensemble of events gathered in folders.
  
−
Each folder may contain events or folders, which can produce a tree view more or less complex.
+
Each folder may contain either events or other folders, which can produce a tree that is more or less complex.
 
</div>
 
</div>
−
*'''Zone 1''' allows you to navigate in this tree view.
+
*'''Zone 1''' and '''Zone 3''' allow you to navigate in this tree view.
 
{|
 
{|
 
|[[File:Fp_building.png|32px|Home]]
 
|[[File:Fp_building.png|32px|Home]]
−
|The root appears as a small «house» icon. The «house» is the first folder, the one that contins all other elements, events and folders.
+
|The root directory appears as a small «house» icon. The «house» is the first folder, the one that contains all other elements, events and folders.
 
|-
 
|-
 
|[[File:Folder.png|32px|Folder]]
 
|[[File:Folder.png|32px|Folder]]
−
|Generally, folders are represented with classical icons for folders (the last two ones in the example shown here above). Some important folders are bestowed a specific icon.
+
|Generally, folders are represented with classical icons for folders (the last two ones in the example shown here above). Some important folders are given a specific icon.
 
|-
 
|-
 
|[[File:Application_view_gallery.png|32px|Event]]
 
|[[File:Application_view_gallery.png|32px|Event]]
 
|Events are represented with the icon shown on the left.
 
|Events are represented with the icon shown on the left.
 
|}
 
|}
−
*'''Zone 2''' allows to create a new folder or a new event.
+
*'''Zone 2''' allows you to create a new folder or a new event in the displayed portion of Zone 1.
 
**The first field will contain the name of the object, preferably in English for common data, and preferably without accented or specific characters (â, ñ, ß...)
 
**The first field will contain the name of the object, preferably in English for common data, and preferably without accented or specific characters (â, ñ, ß...)
−
**The second fied is a list of values:
+
**The second field is a pulldown selection of options:
 
***Default value is ''Folder''.
 
***Default value is ''Folder''.
 
***Second choice, when reading down the list, is ''Event''.
 
***Second choice, when reading down the list, is ''Event''.
 
**The third and last field, ''add'', is actually a button. Click on it to start the creation of the object. Notice that hitting the <Enter> key is equivalent to clicking the ''add'' button.
 
**The third and last field, ''add'', is actually a button. Click on it to start the creation of the object. Notice that hitting the <Enter> key is equivalent to clicking the ''add'' button.
  
−
*'''Zone 3''' contains the objects, folders or events, which have already been created in Zone 1 (here «house»).
+
*'''Zone 3''' contains the objects, folders or events, which have already been created in a particular level in Zone 1 (here «house»). By selecting one of these you will see the contents of that folder or event.  You can back up in the directory tree by selection of a level in '''Zone 1'''.
  
 
===Navigation===
 
===Navigation===
Line 52: Line 63:
 
[[File:Navigation 1.png|200px|thumb|left|Navigation successive windows]]
 
[[File:Navigation 1.png|200px|thumb|left|Navigation successive windows]]
  
−
This '''zone 3''' allows to navigate through the tree view.
+
The '''Zone 3''' area allows one to navigate through the directory and event tree.
−
In the following example, the «TESTS» folders contains the «bepock» folder which, in turn, containts the «test» folder. This one contains one event («Event0») which consists of several scripts. The event is a «sheet» of the tree view browsed during the navigation.
+
In the example shown, the «TESTS» folder contains the «bepock» folder which, in turn, contains the «test» folder. This one contains one event («Event0») which consists of several scripts. The event is a «sheet» of the tree view browsed during the navigation. (NOTE: For illustration the windows of the browser have been overlapped to show the progress; your browser will only show one pane at a time.)  If you need to back up one or several levels you can click on the level you want to go to in '''Zone 1'''. 
 
</div>
 
</div>
 
<div style="clear: both"></div>
 
<div style="clear: both"></div>
 +
 
==Event==
 
==Event==
 
<div style="overflow: hidden">
 
<div style="overflow: hidden">
 
[[File:Event.png|200px|thumb|left|Event window]]
 
[[File:Event.png|200px|thumb|left|Event window]]
−
The event window allow to manage the internal scripts and databases of this event.
+
The event window is a specialized folder with a separate window.  The event window allows you to manage the scripts and databases of the event.
 
It is divided into five zones.
 
It is divided into five zones.
 
</div>
 
</div>
 
===Navigation bar (Zone 1)===
 
===Navigation bar (Zone 1)===
−
Zone 1 shows the place of the event in the folders tree view.
+
Zone 1 shows the place of the event in the folders tree.
−
Eack clickable link allows to go to the intended folder.
+
Each clickable link allows you to go to the specified folder (but remember to save your progress first).
 
===Creation field (Zone 2)===
 
===Creation field (Zone 2)===
−
Zone 2 allows to create a new script or a new database.
+
Zone 2 allows you to create a new script or a new database.
−
*The first field will contain the name of the object, preferably in English for common data, and preferably without accented or specific characters (â, ñ, ß...).
+
*The first field will contain the name of the object, preferably in English for common data, and preferably without accented or special characters (â, ñ, ß...).
−
*The second fied is a list of values:
+
*The second field is a pulldown list of values:
 
**Default value is ''Script''.
 
**Default value is ''Script''.
−
**Second choice, when reading down the list, is ''Database''.
+
**Second choice is ''Database''.
 
*The third and last field, ''add'', is actually a button. Click on it to start the creation of the object. Notice that hitting the <Enter> key is equivalent to clicking the ''add'' button.
 
*The third and last field, ''add'', is actually a button. Click on it to start the creation of the object. Notice that hitting the <Enter> key is equivalent to clicking the ''add'' button.
 
===Tools (Zone 3)===
 
===Tools (Zone 3)===
 
Zone 3 contains two tools:
 
Zone 3 contains two tools:
 
====Parameters of the event====
 
====Parameters of the event====
 +
'''''((This link does not yet point to anything substantial - Ceru 25 Sept 2014.))'''''
 
{|
 
{|
 
|[[File:Table edit.png |32px]]
 
|[[File:Table edit.png |32px]]
 
|[[ARCC paramètres|Set-up]]
 
|[[ARCC paramètres|Set-up]]
 
|}
 
|}
 +
 
====Automated translations====
 
====Automated translations====
 
{|
 
{|
 
|[[File:Langs.png |32px]]
 
|[[File:Langs.png |32px]]
−
|[[ARCC traductions|Automated translations]]
+
|[[ARCC traductions EN|How to do automated translations]]
 
|}
 
|}
 +
 
===Scripts (Zone 4)===
 
===Scripts (Zone 4)===
 
Zone 4 contains the scripts created in the event shown in zone 1 (here «New Event»).
 
Zone 4 contains the scripts created in the event shown in zone 1 (here «New Event»).
Line 91: Line 106:
 
The middle part contains the list of the scripts associated to the event.
 
The middle part contains the list of the scripts associated to the event.
  
−
To each script is associated an ensemble of indicators and actions, listed here bellow as they appear from left to right. ''(to be checked with the English version of the screenshots)''
+
To each script is associated a set of indicators and actions, listed here bellow as they appear from left to right. ''(to be checked with the English version of the screenshots)''
 
*Script type:
 
*Script type:
 
{|
 
{|
Line 108: Line 123:
 
|[[File:Bullet black.png|32px|Black]]
 
|[[File:Bullet black.png|32px|Black]]
 
|}
 
|}
−
*Name of the script. Clicking on the name of the script allows to see and update the content, accordingly to the users rights.
+
*Name of the script. Clicking on the name of the script allows one to see and edit the content, depending on the user's rights.
 
*Name of the author who created the script.
 
*Name of the author who created the script.
 
*Possible actions on the scripts.
 
*Possible actions on the scripts.
Line 123: Line 138:
 
|Zone 5 shows the list of the databases of the event.
 
|Zone 5 shows the list of the databases of the event.
 
|}
 
|}
 +
 +
==Script==
 +
<div style="overflow: hidden">
 +
[[File:ScriptWindow.png|200px|thumb|left|Script window]]
 +
To create a script, it is only required to give an name in the text field of Zone 2 of the Event page, and to hit <enter> or to click on the «add» button.
 +
Creating the script will open the following window, made op five zones.
 +
</div>
 +
*'''Zone 1''' shows the place of the event in the folders tree view down to the event which contains the current scripts.
 +
Eack clickable link allows to go to the intended folder.
 +
*'''Zone 2''' allows to test the script.
 +
*'''Zone 3''' allows to manage the source code and the history of updates.
 +
*'''Zone 4''' shows additional information about the running of the script.
 +
*'''Zone 5''' manages the actual creation of the script.
 +
 +
The quickest and least wearying method to create a script is to copy it from another one ressembling to what we want to produce. This method is very useful to create quickly a script that looks like another one, but you'll have to learn how to modify it sooner or later... otherwise, of which use would it be to have two script identical except for their names? That will be explaned in part II of the this user guide for ARCC.
 +
<div style="overflow: hidden">
 +
[[File:Hackers 1.png|200px|thumb|left|Event window]]
 +
'''Start with creating a new script with the default values.
 +
*'''1)''' Write the name of the new script («script1» in this example);
 +
*'''2)''' Check that it is indeed a script (default value);
 +
*'''3)''' Click on «add» or hit <enter>.
 +
</div>
 +
<div style="overflow: hidden">
 +
[[File:Hackers 2.png|200px|thumb|left|Event window]]
 +
*'''4)''' and '''5)''' The new script has been added to the list.
 +
*'''6)''' As an example, let's imagine that we want to copy «Script2» into «Script1».
 +
'''Open the script you want to copy.'''
 +
 +
It is only needed to click on the «Script2» link, in the example, which opens the script window.
 +
</div>
 +
<div style="overflow: hidden">
 +
[[File:Hackers 3.png|200px|thumb|left|Script window]]
 +
What appears isn't best fitted for a copy/paste.
 +
*'''7)''' Click on «View Source Code» to show the source code.
 +
</div>
 +
<div style="overflow: hidden">
 +
[[File:Hackers 4.png|200px|thumb|left|Script window]]
 +
It's better but...
 +
*'''8)''' Click on «Base64» to '''get a compact display''' of the generated code.
 +
</div>
 +
<div style="overflow: hidden">
 +
[[File:Hackers 5.png|200px|thumb|left|Script window]]
 +
The display is the one of a file that can easily been copied (ASCII printables characters). To '''copy''', just save it in the clipboard by any method, for example: click on the text (to place the focus), then hit <Ctrl>+A, <Ctrl>+C on Windows and most of the Unices (Unix, Linux, BSD, Androïd...). Beware! If you don't click on the text, you're at risk of saving the whole window with its icons... wich isn't much useful. Replace ''<Ctrl>'' with ''<Apple'>' on Mac.
 +
 +
*'''9)''' Once the copy done, click on the path to '''find the script newly created''' («Script1» stored in «Event0» in our example)
 +
</div>
 +
'''Fill the new script.'''
 +
 +
Replay sequences 6 to 8 with «Script1»
 +
*6) open the script
 +
*7) show the source
 +
*8) show the source in Base64
 +
 +
Then, click in the already existing text (to place the focus) and select it all (for example: by hitting <Ctrl>+A on Windows and Unices) to replace it with the text saved in the clipboard (for example, by hitting <Ctrl>+V). Once the text has been replaced, save it:
 +
 +
<div style="overflow: hidden">
 +
[[File:Hackers 6.png|200px|thumb|left|Script window]]
 +
*'''10)''' '''Save your work''' by clickin the Submit button.
 +
 +
«Script1» is now a copy of «Script2».
 +
</div>
 +
 +
==Databases==
 +
<div style="overflow: hidden">
 +
[[File:DBcreating.png|200px|thumb|left|Event window]]
 +
ARCC databases are used to store information such as the number of mats of a given type gathered by a given player. They're much lick simple tables and don't hold any function nore complex relationships such as the ones that can be found in spreadsheets or relational databases.
 +
</div>
 +
<div style="overflow: hidden">
 +
[[File:NewDB.png|200px|thumb|left|DB window]]
 +
If no name is given at the DB creation, this one will nonetheless be prepared (DB icon without any name on the left). it is always possible to rename a DB. Beware! This rename won't be passed on the scripts which call this base.
 +
</div>
 +
<div style="overflow: hidden">
 +
[[File:DBMaking.png|200px|thumb|left|DB window]]
 +
Initialy, creation of a database shows as follow:
 +
*'''1)''' ''Name'': Name of the database - can be modified.
 +
*'''2)''' ''Use View'': Context of the database. This context can be:
 +
</div>
 +
**Player
 +
**Global
 +
**Civ
 +
**Cult
 +
**Organization (Faction)
 +
**Other
 +
*'''3)''' ''Number of Rows''
 +
*'''4)''' Content (emply when creating it)
 +
<div style="overflow: hidden">
 +
[[File:DBArray.png|200px|thumb|left|DB window]]
 +
Current example will give the following DB, where:
 +
*'''1)''' Given name here is ''TestDB''.
 +
*'''2)''' Vue to be used, here ''Global''.
 +
*'''3)''' The number of rows, here ''10''.
 +
*'''4)''' This value have the corresponding number of fields (''10'') to appear.
 +
These fields can be named to make it easier to read and use the scripts which call these data.
 +
*'''5)''' Update have to be submitted to be saved.
 +
</div>
 +
<div style="overflow: hidden">
 +
[[File:UsingDB.png|200px|thumb|left|Script window]]
 +
Filling the base is down by the script, as shown in the left image.
 +
Writing such a script will be explained in the «Part II: User Guide».
 +
</div>
 +
Once this function has been activated, the database shows a content like this one.
 +
<div style="overflow: hidden">
 +
[[File:DBfilling.png|200px|thumb|left|DB window]]
 +
*'''6)''' A dataline (''n°1'') has been created.
 +
*'''7)''' A value (''64'') has been given to a column (''Psi).
 +
*'''8)'''
 +
{|
 +
|[[File:Database edit.png|32px|Script]]
 +
|An icone at the bottom indicates that the data can be modified manually.
 +
|}
 +
</div>
 +
Here you have a filling of databases with different context.
 +
<div style="overflow: hidden">
 +
[[File:Database filling.png|200px|thumb|left|DB window]]
 +
*Omega DB in "Global" mode
 +
*C3PO_R2D2 DB in "Player" mode
 +
All mode coexists.
 +
</div>
 +
 +
==Running==
 +
<div style="overflow: hidden">
 +
[[File:ExecutionTop.png|200px|thumb|left|Script window]]
 +
First, the parameters which affect the running of the script (from 7 to 16) will be described.
 +
</div>
 +
===Running set-up===
 +
<div style="overflow: hidden">
 +
[[File:ScriptName.png|200px|thumb|left|Event window]]
 +
*'''7)''' Name of the script as it appears in the event (here: «'''ResidentMaduck'''»).
 +
</div>
 +
 +
<div style="overflow: hidden">
 +
[[File:WindowName.png|200px|thumb|left|IG window]]
 +
*'''8)''' {WindowTitle} Title of the WebIG window (here: «Unit test: May the Force be with you.»)
 +
</div>
 +
*'''9)''' Hide during launch (Yes/no)
 +
 +
*'''10)''' Require validation (Yes/No)
 +
 +
*'''11)''' {singleInstance} (Yes/No)
 +
 +
*'''12)''' {resetAtStart} (Yes/No)
 +
 +
*'''13)''' {updateStagesInDb} (Yes/No)
 +
 +
*'''14)''' {missionTimeout} (Units)
 +
 +
*'''15)''' {replayTimer} (Units)
 +
<div style="overflow: hidden">
 +
[[File:Execution 3.png|200px|thumb|left|In Game]]
 +
*'''16)''' Name of action of NPC
 +
</div>
 +
 +
===Testing in browser===
 +
 +
<div style="overflow: hidden">
 +
[[File:ExecutionTop 1.png|200px|thumb|left|Top Left Creation Window]]
 +
</div>
 +
{|
 +
|[[File:Control_play.png|32px|Script]]
 +
|You can start by testing the script in the browser by clicking on '''(1)''' in the browser.
 +
|}
 +
It allows to test most or the script proceedings, especially the part about algorithms and displays. Be aware nonetheless to the display which doesn't necessarily appear exactly the same way in the Web and in the WebIG. Indeed some html tags doesn't pass through the last one. For example the <nowiki><hr/> tag (horizontal rule) doesn't appear in the WebIg, and neither does <br/></nowiki> (line break). That's why it's better to use bbcode.
 +
 +
To conclude, launching a script in a browser shouldn't be used to check the appearance of a display.
 +
 +
===Step by step===
 +
{|
 +
|[[File:Bug_go.png|32px]]
 +
|If a problem appears during the execution, it may be useful to test the proceedings. In this case, click on '''(2)'''. The following image shows the result for the current example:
 +
|}
 +
<div style="overflow: hidden">
 +
[[File:pazapa.png|200px|thumb|left|Web]]
 +
*'''17)''' From an execution launched on the Web, it is possible
 +
{|
 +
|-
 +
|[[File:Script_edit.png|32px]]
 +
| either to edit the script,
 +
|-
 +
|[[File:Arrow_refresh.png|32px]]
 +
|or to relaunch it.
 +
|}
 +
</div>
 +
*'''18)''' Each step is moved forward manually
 +
{|
 +
|-
 +
|[[File:Resultset_next.png|32px|right]]
 +
|either simply by clicking on the progess icon,
 +
|-
 +
|[[File:pazapa_1.png|200px|right]]
 +
|or by selecting the proposed choice when there is a multiple connection.
 +
|}
 +
*'''19)''' Columns on the right side show the status of each function in the script.
 +
 +
===Yubo===
 +
To test the script life-size, it has to be lauchned on the test server known under the name of «Yubo».
 +
For this, connect on the «Yubo» with an authorized account, choose preferabily a static NPC (so that you don't have to run behind him for the tests) and, of course, a free one (don't re-use a mission NPC so that you don't get unexpected complications).
 +
<div style="overflow: hidden">
 +
[[File:ExecutionTop 2.png|200px|thumb|left|Top Right Creation Window]]
 +
</div>
 +
 +
<div style="overflow: hidden">
 +
[[File:NPC assigned.png|200px|thumb|left|In Game]]
 +
Here, a posted guard has been selected.
 +
It shows its interaction mode in a cartouche: ((«ATTACK» in French).
 +
{|
 +
|-
 +
|[[File:User go.png|32px]]
 +
|It is assigned the current script (here, Unit_Test) by a click on the icon '''(3)'''.
 +
|}
 +
The result of this assignment can't be seen instantaneously, even if it's already active. To make it visible quickly, just click on another NPC and come back on this one. Now, the cartouche should have changed (here: « Live long and prosper »).
 +
The script can now be run by the NPC.
 +
</div>
 +
 +
==Update and removal==
 +
<div style="overflow: hidden">
 +
[[File:ExecutionTop 2.png|200px|thumb|left|Top Right Create window]]
 +
</div>
 +
{|
 +
|[[File:Script_code.png|32px]]
 +
|Using the source code has been seen '''(5)''' in chapter 4, when copying/pasting the content of a script into another one.
 +
|-
 +
|[[File:Time.png|32px]]
 +
|When update fails, it is always possible to come back to a former version by clicking on  '''(6)'''.
 +
|}
 +
<div style="overflow: hidden">
 +
[[File:Edition.png|200px|thumb|left|Script window]]
 +
The most standard way to edit a script is by clicking on its title (here: « jumping »),
 +
</div>
 +
{|
 +
|[[File:Add.png|32px]]
 +
|then by adding,
 +
|-
 +
|[[File:Delete.png|32px]]
 +
| removing,
 +
|-
 +
|[[File:Arrow down.png|32px]]
 +
| moving functions,
 +
|-
 +
|[[File:Arrow up.png|32px]]
 +
|and of course, by modifiant the content of the functions themselves (here: « weVMessage_v3_True ») which will be seen in Part II.
 +
|}
 +
 +
 +
 +
<div style="overflow: hidden">
 +
[[File:IsDeadJim.png|200px|thumb|left|Function part of script window]]
 +
Nota: the erasure icon for a function is at its right. Erasure is immediate, without any alerte or confirmation window. But feel reassured! The history allows you to rollback.
 +
</div>
 +
 +
==Other tools for the Event==
 +
===Status===
 +
{|
 +
|[[File:Bullet red.png |32px]]
 +
|Being edited.
 +
|-
 +
|[[File:Bullet orange.png |32px]]
 +
|Undergoing testing
 +
|-
 +
|[[File:Bullet green.png |32px]]
 +
|Active on Atys and Yubo
 +
|-
 +
|[[File:Bullet blue.png |32px]]
 +
|Working and locked
 +
|-
 +
|[[File:Bullet black.png |32px]]
 +
|Deactivated (to be removed)
 +
|}
 +
 +
===Related rights and shortcuts===
 +
{|
 +
|[[File:Control play.png |32px]]
 +
|Run the script.
 +
|-
 +
|[[File:Script code.png |32px]]
 +
|See and edit the script both in human and machine language.
 +
|-
 +
|[[File:Key.png |32px]]
 +
|See and edit the access and running rights.
 +
|-
 +
|[[File:Status online.png |32px]]
 +
|Show who is using the script.
 +
|-
 +
|[[File:Basket put.png |32px]]
 +
|Ask for the script deletion.
 +
|-
 +
|[[File:Delete.png |32px]]
 +
|Deletion of the script.
 +
|}
 +
 +
{{In_Category|ARCC}}
 +
{{TPInWikiRyzom‎}}
 +
[[Category:Tutorials]]
 +
[[Category:ARCC]]
 +
[[Category:EN]]

Latest revision as of 15:49, 7 June 2018

Migration

Please use the migrated document at URL shown below.

Migrated to en:ARK, quick guide at 2018-06-07

Flag-DE

Übersetzung , bitte.

Flag-EN

To check the quality of the text itself

Flag-ES

Traducción, por favor.

Flag-FR

À corriger par rapport à l'anglais

Flag-RU

перевод, пожалуйста.


User guide for Ark, short for Ryzom Arkitect.

For historical reasons, those manuals refers very often, almost always, to A.R.C.C.. This is due to the fact that the full documentation has been started with the initial name, ARCC, meaning Advanced Ryzom Content Creator.

Ark

This guide aims at explaining how to use Ark, the Ryzom Arkitect tool that allows the creation of scripts interpreted by a web server and interacting with Ryzom's server.

Access

ARCC Login window

In the top left corner, flags allow you to choose the language of the interface (current screenshots show French view - to be changed whenever someone has time to do it). This login window is the same everywhere in Ryzom. You'll have to fill in the first field with your Character (PC) name. Beware, for the animation team, it should be the name of their animation toon, and not the one of the private characters they could have created in the game (they are allowed 5 PC in game, as any player).

Folders and events

Open

((~This is going to have to be changed because of the selection panel that Ulukyn has made which is divided into different areas of the basic tree structure~)) As soon as login on, use finds a page offering access to various areas of the ARCC.

1st page window

The ARCC is laid out as an ensemble of events gathered in folders.

Each folder may contain either events or other folders, which can produce a tree that is more or less complex.

  • Zone 1 and Zone 3 allow you to navigate in this tree view.
Home The root directory appears as a small «house» icon. The «house» is the first folder, the one that contains all other elements, events and folders.
Folder Generally, folders are represented with classical icons for folders (the last two ones in the example shown here above). Some important folders are given a specific icon.
Event Events are represented with the icon shown on the left.
  • Zone 2 allows you to create a new folder or a new event in the displayed portion of Zone 1.
    • The first field will contain the name of the object, preferably in English for common data, and preferably without accented or specific characters (â, ñ, ß...)
    • The second field is a pulldown selection of options:
      • Default value is Folder.
      • Second choice, when reading down the list, is Event.
    • The third and last field, add, is actually a button. Click on it to start the creation of the object. Notice that hitting the <Enter> key is equivalent to clicking the add button.
  • Zone 3 contains the objects, folders or events, which have already been created in a particular level in Zone 1 (here «house»). By selecting one of these you will see the contents of that folder or event. You can back up in the directory tree by selection of a level in Zone 1.

Navigation

Navigation successive windows

The Zone 3 area allows one to navigate through the directory and event tree. In the example shown, the «TESTS» folder contains the «bepock» folder which, in turn, contains the «test» folder. This one contains one event («Event0») which consists of several scripts. The event is a «sheet» of the tree view browsed during the navigation. (NOTE: For illustration the windows of the browser have been overlapped to show the progress; your browser will only show one pane at a time.) If you need to back up one or several levels you can click on the level you want to go to in Zone 1.

Event

Event window

The event window is a specialized folder with a separate window. The event window allows you to manage the scripts and databases of the event. It is divided into five zones.

Navigation bar (Zone 1)

Zone 1 shows the place of the event in the folders tree. Each clickable link allows you to go to the specified folder (but remember to save your progress first).

Creation field (Zone 2)

Zone 2 allows you to create a new script or a new database.

  • The first field will contain the name of the object, preferably in English for common data, and preferably without accented or special characters (â, ñ, ß...).
  • The second field is a pulldown list of values:
    • Default value is Script.
    • Second choice is Database.
  • The third and last field, add, is actually a button. Click on it to start the creation of the object. Notice that hitting the <Enter> key is equivalent to clicking the add button.

Tools (Zone 3)

Zone 3 contains two tools:

Parameters of the event

((This link does not yet point to anything substantial - Ceru 25 Sept 2014.))

Table edit.png Set-up

Automated translations

Langs.png How to do automated translations

Scripts (Zone 4)

Zone 4 contains the scripts created in the event shown in zone 1 (here «New Event»).

The bottom part contains the meaning of the colored bullets appended to the scripts.

The middle part contains the list of the scripts associated to the event.

To each script is associated a set of indicators and actions, listed here bellow as they appear from left to right. (to be checked with the English version of the screenshots)

  • Script type:
Script A simple script
Linked Script A linked script, meaning assigned to a NPC
  • Script status, shown as a colored bullet, which meaning appears in the bottom part of the window.
Red Orange Green Blue Black
  • Name of the script. Clicking on the name of the script allows one to see and edit the content, depending on the user's rights.
  • Name of the author who created the script.
  • Possible actions on the scripts.
Control_play Script_code Key Status_online Basket_put

Databases (Zone 5)

Script Zone 5 shows the list of the databases of the event.

Script

Script window

To create a script, it is only required to give an name in the text field of Zone 2 of the Event page, and to hit <enter> or to click on the «add» button. Creating the script will open the following window, made op five zones.

  • Zone 1 shows the place of the event in the folders tree view down to the event which contains the current scripts.

Eack clickable link allows to go to the intended folder.

  • Zone 2 allows to test the script.
  • Zone 3 allows to manage the source code and the history of updates.
  • Zone 4 shows additional information about the running of the script.
  • Zone 5 manages the actual creation of the script.

The quickest and least wearying method to create a script is to copy it from another one ressembling to what we want to produce. This method is very useful to create quickly a script that looks like another one, but you'll have to learn how to modify it sooner or later... otherwise, of which use would it be to have two script identical except for their names? That will be explaned in part II of the this user guide for ARCC.

Event window

Start with creating a new script with the default values.

  • 1) Write the name of the new script («script1» in this example);
  • 2) Check that it is indeed a script (default value);
  • 3) Click on «add» or hit <enter>.
Event window
  • 4) and 5) The new script has been added to the list.
  • 6) As an example, let's imagine that we want to copy «Script2» into «Script1».

Open the script you want to copy.

It is only needed to click on the «Script2» link, in the example, which opens the script window.

Script window

What appears isn't best fitted for a copy/paste.

  • 7) Click on «View Source Code» to show the source code.
Script window

It's better but...

  • 8) Click on «Base64» to get a compact display of the generated code.
Script window

The display is the one of a file that can easily been copied (ASCII printables characters). To copy, just save it in the clipboard by any method, for example: click on the text (to place the focus), then hit <Ctrl>+A, <Ctrl>+C on Windows and most of the Unices (Unix, Linux, BSD, Androïd...). Beware! If you don't click on the text, you're at risk of saving the whole window with its icons... wich isn't much useful. Replace <Ctrl> with <Apple'>' on Mac.

  • 9) Once the copy done, click on the path to find the script newly created («Script1» stored in «Event0» in our example)

Fill the new script.

Replay sequences 6 to 8 with «Script1»

  • 6) open the script
  • 7) show the source
  • 8) show the source in Base64

Then, click in the already existing text (to place the focus) and select it all (for example: by hitting <Ctrl>+A on Windows and Unices) to replace it with the text saved in the clipboard (for example, by hitting <Ctrl>+V). Once the text has been replaced, save it:

Script window
  • 10) Save your work by clickin the Submit button.

«Script1» is now a copy of «Script2».

Databases

Event window

ARCC databases are used to store information such as the number of mats of a given type gathered by a given player. They're much lick simple tables and don't hold any function nore complex relationships such as the ones that can be found in spreadsheets or relational databases.

DB window

If no name is given at the DB creation, this one will nonetheless be prepared (DB icon without any name on the left). it is always possible to rename a DB. Beware! This rename won't be passed on the scripts which call this base.

DB window

Initialy, creation of a database shows as follow:

  • 1) Name: Name of the database - can be modified.
  • 2) Use View: Context of the database. This context can be:
    • Player
    • Global
    • Civ
    • Cult
    • Organization (Faction)
    • Other
  • 3) Number of Rows
  • 4) Content (emply when creating it)
DB window

Current example will give the following DB, where:

  • 1) Given name here is TestDB.
  • 2) Vue to be used, here Global.
  • 3) The number of rows, here 10.
  • 4) This value have the corresponding number of fields (10) to appear.

These fields can be named to make it easier to read and use the scripts which call these data.

  • 5) Update have to be submitted to be saved.
Script window

Filling the base is down by the script, as shown in the left image. Writing such a script will be explained in the «Part II: User Guide».

Once this function has been activated, the database shows a content like this one.

DB window
  • 6) A dataline (n°1) has been created.
  • 7) A value (64) has been given to a column (Psi).
  • 8)
Script An icone at the bottom indicates that the data can be modified manually.

Here you have a filling of databases with different context.

DB window
  • Omega DB in "Global" mode
  • C3PO_R2D2 DB in "Player" mode

All mode coexists.

Running

Script window

First, the parameters which affect the running of the script (from 7 to 16) will be described.

Running set-up

Event window
  • 7) Name of the script as it appears in the event (here: «ResidentMaduck»).
IG window
  • 8) {WindowTitle} Title of the WebIG window (here: «Unit test: May the Force be with you.»)
  • 9) Hide during launch (Yes/no)
  • 10) Require validation (Yes/No)
  • 11) {singleInstance} (Yes/No)
  • 12) {resetAtStart} (Yes/No)
  • 13) {updateStagesInDb} (Yes/No)
  • 14) {missionTimeout} (Units)
  • 15) {replayTimer} (Units)
In Game
  • 16) Name of action of NPC

Testing in browser

Top Left Creation Window
Script You can start by testing the script in the browser by clicking on (1) in the browser.

It allows to test most or the script proceedings, especially the part about algorithms and displays. Be aware nonetheless to the display which doesn't necessarily appear exactly the same way in the Web and in the WebIG. Indeed some html tags doesn't pass through the last one. For example the <hr/> tag (horizontal rule) doesn't appear in the WebIg, and neither does <br/> (line break). That's why it's better to use bbcode.

To conclude, launching a script in a browser shouldn't be used to check the appearance of a display.

Step by step

Bug go.png If a problem appears during the execution, it may be useful to test the proceedings. In this case, click on (2). The following image shows the result for the current example:
Web
  • 17) From an execution launched on the Web, it is possible
Script edit.png either to edit the script,
Arrow refresh.png or to relaunch it.
  • 18) Each step is moved forward manually
Resultset next.png
 either simply by clicking on the progess icon,
Pazapa 1.png
 or by selecting the proposed choice when there is a multiple connection.
  • 19) Columns on the right side show the status of each function in the script.

Yubo

To test the script life-size, it has to be lauchned on the test server known under the name of «Yubo». For this, connect on the «Yubo» with an authorized account, choose preferabily a static NPC (so that you don't have to run behind him for the tests) and, of course, a free one (don't re-use a mission NPC so that you don't get unexpected complications).

Top Right Creation Window
In Game

Here, a posted guard has been selected. It shows its interaction mode in a cartouche: ((«ATTACK» in French).

User go.png It is assigned the current script (here, Unit_Test) by a click on the icon (3).

The result of this assignment can't be seen instantaneously, even if it's already active. To make it visible quickly, just click on another NPC and come back on this one. Now, the cartouche should have changed (here: « Live long and prosper »). The script can now be run by the NPC.

Update and removal

Top Right Create window
Script code.png Using the source code has been seen (5) in chapter 4, when copying/pasting the content of a script into another one.
Time.png When update fails, it is always possible to come back to a former version by clicking on (6).
Script window

The most standard way to edit a script is by clicking on its title (here: « jumping »),

Add.png then by adding,
Delete.png removing,
Arrow down.png moving functions,
Arrow up.png and of course, by modifiant the content of the functions themselves (here: « weVMessage_v3_True ») which will be seen in Part II.


Function part of script window

Nota: the erasure icon for a function is at its right. Erasure is immediate, without any alerte or confirmation window. But feel reassured! The history allows you to rollback.

Other tools for the Event

Status

Bullet red.png Being edited.
Bullet orange.png Undergoing testing
Bullet green.png Active on Atys and Yubo
Bullet blue.png Working and locked
Bullet black.png Deactivated (to be removed)

Related rights and shortcuts

Control play.png Run the script.
Script code.png See and edit the script both in human and machine language.
Key.png See and edit the access and running rights.
Status online.png Show who is using the script.
Basket put.png Ask for the script deletion.
Delete.png Deletion of the script.


63 pages in ARCC

Ryzom Wiki: Ryzom Commons | DE • EN • ES • FR • RU | Ryzom Forge
Retrieved from "https://en.wiki.ryzom.com/wiki/Portal:Forge?from=/w/index.php?title=EN_ARK_basis_user_manual&oldid=4853"