History

Adding Game Entities (Armor, Spells etc.)¶

Description¶

After hours and hours of staring at the xml files and browsing restless through the georges editor, i finally could shed some light into the mysteries of entity creation in Ryzom Core. There is still much to learn but this is a good point to start to share my knowledge i gathered so far.

So what we're going to do is creating an armor item including an crafting plan and two spells (Heal & Dmg) plus some more spell credits. We're going to put them on the server and add them to some corresponding merchants & trainer.

Note 1: For the sake of simplicity in this guide i oriented myself at the old spells and armor. Of Course, the goal of Ryzom Core is not to rebuild the original Ryzom. But in my opinion it will take some time till we have e.g. some truly new spells as this also relies heavily on source code additions. Until then it should be ok if we create some more samples to get to known with the whole process.

Note 2: Personally i think the current georges editor has much potential, but most times im kind of overwhelmed by the masses of editable informations.
So i switched to just open the actual xml files and edit them. I decided to do it for this guide as well which also saves me from making a lot of screenshots :) But of course you are welcome to do it all in the offical Nel tool!

Prerequisites¶

Here is a small list with stuff you should have ready for things to work.

Get the source
Look here for more

Note: For windows there are some prebuild binaries for everything (client, server, nel tools, ryzom tools). Look here to find out more.

Client / Server
Well this should be clear but of course you need a working client to test the additions and a working server with access to it as we have to add files on it. There are a bunch of tutorials in the wiki for the plattform of your choice. E.g.:
- Linux
- Mac OS X
- Windows

Char with admin rights
Create a character on your server and grant it some privileges.
This can be done by using the EGS (Entity Game Service - part of the server) command "setPriv 1 :DEV:" when the corresponding user is logged into the Client, or by directly altering the corresponding table entry for your character in the mysql database on the server.

Note: If you have more than one character on your server you need to change the EGS command to "setPriv x :DEV:" where x is the id of the char found in the mysql database

NeL tool "make_sheet_id"
This tool is needed to create the sheet_id.bin file which is residing in $RYZOM_HOME$/code/ryzom/common/data_leveldesign/leveldesign/Game_elem. Therefore build it and make it ready for use. It can be found in $RYZOM_HOME$/code/nel/tools/misc/make_sheet_id.
Use it with the following syntax to build your sheet_id.bin:

make_sheet_id_r -oL:/leveldesign/game_elem/sheet_id.bin L:/leveldesign/game_elem L:/leveldesign/game_element L:/leveldesign/world

Note: To get working make_sheet_id tool you need set allowed extensions or simply just delete or comment ExtensionsAllowed = { "sample_config" }; line in $RYZOM_HOME$/code/nel/tools/misc/make_sheet_id.cfg

Ryzom tool "sheets_packer"
This tool is needed to build the .packed_sheets files from the contents in your leveldesign directory. It can be found $RYZOM_HOME$"/code/ryzom/tools/sheets_packer. Build it and make it ready for use. When executing, it will default create the .packed_sheets in $RYZOM_HOME$"/code/ryzom/client/data.

Ryzom assets
Its really nice to have the ryzom media assets available. E.g. the Interfaces directory contains all the icons for spells and stuff. You could search for them online at http://media.ryzom.com/ but having them locally is much faster. Bear in mind that all assets, if extracted, are like 11GB in 26k files

bnps
For creating armor its nice to have some of the bnps available unpacked to look for nice shapes you want to use. Download the Open Ryzom Client extract it and look into the data directory. There you will find all the .bnp files. Use the NeL tool bnp_make to unpack the files. The easiest way to do so is to copy the desired bnp and the executable in a directory and using following command. This will create a directory with the name of the file and unpack all contents there.

bnp_make /u desired_bnp.bnp

sbrick_words_en.txt / skill_words_en.txt / item_words_en.txt / sheets.txt
It comes in handy if you have these files open. The first three can be found in the $RYZOM_HOME$/code/ryzom/server/data_shard/language directory. They are needed later to find the correct skill families and item names (more on that below).
The fourth file gets created if you repack your sheets with the mentioned sheets_packer tool. It contains a human readable overview of the contents of the sheets_id.bin and can be used to find out correct file naming as we're orienting on the original ryzom file scheme. It lies in the same directory as the sheets_id.bin.

Adding Armor¶

General¶

Each craftable item needs a .sitem file which defines the characteristics of the item and a .sbrick file which defines the crafting plan for the item (eg which material is used). As kaetemi already stated in his armor example: "Craftable items MUST be prefixed with "ic", bricks for crafting MUST be prefixed with "bc"". As we orient ourselves to the ryzom naming scheme there are some more rules to learn. But more on this in the next paragraph

File Naming, Skill Families, Icons etc.¶

To get correct .sitem file naming we are looking into the item_words_en.txt
To get correct .sbrick file naming we are looking into the sbrick_words_en.txt
We can double check with the sheets.txt if the file names are appearing there

Below is a table with some examples for the naming scheme for matis armor .sitems and there corresponding .sbricks . There is a lot more to discover if you skim through these files but this should be sufficent to get the idea.

SItem
filename	description	filename	description	filename	description
icmalb	item craftable matis light boots	icmamb	item craftable matis medium boots	icmahb	item craftable matis heavy boots
icmalv	item craftable matis light vest	icmamv	item craftable matis medium vest	icmahv	item craftable matis heavy vest
icmalg	item craftable matis light gloves	icmamg	item craftable matis medium gloves	icmahg	item craftable matis heavy gloves
icmalp	item craftable matis light pants	icmamp	item craftable matis medium pants	icmahp	item craftable matis heavy pants
icmals	item craftable matis light sleeves	icmams	item craftable matis medium sleeves	icmahs	item craftable matis heavy sleeves
				icmahh	item craftable matis heavy head
SBrick
filename	description	filename	description	filename	description
bcmaea01	Heavy Boots - Basic Quality	bcmaea07	Light Boots - Basic Quality	bcmaea12	Medium Boots - Basic Quality
bcmaea02	Heavy Gloves - Basic Quality	bcmaea08	Light Gloves - Basic Quality	bcmaea13	Medium Gloves - Basic Quality
bcmaea03	Heavy Helmet - Basic Quality	bcmaea09	Light Pants - Basic Quality	bcmaea14	Medium Pants - Basic Quality
bcmaea04	Heavy Pants - Basic Quality	bcmaea10	Light Sleeves - Basic Quality	bcmaea15	Medium Sleeves - Basic Quality
bcmaea05	Heavy Sleeves - Basic Quality	bcmaea11	Light Vest - Basic Quality	bcmaea16	Medium Vest - Basic Quality
bcmaea06	Heavy Vest - Basic Quality

Note: The character combination in front is equal to the FamilyId defined in each .sbrick file

For the crafting plans we need to know the corresponding skills involved

To get the correct skill family we are looking into skill_words_en.txt

Below is a table with some example skills we are going to use and there skill family. This should give you an sufficent idea.

skill familyId	skill description	filename	description	filename	description
SCALBEM	Master Light Boots Crafting	SCAMBEM	Master Medium Boots Crafting	SCAHBEM	Master Heavy Boots Crafting
SCALGEM	Master Light Gloves Crafting	SCAMGEM	Master Medium Gloves Crafting	SCAHGEM	Master Heavy Gloves Crafting
SCALPEM	Master Light Pants Crafting	SCAMPEM	Master Medium Pants Crafting	SCAHHEM	Master Heavy Helmet Crafting
SCALSEM	Master Light Sleeves Crafting	SCAMSEM	Master Medium Sleeves Crafting	SCAHPEM	Master Heavy Pants Crafting
SCALVEM	Master Light Vest Crafting	SCAMVEM	Master Medium Vest Crafting	SCAHSEM	Master Heavy Sleeves Crafting
				SCAHVEM	Master Heavy Vest Crafting

Throughout the existing .sbricks i found they always used the master skill, although there are familyIds for e.g. the expert skill. Im adapting this remembering that even in original ryzom they got this strange info message that you can`t gain any more XP in the master skill lvl when killing low mobs even though you not yet reached that master skill.

All items, skills and plans etc. need an icon to show ingame. Here is a short list, find others in the ryzom_assets:

icon	description	icon	description
AR_botte.tga	icon for boots	BK_matis.tga	matis background
AR_hand.tga	icon for gloves	BK_fyros.tga	fyros background
AR_pantabotte.tga	icon for pants	BK_tryker.tga	tryker background
AR_armpad.tga	icon for sleeves	BK_zorai.tga	zorai background
AR_gilet.tga	icon for vest
AR_helmet.tga	icon for helmet

Creating Armor SItem¶

So first we are looking for some nice armor to add. For this step you need to unpack the characters_shapes.bnp. Now skim through the .shape files with the Nel object viewer or the new object_viewer_qt until you find a pleasing one. If you want the shape to have textures provide them from the ryzom assets. They can be found in e.g. PathToAssets/Stuff/Matis/Agents/_textures/Actors

As my toon is matis and female im choosing MA_HOF_armor00_gilet.shape (MA = Matis; HOF = Homin Female). The male shape would be MA_HOM_armor00_gilet.shape

Ok so now its time to actually write the georges files.

Switch over to your leveldesign directory to the corresponding sitem armor folder. In my case this is

$RYZOM_HOME$/code/ryzom/client/common/data_leveldesign/leveldesign/game_element/sitem/armor/matis/light_armor

There you'll find the already provided matis light armor boots file

icmalb.sitem

We are lazy and just copy this file. Now rename it according to your desired item (see filenaming above). As i want to have a matis light vest i'll name it icmalv.sitem

Open it and you should see something like this:

 1<?xml version="1.0"?>
 2<FORM Revision="$Revision: 1.4 $" State="modified">
 3  <PARENT Filename="_gma_l.sitem"/>
 4  <STRUCT>
 5    <STRUCT Name="basics">
 6      <ATOM Name="name" Value="matis light boots"/>
 7      <ATOM Name="ItemType" Value="Light boots"/>
 8      <STRUCT Name="EquipmentInfo">
 9        <ARRAY Name="EquipmentSlots">
10          <ATOM Value="Feet"/>
11        </ARRAY>
12      </STRUCT>
13      <ATOM Name="CraftPlan" Value="bcmaea07.sbrick"/>
14    </STRUCT>
15    <STRUCT Name="3d">
16      <ATOM Name="shape" Value="MA_HOM_civil01_bottes.shape"/>
17      <ATOM Name="shape_female" Value="MA_HOF_civil01_bottes.shape"/>
18      <ATOM Name="map_variant" Value="Low Quality"/>
19      <ATOM Name="icon" Value="AR_botte.tga"/>
20      <ATOM Name="icon background" Value="BK_matis.tga"/>
21    </STRUCT>
22    <STRUCT Name="faber">
23      <ATOM Name="Tool type" Value="ArmorTool"/>
24    </STRUCT>
25  </STRUCT>
26  <LOG/></FORM>

As you can see there's also a parent defined which declares some standard matis armor values. We dont need it at the moment but if you want to have a look at it you'll find the file at leveldesign/game_element/sitem/armor/_parent/matis

So now we need to change the values to match a vest:

change the "EquipmentSlot" from Value="Feet" to Value="Chest"
change the "CraftPlan" to "bcmaea11.sbrick". This is the needed corresponding sbrick file i mentioned earlier. We will create it later.
change "shape" and "shape_female" to the shape names we found out earlier (MA_HOM_armor00_gilet.shape and MA_HOF_armor00_gilet.shape)
change "icon" to "AR_gilet.tga" (see icons above)
if you like you can add another "ATOM" below "icon background" in the "3D" "STRUCT". Name it "color" and give it the value "White" (Black, Beige, Green, Red, Turquoise, Blue, Violet are also available).
save the file which should now look something like this:

 1<?xml version="1.0"?>
 2<FORM Revision="$Revision: 1.0 $" State="modified">
 3  <PARENT Filename="_gma_l.sitem"/>
 4  <STRUCT>
 5    <STRUCT Name="basics">
 6      <ATOM Name="name" Value="matis light vest"/>
 7      <ATOM Name="ItemType" Value="Light vest"/>
 8      <STRUCT Name="EquipmentInfo">
 9        <ARRAY Name="EquipmentSlots">
10          <ATOM Value="Chest"/>
11        </ARRAY>
12      </STRUCT>
13      <ATOM Name="CraftPlan" Value="bcmaea11.sbrick"/>
14    </STRUCT>
15    <STRUCT Name="3d">
16      <ATOM Name="shape" Value="MA_HOM_armor00_gilet.shape"/>
17      <ATOM Name="shape_female" Value="MA_HOF_armor00_gilet.shape"/>
18      <ATOM Name="map_variant" Value="Low Quality"/>
19      <ATOM Name="icon" Value="AR_gilet.tga"/>
20      <ATOM Name="icon background" Value="BK_matis.tga"/>
21      <ATOM Name="color" Value="White"/>
22    </STRUCT>
23    <STRUCT Name="faber">
24      <ATOM Name="Tool type" Value="ArmorTool"/>
25    </STRUCT>
26  </STRUCT>
27  <LOG>created by aquiles</LOG>
28</FORM>

Creating Armor SBrick¶

So far so good! Now we need to add the brick for crafting. Have a look into the sbrick folder

leveldesign/game_element/sbrick).
There you will find the bcmaea07.sbrick file which was mentioned in the .sitem file for the light boots as "CraftPlan".
Make a copy of bcmaea07.sbrick and name it "bcmaea11.sbrick". It should look like this:

 1<?xml version="1.0"?>
 2<FORM Revision="$Revision: 1.22 $" State="modified">
 3  <STRUCT>
 4    <STRUCT Name="Basics">
 5      <ATOM Name="FamilyId" Value="BCMAEA"/>
 6      <ATOM Name="IndexInFamily" Value="1"/>
 7      <ATOM Name="SPCost" Value="30"/>
 8      <ATOM Name="LearnRequiresOneOfSkills" Value="SC 0"/>
 9      <ATOM Name="Action Nature" Value="CRAFT"/>
10      <ATOM Name="Skill" Value="SCALBEM"/>
11      <ATOM Name="LearnRequiresBricks" Value="bcpa10.sbrick"/>
12      <ATOM Name="CivRestriction" Value="matis"/>
13    </STRUCT>
14    <STRUCT Name="Client">
15      <ATOM Name="Icon" Value="AR_botte.tga"/>
16      <ATOM Name="IconBack" Value="BK_matis_brick.tga"/>
17      <ATOM Name="IconOver" Value="FP_over.tga"/>
18      <ATOM Name="IconOver2"/>
19    </STRUCT>
20    <STRUCT Name="faber">
21      <ATOM Name="Tool type" Value="ArmorTool"/>
22      <ATOM Name="Item Max Level" Value="100"/>
23      <STRUCT Name="Create">
24        <ATOM Name="Crafted Item" Value="icmalb.sitem"/>
25        <ATOM Name="Nb built items" Value="1"/>
26        <ATOM Name="MP 1" Value="Raw Material for Clothes"/>
27        <ATOM Name="Quantity 1" Value="2"/>
28        <ATOM Name="MP 2" Value="Raw Material for Armor interior coating"/>
29        <ATOM Name="Quantity 2" Value="2"/>
30        <ATOM Name="MP 3" Value="Raw Material for Armor interior stuffing"/>
31        <ATOM Name="Quantity 3" Value="1"/>
32        <ATOM Name="MP 4" Value="Raw Material for Armor clip"/>
33        <ATOM Name="Quantity 4" Value="1"/>
34        <ATOM Name="MP 5"/>
35        <ATOM Name="Quantity 5" Value="0"/>
36      </STRUCT>
37    </STRUCT>
38  </STRUCT>
39<LOG/></FORM>

Again we are going to change it now to resemble a vest craft plan

change IndexInFamily to 11 as this is the 11th item in the BCMAEA family
change Skill to SCALVEM (Master Light Vest Crafting)
change icon to AR_gilet.tga
change "Crafted Item" to icmalv.sitem (the one which we created earlier)
for simplicity i shortened the raw material list :)

Finally your file should look something like this:

 1<?xml version="1.0"?>
 2<FORM Revision="$Revision: 1.0 $" State="modified">
 3  <STRUCT>
 4    <STRUCT Name="Basics">
 5      <ATOM Name="FamilyId" Value="BCMAEA"/>
 6      <ATOM Name="IndexInFamily" Value="11"/>
 7      <ATOM Name="SPCost" Value="30"/>
 8      <ATOM Name="LearnRequiresOneOfSkills" Value="SC 0"/>
 9      <ATOM Name="Action Nature" Value="CRAFT"/>
10      <ATOM Name="Skill" Value="SCALVEM"/>
11      <ATOM Name="LearnRequiresBricks" Value="bcpa10.sbrick"/>
12      <ATOM Name="CivRestriction" Value="matis"/>
13    </STRUCT>
14    <STRUCT Name="Client">
15      <ATOM Name="Icon" Value="AR_gilet.tga"/>
16      <ATOM Name="IconBack" Value="BK_matis_brick.tga"/>
17      <ATOM Name="IconOver" Value="FP_over.tga"/>
18      <ATOM Name="IconOver2"/>
19    </STRUCT>
20    <STRUCT Name="faber">
21      <ATOM Name="Tool type" Value="ArmorTool"/>
22      <ATOM Name="Item Max Level" Value="100"/>
23      <STRUCT Name="Create">
24        <ATOM Name="Crafted Item" Value="icmalv.sitem"/>
25        <ATOM Name="Nb built items" Value="1"/>
26        <ATOM Name="MP 1" Value= "Raw Material for Clothes"/>
27        <ATOM Name="Quantity 1" Value="2"/>
28      </STRUCT>
29    </STRUCT>
30  </STRUCT>
31  <LOG>created by aquiles</LOG>
32</FORM>
33

Make it available on server and client¶

Well, we have come a long way :) Now its time to test it!

Build the sheets_id.bin with the make_sheet_id tool and copy it to the user dir in your game client dir
Build the .packed_sheets with the sheets_packer and copy it to the same location
Copy your newly created sheets on the server and delete all .packed_sheets from the server/data_shard and server/src/entities_game_service folders if existing
If it works, the server will recreate the .packed_sheets in server/data_shard
Make sure the two files we created are existing in the correct dir in your leveldesign dir and that they contain the content i explained before
Start your server
start your client and let him connect to your server
when ingame select your char and type the following command into the chat

/a createItemInBag icmalv.sitem 1 25

you should now have the new item in your inventory, congratz :D

Tutorial Videos:¶

Part 1: http://www.youtube.com/watch?v=xNoBDkQfR3Y
Part 2: http://www.youtube.com/watch?v=pCjZeiVR3ao
Part 3: http://www.youtube.com/watch?v=g83L1unNEA8

Add armor to merchant¶

Let's say we want to add our previously created vest to the existing light armor mechant.

Edit code/ryzom/common/data_leveldesign/primitives/newbieland/urban_newbieland.primitive and search for:

 1<PROPERTY TYPE="string_array">
 2  <NAME>chat_parameters</NAME>
 3  <STRING>shop : NEWBIELAND_LARMOR_ALL</STRING>
 4  <STRING>item : icmalb.sitem 10</STRING>
 5  <STRING>item : icmalb.sitem 20</STRING>
 6  <STRING>item : icmalb.sitem 50</STRING>
 7  <STRING>item : icfalb.sitem 10</STRING>
 8  <STRING>item : icfalb.sitem 20</STRING>
 9  <STRING>item : icfalb.sitem 50</STRING>
10  <STRING>item : ictalb.sitem 10</STRING>
11  <STRING>item : ictalb.sitem 20</STRING>
12  <STRING>item : ictalb.sitem 50</STRING>
13  <STRING>item : iczalb.sitem 10</STRING>
14  <STRING>item : iczalb.sitem 20</STRING>
15  <STRING>item : iczalb.sitem 50</STRING>
16</PROPERTY>

That's the list of items, the merchant is already selling.

We will add our vest to the end of the list:

<STRING>item : icmalv.sitem 10</STRING>

The number following the sitem is the level of the item.

Save the file and place it on your server
Start your server
Your vest should be available in the light armor merchant list

Tutorial Videos:¶

Full Video: http://www.youtube.com/watch?v=cZ_mkTkQPgo

Add crafting plan to trainer (todo)¶

Toto

Adding Spells¶

As for the current system a spell consists of different components:

The general type (heal, damage, affliction etc.)
An effect type for that general type (e.g. cold and acid are dmg spell effects)
The explicit spell level component (eventually while leveling you can e.g. replace your old boring acid damage spell lvl 4 with the brand new lvl 5)
Options for the spell like area damage or ricochet
Credits to equal the costs of the spell (common credits are Mana (SAP as with ryzom ;) ) or cast time etc.)

Add cold spell¶

So lets start with something easy. Fortunately WinchGate provided us with an example acid spell which we will take as guideance.

So first head over to your sbrick dir.

We already have the general damage spell component which is defined in the bmpa01.sbrick file but as we are going to do another damage spell, we can ignore it for now.

Creating the cold damage spell effect

The acid spell effect is defined in the bmoetea01.sbrick file. Copy it, name it bmoetea02.sbrick and open it so we can change it accordingly to the cold effect. You should see something like this:

 1<?xml version="1.0"?>
 2<FORM Revision="$Revision: 1.3 $" State="modified">
 3  <STRUCT>
 4    <STRUCT Name="Basics">
 5      <ATOM Name="FamilyId" Value="BMOETEA"/>
 6      <ATOM Name="SabrinaCost" Value="0"/>
 7      <ATOM Name="SPCost" Value="37"/>
 8      <ATOM Name="LearnRequiresOneOfSkills" Value="SM 0"/>
 9      <ATOM Name="Action Nature" Value="OFFENSIVE_MAGIC"/>
10      <ATOM Name="Skill" Value="SMOEAEM"/>
11    </STRUCT>
12    <STRUCT Name="Client">
13      <ATOM Name="Icon" Value="ICO_Acid.tga"/>
14      <ATOM Name="IconBack" Value="EF_Back.tga"/>
15    </STRUCT>
16    <STRUCT Name="Parameter">
17      <ATOM Name="f0" Value="BMOETMA"/>
18    </STRUCT>
19  </STRUCT>
20</FORM>

Change Icon to ICO_Cold.tga
Change the f0 Parameter to BMOETMC family since this is going to be a cold spell effect

Note: Offensive Magic Damage families in ryzom so far are 
* BMOETMA    Acid Damage
* BMOETMC    Cold Damage
* BMOETMR    Rot Damage
* BMOETME    Electricity Damage
* BMOETMF    Fire Damage
* BMOETMP    Poison Damage
* BMOETMS    Shockwave Damage

Creating the cold damage component

The provided acid spell damage is defined in the bmoetma00003.sbrick file. Copy it, name it bmoetmc00005.sbrick and open it so we change it accordingly to the cold damage. You should see something like this:

 1<?xml version="1.0"?>
 2<FORM Revision="$Revision: 1.12 $" State="modified">
 3  <STRUCT>
 4    <STRUCT Name="Basics">
 5      <ATOM Name="FamilyId" Value="BMOETMA"/>
 6      <ATOM Name="IndexInFamily" Value="1"/>
 7      <ATOM Name="SabrinaCost" Value="3"/>
 8      <ATOM Name="SPCost" Value="7"/>
 9      <ATOM Name="Property 0" Value="MA: moet"/>
10      <ATOM Name="Property 1" Value="MA_DMG: 15: 0: 0"/>
11      <ATOM Name="Property 2" Value="MA_DMG_TYPE: acid"/>
12      <ATOM Name="Property 4" Value="SET_BEHAVIOUR:CAST_ACID"/>
13      <ATOM Name="Property 5" Value="MA_END"/>
14      <ATOM Name="LearnRequiresOneOfSkills" Value="SM 0"/>
15      <ATOM Name="Action Nature" Value="OFFENSIVE_MAGIC"/>
16    </STRUCT>
17    <STRUCT Name="Client">
18      <ATOM Name="Icon" Value="ICO_Power.tga"/>
19      <ATOM Name="IconBack" Value="PA_Back.tga"/>
20    </STRUCT>
21  </STRUCT>
22</FORM>

Change the FamilyId to the cold family which is BMOETMC
Since this is the first level of our new cold spell leave the familyIndex at 1. If you add more later remember to increment this number
Change the sabrina costs as you like, ill leave it at 3 so i can create the spell with the existing spell credits
Property 1 defines how much damage the spell does to which value. The order is hp:sap:sta
Change Property 2 to MA_DMG_TYPE: cold
Change Property 4 to SET_BEHAVIOUR:CAST_COLD

Time to test it!

Build the sheets_id.bin with the make_sheet_id tool and copy it to the user dir in your game client dir
Build the .packed_sheets with the sheets_packer and copy it to the same location
Copy your newly created sheets on the server and delete all .packed_sheets from the server/data_shard dir if existing
Make sure the two files we created are existing in the correct dir in your leveldesign dir and that they contain the content i explained before
Start your server
Start your client and let him connect to your server
When ingame select your char and type the following command into the chat

/a learnBrick bmoetea02.sbrick

/a learnBrick bmoetmc00005.sbrick

You should now be able to create a cold damage spell, congratz :D

Add heal spell¶

So now we are going to add something more complex. For the heal spell we need to define a new generic spell type, the new spell effect and the actual spell level.

Switch to your sbrick folder and find the bmpa01.sbrick file, copy it and rename it to bmpa04.brick. This file will define the new generic type for heal spells. Open it and it should look something like this:

 1<?xml version="1.0"?>
 2<FORM Revision="$Revision: 1.0 $" State="modified">
 3  <STRUCT>
 4    <STRUCT Name="Basics">
 5      <ATOM Name="FamilyId" Value="BMPA"/>
 6      <ATOM Name="SabrinaCost" Value="0"/>
 7      <ATOM Name="LearnRequiresOneOfSkills" Value="SM 0"/>
 8      <ATOM Name="Action Nature" Value="OFFENSIVE_MAGIC"/>
 9      <ATOM Name="MinCastTime" Value="28"/>
10    </STRUCT>
11    <STRUCT Name="Client">
12      <ATOM Name="Icon" Value="ICO_Atysian.tga"/>
13      <ATOM Name="IconBack" Value="MP_Back_Offensive.tga"/>
14    </STRUCT>
15    <STRUCT Name="Mandatory">
16      <ATOM Name="f0" Value="BMOETEA"/>
17    </STRUCT>
18    <STRUCT Name="Optional">
19      <ATOM Name="f0" Value="BMOF"/>
20      <ATOM Name="f1" Value="BMOG"/>
21      <ATOM Name="f2" Value="BMOH"/>
22      <ATOM Name="f3" Value="BMOV"/>
23        <ATOM Name="f4" Value="BMOR"/>
24    </STRUCT>
25    <STRUCT Name="Credit">
26      <ATOM Name="f0" Value="BMCA"/>
27      <ATOM Name="f1" Value="BMCR"/>
28      <ATOM Name="f2" Value="BMCC"/>
29      <ATOM Name="f3" Value="BMCP"/>
30    </STRUCT>
31  </STRUCT>
32  <LOG/></FORM>

Change the Action Nature to CURATIVE_MAGIC which is the coded family for heal spells.
If you want you can change the MinCastTime. The old value 28 means it will take 2.8s to cast this spell. A value of 20 would mean 2.0s cast time.
Change the Icon to ICO_Celestial.tga
Change IconBack to MP_Back_Curative.tga
Change the f0 atom from Mandatory to BMDHTEA which is the heal effect family
I did remove the f3 atom from Optional because it is the Vampirism efecct which doesnt make sense for a heal spell; i think this was said somewhere in the source code too

Creating the heal spell effect

Now find the bmoetea01.sbrick file, copy and rename it to bmdhtea01.sbrick. The content of this file which previously defined the acid spell effect will now be adjusted to define a heal hp spell effect. Open it and it should look something like this:

 1<?xml version="1.0"?>
 2<FORM Revision="$Revision: 1.0 $" State="modified">
 3  <STRUCT>
 4    <STRUCT Name="Basics">
 5      <ATOM Name="FamilyId" Value="BMOETEA"/>
 6      <ATOM Name="SabrinaCost" Value="0"/>
 7      <ATOM Name="SPCost" Value="37"/>
 8      <ATOM Name="LearnRequiresOneOfSkills" Value="SM 0"/>
 9      <ATOM Name="Action Nature" Value="OFFENSIVE_MAGIC"/>
10      <ATOM Name="Skill" Value="SMOEAEM"/>
11    </STRUCT>
12    <STRUCT Name="Client">
13      <ATOM Name="Icon" Value="ICO_Acid.tga"/>
14      <ATOM Name="IconBack" Value="EF_Back.tga"/>
15    </STRUCT>
16    <STRUCT Name="Parameter">
17      <ATOM Name="f0" Value="BMOETMA"/>
18    </STRUCT>
19  </STRUCT>
20</FORM>

Change the FamilyId to BMDHTEA
Change the Action Nature to CURATIVE_MAGIC
Change the Skill to SMDHAEM
Change the Icon to ICO_Heal.tga
Change the f0 Parameter to BMDHTMP

Creating the heal level component

Now find the bmoetma00003.sbrick file, copy and rename it to bmdhtmp00005.sbrick. The content of this file which previously defined the acid spell level will now be adjusted to define the heal hp spell level. Open it and it should look something like this:

 1<?xml version="1.0"?>
 2<FORM Revision="$Revision: 1.0 $" State="modified">
 3  <STRUCT>
 4    <STRUCT Name="Basics">
 5      <ATOM Name="FamilyId" Value="BMOETMA"/>
 6      <ATOM Name="IndexInFamily" Value="1"/>
 7      <ATOM Name="SabrinaCost" Value="3"/>
 8      <ATOM Name="SPCost" Value="7"/>
 9      <ATOM Name="Property 0" Value="MA: moet"/>
10      <ATOM Name="Property 1" Value="MA_DMG: 15: 0: 0"/>
11      <ATOM Name="Property 2" Value="MA_DMG_TYPE: acid"/>
12      <ATOM Name="Property 4" Value="SET_BEHAVIOUR:CAST_ACID"/>
13      <ATOM Name="Property 5" Value="MA_END"/>
14      <ATOM Name="LearnRequiresOneOfSkills" Value="SM 0"/>
15      <ATOM Name="Action Nature" Value="OFFENSIVE_MAGIC"/>
16      <ATOM Name="MinCastTime" Value="30"/>
17      <ATOM Name="MaxCastTime" Value="130"/>
18    </STRUCT>
19    <STRUCT Name="Client">
20      <ATOM Name="Icon" Value="ICO_Power.tga"/>
21      <ATOM Name="IconBack" Value="PA_Back.tga"/>
22    </STRUCT>
23  </STRUCT>
24</FORM>

Change the FamilyId to BMDHTMP
Change the Property 0 to MA: mdht
Change the Property 1 to MA_HEAL: 15: 0: 0
Delete the Property 2, we dont need a dmg type
Change the Property 4 to SET_BEHAVIOUR:CAST_HEALHP
Change the Action Nature to CURATIVE_MAGIC

Time to test it!

Build the sheets_id.bin with the make_sheet_id tool and copy it to the user dir in your game client dir
Build the .packed_sheets with the sheets_packer and copy it to the same location
Copy your newly created sheets on the server and delete all .packed_sheets from the server/data_shard dir if existing
Make sure the three files we created are existing in the correct dir in your leveldesign dir and that they contain the content i explained before
Start your server
Start your client and let him connect to your server
When ingame select your char and type the following command into the chat

/a learnBrick bmpa04.sbrick

/a learnBrick bmdhtea01.sbrick

/a learnBrick bmdhtmp00005.sbrick

You should now be able to create a heal spell, congratz :D

Add sap credit¶

Ryzom Core provides a sap credit 2 defined in bmca00002.sbrick.
Let's create a sap credit 5.

Copy the previous file and name it bmca00005.sbrick.
Then open it to create the desire sap credit.

You should see something like this:

 1<?xml version="1.0"?>
 2<FORM Revision="$Revision: 1.17 $" State="modified">
 3  <STRUCT>
 4    <STRUCT Name="Basics">
 5      <ATOM Name="FamilyId" Value="BMCA"/>
 6      <ATOM Name="IndexInFamily" Value="2"/>
 7      <ATOM Name="SabrinaCost" Value="-2"/>
 8      <ATOM Name="SPCost" Value="3"/>
 9      <ATOM Name="Property 1" Value="SAP: 7"/>
10      <ATOM Name="LearnRequiresOneOfSkills" Value="SM 0"/>
11      <ATOM Name="Action Nature" Value="UNKNOWN"/>
12    </STRUCT>
13    <STRUCT Name="Client">
14      <ATOM Name="Icon" Value="ICO_Sap.tga"/>
15      <ATOM Name="IconBack" Value="CP_Back.tga"/>
16      <ATOM Name="IconOver" Value="CP_Over_More.tga"/>
17    </STRUCT>
18  </STRUCT>
19</FORM>

Change the IndexInFamily to 5, that's the 5th credit in the family
Change the SabrinaCost to -5, the value of the credit
Change the Property 1 to SAP: 10, the sap cost of the credit

Time to test it!

Build the sheets_id.bin with make_sheet_id, copy it to your client user folder
Build the .packed_sheets with sheets_packer, copy everything in the same folder
Copy your newly created sheets on the server and delete all .packed_sheets from code/ryzom/server/data_shard
Place the new brick in your server
Start your server
Connect your client to your server

Type the following command in your client

/a learnBrick bmca00005.sbrick

You should have a new sap credit available now.

Add bomb effect¶

The bomb effect allows us to hit multiple targets.

Let's create our own file this time.

We will use an existing sheet name.
Create a new file and name it bmof00040.sbrick.

Then paste the following content:

 1<?xml version="1.0"?>
 2<FORM Revision="$Revision: 1.0 $" State="modified">
 3  <STRUCT>
 4    <STRUCT Name="Basics">
 5      <ATOM Name="FamilyId" Value="BMOF"/>
 6      <ATOM Name="IndexInFamily" Value="1"/>
 7      <ATOM Name="SabrinaCost" Value="0"/>
 8      <ATOM Name="SPCost" Value="7"/>
 9      <ATOM Name="Property 0" Value="AREA_BOMB: 20: 0.9: 5"/>
10      <ATOM Name="Property 1" Value="AREA_TARGETS: 0.9: 5"/>
11      <ATOM Name="LearnRequiresOneOfSkills" Value="SM 0"/>
12      <ATOM Name="Action Nature" Value="UNKNOWN"/>
13    </STRUCT>
14    <STRUCT Name="Client">
15      <ATOM Name="Icon" Value="ICO_Bomb.tga"/>
16      <ATOM Name="IconBack" Value="OP_Back.tga"/>
17    </STRUCT>
18  </STRUCT>
19</FORM>

Let's try to understand the syntax.

Set the FamilyId to BMOF, that's the base name of the sheet family
Set the IndexInFamily to 1, it's the 1st effect in the family
Set the SabrinaCost to 0,
we are setting the sap cost of the effect to 0, that way we don't need more sap credits
Set the Property 0 to AREA_BOMB: 20: 0.9: 5,
the syntax AREA_BOMB: Radius: MinFactor: MaxTargets
Set the Property 1 to AREA_TARGETS: 0.9: 5,
the syntax AREA_TARGETS: TargetFactor: MaxTargets
Set the Action Nature to UNKNOWN,
the bomb effect can be use with both the acid spell and the healing spell
Set the Icon to ICO_Bomb.tga, the foreground icon
Set the IconBack to OP_Back.tga, the background icon

Time to test it!

Build the sheets_id.bin with make_sheet_id,
copy it to your client user folder
Build the .packed_sheets with sheets_packer,
copy everything in the same folder
Copy your newly created sheets on the server and delete all .packed_sheets from
code/ryzom/server/data_shard
Place the new brick in your server
Start your server
Connect your client to your server

Type the following command in your client

/a learnBrick bmof00040.sbrick

You should have a bomb effect available now.

Add removal brick¶

We need a brick to remove the stanzas in our actions.

We will create a dummy brick for that purpose.
Create a new file and name it big_remove.sbrick.

Then paste the following content:

1<?xml version="1.0"?>
2<FORM Revision="$Revision: 1.0 $" State="modified">
3  <STRUCT>
4    <STRUCT Name="Client">
5      <ATOM Name="Icon" Value="No_Action.tga"/>
6    </STRUCT>
7  </STRUCT>
8</FORM>

Set the Icon to No_Action.tga, the icon of our dummy brick

Time to test it!

Build the sheets_id.bin with make_sheet_id,
copy it to your client user folder
Build the .packed_sheets with sheets_packer,
copy everything in the same folder
Copy your newly created sheets on the server and delete all .packed_sheets from
code/ryzom/server/data_shard
Place the new brick in your server
Start your server
Connect your client to your server

Type the following command in your client

/a learnBrick big_remove.sbrick

Now you've got a removal brick.

Add spell to trainer¶

Let's add the cold spell (previously defined) to a trainer.

First, we will create a new sphrase.
Create a new file and name it abm_mt_cold_00005.sphrase.

Then paste the following content:

 1<?xml version="1.0"?>
 2<FORM Revision="$Revision: 1.0 $" State="modified">
 3  <STRUCT>
 4    <ATOM Name="brick 0" Value="bmpa01.sbrick"/>
 5    <ATOM Name="brick 1" Value="bmoetea02.sbrick"/>
 6    <ATOM Name="brick 2" Value="bmoetmc00005.sbrick"/>
 7    <ATOM Name="brick 3" Value="bmcr00001.sbrick"/>
 8    <ATOM Name="brick 4" Value="bmca00002.sbrick"/>
 9  </STRUCT>
10</FORM>

Let's try to understand the sphrase format.

A sphrase is a list of sbrick.
We will list all the sbrick (spell, credit, effect, etc) that we need.

We will learn all of them at once:

bmpa01.sbrick General damage spell component
bmoetea02.sbrick Cold spell effect
bmoetmc00005.sbrick Cold spell damage
bmcr00001.sbrick Range credit
bmca00002.sbrick Sap credit

Now that we have something to learn, let's add the trainer.

You can use either the World Editor or edit the primitive yourself.

If you don't know how to use the World Editor, have a look here:

http://dev.ryzom.com/projects/ryzom/wiki/UseWorldEditor

With the World Editor, open code/ryzom/common/data_leveldesign/primitives/newbieland/urban_newbieland.primitive.
Add a npc_group and call it nb_trainers.

In that groupe, add a npc_bot and enter the following properties:

In chat_parameters, we will list all the sphrase we want.

You can move your trainer wherever you want.

Save the primitive.

Alternatively, if you don't want to use the World Editor.

Open code/ryzom/common/data_leveldes 2 3 4 5 6 7 8 9 1 11 12 13 14 15 16 17 18 19 2 21 22 23 24 25 26 27 28 29 3 31 32 33 34 35 36 37 38 39 4 41 42 43 44 45 46 47 48 49 5 51 52 53 54 55 56 57 58 59 6 61 62 63 64 65 66 67 68 69 7 71 72 73 ign/primitives/newbieland/urban_newbieland.primitive and add the following content:

 1        <CHILD TYPE="CPrimNode"> <PROPERTY TYPE="string"> <NAME>class</NAME> <STRING>npc_group</STRING> </PROPERTY> <PROPERTY TYPE="string"> <NAME>name</NAME> <STRING>nb_trainers</STRING> </PROPERTY> 0          <CHILD TYPE="CPrimNode"> <PROPERTY TYPE="string"> <NAME>class</NAME> <STRING>npc_group_parameters</STRING> </PROPERTY> <PROPERTY TYPE="string"> <NAME>name</NAME> <STRING>parameters</STRING> </PROPERTY> </CHILD> 0          <CHILD TYPE="CPrimAlias"> <ALIAS VALUE="1260"/> <PROPERTY TYPE="string"> <NAME>class</NAME> <STRING>alias</STRING> </PROPERTY> <PROPERTY TYPE="string"> <NAME>name</NAME> <STRING>alias</STRING> </PROPERTY> 0          </CHILD> <CHILD TYPE="CPrimPoint"> <PT X="10313.020508" Y="-11731.011719" Z="0.000000"/> <PROPERTY TYPE="string_array"> <NAME>chat_parameters</NAME> <STRING>phrase : abm_mt_cold_00005.sphrase</STRING> </PROPERTY> <PROPERTY TYPE="string"> <NAME>class</NAME> <STRING>npc_bot</STRING> 0            </PROPERTY> <PROPERTY TYPE="string_array"> <NAME>equipment</NAME> <STRING>CHANDS : 1</STRING> <STRING>CBODY : 3</STRING> <STRING>CLEGS : 3</STRING> <STRING>CFEETS : 3</STRING> <STRING>CARMS : 1</STRING> </PROPERTY> <PROPERTY TYPE="string"> 0              <NAME>is_stuck</NAME> <STRING>true</STRING> </PROPERTY> <PROPERTY TYPE="string"> <NAME>name</NAME> <STRING>nbland_trainer_magic$fct_m_trainer$</STRING> </PROPERTY> <PROPERTY TYPE="string"> <NAME>sheet_client</NAME> <STRING>company_of_the_drill_loge_master_z_h_b1</STRING> 0            </PROPERTY> <CHILD TYPE="CPrimAlias"> <ALIAS VALUE="1261"/> <PROPERTY TYPE="string"> <NAME>class</NAME> <STRING>alias</STRING> </PROPERTY> <PROPERTY TYPE="string"> <NAME>name</NAME> <STRING>alias</STRING> 0              </PROPERTY> </CHILD> </CHILD> </CHILD>


	after the following lines (the merchant group):
 1              <ALIAS VALUE="146"/>
 2              <PROPERTY TYPE="string">
 3                <NAME>class</NAME>
 4                <STRING>alias</STRING>
 5              </PROPERTY>
 6              <PROPERTY TYPE="string">
 7                <NAME>name</NAME>
 8                <STRING>alias</STRING>
 9              </PROPERTY>
10            </CHILD>
11          </CHILD>
12        </CHILD>



	Time to test it!


	
	Place the new sphrase in your server somewhere in code/ryzom/common/data_leveldesign/leveldesign/game_element/sphrase
		Update code/ryzom/common/data_leveldesign/primitives/newbieland/urban_newbieland.primitive on your server
		Start your server
		Connect your client to your server
	


	
	Your trainer should appear next to the tower.
	


	
Making spells visible in skill tree (todo)¶


	Todo


	
Troubleshooting¶


	If not everything is working as expected enable debug infos for the EGS service on your server. Set the following parameters in EGS. Now when trying to create a armor or learn some bricks you should get some more infos in the EGS output to find the error. Of course you can also ask me in irc.


	
	EGS commands
	
	VerboseBrickManagerInfo 1
		VerboseBrickManagerDbg 1
		DisableNLDebug 0






shape.png  
  (14 kB)
	
	
  
    aquiles, 05/29/2010 04:43 pm
  
  

light_armor_set.png  
  (63.7 kB)
	
	
  
    aquiles, 05/29/2010 05:21 pm
  
  

edit_acid1.png  
  (126.2 kB)
	
	
  
    aquiles, 05/29/2010 05:54 pm
  
  

edit_cold1.png  
  (130.9 kB)
	
	
  
    aquiles, 05/29/2010 06:28 pm
  
  

cast_cold1.png  
  (117.5 kB)
	
	
  
    aquiles, 05/29/2010 06:28 pm
  
  

sap_credit.png  
  (113.9 kB)
	
	
  
    molator, 09/01/2010 05:42 pm
  
  

bomb_effect.png  
  (123.6 kB)
	
	
  
    molator, 09/12/2010 10:02 pm
  
  

bomb_effect2.png  
  (117.8 kB)
	
	
  
    molator, 09/13/2010 05:51 pm
  
  

removal_brick.png  
  (107.3 kB)
	
	
  
    molator, 09/22/2010 11:07 am
  
  

trainer.png  
  (12.1 kB)
	
	
  
    molator, 06/07/2011 07:58 pm

Ryzom

Wiki

Adding Game Entities (Armor, Spells etc.)¶

Description¶

Prerequisites¶

Adding Armor¶

General¶

File Naming, Skill Families, Icons etc.¶

Creating Armor SItem¶

Creating Armor SBrick¶

Make it available on server and client¶

Tutorial Videos:¶

Add armor to merchant¶

Tutorial Videos:¶

Add crafting plan to trainer (todo)¶

Adding Spells¶

Add cold spell¶

Add heal spell¶

Add sap credit¶

Add bomb effect¶

Add removal brick¶

Add spell to trainer¶

Making spells visible in skill tree (todo)¶

Troubleshooting¶