Difference between revisions of "EN ARK basis user manual"

From Ryzom Forge Wiki

Jump to: navigation, search
(Paragraphs 1 and 2)
m (Paragraphs 3 and 4)
Line 1: Line 1:
 
{{tabLang|EN|DE|{{FULLPAGENAME}}|ES|ARCC_intro_FR|RU}}
 
{{tabLang|EN|DE|{{FULLPAGENAME}}|ES|ARCC_intro_FR|RU}}
 
{{toTrad}}
 
{{toTrad}}
−
(Page currently under translation)
+
(Translation in progress)
 +
 
 
<big>User manual for '''A.R.C.C.'''</big>
 
<big>User manual for '''A.R.C.C.'''</big>
 
*[[ARCC intro EN|Part I: Quick Start Guide]]
 
*[[ARCC intro EN|Part I: Quick Start Guide]]
−
*[[ARCC Guide FR|Part II: User Guide]] (to be translated)
+
*[[ARCC Guide FR|Part II: User Guide]] ''(to be translated)''
−
*[[ARCC Expert FR|Part III: Advanced User Guide]] (to be translated)
+
*[[ARCC Expert FR|Part III: Advanced User Guide]] ''(to be translated)''
 
==A.R.C.C.==
 
==A.R.C.C.==
 
This guide aims at explaining how to use A.R.C.C., the Advanced Ryzom Content Creator.
 
This guide aims at explaining how to use A.R.C.C., the Advanced Ryzom Content Creator.
Line 12: Line 13:
 
== Access==
 
== Access==
 
<div style="overflow: hidden">
 
<div style="overflow: hidden">
−
[[File:ARCC Loggin.png|200px|thumb|left|ARCC Loggin window]]
+
[[File:ARCC Loggin.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).
+
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)''.
 
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 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).
 
</div>
 
</div>
 +
==Folders and events==
 +
===Open===
 +
As soon as login on, use finds a page offering access to various parts of the ARCC.
 +
<div style="overflow: hidden">
 +
[[File:1stPage.png|200px|thumb|left|1st page window]]
 +
 +
The ARCC appears like an ensemble of events gathered in folders.
 +
 +
Each folder may contain events or folders, which can produce a tree view more or less complex.
 +
</div>
 +
*'''Zone 1''' allows you to navigate in this tree view.
 +
{|
 +
|[[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.
 +
|-
 +
|[[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.
 +
|-
 +
|[[File:Application_view_gallery.png|32px|Event]]
 +
|Events are represented with the icon shown on the left.
 +
|}
 +
*'''Zone 2''' allows to create a new folder or a new event.
 +
**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:
 +
***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 Zone 1 (here «house»).
 +
 +
===Navigation===
 +
<div style="overflow: hidden">
 +
[[File:Navigation 1.png|200px|thumb|left|Navigation successive windows]]
 +
 +
This '''zone 3''' allows to navigate through the tree view.
 +
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.
 +
</div>
 +
<div style="clear: both"></div>
 +
==Event==
 +
<div style="overflow: hidden">
 +
[[File:Event.png|200px|thumb|left|Event window]]
 +
The event window allow to manage the internal scripts and databases of this event.
 +
It is divided into five zones.
 +
</div>
 +
===Navigation bar (Zone 1)===
 +
Zone 1 shows the place of the event in the folders tree view.
 +
Eack clickable link allows to go to the intended folder.
 +
===Creation field (Zone 2)===
 +
Zone 2 allows 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 second fied is a list of values:
 +
**Default value is ''Script''.
 +
**Second choice, when reading down the list, 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====
 +
{|
 +
|[[File:Table edit.png |32px]]
 +
|[[ARCC paramètres|Set-up]]
 +
|}
 +
====Automated translations====
 +
{|
 +
|[[File:Langs.png |32px]]
 +
|[[ARCC traductions|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 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)''
 +
*Script type:
 +
{|
 +
|[[File:Script.png|32px|Script]]
 +
|A simple script
 +
|-
 +
|[[File:Script_link.png|32px|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.
 +
{|
 +
|[[File:Bullet_red.png|32px|Red]]
 +
|[[File:Bullet orange.png|32px|Orange]]
 +
|[[File:Bullet green.png|32px|Green]]
 +
|[[File:Bullet blue.png|32px|Blue]]
 +
|[[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 author who created the script.
 +
*Possible actions on the scripts.
 +
{|
 +
|[[File:Control_play.png|32px|Control_play]]
 +
|[[File:Script_code.png|32px|Script_code]]
 +
|[[File:Key.png|32px|Key]]
 +
|[[File:Status_online.png|32px|Status_online]]
 +
|[[File:Basket_put.png|32px|Basket_put]]
 +
|}
 +
===Databases (Zone 5)===
 +
{|
 +
|[[File:Database.png|32px|Script]]
 +
|Zone 5 shows the list of the databases of the event.
 +
|}

Revision as of 19:30, 11 August 2014

Flag-{{{1}}}

Translation requested, please.

(Translation in progress)

User manual for A.R.C.C.

A.R.C.C.

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.

Access

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

Folders and events

Open

As soon as login on, use finds a page offering access to various parts of the ARCC.

1st page window

The ARCC appears like an ensemble of events gathered in folders.

Each folder may contain events or folders, which can produce a tree view more or less complex.

  • Zone 1 allows you to navigate in this tree view.
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.
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.
Event Events are represented with the icon shown on the left.
  • Zone 2 allows to create a new folder or a new event.
    • 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:
      • 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 Zone 1 (here «house»).

Navigation

Navigation successive windows

This zone 3 allows to navigate through the tree view. 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.

Event

Event window

The event window allow to manage the internal scripts and databases of this event. It is divided into five zones.

Navigation bar (Zone 1)

Zone 1 shows the place of the event in the folders tree view. Eack clickable link allows to go to the intended folder.

Creation field (Zone 2)

Zone 2 allows 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 second fied is a list of values:
    • Default value is Script.
    • Second choice, when reading down the list, 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

Table edit.png Set-up

Automated translations

Langs.png 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 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)

  • 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 to see and update the content, accordingly to the users 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.
Retrieved from "https://en.wiki.ryzom.com/wiki/Portal:Forge?from=/w/index.php?title=EN_ARK_basis_user_manual&oldid=1760"