Hercules Wiki - User contributions [en]

Custom Mobs

2016-07-02T23:52:02Z

Asheraf:

= Intro =
You can have up to 10,000 mob IDs. This guide was written without testing on Git; use at your own discretion.
Well, its pretty easy if you do it correctly and go step by step without rushing.

= Gettings Started =
== Database Structure ==
Let's take a look at the structure of the entries in mob_db.conf:

Note: If you're adding custom mobs, it's better to add them to mob_db2.conf

<pre>
{
// =================== Mandatory fields ===============================
Id: ID (int)
SpriteName: "SPRITE_NAME" (string)
Name: "Mob name" (string)
// =================== Optional fields ================================
Lv: level (int, defaults to 1)
Hp: health (int, defaults to 1)
Sp: mana (int, defaults to 0)
Exp: basic experience (int, defaults to 0)
JExp: job experience (int, defaults to 0)
AttackRange: attack range (int, defaults to 1)
Attack: [attack1, attack2] (int, defaults to 0)
Def: defence (int, defaults to 0)
Mdef: magic defence (int, defaults to 0)
Stats: {
Str: strength (int, defaults to 0)
Agi: agility (int, defaults to 0)
Vit: vitality (int, defaults to 0)
Int: intelligence (int, defaults to 0)
Dex: dexterity (int, defaults to 0)
Luk: luck (int, defaults to 0)
}
ViewRange: view range (int, defaults to 1)
ChaseRange: chase range (int, defaults to 1)
Size: size (int, defaults to 1)
Race: race (int, defaults to 0)
Element: (type, level)
Mode: {
CanMove: true/false (bool)
Looter: true/false (bool)
Aggressive: true/false (bool)
Assist: true/false (bool)
CastSensorIdle:true/false (bool)
Boss: true/false (bool)
Plant: true/false (bool)
CanAttack: true/false (bool)
Detector: true/false (bool)
CastSensorChase: true/false (bool)
ChangeChase: true/false (bool)
Angry: true/false (bool)
ChangeTargetMelee: true/false (bool)
ChangeTargetChase: true/false (bool)
TargetWeak: true/false (bool)
}
MoveSpeed: move speed (int, defaults to 0)
AttackDelay: attack delay (int, defaults to 4000)
AttackMotion: attack motion (int, defaults to 2000)
DamageMotion: damage motion (int, defaults to 0)
MvpExp: mvp experience (int, defaults to 0)
MvpDrops: {
AegisName: chance (string: int)
...
}
Drops: {
AegisName: chance (string: int)
...
}

},
</pre>

{| class="wikitable"
|-
! Fields !! Description
|-
| '''Id''' || ID of the mob
|-
| '''SpriteName''' || This first name is the DB name. When you use @spawn/@summon and you know the name of the mob, but not the ID, type this name instead. Try making the normal name the same as this so you wont get confused.
|-
| '''Name''' || This is the name the server shows.
|-
| '''Lv''' || Level of the mob
|-
| '''Hp''' || HP of the mob
|-
| '''Sp''' || SP of the mob
|-
| '''Exp''' || Exp granted by the mob
|-
| '''JExp''' || Job exp granted by the mob
|-
| '''AttackRange''' || Range of the mob attack. If set to 1 or 2, it will melee. 3 or more than 3 will set it to ranged
|-
| '''Attack1''' || Affects ATK of the mob
|-
| '''Attack2''' || Affects MATK of the mob
|-
| '''Def''' || Defense of the mob (Tip: 100 def = Invulnerability below 8K attack. Watch out, only melee/ranged attacks, but generally direct hits attacks are drastically reduced. Setting this high enough may make monks pretty cheap to level because of of Psychic Wave/Occult Impact/Investigate.)
|-
| '''MDef''' || Magic Defense of the mob (Hint: 100 mdef = golden thief bug effect below 9K magic attack. It's for all magic-using skills.)
|-
| '''Stats''' || All Stats of mobs belongs to this block.
{| class="wikitable"
|-
! Stats !! Description
|-
| '''Str''' || Strength of the mob. This also affects its ATK.
|-
| '''Agi''' || Agility of the mob. This also affects the mob flee rate.
|-
| '''Vit''' || Vitality of the mob. This affects the duration of stun status.
|-
| '''Int''' || Intelligence of the mob. This also affects its MATK.
|-
| '''Dex''' || Dexterity of the mob. This also affects the mob hit rate.
|-
| '''Luk''' || Luck of the mob. This also defines the mob perfect dodge/lucky flee/perfect flee/lucky dodge rate.
|}
|-
| '''ViewRange''' || Maximum Skill Range
|-
| '''ChaseRange''' || Sight limit for mobs. If set to 1000 or beyond, mobs will follow you all over the map.
|-
| '''Size''' || 0 if its Small, 1 if its Medium, 2 if its Large
or Small=Size_Small, Medium=Size_Medium, Large=Size_Large
|-
| '''Race''' || 0=formless, 1=undead, 2=animal, 3=plant, 4=insect, 5=fish, 6=demon, 7=demihuman, 8=angel, 9=dragon.
or formless=RC_Formless, undead=RC_Undead, animal=RC_Brute, plant=RC_Plant, fish=RC_Fish, demihuman=RC_DemiHuman, angel=RC_Angel, dragon=RC_Dragon.
|-
| '''Element''' || This is a two-digit number representing the rank (level) and element of the mob. 
|-
| '''Element(Type)''' || Element Type of mob as mentioned below. 
{| class="wikitable" style="text-align: center;"
|
|Neutral
|Water
|Earth
|Fire
|Wind
|Poison
|Holy
|Shadow
|Ghost
|Undead
|-
| Type
|0
|1
|2
|3
|4
|5
|6
|7
|8
|9
|}
or "Ele_Name" (Neutral, Water, Earth, Fire, Wind, Poison, Holy, Shadow, Ghost, Undead.)

|-
| '''Element(Level)''' || Element level of mob from (1-4). 
|-
| '''Mode''' || This defines the mob behaves.
|-
| '''MoveSpeed''' || Walking speed of the mob. 1 is the fastest, 1000 is the lowest. 100 is the normal walking speed.
|-
| '''AttackDelay''' || ADelay= Attack Delay, also known as ASPD. This one will change the aspd of the mob. The lower the faster, but don't make it too low or it will lag when mobbed by several of these.
|-
| '''AttackMotion''' || Attack animation motion. Lower this value and the mob's attack will be displayed in higher fps (making it shorter, too) (Thanks to Wallex for this)
|-
| '''DamageMotion''' || Damage animation motion, same as aMotion but used to display the "I am hit" animation. Coincidentally, this same value is used to determine how long it is before the mob/player can move again. Endure is dMotion = 0, obviously.
|-
| '''MvpExp''' || The MVP exp the mob gives when it is defeated (to the player who got the MVP reward) (This exp is a percentage of the exp the monster gives.)
|-
The following fields are for drops and drop rates. Remember that these are in percentages; i.e. 100 = 100%
|-
| '''MvpDrops''' || The MvP Drops goes here, format is:
<pre>AegisName: Chance</pre>
Example:
<pre>Poring_Card: 1000</pre>
|-
| '''Drops''' || The Normal Drops goes here, format is:
<pre>AegisName: Chance</pre>
Example:
<pre>Poring_Card: 1000</pre>
|}

== Making it visible ==
=== Server Side ===
If you've got a sprite and you're happy with it, then you can skip this part. If you would like to make your mob look like another mob, or even a player, then you need to take a look at {{git|db/mob_avail.txt|full}}

For normal mobs, you can use the data that's already in the file as an example to work on:
// mob_id,sprite_id,equip #
// iRO Halloween Event 2008
//3000,1015,0
//3001,1036,0
//3002,1298,0

// iRO Halloween Event 2009
//3014,1179,0
//3015,1272,0

However, if you would like to make your mob look like a character, you need to add more options: 
// Valaris
{| class="wikitable"
|-
| MobID || SpriteID || Sex || Hair || Hair_Color || Weapon || Shield || Head_Top || Head_Middle || Head_Bottom || Option || Dye_Color
|-
| 1900, || 4013, || 1, || 1, || 1, || 1254, || 0, || 67, || 12, || 54, || 16, || 1
|}
You will need to use the Item ID for your mob's weapon and shield instead of the View ID of the item. Doing so may have undesirable effects.

A more in-depth look at each value: 
 '''MobID''': This is your mob ID.
 '''SpriteID''': The Job number you want it to look like. They are:
<pre>Job_Novice 0
Job_Swordman 1
Job_Mage 2
Job_Archer 3
Job_Acolyte 4
Job_Merchant 5
Job_Thief 6
Job_Knight 7
Job_Priest 8
Job_Wizard 9
Job_Blacksmith 10
etc</pre>
They can also be found on {{git|db/const.txt}} file.

 '''Sex''': 0 for female, 1 for male
 '''Hair''': The mob hair style, goes from 1 to 23
 '''Hair_Color''': The mob hair color. Goes from 0 to 8 or 10, but it depends on the server's palette files.
 '''Weapon''':The ID of the Weapon you want. See [[Custom_weapons|Custom Weapons]] for it. Also read at the end of the pre if you cant find the headgear you want.
 '''Shield''': Same as above
 '''Head_Top''': Same as above
 '''Head_Middle''': Same as above
 '''Head_Bottom''': Same as above
 '''Option''': this option parameter will make the mob change its status, as well as give them carts, pecopecos, and falcons. In other words, this will change the visual effects of your mobs. The options are these*:
<pre>
1 Sight 32 Peco Peco riding 2048 Orc Head
2 Hide 64 GM Perfect Hide 4096 Wedding Sprites
4 Cloak 128 Level 2 Cart 8192 Ruwach
8 Level 1 Cart 256 Level 3 Cart
16 Falcon 512 Level 4 Cart
1024 Level 5 Cart
</pre>

 '''Dye_Color''': Same as hair color. It goes from 0 to 77

=== Client Side ===
For your mob to exist in the client, you need to add it to a few [[Lua]] files.
==== datainfo/npcidentity.lua ====
Example at the end of the file: 
["JT_4_F_TAEKWON"] = 644,
["JT_4_F_SWORDMAN"] = 645,
-- Custom Mobs
["JT_JACOB"] = 2500,
["JT_AQUARING"] = 2600
}
The number after the = sign denotes the mob's database ID number. Other sprites in this file have their view ID e.g. [[Adding_a_Script#Client_Side|NPC sprite number]].

==== datainfo/jobname.lua ====
Example at the end of the file: 
[jobtbl.JT_GIBBET] = "GIBBET",
[jobtbl.JT_DULLAHAN] = "DULLAHAN",
[jobtbl.JT_LOLI_RURI] = "LOLI_RURI",
[jobtbl.JT_DISGUISE] = "DISGUISE",
-- Custom Mobs
[jobtbl.JT_JACOB] = "jacobmob",
[jobtbl.JT_AQUARING] = "aquaring"
}
In this file, the value after the = sign is the name of the actual sprite in your data folder/[[GRF]]

== Your mob in other files ==
=== Dead Branch ===
Adding your mob to {{git|db/pre-re/mob_branch.txt}} or {{git|db/re/mob_branch.txt}} will allow Dead Branches to summon it.

=== Bloody Branch ===
Adding your mob to {{git|db/pre-re/mob_boss.txt}} or {{git|db/re/mob_boss.txt}} will allow Bloody Branches to summon it.

=== Poring Box ===
Adding your mob to {{git|db/pre-re/mob_poring.txt}} or {{git|db/re/mob_poring.txt}} will make your mob spawnable via the Poring Box.

=== Monster Racial Groups ===
Adding your mob to {{git|db/pre-re/mob_race2_db.txt}} or {{git|db/re/mob_race2_db.txt}} will add your mob to a [[Racial_Group|Racial Group]]. Guardians, Goblins and other mobs are members of particular Racial Groups.

=== Red Pouch of Surprise ===
Adding your mob to {{git|db/mob_pouch.txt}} will make your mob spawnable via the Red Pouch of Surprise.

== Spawn Points ==
Let's look at the syntax of a mob spawn point:

<pre>
<map name>,<x1>,<y1>,<x2>,<y2>%TAB%monster%TAB%<monster name>%TAB%<mob id>,<amount>,<delay1>,<delay2>,<event>{,<mob size>,<mob ai>}
</pre>

Only the things between <> are changed. Do not remove or change monster after the coordinates, because that's what tells the server that this line is a monster spawn script.

 '''map name''': Name of the map. Use /where along with the following coordinates
 '''x1''': X axis coordinates. It start from the left side of the map, and the higher it gets, the more it gets closer to the right side of the map.
 '''y1''': Y axis coordinates. It start from the bottom, and the higher it gets, the more it gets closer to the top of the map.
 '''x2''': X axis coordinates. It start from the left side of the map, and the higher it gets, the more it gets closer to the right side of the map.
 '''y2''': Y axis coordinates. It start from the bottom, and the higher it gets, the more it gets closer to the top of the map.
 These 4 coordinates will make a spawn area where the mob will spawn, however it won't limit its movement, so lets say you put 120,150 on the first pair, and 130,160 pair- That's a 10x10 cell area where the mob will spawn randomly.
 If you want the mob to spawn at a random point, use 0 for all the coordinates.
 '''monster name''': The name of the mob you want to be shown (using --ja-- in place of a name will display the "Japanese Name" from your database).
 You can specify a custom level to use for the mob different from the one of the database by adjoining the level after the name with a comma. eg: "Poring,50" for a name will spawn a monster with name Poring and level 50.
 '''mob id''': The ID of your mob.
 '''amount''': How many mobs you want to be spawned.
 '''delay1''': Minimum amount of time before a monster respawns.
 '''delay2''': Maximum amount of time before a monster respawns.
 delay1 and delay2 are used to define the time it takes for a monster to respawn; in milliseconds. Normal mobs usually have 0 (Instant Respawn), while MVPs have 7200000 (2 hours). If delay2 is greater than delay 1, the mob won't respawn until the map server restarts.
 '''event''': Script event to be executed when the mob is killed. The event must be in the form "NPCName::OnEventName" to execute, and the event name label should start with "On". As with all events, if the NPC is an on-touch NPC, the player who triggers the script must be within 'trigger' range for the event to work.
 '''size''': Optional. Size can be 0 (medium), 1 (small), or 2 (big).
 '''ai''': Optional. AI can be 0 (default), 1 (attack/friendly), 2 (sphere), 3 (flora), or 4 (zanzou).

== Adding Skills ==

Lets look at the syntax of a mob skill:

<pre>
MOB_ID, a unused dummy character sequence (for information only), STATE, SKILL_ID, SKILL_LV,
rate (10000 = 100%), casttime, delay, cancelable, a target, a condition type, a condition value,
a value 1, a value 2, a value 3, a value 4, a value 5, emotion
</pre>

 '''''
NOTE: I had to cut the mob_avail structure so it could fit.
It's a whole line, not 3 lines.
'''''

 '''MOD_ID''': your mob ID.
 '''an unused.. etc etc''': you can put any text here you want, its just for information and to know what does this do.* tip tip*You will see inside this file things like Poring@TF_POISON. Well, you could use this too. It would tell you: mob_name@DB_Skill_Name. *tip tip*
 '''state''': this is the state that the mob must accomplish before being able to use this skill. The states are:

<pre>
any, idle (in standby), walk (in movement), attack, dead (on killed), loot, chase (following target),
counterattack.
</pre>

 '''SKILL_ID''': The ID of the skill goes here. To look for one, go to your db folder and open the skill_db.txt file. You will see a lot of lines like this one:

<pre>2,0,0,0,0,0,10,0,no,0,0,0,weapon,0 //SM_SWORD#Œ•C—û#</pre>

And the syntax is:

<pre>
id,range,hit,inf,pl,nk,max,list_num,castcancel,cast_defence_rate,inf2,maxcount,skill_type,blow_count
</pre>

so, the ID of the SM_SWORD, which is the Swordman's Sword Mastery by the way, is 2:

<pre>'''2''',0,0,0,0,0,10,0,no,0,0,0,weapon,0 //SM_SWORD#Œ•C—û#</pre>

 '''SKILL_LV''': You can put the skill level as high as you want. Though, 100 is usually as far as most skills go.
 '''rate''': How frequent will the mob use the skill.
 '''casttime''': Skill's cast time.
 '''delay''': How much time must pass before the skill can be used again, in milliseconds.
 '''cancelable''': if the skill cast can be interrupted. Set it either '''yes''' or '''no'''.
 '''a target''': the target of the skill. It can be:
<pre>
target (player), self (the mob itself), friend (slaves)
</pre>

 '''a condition type''':a condition that also must be fulfilled before the mob is able to use this skill. There are two kinds of conditions:

1. Mob Condition:
<pre>//conditions: (condition type) (value which specifies a condition value)
// always unconditional
// myhpltmaxrate when the mob's hp drops to a certain %
// mystatuson If the mob has any abnormalities in status (condition value),
// mystatusoff If the mob has ended any abnormalities in status (condition value),
// friendhpltmaxrate when the mobs' friend's hp drops to a certain %
// friendstatuson If the friend has any abnormalities in status (condition value),
// friendstatusoff If the friend has ended any abnormalities in status (condition value),
// attackpcgt Attack PC becomes more than the number of specification
// attackpcge Attack PC becomes equal or more than the number of specification.
// slavelt when the number of slaves is lower than the original number of specification.
// slavele when the number of slaves is lower or equal than the original number of specification.
// closedattacked when melee attacked (close range attack)
// longrangeattacked when long ranged attacked (like bows and far range weapons)
// skillused when a skill is used on the mob
// casttargeted when a target is in cast range.
// rudeattacked when a target is rude attacked
// hiding when a target is hidden *not implemented yet*
</pre>

2. Target Conditions
<pre>
// The character's state which can be specified to be a condition value
// by the statuson/statusoff system
//
// anybad any type of state change
// stone condition of being in stone state
// freeze condition of being in frozen state
// stan condition of being in stunned state
// sleep condition of being in sleep state
// poison condition of being in poisoned state
// curse condition of being in cursed state
// silence condition of being in silenced state
// confusion condition of being in confusion state
// blind condition of being in blind state
// hiding condition of being in hidden state
// sight condition of being in unhidden state
</pre>

You can use only ONE of these conditions.

 '''value1,value2,value3,value4,value5''': Basically they're only the same but, when you want your mob using the same condition to trigger the skill, but in different times, in case of the myhpltmaxrate when the hp is being decreased, you can set them in a decreasing order, like:

<pre>80,60,40,20,10</pre>

 '''emotion''': Lets your mob use an emotion, at random times. The emotion IDs are:

<pre>
e_gasp 0
e_what 1
e_ho 2
e_lv 3
e_swt 4
e_ic 5
etc
</pre>

For more info, go to your {{git|db/const.txt}} file.

== Making it talk! ==
Another add, suggested by chronocrosser_x and Fenrir Soarblade:

Well, I believe you have seen some mobs on your server talking when certain things happens. I never saw them again talking, dont know why but they used to talk. I believe they still do it.

Ok, go to your Data folder. If you look in the files, you should find a file called monstertalktable. If there isnt, we will create one with Wordpad =3!. If there is, open it with Wordpad, not Notepad.

Once there, we will copy and paste this:

<pre><nowiki><?xml version="1.0" encoding="euc-kr" ?>

<enemy_monster_talk_table>

<mob_db_name_here>
<discovery></discovery>
<attack></attack>
<hp50></hp50>
<hp25></hp25>
<kill></kill>
<dead></dead>
</mob_db_name_here>
</enemy_monster_talk_table></nowiki></pre>

Well, lets see step by step =3!:

 '''<enemy_monster_talk_table>''': This is the start of the monster talk table. Leave it as it is =3!
 '''<mob_db_name_here>''': The mob_db.txt first name you see, after the ID, goes here =3! Its used to identify the mob
 '''<discovery>%TAB%Text Here%TAB%</discovery>''': This is an event, same as the one below. When a monster see you, this one will be displayed =3!
 '''<attack>%TAB%Text Here%TAB%</attack>''': When a monster attacks you, this one will be displayed O_O!
 '''<hp50>%TAB%Text Here%TAB%</hp50>''': When a monster's hp is at 50%, this one will be displayed o..o!
 '''<hp25>%TAB%Text Here%TAB%</hp25>''': When a monster's hp is at 25%, this one will be displayed x,x
 '''<kill>%TAB%Text Here%TAB%</kill>''': When a monster kills a character/player, this one will be displayed T~T!
 '''<dead>%TAB%Text Here%TAB%</dead>''': When a monster dies by player hand, this one will be displayed ^__^!
 '''</mob_db_name_here>''': The same name of the mob_db.txt, the one after the ID.
 '''</enemy_monster_talk_table>''': Keep it like this.

I never messed with this, but i think its ok =3! Also for those spaces other than the messages spaces, use TAB, not the Space Bar for it ._.!

[[Category:Database]]
[[Category:Data]]
[[Category:Customization]]

Quest Log System

2016-07-01T16:16:46Z

Asheraf: Update quest db structure example

== Quest Log System ==

==== Basic Structure of NPC ====

First of all you must have a knowledge on basic scripting, if not please kindly Click [[Basic_Scripting|Here!]].

==== Quest Window ====

The Quest Window or Quest Journal (Opened via Alt+U) allows the player to view all quests their character has started but not yet completed (Except for instance dungeon quests and Battlegrounds instances, which always remain once started).
To place a quest in the Inactive tab, right click once on it and the name will turn gray. It will then appear on the Inactive tab instead of Active. Right clicking the name again will bring it back to the Active tab. Moving the quest back and forth has no effect on whether you can continue it or not.
Not every quest has a quest window component. Those quests who have quest window walkthroughs can be found in this category as well as by having their infobox in gold. Additionally, the Quest Window guides are not comprehensive, and do not specify the exact coordinates of the next NPC or location the player must visit. It is highly recommended to continue using the wiki guides along with the in-game walkthroughs.

[[File:QWindow.jpg|center|caption]]

== Quest Database - Adding Quest ==

=== Structure ===

<pre>
{
Id: Quest ID
Name: "Quest Name"
TimeLimit: seconds
Targets: (
{
MobId: Mob_ID
Count: number
},
)
Drops: (
{
ItemId: item_to_drop
Rate: Drop_Rate
MobId: Mob_ID_to_match
},
)
},
</pre>

Quest ID - ID of the quest, must increment and should not be duplicated. 
Name - The title of the Quest you made. 
Time Limit - Time limit for the quest to be finish in seconds. 
Targets - Monsters killing list contain mob ids and count. 
Drops - Item id to drop.

=== Example ===
For this example I will make a quest that will require to kill 10 Poring's.

<pre>
{
Id: 65000
Name: "Quest - Poring Hunt"
Targets: (
{
MobId: 1002
Count: 10
},
)
},
</pre>

==== Client Side Editing ====

You have to edit your questid2display.txt

==== Structure ====
<pre>
QUESTID#Quest Name#FILENAME#LOG_FILENAME#
Summary description#
Objective description#
</pre>

=== Example ===
<pre>
65000#Quest - Poring Hunt#SG_FEEL#QUE_NOIMAGE#
Find the monster named Poring and kill 10#
Hunting 10 Poring#
</pre>

== Quest Log Commands ==

=== Set Quest ===
<pre>*setquest <ID>;</pre>

Place quest of <ID> in the users quest log, the state of which is "active".

=== Example ===
<pre>prontera,xx,xx,4 script SetQuest 51,{
setquest 65000; // This will add the Quest ID 65000 to your Quest Window.
}
</pre>

This sample will add the quest "Quest - Poring Hunt" which I stated on the Adding Quest.
'''Note''': The example is just a simple NPC that will add Quest ID 65000 every time you click it, You can add conditions so that it can only be taken once.

=== Complete Quest ===
<pre>*completequest <ID>{,<ID2>};</pre>

Change the state for the given quest <ID> to "complete" and remove from
the users quest log.
 
If a second quest id of greater value is specified, all quests between the two
will be completed.

=== Example ===
<pre>prontera,xx,xx,4 script CompleteQuest 51,{
completequest 65000; // This will change the state of the quest to "complete"
set zeny,zeny + 100; //just add line like this if you want to give zeny reward if a player finish the quest.
getitem 501,1; //just add line like this if you want to give item reward if a player finish the quest.
}
</pre>

=== Erase Quest ===
<pre>*erasequest <ID>{,<ID2>};</pre>

Remove the quest of the given <ID> from the user's quest log.
 
If a second quest id of greater value is specified, all quests between the two
will be erased.

=== Example ===
<pre>prontera,xx,xx,4 script EraseQuest 51,{
erasequest 65000; // This will remove the quest to your Quest Window.
}
</pre>

=== Change Quest ===
<pre>*changequest <ID>,<ID2>;</pre>

Remove quest of the given <ID> from the user's quest log.
Add quest of the <ID2> to the the quest log, and the state is "active".

=== Example ===
<pre>prontera,xx,xx,4 script ChangeQuest 51,{
changequest 65000,65001; // This will remove the quest ID 65000 and change it to 65001 with the state "active".
}
</pre>

=== Check Quest Progress ===

<pre>*questprogress(<ID>{,PLAYTIME|HUNTING})</pre>

If no additional argument supplied, return the state of the quest:
<pre>
0 = Quest not started (not in quest log)
1 = Quest has been given
2 = Quest completed
</pre>

<pre>*questactive(<ID>)</pre>
Check whether the given quest is in its active state.
Returns true if the quest is active, false otherwise (quest not started, inactive or completed)

=== Example ===
<pre>prontera,xx,xx,4 script CheckQuest 51,{

if(!questactive(65000)) { //Quest is Inactive
mes "[Jelly]";
mes "Quest is Inactive";
close;
} else if(!questprogress(65000)) { //Quest Not started yet
mes "[Jelly]";
mes "Quest Not Started";
close;
} else if(questactive(65000)) { //Quest is Active
mes "[Jelly]";
mes "Quest is Active!";
close;
} else if(questprogress(65000) == 2) { // Quest finished.
mes "[Jelly]";
mes "Quest Finished!";
completequest 65000;
close;
}
}
</pre>

If parameter "PLAYTIME" is supplied:
<pre>
0 = Quest not started (not in quest log)
1 = the time limit has not yet been reached
2 = the time limit has been reached
</pre>

If parameter "HUNTING" is supplied:
<pre>
0 = Quest not started (not in quest log)
1 = Player hasn't killed all of the target monsters
2 = Player has killed all of the target monsters
</pre>

=== Example | Hunting ===
<pre>prontera,xx,xx,4 script CheckQuest 51,{

if (!questprogress(65000,HUNTING)) {
mes "[Jelly]";
mes "Quest not Started",
close;
} else if (questprogress(65000,HUNTING) == 1) {
mes "[Jelly]";
mes "You haven't killed all of the target monsters.";
close;
} else if (questprogress(65000,HUNTING) == 2) {
completequest 65000;
set zeny,zeny+100; //Zeny Reward
getitem 501,1; // Item Reward
mes "[Jelly]";
mes "Quest Finished";
close;
}
}
</pre>

=== Show Event ===
<pre>
*showevent <state>, <color>;

Show a colored mark in the mini-map like "viewpoint" and an emotion on top
of a NPC. This is used to indicate that a NPC has a quest or an event to
certain player/s.

state can be:
0 = disable ( Used to disable and remove the mark and the emotion from
the NPC. )
1 = exclamation emotion ( Used to show an important quest event to
certain player. )
2 = interrogation emotion ( Used to show an non-important quest event
to certain player. )
Other value may cause client crashes.

color can be:
0 = yellow "Quest"
1 = orange "Job"
2 = green "Event"
3 = an MVP flag
Other values show a transparent mark in the mini-map.
</pre>

=== Increasing Max Quest DB ===
<pre>
trunk/src/map/quest.h
</pre>

Find this line and increase the value.
<pre>
#define MAX_QUEST_DB (60355+1) // Highest quest ID + 1
</pre>

Recompile, Cheers!

(If you don't know how to recompile click [[Compiling|Here!]])

[[Category:Script Command]]

Quest Log System

2016-07-01T16:14:48Z

Asheraf: Update quest db structure.

== Quest Log System ==

==== Basic Structure of NPC ====

First of all you must have a knowledge on basic scripting, if not please kindly Click [[Basic_Scripting|Here!]].

==== Quest Window ====

The Quest Window or Quest Journal (Opened via Alt+U) allows the player to view all quests their character has started but not yet completed (Except for instance dungeon quests and Battlegrounds instances, which always remain once started).
To place a quest in the Inactive tab, right click once on it and the name will turn gray. It will then appear on the Inactive tab instead of Active. Right clicking the name again will bring it back to the Active tab. Moving the quest back and forth has no effect on whether you can continue it or not.
Not every quest has a quest window component. Those quests who have quest window walkthroughs can be found in this category as well as by having their infobox in gold. Additionally, the Quest Window guides are not comprehensive, and do not specify the exact coordinates of the next NPC or location the player must visit. It is highly recommended to continue using the wiki guides along with the in-game walkthroughs.

[[File:QWindow.jpg|center|caption]]

== Quest Database - Adding Quest ==

=== Structure ===

<pre>
{
Id: Quest ID
Name: "Quest Name"
TimeLimit: seconds
Targets: (
{
MobId: Mob_ID
Count: number
},
)
Drops: (
{
ItemId: item_to_drop
Rate: Drop_Rate
MobId: Mob_ID_to_match
},
)
},
</pre>

Quest ID - ID of the quest, must increment and should not be duplicated. 
Name - The title of the Quest you made. 
Time Limit - Time limit for the quest to be finish in seconds. 
Targets - Monsters killing list contain mob ids and count. 
Drops - Item id to drop.

=== Example ===
For this example I will make a quest that will require to kill 10 Poring's.

<pre>65000,0,1002,10,0,0,0,0,"Quest - Poring Hunt"</pre>

==== Client Side Editing ====

You have to edit your questid2display.txt

==== Structure ====
<pre>
QUESTID#Quest Name#FILENAME#LOG_FILENAME#
Summary description#
Objective description#
</pre>

=== Example ===
<pre>
65000#Quest - Poring Hunt#SG_FEEL#QUE_NOIMAGE#
Find the monster named Poring and kill 10#
Hunting 10 Poring#
</pre>

== Quest Log Commands ==

=== Set Quest ===
<pre>*setquest <ID>;</pre>

Place quest of <ID> in the users quest log, the state of which is "active".

=== Example ===
<pre>prontera,xx,xx,4 script SetQuest 51,{
setquest 65000; // This will add the Quest ID 65000 to your Quest Window.
}
</pre>

This sample will add the quest "Quest - Poring Hunt" which I stated on the Adding Quest.
'''Note''': The example is just a simple NPC that will add Quest ID 65000 every time you click it, You can add conditions so that it can only be taken once.

=== Complete Quest ===
<pre>*completequest <ID>{,<ID2>};</pre>

Change the state for the given quest <ID> to "complete" and remove from
the users quest log.
 
If a second quest id of greater value is specified, all quests between the two
will be completed.

=== Example ===
<pre>prontera,xx,xx,4 script CompleteQuest 51,{
completequest 65000; // This will change the state of the quest to "complete"
set zeny,zeny + 100; //just add line like this if you want to give zeny reward if a player finish the quest.
getitem 501,1; //just add line like this if you want to give item reward if a player finish the quest.
}
</pre>

=== Erase Quest ===
<pre>*erasequest <ID>{,<ID2>};</pre>

Remove the quest of the given <ID> from the user's quest log.
 
If a second quest id of greater value is specified, all quests between the two
will be erased.

=== Example ===
<pre>prontera,xx,xx,4 script EraseQuest 51,{
erasequest 65000; // This will remove the quest to your Quest Window.
}
</pre>

=== Change Quest ===
<pre>*changequest <ID>,<ID2>;</pre>

Remove quest of the given <ID> from the user's quest log.
Add quest of the <ID2> to the the quest log, and the state is "active".

=== Example ===
<pre>prontera,xx,xx,4 script ChangeQuest 51,{
changequest 65000,65001; // This will remove the quest ID 65000 and change it to 65001 with the state "active".
}
</pre>

=== Check Quest Progress ===

<pre>*questprogress(<ID>{,PLAYTIME|HUNTING})</pre>

If no additional argument supplied, return the state of the quest:
<pre>
0 = Quest not started (not in quest log)
1 = Quest has been given
2 = Quest completed
</pre>

<pre>*questactive(<ID>)</pre>
Check whether the given quest is in its active state.
Returns true if the quest is active, false otherwise (quest not started, inactive or completed)

=== Example ===
<pre>prontera,xx,xx,4 script CheckQuest 51,{

if(!questactive(65000)) { //Quest is Inactive
mes "[Jelly]";
mes "Quest is Inactive";
close;
} else if(!questprogress(65000)) { //Quest Not started yet
mes "[Jelly]";
mes "Quest Not Started";
close;
} else if(questactive(65000)) { //Quest is Active
mes "[Jelly]";
mes "Quest is Active!";
close;
} else if(questprogress(65000) == 2) { // Quest finished.
mes "[Jelly]";
mes "Quest Finished!";
completequest 65000;
close;
}
}
</pre>

If parameter "PLAYTIME" is supplied:
<pre>
0 = Quest not started (not in quest log)
1 = the time limit has not yet been reached
2 = the time limit has been reached
</pre>

If parameter "HUNTING" is supplied:
<pre>
0 = Quest not started (not in quest log)
1 = Player hasn't killed all of the target monsters
2 = Player has killed all of the target monsters
</pre>

=== Example | Hunting ===
<pre>prontera,xx,xx,4 script CheckQuest 51,{

if (!questprogress(65000,HUNTING)) {
mes "[Jelly]";
mes "Quest not Started",
close;
} else if (questprogress(65000,HUNTING) == 1) {
mes "[Jelly]";
mes "You haven't killed all of the target monsters.";
close;
} else if (questprogress(65000,HUNTING) == 2) {
completequest 65000;
set zeny,zeny+100; //Zeny Reward
getitem 501,1; // Item Reward
mes "[Jelly]";
mes "Quest Finished";
close;
}
}
</pre>

=== Show Event ===
<pre>
*showevent <state>, <color>;

Show a colored mark in the mini-map like "viewpoint" and an emotion on top
of a NPC. This is used to indicate that a NPC has a quest or an event to
certain player/s.

state can be:
0 = disable ( Used to disable and remove the mark and the emotion from
the NPC. )
1 = exclamation emotion ( Used to show an important quest event to
certain player. )
2 = interrogation emotion ( Used to show an non-important quest event
to certain player. )
Other value may cause client crashes.

color can be:
0 = yellow "Quest"
1 = orange "Job"
2 = green "Event"
3 = an MVP flag
Other values show a transparent mark in the mini-map.
</pre>

=== Increasing Max Quest DB ===
<pre>
trunk/src/map/quest.h
</pre>

Find this line and increase the value.
<pre>
#define MAX_QUEST_DB (60355+1) // Highest quest ID + 1
</pre>

Recompile, Cheers!

(If you don't know how to recompile click [[Compiling|Here!]])

[[Category:Script Command]]

Category:Installation Guides

2016-05-05T22:59:57Z

Asheraf:

This category contains complete, detailed Hercules installation guides for various operating systems and software.
[[Category:Installation]]
Temporary:
For instructions on how to install on Linux, please refer to the following forum post by Ind, http://herc.ws/board/topic/105-regarding-github/

Please note, if your Linux does not have "apt-get", you may need to use "yum install" instead.

Custom Mobs

2016-05-05T22:49:19Z

Asheraf: mob db structure

= Intro =
You can have up to 10,000 mob IDs. This guide was written without testing on Git; use at your own discretion.
Well, its pretty easy if you do it correctly and go step by step without rushing.

= Gettings Started =
== Database Structure ==
Let's take a look at the structure of the entries in mob_db.conf:

Note: If you're adding custom mobs, it's better to add them to mob_db2.conf

<pre>
{
// =================== Mandatory fields ===============================
Id: ID (int)
SpriteName: "SPRITE_NAME" (string)
Name: "Mob name" (string)
// =================== Optional fields ================================
Lv: level (int, defaults to 1)
Hp: health (int, defaults to 1)
Sp: mana (int, defaults to 0)
Exp: basic experience (int, defaults to 0)
JExp: job experience (int, defaults to 0)
AttackRange: attack range (int, defaults to 1)
Attack: [attack1, attack2] (int, defaults to 0)
Def: defence (int, defaults to 0)
Mdef: magic defence (int, defaults to 0)
Stats: {
Str: strength (int, defaults to 0)
Agi: agility (int, defaults to 0)
Vit: vitality (int, defaults to 0)
Int: intelligence (int, defaults to 0)
Dex: dexterity (int, defaults to 0)
Luk: luck (int, defaults to 0)
}
ViewRange: view range (int, defaults to 1)
ChaseRange: chase range (int, defaults to 1)
Size: size (int, defaults to 1)
Race: race (int, defaults to 0)
Element: (type, level)
Mode: {
CanMove: true/false (bool)
Looter: true/false (bool)
Aggressive: true/false (bool)
Assist: true/false (bool)
CastSensorIdle:true/false (bool)
Boss: true/false (bool)
Plant: true/false (bool)
CanAttack: true/false (bool)
Detector: true/false (bool)
CastSensorChase: true/false (bool)
ChangeChase: true/false (bool)
Angry: true/false (bool)
ChangeTargetMelee: true/false (bool)
ChangeTargetChase: true/false (bool)
TargetWeak: true/false (bool)
}
MoveSpeed: move speed (int, defaults to 0)
AttackDelay: attack delay (int, defaults to 4000)
AttackMotion: attack motion (int, defaults to 2000)
DamageMotion: damage motion (int, defaults to 0)
MvpExp: mvp experience (int, defaults to 0)
MvpDrops: {
AegisName: chance (string: int)
...
}
Drops: {
AegisName: chance (string: int)
...
}

},
</pre>

{| class="wikitable"
|-
! Fields !! Description
|-
| '''Id''' || ID of the mob
|-
| '''SpriteName''' || This first name is the DB name. When you use @spawn/@summon and you know the name of the mob, but not the ID, type this name instead. Try making the normal name the same as this so you wont get confused.
|-
| '''Name''' || This is the name the server shows.
|-
| '''Lv''' || Level of the mob
|-
| '''Hp''' || HP of the mob
|-
| '''Sp''' || SP of the mob
|-
| '''Exp''' || Exp granted by the mob
|-
| '''JExp''' || Job exp granted by the mob
|-
| '''AttackRange''' || Range of the mob attack. If set to 1 or 2, it will melee. 3 or more than 3 will set it to ranged
|-
| '''Attack1''' || Affects ATK of the mob
|-
| '''Attack2''' || Affects MATK of the mob
|-
| '''Def''' || Defense of the mob (Tip: 100 def = Invulnerability below 8K attack. Watch out, only melee/ranged attacks, but generally direct hits attacks are drastically reduced. Setting this high enough may make monks pretty cheap to level because of of Psychic Wave/Occult Impact/Investigate.)
|-
| '''MDef''' || Magic Defense of the mob (Hint: 100 mdef = golden thief bug effect below 9K magic attack. It's for all magic-using skills.)
|-
| '''Stats''' || All Stats of mobs belongs to this block.
{| class="wikitable"
|-
! Stats !! Description
|-
| '''Str''' || Strength of the mob. This also affects its ATK.
|-
| '''Agi''' || Agility of the mob. This also affects the mob flee rate.
|-
| '''Vit''' || Vitality of the mob. This affects the duration of stun status.
|-
| '''Int''' || Intelligence of the mob. This also affects its MATK.
|-
| '''Dex''' || Dexterity of the mob. This also affects the mob hit rate.
|-
| '''Luk''' || Luck of the mob. This also defines the mob perfect dodge/lucky flee/perfect flee/lucky dodge rate.
|}
|-
| '''ViewRange''' || Maximum Skill Range
|-
| '''ChaseRange''' || Sight limit for mobs. If set to 1000 or beyond, mobs will follow you all over the map.
|-
| '''Size''' || 0 if its Small, 1 if its Medium, 2 if its Large
or Small=Size_Small, Medium=Size_Medium, Large=Size_Large
|-
| '''Race''' || 0=formless, 1=undead, 2=animal, 3=plant, 4=insect, 5=fish, 6=demon, 7=demihuman, 8=angel, 9=dragon.
or formless=RC_Formless, undeas=RC_Undead, animal=RC_Brute, plant=RC_Plant, fish=RC_Fish, demihuman=RC_DemiHuman, angel=RC_Angel, dragon=RC_Dragon.
|-
| '''Element''' || This is a two-digit number representing the rank (level) and element of the mob. 
|-
| '''Element(Type)''' || Element Type of mob as mentioned below. 
{| class="wikitable" style="text-align: center;"
|
|Neutral
|Water
|Earth
|Fire
|Wind
|Poison
|Holy
|Shadow
|Ghost
|Undead
|-
| Type
|0
|1
|2
|3
|4
|5
|6
|7
|8
|9
|}
or "Ele_Name" (Neutral, Water, Earth, Fire, Wind, Poison, Holy, Shadow, Ghost, Undead.)

|-
| '''Element(Level)''' || Element level of mob from (1-4). 
|-
| '''Mode''' || This defines the mob behaves.
|-
| '''MoveSpeed''' || Walking speed of the mob. 1 is the fastest, 1000 is the lowest. 100 is the normal walking speed.
|-
| '''AttackDelay''' || ADelay= Attack Delay, also known as ASPD. This one will change the aspd of the mob. The lower the faster, but don't make it too low or it will lag when mobbed by several of these.
|-
| '''AttackMotion''' || Attack animation motion. Lower this value and the mob's attack will be displayed in higher fps (making it shorter, too) (Thanks to Wallex for this)
|-
| '''DamageMotion''' || Damage animation motion, same as aMotion but used to display the "I am hit" animation. Coincidentally, this same value is used to determine how long it is before the mob/player can move again. Endure is dMotion = 0, obviously.
|-
| '''MvpExp''' || The MVP exp the mob gives when it is defeated (to the player who got the MVP reward) (This exp is a percentage of the exp the monster gives.)
|-
The following fields are for drops and drop rates. Remember that these are in percentages; i.e. 100 = 100%
|-
| '''MvpDrops''' || The MvP Drops goes here, format is:
<pre>AegisName: Chance</pre>
Example:
<pre>Poring_Card: 1000</pre>
|-
| '''Drops''' || The Normal Drops goes here, format is:
<pre>AegisName: Chance</pre>
Example:
<pre>Poring_Card: 1000</pre>
|}

== Making it visible ==
=== Server Side ===
If you've got a sprite and you're happy with it, then you can skip this part. If you would like to make your mob look like another mob, or even a player, then you need to take a look at {{git|db/mob_avail.txt|full}}

For normal mobs, you can use the data that's already in the file as an example to work on:
// mob_id,sprite_id,equip #
// iRO Halloween Event 2008
//3000,1015,0
//3001,1036,0
//3002,1298,0

// iRO Halloween Event 2009
//3014,1179,0
//3015,1272,0

However, if you would like to make your mob look like a character, you need to add more options: 
// Valaris
{| class="wikitable"
|-
| MobID || SpriteID || Sex || Hair || Hair_Color || Weapon || Shield || Head_Top || Head_Middle || Head_Bottom || Option || Dye_Color
|-
| 1900, || 4013, || 1, || 1, || 1, || 1254, || 0, || 67, || 12, || 54, || 16, || 1
|}
You will need to use the Item ID for your mob's weapon and shield instead of the View ID of the item. Doing so may have undesirable effects.

A more in-depth look at each value: 
 '''MobID''': This is your mob ID.
 '''SpriteID''': The Job number you want it to look like. They are:
<pre>Job_Novice 0
Job_Swordman 1
Job_Mage 2
Job_Archer 3
Job_Acolyte 4
Job_Merchant 5
Job_Thief 6
Job_Knight 7
Job_Priest 8
Job_Wizard 9
Job_Blacksmith 10
etc</pre>
They can also be found on {{git|db/const.txt}} file.

 '''Sex''': 0 for female, 1 for male
 '''Hair''': The mob hair style, goes from 1 to 23
 '''Hair_Color''': The mob hair color. Goes from 0 to 8 or 10, but it depends on the server's palette files.
 '''Weapon''':The ID of the Weapon you want. See [[Custom_weapons|Custom Weapons]] for it. Also read at the end of the pre if you cant find the headgear you want.
 '''Shield''': Same as above
 '''Head_Top''': Same as above
 '''Head_Middle''': Same as above
 '''Head_Bottom''': Same as above
 '''Option''': this option parameter will make the mob change its status, as well as give them carts, pecopecos, and falcons. In other words, this will change the visual effects of your mobs. The options are these*:
<pre>
1 Sight 32 Peco Peco riding 2048 Orc Head
2 Hide 64 GM Perfect Hide 4096 Wedding Sprites
4 Cloak 128 Level 2 Cart 8192 Ruwach
8 Level 1 Cart 256 Level 3 Cart
16 Falcon 512 Level 4 Cart
1024 Level 5 Cart
</pre>

 '''Dye_Color''': Same as hair color. It goes from 0 to 77

=== Client Side ===
For your mob to exist in the client, you need to add it to a few [[Lua]] files.
==== datainfo/npcidentity.lua ====
Example at the end of the file: 
["JT_4_F_TAEKWON"] = 644,
["JT_4_F_SWORDMAN"] = 645,
-- Custom Mobs
["JT_JACOB"] = 2500,
["JT_AQUARING"] = 2600
}
The number after the = sign denotes the mob's database ID number. Other sprites in this file have their view ID e.g. [[Adding_a_Script#Client_Side|NPC sprite number]].

==== datainfo/jobname.lua ====
Example at the end of the file: 
[jobtbl.JT_GIBBET] = "GIBBET",
[jobtbl.JT_DULLAHAN] = "DULLAHAN",
[jobtbl.JT_LOLI_RURI] = "LOLI_RURI",
[jobtbl.JT_DISGUISE] = "DISGUISE",
-- Custom Mobs
[jobtbl.JT_JACOB] = "jacobmob",
[jobtbl.JT_AQUARING] = "aquaring"
}
In this file, the value after the = sign is the name of the actual sprite in your data folder/[[GRF]]

== Your mob in other files ==
=== Dead Branch ===
Adding your mob to {{git|db/pre-re/mob_branch.txt}} or {{git|db/re/mob_branch.txt}} will allow Dead Branches to summon it.

=== Bloody Branch ===
Adding your mob to {{git|db/pre-re/mob_boss.txt}} or {{git|db/re/mob_boss.txt}} will allow Bloody Branches to summon it.

=== Poring Box ===
Adding your mob to {{git|db/pre-re/mob_poring.txt}} or {{git|db/re/mob_poring.txt}} will make your mob spawnable via the Poring Box.

=== Monster Racial Groups ===
Adding your mob to {{git|db/pre-re/mob_race2_db.txt}} or {{git|db/re/mob_race2_db.txt}} will add your mob to a [[Racial_Group|Racial Group]]. Guardians, Goblins and other mobs are members of particular Racial Groups.

=== Red Pouch of Surprise ===
Adding your mob to {{git|db/mob_pouch.txt}} will make your mob spawnable via the Red Pouch of Surprise.

== Spawn Points ==
Let's look at the syntax of a mob spawn point:

<pre>
<map name>,<x1>,<y1>,<x2>,<y2>%TAB%monster%TAB%<monster name>%TAB%<mob id>,<amount>,<delay1>,<delay2>,<event>{,<mob size>,<mob ai>}
</pre>

Only the things between <> are changed. Do not remove or change monster after the coordinates, because that's what tells the server that this line is a monster spawn script.

 '''map name''': Name of the map. Use /where along with the following coordinates
 '''x1''': X axis coordinates. It start from the left side of the map, and the higher it gets, the more it gets closer to the right side of the map.
 '''y1''': Y axis coordinates. It start from the bottom, and the higher it gets, the more it gets closer to the top of the map.
 '''x2''': X axis coordinates. It start from the left side of the map, and the higher it gets, the more it gets closer to the right side of the map.
 '''y2''': Y axis coordinates. It start from the bottom, and the higher it gets, the more it gets closer to the top of the map.
 These 4 coordinates will make a spawn area where the mob will spawn, however it won't limit its movement, so lets say you put 120,150 on the first pair, and 130,160 pair- That's a 10x10 cell area where the mob will spawn randomly.
 If you want the mob to spawn at a random point, use 0 for all the coordinates.
 '''monster name''': The name of the mob you want to be shown (using --ja-- in place of a name will display the "Japanese Name" from your database).
 You can specify a custom level to use for the mob different from the one of the database by adjoining the level after the name with a comma. eg: "Poring,50" for a name will spawn a monster with name Poring and level 50.
 '''mob id''': The ID of your mob.
 '''amount''': How many mobs you want to be spawned.
 '''delay1''': Minimum amount of time before a monster respawns.
 '''delay2''': Maximum amount of time before a monster respawns.
 delay1 and delay2 are used to define the time it takes for a monster to respawn; in milliseconds. Normal mobs usually have 0 (Instant Respawn), while MVPs have 7200000 (2 hours). If delay2 is greater than delay 1, the mob won't respawn until the map server restarts.
 '''event''': Script event to be executed when the mob is killed. The event must be in the form "NPCName::OnEventName" to execute, and the event name label should start with "On". As with all events, if the NPC is an on-touch NPC, the player who triggers the script must be within 'trigger' range for the event to work.
 '''size''': Optional. Size can be 0 (medium), 1 (small), or 2 (big).
 '''ai''': Optional. AI can be 0 (default), 1 (attack/friendly), 2 (sphere), 3 (flora), or 4 (zanzou).

== Adding Skills ==

Lets look at the syntax of a mob skill:

<pre>
MOB_ID, a unused dummy character sequence (for information only), STATE, SKILL_ID, SKILL_LV,
rate (10000 = 100%), casttime, delay, cancelable, a target, a condition type, a condition value,
a value 1, a value 2, a value 3, a value 4, a value 5, emotion
</pre>

 '''''
NOTE: I had to cut the mob_avail structure so it could fit.
It's a whole line, not 3 lines.
'''''

 '''MOD_ID''': your mob ID.
 '''an unused.. etc etc''': you can put any text here you want, its just for information and to know what does this do.* tip tip*You will see inside this file things like Poring@TF_POISON. Well, you could use this too. It would tell you: mob_name@DB_Skill_Name. *tip tip*
 '''state''': this is the state that the mob must accomplish before being able to use this skill. The states are:

<pre>
any, idle (in standby), walk (in movement), attack, dead (on killed), loot, chase (following target),
counterattack.
</pre>

 '''SKILL_ID''': The ID of the skill goes here. To look for one, go to your db folder and open the skill_db.txt file. You will see a lot of lines like this one:

<pre>2,0,0,0,0,0,10,0,no,0,0,0,weapon,0 //SM_SWORD#Œ•C—û#</pre>

And the syntax is:

<pre>
id,range,hit,inf,pl,nk,max,list_num,castcancel,cast_defence_rate,inf2,maxcount,skill_type,blow_count
</pre>

so, the ID of the SM_SWORD, which is the Swordman's Sword Mastery by the way, is 2:

<pre>'''2''',0,0,0,0,0,10,0,no,0,0,0,weapon,0 //SM_SWORD#Œ•C—û#</pre>

 '''SKILL_LV''': You can put the skill level as high as you want. Though, 100 is usually as far as most skills go.
 '''rate''': How frequent will the mob use the skill.
 '''casttime''': Skill's cast time.
 '''delay''': How much time must pass before the skill can be used again, in milliseconds.
 '''cancelable''': if the skill cast can be interrupted. Set it either '''yes''' or '''no'''.
 '''a target''': the target of the skill. It can be:
<pre>
target (player), self (the mob itself), friend (slaves)
</pre>

 '''a condition type''':a condition that also must be fulfilled before the mob is able to use this skill. There are two kinds of conditions:

1. Mob Condition:
<pre>//conditions: (condition type) (value which specifies a condition value)
// always unconditional
// myhpltmaxrate when the mob's hp drops to a certain %
// mystatuson If the mob has any abnormalities in status (condition value),
// mystatusoff If the mob has ended any abnormalities in status (condition value),
// friendhpltmaxrate when the mobs' friend's hp drops to a certain %
// friendstatuson If the friend has any abnormalities in status (condition value),
// friendstatusoff If the friend has ended any abnormalities in status (condition value),
// attackpcgt Attack PC becomes more than the number of specification
// attackpcge Attack PC becomes equal or more than the number of specification.
// slavelt when the number of slaves is lower than the original number of specification.
// slavele when the number of slaves is lower or equal than the original number of specification.
// closedattacked when melee attacked (close range attack)
// longrangeattacked when long ranged attacked (like bows and far range weapons)
// skillused when a skill is used on the mob
// casttargeted when a target is in cast range.
// rudeattacked when a target is rude attacked
// hiding when a target is hidden *not implemented yet*
</pre>

2. Target Conditions
<pre>
// The character's state which can be specified to be a condition value
// by the statuson/statusoff system
//
// anybad any type of state change
// stone condition of being in stone state
// freeze condition of being in frozen state
// stan condition of being in stunned state
// sleep condition of being in sleep state
// poison condition of being in poisoned state
// curse condition of being in cursed state
// silence condition of being in silenced state
// confusion condition of being in confusion state
// blind condition of being in blind state
// hiding condition of being in hidden state
// sight condition of being in unhidden state
</pre>

You can use only ONE of these conditions.

 '''value1,value2,value3,value4,value5''': Basically they're only the same but, when you want your mob using the same condition to trigger the skill, but in different times, in case of the myhpltmaxrate when the hp is being decreased, you can set them in a decreasing order, like:

<pre>80,60,40,20,10</pre>

 '''emotion''': Lets your mob use an emotion, at random times. The emotion IDs are:

<pre>
e_gasp 0
e_what 1
e_ho 2
e_lv 3
e_swt 4
e_ic 5
etc
</pre>

For more info, go to your {{git|db/const.txt}} file.

== Making it talk! ==
Another add, suggested by chronocrosser_x and Fenrir Soarblade:

Well, I believe you have seen some mobs on your server talking when certain things happens. I never saw them again talking, dont know why but they used to talk. I believe they still do it.

Ok, go to your Data folder. If you look in the files, you should find a file called monstertalktable. If there isnt, we will create one with Wordpad =3!. If there is, open it with Wordpad, not Notepad.

Once there, we will copy and paste this:

<pre><nowiki><?xml version="1.0" encoding="euc-kr" ?>

<enemy_monster_talk_table>

<mob_db_name_here>
<discovery></discovery>
<attack></attack>
<hp50></hp50>
<hp25></hp25>
<kill></kill>
<dead></dead>
</mob_db_name_here>
</enemy_monster_talk_table></nowiki></pre>

Well, lets see step by step =3!:

 '''<enemy_monster_talk_table>''': This is the start of the monster talk table. Leave it as it is =3!
 '''<mob_db_name_here>''': The mob_db.txt first name you see, after the ID, goes here =3! Its used to identify the mob
 '''<discovery>%TAB%Text Here%TAB%</discovery>''': This is an event, same as the one below. When a monster see you, this one will be displayed =3!
 '''<attack>%TAB%Text Here%TAB%</attack>''': When a monster attacks you, this one will be displayed O_O!
 '''<hp50>%TAB%Text Here%TAB%</hp50>''': When a monster's hp is at 50%, this one will be displayed o..o!
 '''<hp25>%TAB%Text Here%TAB%</hp25>''': When a monster's hp is at 25%, this one will be displayed x,x
 '''<kill>%TAB%Text Here%TAB%</kill>''': When a monster kills a character/player, this one will be displayed T~T!
 '''<dead>%TAB%Text Here%TAB%</dead>''': When a monster dies by player hand, this one will be displayed ^__^!
 '''</mob_db_name_here>''': The same name of the mob_db.txt, the one after the ID.
 '''</enemy_monster_talk_table>''': Keep it like this.

I never messed with this, but i think its ok =3! Also for those spaces other than the messages spaces, use TAB, not the Space Bar for it ._.!

[[Category:Database]]
[[Category:Data]]
[[Category:Customization]]

Compiling/Windows

2016-05-05T21:26:22Z

Asheraf: /* Using Visual Studio */

For compiling on Windows, Visual Studio is the preferred method, although using Cygwin is also possible.

=== Using Visual Studio ===
[[Image:Compile_hercules.PNG|thumb|300px|MS Visual Studio 2012: Compile configuration (red) and solution (blue) with it's child projects.]]
Hercules ships with solution and project files for Visual Studio from 2012 onwards.
* Download the latest version of [https://www.visualstudio.com Visual Studio] (at the time of writing, MS Visual Studio 2015 Community Edition) and install it, if you do not have Visual Studio already installed.
* Open '''Hercules-14.sln''' in your Hercules folder if you use Visual Studio 2015, for Visual Studio 2013, you need to open '''Hercules-12.sln''', for Visual Studio 2012, you need to open '''Hercules-11.sln''' instead.
* Select the desired compile configuration (marked red). Use '''Release''' when you compile the server, where players will be playing on. '''Debug''' compiles the server without optimizations and with debugging information.
* Right-click the solution node (marked blue) and select '''Build solution'''. If you have compiled the server before, it is recommended to use '''Rebuild solution''', as it forces the compiling of all components, not just those, which seem to have changed since last compile.
* If the compilation was successful, the resulting executables are in the same folder as the solution named ''login-server.exe'', ''char-server.exe'', ''map-server.exe'' and ''mapcache.exe''.

=== Using Cygwin ===
[http://www.cygwin.com/ Cygwin] is a POSIX compatibility layer for Windows. As such it enables compiling the way it would be done on Linux. Compiling in Cygwin is '''not recommended''' due to lower performance and increased installation complexity.

* Download [http://www.cygwin.com/setup.exe Cygwin] and install it, if not already done so. When installing, select following packages:
** from ''Devel'': ''cmake'', ''gcc'' and ''make''
** from ''Lib'': ''libidn-devel'', ''libpcre-devel'', ''readline'', ''zlib-devel''
* Running Cygwin Terminal will create folder <code>'''home/user'''</code> inside Cygwin installation folder, where ''user'' is the name currently logged on Windows user.
* SQL server needs to be installed in Cygwin so the compiler can access the SQL libraries. Download the .tar.gz archive from the [http://dev.mysql.com/downloads/mysql/?current_os=src MySQL website], such as '''mysql-5.5.20.tar.gz'''.
* Place the archive into <code>'''/home/user'''</code> and execute following inside Cygwin Terminal to unpack it:
cd ~
tar xvzf mysql-5.5.20.tar.gz
* Navigate to directory with unpacked archive:
cd mysql-5.5.20
* To avoid conficts, replace ''dtoa()'' with ''_dtoa()'' in ''strings/dtoa.c'' file:
sed -i 's/dtoa(/_dtoa(/g' ./strings/dtoa.c
* Build MySQL with following commands:
cmake .
make mysqlclient libmysql
make install
* After everything completes, Cygwin is ready for compiling Hercules. Navigate to the Hercules folder in Cygwin. Windows drives are accesible as <code>/cygdrive/x</code> where ''x'' is the letter assigned to the drive by Windows.
* Execute following commands inside Hercules folder to compile it:
./configure --with-mysql=/usr/local/mysql/bin/mysql_config
make sql
* If the compilation was successful, the resulting executables are in the Hercules folder named ''login-server_sql.exe'', ''char-server_sql.exe'' and ''map-server_sql.exe''.
* Server executables can be run inside Cygwin Terminal or directly, but in this case you need to copy required libraries to Hercules folder:
** ''cygwin1.dll'', ''cygz.dll'', ''cyggcc_s-1.dll'', ''cygpcre-0.dll'' from <code>/bin</code>
** ''cygmysqlclient-18.dll'' from <code>/usr/local/mysql/lib</code>

File:Compile hercules.PNG

2016-05-05T21:25:40Z

Asheraf:

Custom Items

2016-05-05T21:04:49Z

Asheraf: >.<

=Structure=
First, let's take a look at the item_db.conf in the db folder, and its structure:
item_db: (
{
// =================== Mandatory fields ===============================
Id: ID (int)
AegisName: "Aegis_Name" (string, optional if Inherit: true)
Name: "Item Name" (string, optional if Inherit: true)
// =================== Optional fields ================================
Type: Item Type (int, defaults to 3 = etc item)
Buy: Buy Price (int, defaults to Sell * 2)
Sell: Sell Price (int, defaults to Buy / 2)
Weight: Item Weight (int, defaults to 0)
Atk: Attack (int, defaults to 0)
Matk: Magical Attack (int, defaults to 0, ignored in pre-re)
Def: Defense (int, defaults to 0)
Range: Attack Range (int, defaults to 0)
Slots: Slots (int, defaults to 0)
Job: { (defaults to all job)
All: true/false (boolean, defaults to false)
Novice: true/false (boolean, defaults to false)
Swordsman: true/false (boolean, defaults to false)
Magician: true/false (boolean, defaults to false)
Archer: true/false (boolean, defaults to false)
Acolyte: true/false (boolean, defaults to false)
Merchant: true/false (boolean, defaults to false)
Thief: true/false (boolean, defaults to false)
Knight: true/false (boolean, defaults to false)
Priest: true/false (boolean, defaults to false)
Wizard: true/false (boolean, defaults to false)
Blacksmith: true/false (boolean, defaults to false)
Hunter: true/false (boolean, defaults to false)
Assassin: true/false (boolean, defaults to false)
Crusader: true/false (boolean, defaults to false)
Monk: true/false (boolean, defaults to false)
Sage: true/false (boolean, defaults to false)
Rogue: true/false (boolean, defaults to false)
Alchemist: true/false (boolean, defaults to false)
Bard: true/false (boolean, defaults to false)
Taekwon: true/false (boolean, defaults to false)
Star_Gladiator: true/false (boolean, defaults to false)
Soul_Linker: true/false (boolean, defaults to false)
Gunslinger: true/false (boolean, defaults to false)
Ninja: true/false (boolean, defaults to false)
Gangsi: true/false (boolean, defaults to false)
Death_Knight: true/false (boolean, defaults to false)
Dark_Collector: true/false (boolean, defaults to false)
Kagerou: true/false (boolean, defaults to false)
Rebellion: true/false (boolean, defaults to false)
}
Job: Job mask (int, defaults to all jobs = 0xFFFFFFFF)
Upper: Upper mask (int, defaults to any = 0x3f)
Gender: Gender (int, defaults to both = 2)
Loc: Equip location (int, required value for equipment)
WeaponLv: Weapon Level (int, defaults to 0)
EquipLv: Equip required level (int, defaults to 0)
EquipLv: [min, max] (alternative syntax with min / max level)
Refine: Refineable (boolean, defaults to true)
View: View ID (int, defaults to 0)
BindOnEquip: true/false (boolean, defaults to false)
ForceSerial: true/false (boolean, defaults to false)
BuyingStore: true/false (boolean, defaults to false)
Delay: Delay to use item (int, defaults to 0)
KeepAfterUse: true/false (boolean, defaults to false)
Trade: { (defaults to no restrictions)
override: GroupID (int, defaults to 100)
nodrop: true/false (boolean, defaults to false)
notrade: true/false (boolean, defaults to false)
nostorage: true/false (boolean, defaults to false)
nocart: true/false (boolean, defaults to false)
noselltonpc: true/false (boolean, defaults to false)
nomail: true/false (boolean, defaults to false)
noauction: true/false (boolean, defaults to false)
nogstorage: true/false (boolean, defaults to false)
partneroverride: true/false (boolean, defaults to false)
}
Nouse: { (defaults to no restrictions)
override: GroupID (int, defaults to 100)
sitting: true/false (boolean, defaults to false)
}
Stack: [amount, type] (int, defaults to 0)
Sprite: SpriteID (int, defaults to 0)
Script: <"
Script
(it can be multi-line)
">
OnEquipScript: <" OnEquip Script (can also be multi-line) ">
OnUnequipScript: <" OnUnequip Script (can also be multi-line) ">
// =================== Optional fields (item_db2 only) ================
Inherit: true/false (boolean, if true, inherit the values
that weren't specified, from item_db.conf,
else override it and use default values)
},
)

* '''ID''': ID of the item.
* '''AegisName''': Server name to reference the item in scripts and lookups, should use no spaces.
* '''Name''': Name in English for displaying as output for @ and script commands.
* '''Type''': Purpose of the item.
0 = Usable : healing
2 = Usable : other
3 = Misc
4 = Weapon
5 = Armor
6 = Card
7 = Pet Egg
8 = Pet Equipment
10 = Arrow/Ammunition
11 = Usable : delayed consumption (items with script "pet" or "itemskill")
18 = Another delayed consume that requires user confirmation before using item.
* '''Buy''': Default [[NPC]] buying price in Zeny. When not specified, becomes double the sell price.
* '''Sell''': Default [[NPC]] selling price in Zeny. When not specified, becomes half the buy price.
* '''Weight''': Item's weight. Each 10 is 1 weight. When not specified, becomes 0.
* '''ATK''': Base weapon attack, in case of a weapon. When not specified, becomes 0.
** In '''RE''' enabled servers this field have a optional delimiter ''':''' to define this item's weaponMATK bonus, for example, '''30:50''' would mean the item gives 30 atk and 50 weaponMATK
* '''Matk''': Weapon's magical attack (only used in renewal mode, ignored in pre-renewal). When not specified, becomes 0.
* '''DEF''': Base defense for armor-type items. When not specified, becomes 0.
* '''Range''': Maximum range in map cells a weapon allows to be the player apart from it's target. When not specified, becomes 0.
* '''Slots''': Amount of card slots in weapon/armor-type items. When not specified, becomes 0.
* '''Job''': Which jobs this item is available for. Values below can be combined to achieve availability for multiple job classes, i. e. <code>0x2|0x4 -> 0x6</code> (Swordman+Mage)
(S.) Novice (2^00): 0x00000001
Swordman (2^01): 0x00000002
Mage (2^02): 0x00000004
Archer (2^03): 0x00000008
Acolyte (2^04): 0x00000010
Merchant (2^05): 0x00000020
Thief (2^06): 0x00000040
Knight (2^07): 0x00000080
Priest (2^08): 0x00000100
Wizard (2^09): 0x00000200
Blacksmith (2^10): 0x00000400
Hunter (2^11): 0x00000800
Assassin (2^12): 0x00001000
''Unused'' (2^13): 0x00002000
Crusader (2^14): 0x00004000
Monk (2^15): 0x00008000
Sage (2^16): 0x00010000
Rogue (2^17): 0x00020000
Alchemist (2^18): 0x00040000
Bard/Dancer (2^19): 0x00080000
''Unused'' (2^20): 0x00100000
Taekwon (2^21): 0x00200000
StarGladiator (2^22): 0x00400000
Soul Linker (2^23): 0x00800000
Gunslinger (2^24): 0x01000000
Ninja (2^25): 0x02000000
Gangsi (2^26): 0x04000000
Death Knight (2^27): 0x08000000
Dark Collector (2^28): 0x10000000
Kagerou/Oboro (2^29): 0x20000000
Rebellion (2^30): 0x40000000
'''Some other commonly used values:'''
All Classes : 0xFFFFFFFF
Every Job Except Novice : 0xFFFFFFFE
* '''Upper''': Specifies whether the item can be used by normal, baby or reborn classes. Values below can be combined, i. e. <code>1|4 -> 5</code> (Normal+Baby Classes)
** Note: Setting <code>2</code> enables the item for Transcendant and 3rd classes. Use <code>8</code> to enable the item for 3rd classes only.
Normal jobs: 0x01 (1)
Upper jobs: 0x02 (2)
Baby jobs: 0x04 (4)
Third jobs: 0x08 (8)
Upper Third jobs: 0x10 (16)
Baby Third jobs: 0x20 (32)

Under pre-re mode third classes are considered upper, making use of
the 8 and above masks is therefore not necessary unless in renewal
mode. When no value is specified, all classes (mask 0x3f) are able to
equip the item.
* '''Gender''': Gender restriction for the item.
0 = Female
1 = Male
2 = No restriction (both)
* '''Loc''': Equipment location of armor and arrow-type items. Values below can be combined, i. e. 136 would indicate both accessory slots (typical value for accessories).
(2^0) 1 = Lower headgear
(2^1) 2 = Right hand
(2^2) 4 = Mantle
(2^3) 8 = Accessory 1
(2^4) 16 = Armor
(2^5) 32 = Left hand
(2^6) 64 = Shoes
(2^7) 128 = Accessory 2
(2^8) 256 = Upper headgear
(2^9) 512 = Middle headgear
(2^10) 1024 = Costume Top Headgear
(2^11) 2048 = Costume Mid Headgear
(2^12) 4096 = Costume Low Headgear
(2^13) 8192 = Costume Garment/Robe
(2^15) 32768 = Arrow (arrow-type items only)
(2^16) 65536 = Shadow Armor
(2^17) 131072 = Shadow Weapon
(2^18) 262144 = Shadow Shield
(2^19) 524288 = Shadow Shoes
(2^20) 1048576 = Shadow Accessory 2
(2^21) 2097152 = Shadow Accessory 1
* '''WeaponLv''': Weapon level of an item (1-4), Becomes 0 when not specified.
* '''EquipLv''': Base level required to be able to equip. It is possible to specify two values, if an item has a maximum level, by using the following syntax:
EquipLv: [minLv, maxLv]

If only one value is specified, maxLv becomes the current server's
MAX_LEVEL. If no values are specified, minLv becomes 0.
* '''Refineable''': Whether the item is available for refining (1) or not (0). If no value is specified, it defaults to true.
* '''View''': For normal items, defines a replacement view-sprite for the item
:(eg: Making apples look like apple juice). The special case are weapons and ammo where this value indicates the weapon-class of the item.
** Weapon-type items:
**# Daggers
**# One-Handed Swords
**# Two-Handed Swords
**# One-Handed Spears
**# Two-Handed Spears
**# One-Handed Axes
**# Two-Handed Axes
**# Maces
**# ''(not used)''
**# Wand/Staff
**# Bows/Crossbows
**# Knuckle Weapons
**# Musical Instruments
**# Whips
**# Books
**# Katars
**# Revolvers
**# Rifles
**# Shotguns
**# Gatling guns
**# Grenade launchers
**# Fuuma shuriken
** Shield-type items:
**# Guard, Novice Guard
**# Buckler
**# Shield, Holy Guard, Evangelist
**# Mirror Shield
** Ammunition-type items:
**# Arrows
**# Throw-able daggers
**# Bullets
**# Shells
**# Grenades
**# Shuriken
**# Kunai
**# Cannonballs
**# Throwable Items (Sling Item)
** Headgear-type items: Please see the View IDs section of this guide.
* '''BindOnEquip''': Whether the item will automatically bind to the character when it is equipped for the first time.
:An item that has this field set, will display a confirmation dialog the first time it is equipped, and, if accepted, the item will become character-bound.
* '''Script''': This is where you put your item bonus. Whether it's an usable item or an equip item, it will take effect according to the item type.
* '''OnEquip_Script''': Script to execute when the item is equipped. Warning, not all item bonuses will work here as expected.
* '''OnUnequip_Script''': Script to execute when the item is unequipped. Warning, not all item bonuses will work here as expected.
* '''Inherit''': This can be used only in item_db2.conf, and if set to true, and the item already exists in item_db.conf,
:all the missing fields will be inherited from there rather than using their default values.
 
In the doc folder look for a text file called "item_bonus", it shows all the scripts items can have and how they work.
 
For more information about this structure read [http://herc.ws/board/topic/2954-item-db-file-structure-overhaul/ Item DB file structure overhaul]

=Defining Item clientside (Renewal Clients <= 2012-04-10a & Main Clients <= 2012-07-10a) =
After you make your item, put it in your item_db2.txt, so that you will not run into conflicts when updating your repository later. Then go to your data folder and modify the following files, one after another.

==idnum2itemdisplaynametable.txt==
This file holds the item names, as displayed inside the client. Each item added as:
ItemID#ItemName#
ItemID is the number from your ID column inside the item db. If your item name contains spaces, replace those with _ (underscore).

==idnum2itemdesctable.txt==
This file contains the description of your item, when it is right-clicked. The syntax for an item is:
ItemID#
Item Description Line 1
Item Description Line 2
#
You can use any amount of lines for the description. If your description contains a #, make sure it is followed by a space character.
==idnum2itemresnametable.txt==
This file sets the inventory and drop-sprite for an the item. Item is defined as follows:
ItemID#SpriteName#
The SpriteName is the name of the files in collection and item folders inside texture and the ones inside sprite folder. If you want to use the look of an another item, search for it's id and copy the sprite name from there.
==itemslotcounttable.txt==
In this file you set the amount of visible slots for the item. You do not need to add 0 slot items or items, which do not have slots at all (i. e. usable items). Syntax:
ItemID#NumberOfSlots#
NumberOfSlots should be a number from 1-4, larger values might have undesired effects.
==Files for non-identified items==
The following files specify the name, description and look for items, which have not yet been identified. Their syntax follows the same rules as for the files with ''idnum'' prefix. Normally the same text is entered for non-equipment and generic description (which can be copied from official items) is used for equipment of all sorts (weapons, armor, headgears).
* num2itemdesctable.txt
* num2itemdisplaynametable.txt
* num2itemresnametable.txt

=Defining Items clientside (For New Clients)=
If your client date is newer than specified above then you need to specify all the above item information in 1 file

==System/ItemInfo.lub==
Since ItemInfo.lub is compiled, you need to decompile it to lua , add your customs and recompile back to lub file (Some have said that renaming a decompiled file to lub also works)
Syntax:
[<item id>] = {
unidentifiedDisplayName = <item name to show when not magnified>,
unidentifiedResourceName = <file name prefix used for all the images and drop sprite when not magnified>,
unidentifiedDescriptionName = { <comma separated list of strings>,<to get multiple lines>,<in item description> },
identifiedDisplayName = <item name to show when magnified>,
identifiedResourceName = <file name prefix used for all the images and drop sprite when magnified>,
identifiedDescriptionName = { <same format as unidentifiedDescriptionName but for magnified items> },
slotCount = <number of slots>,
ClassNum = <View ID - yes the same one that was there item_db>
},
For Weapons, ClassNum = View ID specified in Weapon_IDs table (inside weapontable.lub file). Look [[Custom_Items#Weapon_Sprite_Solution_.28For_New_Clients.29|below]] for details.

You can also put the different values in DescriptionName in separate lines.

Example: Lets say i want to add a weapon to item id 25000 - a One handed sword named Devastator with 3 slots & the image files & drop sprite files are all named Black_Sword.* . Also i want to display a Sword when not magnified.

[25000] = {
unidentifiedDisplayName = "Sword",
unidentifiedResourceName = "¼Òµå",
unidentifiedDescriptionName = { "Unidentified item, can be identified with [Magnifier]." },
identifiedDisplayName = "Devastator",
identifiedResourceName = "Black_Sword",
identifiedDescriptionName = {
"An Unholy Sword that was created with the sole purpose of destruction",
"Class :^777777 Sword^000000",
"Attack :^777777 325^000000",
"Weight :^777777 80^000000",
"Weapon Level :^777777 4^000000",
"Required Level :^777777 100^000000",
"Applicable Job :^777777 Novice, Swordsman Class, Merchant Class, Thief Class^000000"
},
slotCount = 3,
ClassNum = 2
},

= Allocating Items on Client Side =
Your custom item will have 4 (6 in case its a headgear or garment) files:
1) Drop sprite -> Helmet_drop.spr
2) Drop act file -> Helmet_drop.act
3) Item Inventory image -> Helmet_item.bmp
4) Item Collection image -> Helmet_collection.bmp (the one you see on its description window)
5) Headgear View sprite -> Helmet.spr
6) Headgear View act file -> Helmet.act

Lets say i downloaded a custom item called Helmet which serves as a headgear and the above six files were in them.

==Step 1:==
We place the first four files based on what we specified in id2numresnametable.txt (IdentifiedResourceName in Iteminfo.lub).
For our example lets say i used "Helmet" as the resource name :
i) Copy Helmet_drop.spr to [RO Folder]\data\sprite\¾ÆÀÌÅÛ\Helmet.spr
ii) Copy Helmet_drop.act to [RO Folder]\data\sprite\¾ÆÀÌÅÛ\Helmet.act
iii) Copy Helmet_item.bmp to [RO Folder]\data\texture\À¯ÀúÀÎÅÍÆäÀÌ½º\item\Helmet.bmp
iv) Copy Helmet_collection.bmp to [RO Folder]\data\texture\À¯ÀúÀÎÅÍÆäÀÌ½º\collection\Helmet.bmp
==Step 2 (only for Headgears):==
For displaying headgear on the character there will be two additional files (sprite & act) or 4 if the sprite author intended for a separate set of files for male & female. In my example i have considered the first scenario.

The filename for headgear sprite are now specified in accname.lua file (details of which is available in the [[Custom_Items#View_IDs.2C_Having_A_Custom_Headgear_Without_Xray|View IDs Section]])

lets say i used
[ACCESSORY_IDs.HELMET] = "_Helmet",
then we need to:
i) Copy Helmet.spr to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\¿©\¿©_Helmet.spr (Female)
ii) Copy Helmet.act to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\¿©\¿©_Helmet.act
iii) Copy Helmet.spr to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\³²\³²_Helmet.spr (Male)
iv) Copy Helmet.act to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\³²\³²_Helmet.act

Now it is ready to be used provided you have added entries properly to the lua files.

==Specifications of the files==
1) Drop sprites - ideally have 1 frame & its act file will be just an empty act (only header will be there inside)

2) Equip sprites - typically have 3+ frames to show images for various orientations & its act file will have the info on where to place each frame.

3) Item bmp - 24x24 size 256 bit bmp file.

4) Collection bmp - 75x100 size bmp file (usually 256 bit but there is no restriction)

How to differentiate between sprite files?

Open both sprite files in [http://ratemyserver.net/download_agent.php?type=1&file_num=10 Spr Conview]. The number of frames in the files can be seen at bottom (Sprite: <currentframe>/<total>). If it says Sprite: 1/1 then its a drop sprite and the other is equip sprite.

Sometimes what sprite authors do is they simply copy the original sprite itself to make a drop sprite. In this case you will see both of them as identical when opened in Spr Conview & we don't need to worry about which one is which (since they are the same).

If the process confused you, [http://www.mediafire.com/?8lzt4cbot100w44 here is an example folder], the sprite is done by drkangel. The folder is virus free.

= View IDs, Having A Custom Headgear Without Xray =
Look in your data folder and make sure there is a folder named "lua files", if there is not make it.[http://svn6.assembla.com/svn/ClientSide/Lua_Project/lubs/ Download the most recent lub package] and extract it to your lua files folder in your data folder. [http://svn6.assembla.com/svn/ClientSide/Lua_Project/lua%20files/datainfo/ Download the most recent accname.lua and accessoryid.lua], put it in your datainfo folder that is inside the lua files folder. Now download [http://svn6.assembla.com/svn/ClientSide/Lua_Project/tool/luac5.0.2.exe this lub compiling tool], and put it in the datainfo folder.
Now, Open accessoryid.lua in the datainfo folder with notepad or a text editor of your choice, go all the way down until the names stop. Add your custom gears before the } symbol. You should use a high number just like with your custom item's database ID, or use unused IDs to be sure you won't have to redo them all in the future, or at least for a while. Example:
ACCESSORY_PINKBUNNY_HAIRBAND = 663,
ACCESSORY_GREENBUNNY_HAIRBAND = 664,
ACCESSORY_OLD_ELFEAR = 665,
ACCESSORY_THA_MAERO_MASK = 666,
ACCESSORY_THANATOS_MAI_MASK = 667,
--668 free
ACCESSORY_FISHPIN = 669,
ACCESSORY_CUSTOM_HAT = 900,
}

''You must compile to lub if you leave space between IDs, if you don't plan on compiling to lub, make sure you do not skip any numbers.''

Now open accname.lua, do basically the same thing but just in a different way, and for the sprite. Add your item to the bottom, have it look like the ones above it, except have your items name and the item's sprite name.
[ACCESSORY_IDs.ACCESSORY_PINKBUNNY_HAIRBAND] = "_ÇÎÅ©Åä³¢¸Ó¸®¶ì",
[ACCESSORY_IDs.ACCESSORY_GREENBUNNY_HAIRBAND] = "_±×¸°Åä³¢¸Ó¸®¶ì",
[ACCESSORY_IDs.ACCESSORY_OLD_ELFEAR] = "_°í´ë¿äÁ¤ÀÇ±Í",
[ACCESSORY_IDs.ACCESSORY_THA_MAERO_MASK] = "_Å¸³ªÅä½ºÀÇ½½ÇÄ°¡¸é",
[ACCESSORY_IDs.ACCESSORY_THANATOS_MAI_MASK] = "_Å¸³ªÅä½ºÀÇÁõ¿À°¡¸é",
[ACCESSORY_IDs.ACCESSORY_FISHPIN] = "_¹°°í±âÇÉ",
[ACCESSORY_IDs.ACCESSORY_CUSTOM_HAT] = "_Sprite_Name_Here",
}
Delete the accname.lub and accessoryid.lub. Now that you are done, make sure luac.exe is in your datainfo folder, right click the luac.exe, create a shortcut, right click the shortcut, and click properties, in the target area, add right after the quotes, with the quotes:
-o "accessoryid.lub" "accessoryid.lua"
So that it looks something like this:
"C:\Program Files (x86)\Gravity\RO\data\lua files\datainfo\luac5.0.2.exe" -o "accessoryid.lub" "accessoryid.lua"
Do this also to "accname.lub" except instead of accessoryid in the quotes, do accname. If there is any lua file leftover, you may want to move it somewhere else just for future changes, like My Documents. For future reference, this is also how you turn the other lub files to lua files.

=Modifications=
==Sprite Replacement==
To replace a headgear with your customized headgear, just delete one of the items you want, and replace your customised item ID with that id.

Lets say you have something like this:
15000,Angel_Wing,Angel Wing,4,,10,10,0,,1,0,0,3,0,0,0,0,0,{},{},{}
And there's an item you wont need, such as:
2220,Hat,Hat,5,1000,,200,,2,,0,10477567,2,256,,0,1,16,{},{},{}
Well, to replace it, just delete everything in the hat line but its ID, and paste there your custom item, all the line but the ID. Should be like this:
'''2220''',Hat,Hat,5,1000,,200,,2,,0,10477567,2,256,,0,1,16,{},{},{}
15000,'''Angel_Wing,Angel Wing,4,,10,10,0,,1,0,0,3,0,0,0,0,0,{},{},{}'''
'''2220,Angel_Wing,Angel Wing,4,,10,10,0,,1,0,0,3,0,0,0,0,0,{},{},{}'''
All you need to do now is changing the View ID to the Hat, and change your file names to its name. You can find them on the idnum2resnametable.txt Search for 2220 and the gibberish besides it, w/o the # # is the file name, then rename it to your custom item name.

Remember to add the files to data\sprite\¾ÆÀÌÅÛ (Icon sprite) and both data\sprite\¾Ç¼¼»ç¸®\³² (Male Item Sprite) and data\sprite\¾Ç¼¼»ç¸®\¿© (Female Item Sprite). Remember, these 2 last item names, must have either a ³²_ for male or ¿©_ for female, at the beginning of the name, both .spr and .act. Also, don't forget to change the other files:

idnum2itemdisplaynametable.txt , idnum2itemdesctable.txt , idnum2itemdesctable.txt , num2itemdesctable.txt , num2itemdisplaynametable.txt , num2itemresnametable.txt and itemslotcounttable.txt

Use these files if you want to replace sprites, they will be useful.
* '''actOR:''' with the actor you modify the act file, which is the one who tells the client where does the weapon go and what does it have to do and at a certain moment.
* '''SPR Conview:''' you can use these to view which sprite is which, and also see sequence per sequence.

==Item Restrictions==
Look on your db folder for a file called item_trade.txt and open it

Now, the pattern for a flag is:

Item ID, TradeMask, GM-Level Override

* '''Item ID''': the ID of your item.
* '''TradeMask''': Testrictions the item will have, such as being dropped, stored or traded. These values can be combined to achieve multiple effects.
1:Item can't be dropped
2:Item can't be traded (nor vended)
4:Item can only be traded with wedded partner
8:Item can't be sold to NPCs
16:Item can't be placed in the cart
32:Item can't be placed in the storage
64:Item can't be placed in the guild storage
* '''GM-Level Override''': This is the minimum GM level a player must have to avoid these restrictions.

==Item Script==
{{duplication
|type=section
|what=[[itemskill]], [[sc_start]] and [[skilleffect]]}}
{{disputed
|type=section
|date=September 2010}}
Okay, I'll update this as I go; otherwise, I wont have anything new to show. First with usable items.

Well, there are 3 types of usables:

1.- Healing items, they have in the type field a 0.

2.- Other uses items, such as fly wings and so, which doesn't heal, but does have an instant effect, they have in the type field a 2.

3.- Usable items, which are skills that requires a target selection, therefore they have a delayed use, and in newer versions the item wont be gone until the target is chosen and the cast has finished. Means, you wont lose the item if the skill hasn't been done. They have in the type field an 11.

Now, for an item skill, the pattern for a skill is:
itemskill <skill id>,<skill level>;
Without <> of course.

Now, we go to our db\skill_db.txt and search for the blessing ID, searching for AL_ or blessing, but first, the structure of a skill:
id,range,hit,inf,element,nk,splash,max,list_num,castcancel,cast_defence_rate,inf2,maxcount,skill_type,blow_count,name,description
Now, the AL_BLESSING or Blessing Skill:
34,9,6,16,0,0x1,0,10,1,yes,0,0,0,magic,0, AL_BLESSING,Blessing
We grab the ID and put it on our code:
itemskill 34,<skill lvl>;
Don't mind the actual level of the skill_db.txt for the skill level part. You can actually put the level you want here below 99, so lets pick 4:
itemskill 34,4;
And finally, insert it on the code.
<pre>,{ itemskill 34,4; },{},{}</pre>

There, we have a Lvl 4 Blessing item skill.

Remember, one space before and one after the script, NOT TAB!

And so on with other skills. Just remember these steps and they should be fine. And remember, itemskill is NOT the same as skill. itemskill will make you CAST that skill, while skill will GIVE you the skill. If you give an item, whether delayed use or normal usable two itemskill commands, only the latter will come into effect, as you cannot cast two skills at the same time.

Now, for Potions.

Instead of using itemskill, we will use itemheal:
,{ itemheal 100,0; },{},{}
The green is the HP, the blue is the SP. To add that random heal amount effect, just pick a set amount, let's say 120, then pick 1 or 2 numbers, up to you. Then, add the rand() command, like this:
,{ itemheal rand(120,9,49),0; },{},{}
Explanation: This item will heal about 49~120 hp and 0 SP. To heal SP you change the 0 to a number. Like this:
,{ itemheal rand(120,9,49),50; },{},{}
It will now heal 50 SP.
Now, for skilleffect and sc_start.

Okay, let's see. Here's a example of an item casting a skill and simulating a skill.
,{ itemskill 34,10; skilleffect 29,0; sc_start 12,140000,5; },{},{}
skilleffect will display on your client a skill visual effect. The pattern is:

skilleffect <skill ID>,<number>;

;skill ID
:Self-explanatory.
;number
:Have you seen those skills that shows up numbers upon casting? Such as heal? Well, putting a number there will display it. But only works on skills with numbers floating.

sc_start has the following pattern:

sc_start <status id>,<duration>,<val1>[,<unit id>];

;status id
:Refer to const.txt in your db folder for all effects. Open it with a text editor then search by either clicking edit, then find, or press and hold the ctrl key, and while still holding it press the f key, then release, and search for "SC_ALL -1". Everything below this is an effect. The effects stop at "e_gasp 0" which are emoticons.
;duration
:Is the amount time in milliseconds (1000 msec = 1 sec) that the status will be active.
;val1
:Typically it's the level of the skill, associated with this status.
;unit id
:Allows to start the status on an other unit, than the attached player. For players this is account id. This parameter is optional, and can be omitted.

Now, for the item I said, it will show you the visual effect of Blessing and cast on you a lvl 5 Agi-Up! skill for 140 seconds.

For more item scripts see script_commands.txt in your doc folder, as well as item_bonus.txt in your doc folder.

==Weapon Sprite Solution (Renewal Clients <= 2012-04-10a & Main Clients <= 2012-07-10a)==
For these clients, Weapons are limited to use a range of Item IDs hardcoded in the clientn for each type.
For e.g.

1265,Bloody_Roar,Bloody Roar,4,,10,1000,120,,1,0,4096,7,2,34,4,75,1,16,{ bonus bIgnoreDefRace,RC_DemiHuman; bonus bFlee,-160; bonus bFlee2,-160; bonus bNoRegen,1; bonus bNoRegen,2; },{},{}
1266,Test,Test,4,4000,2000,10,165,,1,0,4096,7,2,34,3,33,1,16,{}

// 1-Handed Axes
1301,Axe,Axe,4,500,,800,38,,1,3,8803555,7,2,2,1,3,1,6,{}

Here the item 1266 is a custom katar and it does show up as a katar (if you have the proper sprite files ofcourse). but if i use some id like say 22000, client wont display it. So what is the range of item ids you can use? Look below:

* One handed Swords = 1100-1149, 13400-13499
* Two handed Swords = 1150-1199, 21000-21999

* Knives, Daggers etc = 1200-1249, 13000-13099
* Katars = 1250-1299 ; Has 35 free IDs

* One handed Axes = 1300-1349; Has 43 free IDs
* Two handed Axes = 1350-1399; Has 32 free IDs

* One handed Spears = 1400-1449; Has 34 free IDs
* Two Handed Spears = 1450-1471, 1474-1499

* Maces = 1500-1549, 16000-16999
* Books = 1550-1599 ; Has only 2 IDs.
* Knuckles = 1800-1899 ; Has 95 free IDs

* One Handed Staves/Rods = 1600-1699; Has 79 free IDs
* Two Handed Staves/Rods = 1472,1473,2000-2099

* Bows = 1700-1749, 18100-18499
* Guitars = 1900-1949 ; Has 32 free IDs
* Whips = 1950-1999 ; Has 130 free IDs

* Handguns = 13100-13149
* Other guns = 13150-13199

* Ninja weapons = 13300-13399

The number of unused Item IDs left known for a range has also been mentioned above. Best practice to follow check in your range in official db before adding custom weapon.

==Weapon Sprite Solution (For New Clients) ==
For new clients the view id system is also applicable to client. To add a custom weapon you need to first edit a file
called weapontable.lub in your data folder
data/luafiles514/lua files/datainfo/weapontable.lub

I will be adding Oriental_Sword which will be a 1-Handed sword. Open weapontable.lub.
First you will see a table called Weapon_IDs. Take note of the first 30 values in this table - these are the only available Weapon types in the client right now.

Anyways go to the last entry which should be for Wizardy Staff = 97. You can use a view id after that like shown below
WEAPONTYPE_Oriental_Sword = 98,

Come down and you see the next table called WeaponNameTable. Here is where you add your sprite name suffix. 
What do i mean by that? Its the last part in your weapon sprite & act file. Before it used to be _<Item ID>.
data/sprite/<job dependent folder>/<job dependent prefix>_<gender><weapon suffix>.spr

OK Back to topic. so I add my entry like shown below.
[Weapon_IDs.WEAPONTYPE_Oriental_Sword] = "_Oriental"

Lastly come down further in weapontable.lub and you see the last table called Expansion_Weapon_IDs. 
Remember the 30 types i told you to take note of ? here we assign one of those to our custom (like a mapping or connection). 
Since mine is a 1-Handed Sword I specify it like below.
[Weapon_IDs.WEAPONTYPE_Oriental_Sword] = Weapon_IDs.WPCLASS_WEAPONTYPE_SWORD

Now for the most important part. For our client to actually pick up all these details we need to provide the view id which we used in Weapon_IDs table as the ClassNum value in ItemInfo.lua. Check the [[Custom_Items#System.2FItemInfo.lub|ItemInfo.lub format]] shown above for details.

With this your weapon sprite will become visible while attacking.
[[Category:Database]]
[[Category:Data]]
[[Category:Customization]]

Custom Items

2016-05-05T20:38:44Z

Asheraf: edit

=Structure=
First, let's take a look at the item_db.conf in the db folder, and its structure:
item_db: (
{
// =================== Mandatory fields ===============================
Id: ID (int)
AegisName: "Aegis_Name" (string, optional if Inherit: true)
Name: "Item Name" (string, optional if Inherit: true)
// =================== Optional fields ================================
Type: Item Type (int, defaults to 3 = etc item)
Buy: Buy Price (int, defaults to Sell * 2)
Sell: Sell Price (int, defaults to Buy / 2)
Weight: Item Weight (int, defaults to 0)
Atk: Attack (int, defaults to 0)
Matk: Magical Attack (int, defaults to 0, ignored in pre-re)
Def: Defense (int, defaults to 0)
Range: Attack Range (int, defaults to 0)
Slots: Slots (int, defaults to 0)
Job: (defaults to all job)
All: true/false (boolean, defaults to false)
Novice: true/false (boolean, defaults to false)
Swordsman: true/false (boolean, defaults to false)
Magician: true/false (boolean, defaults to false)
Archer: true/false (boolean, defaults to false)
Acolyte: true/false (boolean, defaults to false)
Merchant: true/false (boolean, defaults to false)
Thief: true/false (boolean, defaults to false)
Knight: true/false (boolean, defaults to false)
Priest: true/false (boolean, defaults to false)
Wizard: true/false (boolean, defaults to false)
Blacksmith: true/false (boolean, defaults to false)
Hunter: true/false (boolean, defaults to false)
Assassin: true/false (boolean, defaults to false)
Crusader: true/false (boolean, defaults to false)
Monk: true/false (boolean, defaults to false)
Sage: true/false (boolean, defaults to false)
Rogue: true/false (boolean, defaults to false)
Alchemist: true/false (boolean, defaults to false)
Bard: true/false (boolean, defaults to false)
Taekwon: true/false (boolean, defaults to false)
Star_Gladiator: true/false (boolean, defaults to false)
Soul_Linker: true/false (boolean, defaults to false)
Gunslinger: true/false (boolean, defaults to false)
Ninja: true/false (boolean, defaults to false)
Gangsi: true/false (boolean, defaults to false)
Death_Knight: true/false (boolean, defaults to false)
Dark_Collector: true/false (boolean, defaults to false)
Kagerou: true/false (boolean, defaults to false)
Rebellion: true/false (boolean, defaults to false)

Job: Job mask (int, defaults to all jobs = 0xFFFFFFFF)
Upper: Upper mask (int, defaults to any = 0x3f)
Gender: Gender (int, defaults to both = 2)
Loc: Equip location (int, required value for equipment)
WeaponLv: Weapon Level (int, defaults to 0)
EquipLv: Equip required level (int, defaults to 0)
EquipLv: [min, max] (alternative syntax with min / max level)
Refine: Refineable (boolean, defaults to true)
View: View ID (int, defaults to 0)
BindOnEquip: true/false (boolean, defaults to false)
ForceSerial: true/false (boolean, defaults to false)
BuyingStore: true/false (boolean, defaults to false)
Delay: Delay to use item (int, defaults to 0)
KeepAfterUse: true/false (boolean, defaults to false)
Trade: (defaults to no restrictions)
override: GroupID (int, defaults to 100)
nodrop: true/false (boolean, defaults to false)
notrade: true/false (boolean, defaults to false)
nostorage: true/false (boolean, defaults to false)
nocart: true/false (boolean, defaults to false)
noselltonpc: true/false (boolean, defaults to false)
nomail: true/false (boolean, defaults to false)
noauction: true/false (boolean, defaults to false)
nogstorage: true/false (boolean, defaults to false)
partneroverride: true/false (boolean, defaults to false)

Nouse: (defaults to no restrictions)
override: GroupID (int, defaults to 100)
sitting: true/false (boolean, defaults to false)

Stack: [amount, type] (int, defaults to 0)
Sprite: SpriteID (int, defaults to 0)
Script: <"
Script
(it can be multi-line)
">
OnEquipScript: <" OnEquip Script (can also be multi-line) ">
OnUnequipScript: <" OnUnequip Script (can also be multi-line) ">
// =================== Optional fields (item_db2 only) ================
Inherit: true/false (boolean, if true, inherit the values
that weren't specified, from item_db.conf,
else override it and use default values)
},
...
)

* '''ID''': ID of the item.
* '''AegisName''': Server name to reference the item in scripts and lookups, should use no spaces.
* '''Name''': Name in English for displaying as output for @ and script commands.
* '''Type''': Purpose of the item.
0 = Usable : healing
2 = Usable : other
3 = Misc
4 = Weapon
5 = Armor
6 = Card
7 = Pet Egg
8 = Pet Equipment
10 = Arrow/Ammunition
11 = Usable : delayed consumption (items with script "pet" or "itemskill")
18 = Another delayed consume that requires user confirmation before using item.
* '''Buy''': Default [[NPC]] buying price in Zeny. When not specified, becomes double the sell price.
* '''Sell''': Default [[NPC]] selling price in Zeny. When not specified, becomes half the buy price.
* '''Weight''': Item's weight. Each 10 is 1 weight. When not specified, becomes 0.
* '''ATK''': Base weapon attack, in case of a weapon. When not specified, becomes 0.
** In '''RE''' enabled servers this field have a optional delimiter ''':''' to define this item's weaponMATK bonus, for example, '''30:50''' would mean the item gives 30 atk and 50 weaponMATK
* '''Matk''': Weapon's magical attack (only used in renewal mode, ignored in pre-renewal). When not specified, becomes 0.
* '''DEF''': Base defense for armor-type items. When not specified, becomes 0.
* '''Range''': Maximum range in map cells a weapon allows to be the player apart from it's target. When not specified, becomes 0.
* '''Slots''': Amount of card slots in weapon/armor-type items. When not specified, becomes 0.
* '''Job''': Which jobs this item is available for. Values below can be combined to achieve availability for multiple job classes, i. e. <code>0x2|0x4 -> 0x6</code> (Swordman+Mage)
(S.) Novice (2^00): 0x00000001
Swordman (2^01): 0x00000002
Mage (2^02): 0x00000004
Archer (2^03): 0x00000008
Acolyte (2^04): 0x00000010
Merchant (2^05): 0x00000020
Thief (2^06): 0x00000040
Knight (2^07): 0x00000080
Priest (2^08): 0x00000100
Wizard (2^09): 0x00000200
Blacksmith (2^10): 0x00000400
Hunter (2^11): 0x00000800
Assassin (2^12): 0x00001000
''Unused'' (2^13): 0x00002000
Crusader (2^14): 0x00004000
Monk (2^15): 0x00008000
Sage (2^16): 0x00010000
Rogue (2^17): 0x00020000
Alchemist (2^18): 0x00040000
Bard/Dancer (2^19): 0x00080000
''Unused'' (2^20): 0x00100000
Taekwon (2^21): 0x00200000
StarGladiator (2^22): 0x00400000
Soul Linker (2^23): 0x00800000
Gunslinger (2^24): 0x01000000
Ninja (2^25): 0x02000000
Gangsi (2^26): 0x04000000
Death Knight (2^27): 0x08000000
Dark Collector (2^28): 0x10000000
Kagerou/Oboro (2^29): 0x20000000
Rebellion (2^30): 0x40000000
'''Some other commonly used values:'''
All Classes : 0xFFFFFFFF
Every Job Except Novice : 0xFFFFFFFE
* '''Upper''': Specifies whether the item can be used by normal, baby or reborn classes. Values below can be combined, i. e. <code>1|4 -> 5</code> (Normal+Baby Classes)
** Note: Setting <code>2</code> enables the item for Transcendant and 3rd classes. Use <code>8</code> to enable the item for 3rd classes only.
Normal jobs: 0x01 (1)
Upper jobs: 0x02 (2)
Baby jobs: 0x04 (4)
Third jobs: 0x08 (8)
Upper Third jobs: 0x10 (16)
Baby Third jobs: 0x20 (32)

Under pre-re mode third classes are considered upper, making use of
the 8 and above masks is therefore not necessary unless in renewal
mode. When no value is specified, all classes (mask 0x3f) are able to
equip the item.
* '''Gender''': Gender restriction for the item.
0 = Female
1 = Male
2 = No restriction (both)
* '''Loc''': Equipment location of armor and arrow-type items. Values below can be combined, i. e. 136 would indicate both accessory slots (typical value for accessories).
(2^0) 1 = Lower headgear
(2^1) 2 = Right hand
(2^2) 4 = Mantle
(2^3) 8 = Accessory 1
(2^4) 16 = Armor
(2^5) 32 = Left hand
(2^6) 64 = Shoes
(2^7) 128 = Accessory 2
(2^8) 256 = Upper headgear
(2^9) 512 = Middle headgear
(2^10) 1024 = Costume Top Headgear
(2^11) 2048 = Costume Mid Headgear
(2^12) 4096 = Costume Low Headgear
(2^13) 8192 = Costume Garment/Robe
(2^15) 32768 = Arrow (arrow-type items only)
(2^16) 65536 = Shadow Armor
(2^17) 131072 = Shadow Weapon
(2^18) 262144 = Shadow Shield
(2^19) 524288 = Shadow Shoes
(2^20) 1048576 = Shadow Accessory 2
(2^21) 2097152 = Shadow Accessory 1
* '''WeaponLv''': Weapon level of an item (1-4), Becomes 0 when not specified.
* '''EquipLv''': Base level required to be able to equip. It is possible to specify two values, if an item has a maximum level, by using the following syntax:
EquipLv: [minLv, maxLv]

If only one value is specified, maxLv becomes the current server's
MAX_LEVEL. If no values are specified, minLv becomes 0.
* '''Refineable''': Whether the item is available for refining (1) or not (0). If no value is specified, it defaults to true.
* '''View''': For normal items, defines a replacement view-sprite for the item
:(eg: Making apples look like apple juice). The special case are weapons and ammo where this value indicates the weapon-class of the item.
** Weapon-type items:
**# Daggers
**# One-Handed Swords
**# Two-Handed Swords
**# One-Handed Spears
**# Two-Handed Spears
**# One-Handed Axes
**# Two-Handed Axes
**# Maces
**# ''(not used)''
**# Wand/Staff
**# Bows/Crossbows
**# Knuckle Weapons
**# Musical Instruments
**# Whips
**# Books
**# Katars
**# Revolvers
**# Rifles
**# Shotguns
**# Gatling guns
**# Grenade launchers
**# Fuuma shuriken
** Shield-type items:
**# Guard, Novice Guard
**# Buckler
**# Shield, Holy Guard, Evangelist
**# Mirror Shield
** Ammunition-type items:
**# Arrows
**# Throw-able daggers
**# Bullets
**# Shells
**# Grenades
**# Shuriken
**# Kunai
**# Cannonballs
**# Throwable Items (Sling Item)
** Headgear-type items: Please see the View IDs section of this guide.
* '''BindOnEquip''': Whether the item will automatically bind to the character when it is equipped for the first time.
:An item that has this field set, will display a confirmation dialog the first time it is equipped, and, if accepted, the item will become character-bound.
* '''Script''': This is where you put your item bonus. Whether it's an usable item or an equip item, it will take effect according to the item type.
* '''OnEquip_Script''': Script to execute when the item is equipped. Warning, not all item bonuses will work here as expected.
* '''OnUnequip_Script''': Script to execute when the item is unequipped. Warning, not all item bonuses will work here as expected.
* '''Inherit''': This can be used only in item_db2.conf, and if set to true, and the item already exists in item_db.conf,
:all the missing fields will be inherited from there rather than using their default values.
 
In the doc folder look for a text file called "item_bonus", it shows all the scripts items can have and how they work.
 
For more information about this structure read [http://herc.ws/board/topic/2954-item-db-file-structure-overhaul/ Item DB file structure overhaul]

=Defining Item clientside (Renewal Clients <= 2012-04-10a & Main Clients <= 2012-07-10a) =
After you make your item, put it in your item_db2.txt, so that you will not run into conflicts when updating your repository later. Then go to your data folder and modify the following files, one after another.

==idnum2itemdisplaynametable.txt==
This file holds the item names, as displayed inside the client. Each item added as:
ItemID#ItemName#
ItemID is the number from your ID column inside the item db. If your item name contains spaces, replace those with _ (underscore).

==idnum2itemdesctable.txt==
This file contains the description of your item, when it is right-clicked. The syntax for an item is:
ItemID#
Item Description Line 1
Item Description Line 2
#
You can use any amount of lines for the description. If your description contains a #, make sure it is followed by a space character.
==idnum2itemresnametable.txt==
This file sets the inventory and drop-sprite for an the item. Item is defined as follows:
ItemID#SpriteName#
The SpriteName is the name of the files in collection and item folders inside texture and the ones inside sprite folder. If you want to use the look of an another item, search for it's id and copy the sprite name from there.
==itemslotcounttable.txt==
In this file you set the amount of visible slots for the item. You do not need to add 0 slot items or items, which do not have slots at all (i. e. usable items). Syntax:
ItemID#NumberOfSlots#
NumberOfSlots should be a number from 1-4, larger values might have undesired effects.
==Files for non-identified items==
The following files specify the name, description and look for items, which have not yet been identified. Their syntax follows the same rules as for the files with ''idnum'' prefix. Normally the same text is entered for non-equipment and generic description (which can be copied from official items) is used for equipment of all sorts (weapons, armor, headgears).
* num2itemdesctable.txt
* num2itemdisplaynametable.txt
* num2itemresnametable.txt

=Defining Items clientside (For New Clients)=
If your client date is newer than specified above then you need to specify all the above item information in 1 file

==System/ItemInfo.lub==
Since ItemInfo.lub is compiled, you need to decompile it to lua , add your customs and recompile back to lub file (Some have said that renaming a decompiled file to lub also works)
Syntax:
[<item id>] = {
unidentifiedDisplayName = <item name to show when not magnified>,
unidentifiedResourceName = <file name prefix used for all the images and drop sprite when not magnified>,
unidentifiedDescriptionName = { <comma separated list of strings>,<to get multiple lines>,<in item description> },
identifiedDisplayName = <item name to show when magnified>,
identifiedResourceName = <file name prefix used for all the images and drop sprite when magnified>,
identifiedDescriptionName = { <same format as unidentifiedDescriptionName but for magnified items> },
slotCount = <number of slots>,
ClassNum = <View ID - yes the same one that was there item_db>
},
For Weapons, ClassNum = View ID specified in Weapon_IDs table (inside weapontable.lub file). Look [[Custom_Items#Weapon_Sprite_Solution_.28For_New_Clients.29|below]] for details.

You can also put the different values in DescriptionName in separate lines.

Example: Lets say i want to add a weapon to item id 25000 - a One handed sword named Devastator with 3 slots & the image files & drop sprite files are all named Black_Sword.* . Also i want to display a Sword when not magnified.

[25000] = {
unidentifiedDisplayName = "Sword",
unidentifiedResourceName = "¼Òµå",
unidentifiedDescriptionName = { "Unidentified item, can be identified with [Magnifier]." },
identifiedDisplayName = "Devastator",
identifiedResourceName = "Black_Sword",
identifiedDescriptionName = {
"An Unholy Sword that was created with the sole purpose of destruction",
"Class :^777777 Sword^000000",
"Attack :^777777 325^000000",
"Weight :^777777 80^000000",
"Weapon Level :^777777 4^000000",
"Required Level :^777777 100^000000",
"Applicable Job :^777777 Novice, Swordsman Class, Merchant Class, Thief Class^000000"
},
slotCount = 3,
ClassNum = 2
},

= Allocating Items on Client Side =
Your custom item will have 4 (6 in case its a headgear or garment) files:
1) Drop sprite -> Helmet_drop.spr
2) Drop act file -> Helmet_drop.act
3) Item Inventory image -> Helmet_item.bmp
4) Item Collection image -> Helmet_collection.bmp (the one you see on its description window)
5) Headgear View sprite -> Helmet.spr
6) Headgear View act file -> Helmet.act

Lets say i downloaded a custom item called Helmet which serves as a headgear and the above six files were in them.

==Step 1:==
We place the first four files based on what we specified in id2numresnametable.txt (IdentifiedResourceName in Iteminfo.lub).
For our example lets say i used "Helmet" as the resource name :
i) Copy Helmet_drop.spr to [RO Folder]\data\sprite\¾ÆÀÌÅÛ\Helmet.spr
ii) Copy Helmet_drop.act to [RO Folder]\data\sprite\¾ÆÀÌÅÛ\Helmet.act
iii) Copy Helmet_item.bmp to [RO Folder]\data\texture\À¯ÀúÀÎÅÍÆäÀÌ½º\item\Helmet.bmp
iv) Copy Helmet_collection.bmp to [RO Folder]\data\texture\À¯ÀúÀÎÅÍÆäÀÌ½º\collection\Helmet.bmp
==Step 2 (only for Headgears):==
For displaying headgear on the character there will be two additional files (sprite & act) or 4 if the sprite author intended for a separate set of files for male & female. In my example i have considered the first scenario.

The filename for headgear sprite are now specified in accname.lua file (details of which is available in the [[Custom_Items#View_IDs.2C_Having_A_Custom_Headgear_Without_Xray|View IDs Section]])

lets say i used
[ACCESSORY_IDs.HELMET] = "_Helmet",
then we need to:
i) Copy Helmet.spr to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\¿©\¿©_Helmet.spr (Female)
ii) Copy Helmet.act to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\¿©\¿©_Helmet.act
iii) Copy Helmet.spr to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\³²\³²_Helmet.spr (Male)
iv) Copy Helmet.act to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\³²\³²_Helmet.act

Now it is ready to be used provided you have added entries properly to the lua files.

==Specifications of the files==
1) Drop sprites - ideally have 1 frame & its act file will be just an empty act (only header will be there inside)

2) Equip sprites - typically have 3+ frames to show images for various orientations & its act file will have the info on where to place each frame.

3) Item bmp - 24x24 size 256 bit bmp file.

4) Collection bmp - 75x100 size bmp file (usually 256 bit but there is no restriction)

How to differentiate between sprite files?

Open both sprite files in [http://ratemyserver.net/download_agent.php?type=1&file_num=10 Spr Conview]. The number of frames in the files can be seen at bottom (Sprite: <currentframe>/<total>). If it says Sprite: 1/1 then its a drop sprite and the other is equip sprite.

Sometimes what sprite authors do is they simply copy the original sprite itself to make a drop sprite. In this case you will see both of them as identical when opened in Spr Conview & we don't need to worry about which one is which (since they are the same).

If the process confused you, [http://www.mediafire.com/?8lzt4cbot100w44 here is an example folder], the sprite is done by drkangel. The folder is virus free.

= View IDs, Having A Custom Headgear Without Xray =
Look in your data folder and make sure there is a folder named "lua files", if there is not make it.[http://svn6.assembla.com/svn/ClientSide/Lua_Project/lubs/ Download the most recent lub package] and extract it to your lua files folder in your data folder. [http://svn6.assembla.com/svn/ClientSide/Lua_Project/lua%20files/datainfo/ Download the most recent accname.lua and accessoryid.lua], put it in your datainfo folder that is inside the lua files folder. Now download [http://svn6.assembla.com/svn/ClientSide/Lua_Project/tool/luac5.0.2.exe this lub compiling tool], and put it in the datainfo folder.
Now, Open accessoryid.lua in the datainfo folder with notepad or a text editor of your choice, go all the way down until the names stop. Add your custom gears before the } symbol. You should use a high number just like with your custom item's database ID, or use unused IDs to be sure you won't have to redo them all in the future, or at least for a while. Example:
ACCESSORY_PINKBUNNY_HAIRBAND = 663,
ACCESSORY_GREENBUNNY_HAIRBAND = 664,
ACCESSORY_OLD_ELFEAR = 665,
ACCESSORY_THA_MAERO_MASK = 666,
ACCESSORY_THANATOS_MAI_MASK = 667,
--668 free
ACCESSORY_FISHPIN = 669,
ACCESSORY_CUSTOM_HAT = 900,
}

''You must compile to lub if you leave space between IDs, if you don't plan on compiling to lub, make sure you do not skip any numbers.''

Now open accname.lua, do basically the same thing but just in a different way, and for the sprite. Add your item to the bottom, have it look like the ones above it, except have your items name and the item's sprite name.
[ACCESSORY_IDs.ACCESSORY_PINKBUNNY_HAIRBAND] = "_ÇÎÅ©Åä³¢¸Ó¸®¶ì",
[ACCESSORY_IDs.ACCESSORY_GREENBUNNY_HAIRBAND] = "_±×¸°Åä³¢¸Ó¸®¶ì",
[ACCESSORY_IDs.ACCESSORY_OLD_ELFEAR] = "_°í´ë¿äÁ¤ÀÇ±Í",
[ACCESSORY_IDs.ACCESSORY_THA_MAERO_MASK] = "_Å¸³ªÅä½ºÀÇ½½ÇÄ°¡¸é",
[ACCESSORY_IDs.ACCESSORY_THANATOS_MAI_MASK] = "_Å¸³ªÅä½ºÀÇÁõ¿À°¡¸é",
[ACCESSORY_IDs.ACCESSORY_FISHPIN] = "_¹°°í±âÇÉ",
[ACCESSORY_IDs.ACCESSORY_CUSTOM_HAT] = "_Sprite_Name_Here",
}
Delete the accname.lub and accessoryid.lub. Now that you are done, make sure luac.exe is in your datainfo folder, right click the luac.exe, create a shortcut, right click the shortcut, and click properties, in the target area, add right after the quotes, with the quotes:
-o "accessoryid.lub" "accessoryid.lua"
So that it looks something like this:
"C:\Program Files (x86)\Gravity\RO\data\lua files\datainfo\luac5.0.2.exe" -o "accessoryid.lub" "accessoryid.lua"
Do this also to "accname.lub" except instead of accessoryid in the quotes, do accname. If there is any lua file leftover, you may want to move it somewhere else just for future changes, like My Documents. For future reference, this is also how you turn the other lub files to lua files.

=Modifications=
==Sprite Replacement==
To replace a headgear with your customized headgear, just delete one of the items you want, and replace your customised item ID with that id.

Lets say you have something like this:
15000,Angel_Wing,Angel Wing,4,,10,10,0,,1,0,0,3,0,0,0,0,0,{},{},{}
And there's an item you wont need, such as:
2220,Hat,Hat,5,1000,,200,,2,,0,10477567,2,256,,0,1,16,{},{},{}
Well, to replace it, just delete everything in the hat line but its ID, and paste there your custom item, all the line but the ID. Should be like this:
'''2220''',Hat,Hat,5,1000,,200,,2,,0,10477567,2,256,,0,1,16,{},{},{}
15000,'''Angel_Wing,Angel Wing,4,,10,10,0,,1,0,0,3,0,0,0,0,0,{},{},{}'''
'''2220,Angel_Wing,Angel Wing,4,,10,10,0,,1,0,0,3,0,0,0,0,0,{},{},{}'''
All you need to do now is changing the View ID to the Hat, and change your file names to its name. You can find them on the idnum2resnametable.txt Search for 2220 and the gibberish besides it, w/o the # # is the file name, then rename it to your custom item name.

Remember to add the files to data\sprite\¾ÆÀÌÅÛ (Icon sprite) and both data\sprite\¾Ç¼¼»ç¸®\³² (Male Item Sprite) and data\sprite\¾Ç¼¼»ç¸®\¿© (Female Item Sprite). Remember, these 2 last item names, must have either a ³²_ for male or ¿©_ for female, at the beginning of the name, both .spr and .act. Also, don't forget to change the other files:

idnum2itemdisplaynametable.txt , idnum2itemdesctable.txt , idnum2itemdesctable.txt , num2itemdesctable.txt , num2itemdisplaynametable.txt , num2itemresnametable.txt and itemslotcounttable.txt

Use these files if you want to replace sprites, they will be useful.
* '''actOR:''' with the actor you modify the act file, which is the one who tells the client where does the weapon go and what does it have to do and at a certain moment.
* '''SPR Conview:''' you can use these to view which sprite is which, and also see sequence per sequence.

==Item Restrictions==
Look on your db folder for a file called item_trade.txt and open it

Now, the pattern for a flag is:

Item ID, TradeMask, GM-Level Override

* '''Item ID''': the ID of your item.
* '''TradeMask''': Testrictions the item will have, such as being dropped, stored or traded. These values can be combined to achieve multiple effects.
1:Item can't be dropped
2:Item can't be traded (nor vended)
4:Item can only be traded with wedded partner
8:Item can't be sold to NPCs
16:Item can't be placed in the cart
32:Item can't be placed in the storage
64:Item can't be placed in the guild storage
* '''GM-Level Override''': This is the minimum GM level a player must have to avoid these restrictions.

==Item Script==
{{duplication
|type=section
|what=[[itemskill]], [[sc_start]] and [[skilleffect]]}}
{{disputed
|type=section
|date=September 2010}}
Okay, I'll update this as I go; otherwise, I wont have anything new to show. First with usable items.

Well, there are 3 types of usables:

1.- Healing items, they have in the type field a 0.

2.- Other uses items, such as fly wings and so, which doesn't heal, but does have an instant effect, they have in the type field a 2.

3.- Usable items, which are skills that requires a target selection, therefore they have a delayed use, and in newer versions the item wont be gone until the target is chosen and the cast has finished. Means, you wont lose the item if the skill hasn't been done. They have in the type field an 11.

Now, for an item skill, the pattern for a skill is:
itemskill <skill id>,<skill level>;
Without <> of course.

Now, we go to our db\skill_db.txt and search for the blessing ID, searching for AL_ or blessing, but first, the structure of a skill:
id,range,hit,inf,element,nk,splash,max,list_num,castcancel,cast_defence_rate,inf2,maxcount,skill_type,blow_count,name,description
Now, the AL_BLESSING or Blessing Skill:
34,9,6,16,0,0x1,0,10,1,yes,0,0,0,magic,0, AL_BLESSING,Blessing
We grab the ID and put it on our code:
itemskill 34,<skill lvl>;
Don't mind the actual level of the skill_db.txt for the skill level part. You can actually put the level you want here below 99, so lets pick 4:
itemskill 34,4;
And finally, insert it on the code.
<pre>,{ itemskill 34,4; },{},{}</pre>

There, we have a Lvl 4 Blessing item skill.

Remember, one space before and one after the script, NOT TAB!

And so on with other skills. Just remember these steps and they should be fine. And remember, itemskill is NOT the same as skill. itemskill will make you CAST that skill, while skill will GIVE you the skill. If you give an item, whether delayed use or normal usable two itemskill commands, only the latter will come into effect, as you cannot cast two skills at the same time.

Now, for Potions.

Instead of using itemskill, we will use itemheal:
,{ itemheal 100,0; },{},{}
The green is the HP, the blue is the SP. To add that random heal amount effect, just pick a set amount, let's say 120, then pick 1 or 2 numbers, up to you. Then, add the rand() command, like this:
,{ itemheal rand(120,9,49),0; },{},{}
Explanation: This item will heal about 49~120 hp and 0 SP. To heal SP you change the 0 to a number. Like this:
,{ itemheal rand(120,9,49),50; },{},{}
It will now heal 50 SP.
Now, for skilleffect and sc_start.

Okay, let's see. Here's a example of an item casting a skill and simulating a skill.
,{ itemskill 34,10; skilleffect 29,0; sc_start 12,140000,5; },{},{}
skilleffect will display on your client a skill visual effect. The pattern is:

skilleffect <skill ID>,<number>;

;skill ID
:Self-explanatory.
;number
:Have you seen those skills that shows up numbers upon casting? Such as heal? Well, putting a number there will display it. But only works on skills with numbers floating.

sc_start has the following pattern:

sc_start <status id>,<duration>,<val1>[,<unit id>];

;status id
:Refer to const.txt in your db folder for all effects. Open it with a text editor then search by either clicking edit, then find, or press and hold the ctrl key, and while still holding it press the f key, then release, and search for "SC_ALL -1". Everything below this is an effect. The effects stop at "e_gasp 0" which are emoticons.
;duration
:Is the amount time in milliseconds (1000 msec = 1 sec) that the status will be active.
;val1
:Typically it's the level of the skill, associated with this status.
;unit id
:Allows to start the status on an other unit, than the attached player. For players this is account id. This parameter is optional, and can be omitted.

Now, for the item I said, it will show you the visual effect of Blessing and cast on you a lvl 5 Agi-Up! skill for 140 seconds.

For more item scripts see script_commands.txt in your doc folder, as well as item_bonus.txt in your doc folder.

==Weapon Sprite Solution (Renewal Clients <= 2012-04-10a & Main Clients <= 2012-07-10a)==
For these clients, Weapons are limited to use a range of Item IDs hardcoded in the clientn for each type.
For e.g.

1265,Bloody_Roar,Bloody Roar,4,,10,1000,120,,1,0,4096,7,2,34,4,75,1,16,{ bonus bIgnoreDefRace,RC_DemiHuman; bonus bFlee,-160; bonus bFlee2,-160; bonus bNoRegen,1; bonus bNoRegen,2; },{},{}
1266,Test,Test,4,4000,2000,10,165,,1,0,4096,7,2,34,3,33,1,16,{}

// 1-Handed Axes
1301,Axe,Axe,4,500,,800,38,,1,3,8803555,7,2,2,1,3,1,6,{}

Here the item 1266 is a custom katar and it does show up as a katar (if you have the proper sprite files ofcourse). but if i use some id like say 22000, client wont display it. So what is the range of item ids you can use? Look below:

* One handed Swords = 1100-1149, 13400-13499
* Two handed Swords = 1150-1199, 21000-21999

* Knives, Daggers etc = 1200-1249, 13000-13099
* Katars = 1250-1299 ; Has 35 free IDs

* One handed Axes = 1300-1349; Has 43 free IDs
* Two handed Axes = 1350-1399; Has 32 free IDs

* One handed Spears = 1400-1449; Has 34 free IDs
* Two Handed Spears = 1450-1471, 1474-1499

* Maces = 1500-1549, 16000-16999
* Books = 1550-1599 ; Has only 2 IDs.
* Knuckles = 1800-1899 ; Has 95 free IDs

* One Handed Staves/Rods = 1600-1699; Has 79 free IDs
* Two Handed Staves/Rods = 1472,1473,2000-2099

* Bows = 1700-1749, 18100-18499
* Guitars = 1900-1949 ; Has 32 free IDs
* Whips = 1950-1999 ; Has 130 free IDs

* Handguns = 13100-13149
* Other guns = 13150-13199

* Ninja weapons = 13300-13399

The number of unused Item IDs left known for a range has also been mentioned above. Best practice to follow check in your range in official db before adding custom weapon.

==Weapon Sprite Solution (For New Clients) ==
For new clients the view id system is also applicable to client. To add a custom weapon you need to first edit a file
called weapontable.lub in your data folder
data/luafiles514/lua files/datainfo/weapontable.lub

I will be adding Oriental_Sword which will be a 1-Handed sword. Open weapontable.lub.
First you will see a table called Weapon_IDs. Take note of the first 30 values in this table - these are the only available Weapon types in the client right now.

Anyways go to the last entry which should be for Wizardy Staff = 97. You can use a view id after that like shown below
WEAPONTYPE_Oriental_Sword = 98,

Come down and you see the next table called WeaponNameTable. Here is where you add your sprite name suffix. 
What do i mean by that? Its the last part in your weapon sprite & act file. Before it used to be _<Item ID>.
data/sprite/<job dependent folder>/<job dependent prefix>_<gender><weapon suffix>.spr

OK Back to topic. so I add my entry like shown below.
[Weapon_IDs.WEAPONTYPE_Oriental_Sword] = "_Oriental"

Lastly come down further in weapontable.lub and you see the last table called Expansion_Weapon_IDs. 
Remember the 30 types i told you to take note of ? here we assign one of those to our custom (like a mapping or connection). 
Since mine is a 1-Handed Sword I specify it like below.
[Weapon_IDs.WEAPONTYPE_Oriental_Sword] = Weapon_IDs.WPCLASS_WEAPONTYPE_SWORD

Now for the most important part. For our client to actually pick up all these details we need to provide the view id which we used in Weapon_IDs table as the ClassNum value in ItemInfo.lua. Check the [[Custom_Items#System.2FItemInfo.lub|ItemInfo.lub format]] shown above for details.

With this your weapon sprite will become visible while attacking.
[[Category:Database]]
[[Category:Data]]
[[Category:Customization]]

Custom Items

2016-05-05T20:37:46Z

Asheraf: update item db structure

=Structure=
First, let's take a look at the item_db.conf in the db folder, and its structure:
item_db: (
{
// =================== Mandatory fields ===============================
Id: ID (int)
AegisName: "Aegis_Name" (string, optional if Inherit: true)
Name: "Item Name" (string, optional if Inherit: true)
// =================== Optional fields ================================
Type: Item Type (int, defaults to 3 = etc item)
Buy: Buy Price (int, defaults to Sell * 2)
Sell: Sell Price (int, defaults to Buy / 2)
Weight: Item Weight (int, defaults to 0)
Atk: Attack (int, defaults to 0)
Matk: Magical Attack (int, defaults to 0, ignored in pre-re)
Def: Defense (int, defaults to 0)
Range: Attack Range (int, defaults to 0)
Slots: Slots (int, defaults to 0)
Job: { (defaults to all job)
All: true/false (boolean, defaults to false)
Novice: true/false (boolean, defaults to false)
Swordsman: true/false (boolean, defaults to false)
Magician: true/false (boolean, defaults to false)
Archer: true/false (boolean, defaults to false)
Acolyte: true/false (boolean, defaults to false)
Merchant: true/false (boolean, defaults to false)
Thief: true/false (boolean, defaults to false)
Knight: true/false (boolean, defaults to false)
Priest: true/false (boolean, defaults to false)
Wizard: true/false (boolean, defaults to false)
Blacksmith: true/false (boolean, defaults to false)
Hunter: true/false (boolean, defaults to false)
Assassin: true/false (boolean, defaults to false)
Crusader: true/false (boolean, defaults to false)
Monk: true/false (boolean, defaults to false)
Sage: true/false (boolean, defaults to false)
Rogue: true/false (boolean, defaults to false)
Alchemist: true/false (boolean, defaults to false)
Bard: true/false (boolean, defaults to false)
Taekwon: true/false (boolean, defaults to false)
Star_Gladiator: true/false (boolean, defaults to false)
Soul_Linker: true/false (boolean, defaults to false)
Gunslinger: true/false (boolean, defaults to false)
Ninja: true/false (boolean, defaults to false)
Gangsi: true/false (boolean, defaults to false)
Death_Knight: true/false (boolean, defaults to false)
Dark_Collector: true/false (boolean, defaults to false)
Kagerou: true/false (boolean, defaults to false)
Rebellion: true/false (boolean, defaults to false)
}
Job: Job mask (int, defaults to all jobs = 0xFFFFFFFF)
Upper: Upper mask (int, defaults to any = 0x3f)
Gender: Gender (int, defaults to both = 2)
Loc: Equip location (int, required value for equipment)
WeaponLv: Weapon Level (int, defaults to 0)
EquipLv: Equip required level (int, defaults to 0)
EquipLv: [min, max] (alternative syntax with min / max level)
Refine: Refineable (boolean, defaults to true)
View: View ID (int, defaults to 0)
BindOnEquip: true/false (boolean, defaults to false)
ForceSerial: true/false (boolean, defaults to false)
BuyingStore: true/false (boolean, defaults to false)
Delay: Delay to use item (int, defaults to 0)
KeepAfterUse: true/false (boolean, defaults to false)
Trade: { (defaults to no restrictions)
override: GroupID (int, defaults to 100)
nodrop: true/false (boolean, defaults to false)
notrade: true/false (boolean, defaults to false)
nostorage: true/false (boolean, defaults to false)
nocart: true/false (boolean, defaults to false)
noselltonpc: true/false (boolean, defaults to false)
nomail: true/false (boolean, defaults to false)
noauction: true/false (boolean, defaults to false)
nogstorage: true/false (boolean, defaults to false)
partneroverride: true/false (boolean, defaults to false)
}
Nouse: { (defaults to no restrictions)
override: GroupID (int, defaults to 100)
sitting: true/false (boolean, defaults to false)
}
Stack: [amount, type] (int, defaults to 0)
Sprite: SpriteID (int, defaults to 0)
Script: <"
Script
(it can be multi-line)
">
OnEquipScript: <" OnEquip Script (can also be multi-line) ">
OnUnequipScript: <" OnUnequip Script (can also be multi-line) ">
// =================== Optional fields (item_db2 only) ================
Inherit: true/false (boolean, if true, inherit the values
that weren't specified, from item_db.conf,
else override it and use default values)
},
...
)

* '''ID''': ID of the item.
* '''AegisName''': Server name to reference the item in scripts and lookups, should use no spaces.
* '''Name''': Name in English for displaying as output for @ and script commands.
* '''Type''': Purpose of the item.
0 = Usable : healing
2 = Usable : other
3 = Misc
4 = Weapon
5 = Armor
6 = Card
7 = Pet Egg
8 = Pet Equipment
10 = Arrow/Ammunition
11 = Usable : delayed consumption (items with script "pet" or "itemskill")
18 = Another delayed consume that requires user confirmation before using item.
* '''Buy''': Default [[NPC]] buying price in Zeny. When not specified, becomes double the sell price.
* '''Sell''': Default [[NPC]] selling price in Zeny. When not specified, becomes half the buy price.
* '''Weight''': Item's weight. Each 10 is 1 weight. When not specified, becomes 0.
* '''ATK''': Base weapon attack, in case of a weapon. When not specified, becomes 0.
** In '''RE''' enabled servers this field have a optional delimiter ''':''' to define this item's weaponMATK bonus, for example, '''30:50''' would mean the item gives 30 atk and 50 weaponMATK
* '''Matk''': Weapon's magical attack (only used in renewal mode, ignored in pre-renewal). When not specified, becomes 0.
* '''DEF''': Base defense for armor-type items. When not specified, becomes 0.
* '''Range''': Maximum range in map cells a weapon allows to be the player apart from it's target. When not specified, becomes 0.
* '''Slots''': Amount of card slots in weapon/armor-type items. When not specified, becomes 0.
* '''Job''': Which jobs this item is available for. Values below can be combined to achieve availability for multiple job classes, i. e. <code>0x2|0x4 -> 0x6</code> (Swordman+Mage)
(S.) Novice (2^00): 0x00000001
Swordman (2^01): 0x00000002
Mage (2^02): 0x00000004
Archer (2^03): 0x00000008
Acolyte (2^04): 0x00000010
Merchant (2^05): 0x00000020
Thief (2^06): 0x00000040
Knight (2^07): 0x00000080
Priest (2^08): 0x00000100
Wizard (2^09): 0x00000200
Blacksmith (2^10): 0x00000400
Hunter (2^11): 0x00000800
Assassin (2^12): 0x00001000
''Unused'' (2^13): 0x00002000
Crusader (2^14): 0x00004000
Monk (2^15): 0x00008000
Sage (2^16): 0x00010000
Rogue (2^17): 0x00020000
Alchemist (2^18): 0x00040000
Bard/Dancer (2^19): 0x00080000
''Unused'' (2^20): 0x00100000
Taekwon (2^21): 0x00200000
StarGladiator (2^22): 0x00400000
Soul Linker (2^23): 0x00800000
Gunslinger (2^24): 0x01000000
Ninja (2^25): 0x02000000
Gangsi (2^26): 0x04000000
Death Knight (2^27): 0x08000000
Dark Collector (2^28): 0x10000000
Kagerou/Oboro (2^29): 0x20000000
Rebellion (2^30): 0x40000000
'''Some other commonly used values:'''
All Classes : 0xFFFFFFFF
Every Job Except Novice : 0xFFFFFFFE
* '''Upper''': Specifies whether the item can be used by normal, baby or reborn classes. Values below can be combined, i. e. <code>1|4 -> 5</code> (Normal+Baby Classes)
** Note: Setting <code>2</code> enables the item for Transcendant and 3rd classes. Use <code>8</code> to enable the item for 3rd classes only.
Normal jobs: 0x01 (1)
Upper jobs: 0x02 (2)
Baby jobs: 0x04 (4)
Third jobs: 0x08 (8)
Upper Third jobs: 0x10 (16)
Baby Third jobs: 0x20 (32)

Under pre-re mode third classes are considered upper, making use of
the 8 and above masks is therefore not necessary unless in renewal
mode. When no value is specified, all classes (mask 0x3f) are able to
equip the item.
* '''Gender''': Gender restriction for the item.
0 = Female
1 = Male
2 = No restriction (both)
* '''Loc''': Equipment location of armor and arrow-type items. Values below can be combined, i. e. 136 would indicate both accessory slots (typical value for accessories).
(2^0) 1 = Lower headgear
(2^1) 2 = Right hand
(2^2) 4 = Mantle
(2^3) 8 = Accessory 1
(2^4) 16 = Armor
(2^5) 32 = Left hand
(2^6) 64 = Shoes
(2^7) 128 = Accessory 2
(2^8) 256 = Upper headgear
(2^9) 512 = Middle headgear
(2^10) 1024 = Costume Top Headgear
(2^11) 2048 = Costume Mid Headgear
(2^12) 4096 = Costume Low Headgear
(2^13) 8192 = Costume Garment/Robe
(2^15) 32768 = Arrow (arrow-type items only)
(2^16) 65536 = Shadow Armor
(2^17) 131072 = Shadow Weapon
(2^18) 262144 = Shadow Shield
(2^19) 524288 = Shadow Shoes
(2^20) 1048576 = Shadow Accessory 2
(2^21) 2097152 = Shadow Accessory 1
* '''WeaponLv''': Weapon level of an item (1-4), Becomes 0 when not specified.
* '''EquipLv''': Base level required to be able to equip. It is possible to specify two values, if an item has a maximum level, by using the following syntax:
EquipLv: [minLv, maxLv]

If only one value is specified, maxLv becomes the current server's
MAX_LEVEL. If no values are specified, minLv becomes 0.
* '''Refineable''': Whether the item is available for refining (1) or not (0). If no value is specified, it defaults to true.
* '''View''': For normal items, defines a replacement view-sprite for the item
:(eg: Making apples look like apple juice). The special case are weapons and ammo where this value indicates the weapon-class of the item.
** Weapon-type items:
**# Daggers
**# One-Handed Swords
**# Two-Handed Swords
**# One-Handed Spears
**# Two-Handed Spears
**# One-Handed Axes
**# Two-Handed Axes
**# Maces
**# ''(not used)''
**# Wand/Staff
**# Bows/Crossbows
**# Knuckle Weapons
**# Musical Instruments
**# Whips
**# Books
**# Katars
**# Revolvers
**# Rifles
**# Shotguns
**# Gatling guns
**# Grenade launchers
**# Fuuma shuriken
** Shield-type items:
**# Guard, Novice Guard
**# Buckler
**# Shield, Holy Guard, Evangelist
**# Mirror Shield
** Ammunition-type items:
**# Arrows
**# Throw-able daggers
**# Bullets
**# Shells
**# Grenades
**# Shuriken
**# Kunai
**# Cannonballs
**# Throwable Items (Sling Item)
** Headgear-type items: Please see the View IDs section of this guide.
* '''BindOnEquip''': Whether the item will automatically bind to the character when it is equipped for the first time.
:An item that has this field set, will display a confirmation dialog the first time it is equipped, and, if accepted, the item will become character-bound.
* '''Script''': This is where you put your item bonus. Whether it's an usable item or an equip item, it will take effect according to the item type.
* '''OnEquip_Script''': Script to execute when the item is equipped. Warning, not all item bonuses will work here as expected.
* '''OnUnequip_Script''': Script to execute when the item is unequipped. Warning, not all item bonuses will work here as expected.
* '''Inherit''': This can be used only in item_db2.conf, and if set to true, and the item already exists in item_db.conf,
:all the missing fields will be inherited from there rather than using their default values.
 
In the doc folder look for a text file called "item_bonus", it shows all the scripts items can have and how they work.
 
For more information about this structure read [http://herc.ws/board/topic/2954-item-db-file-structure-overhaul/ Item DB file structure overhaul]

=Defining Item clientside (Renewal Clients <= 2012-04-10a & Main Clients <= 2012-07-10a) =
After you make your item, put it in your item_db2.txt, so that you will not run into conflicts when updating your repository later. Then go to your data folder and modify the following files, one after another.

==idnum2itemdisplaynametable.txt==
This file holds the item names, as displayed inside the client. Each item added as:
ItemID#ItemName#
ItemID is the number from your ID column inside the item db. If your item name contains spaces, replace those with _ (underscore).

==idnum2itemdesctable.txt==
This file contains the description of your item, when it is right-clicked. The syntax for an item is:
ItemID#
Item Description Line 1
Item Description Line 2
#
You can use any amount of lines for the description. If your description contains a #, make sure it is followed by a space character.
==idnum2itemresnametable.txt==
This file sets the inventory and drop-sprite for an the item. Item is defined as follows:
ItemID#SpriteName#
The SpriteName is the name of the files in collection and item folders inside texture and the ones inside sprite folder. If you want to use the look of an another item, search for it's id and copy the sprite name from there.
==itemslotcounttable.txt==
In this file you set the amount of visible slots for the item. You do not need to add 0 slot items or items, which do not have slots at all (i. e. usable items). Syntax:
ItemID#NumberOfSlots#
NumberOfSlots should be a number from 1-4, larger values might have undesired effects.
==Files for non-identified items==
The following files specify the name, description and look for items, which have not yet been identified. Their syntax follows the same rules as for the files with ''idnum'' prefix. Normally the same text is entered for non-equipment and generic description (which can be copied from official items) is used for equipment of all sorts (weapons, armor, headgears).
* num2itemdesctable.txt
* num2itemdisplaynametable.txt
* num2itemresnametable.txt

=Defining Items clientside (For New Clients)=
If your client date is newer than specified above then you need to specify all the above item information in 1 file

==System/ItemInfo.lub==
Since ItemInfo.lub is compiled, you need to decompile it to lua , add your customs and recompile back to lub file (Some have said that renaming a decompiled file to lub also works)
Syntax:
[<item id>] = {
unidentifiedDisplayName = <item name to show when not magnified>,
unidentifiedResourceName = <file name prefix used for all the images and drop sprite when not magnified>,
unidentifiedDescriptionName = { <comma separated list of strings>,<to get multiple lines>,<in item description> },
identifiedDisplayName = <item name to show when magnified>,
identifiedResourceName = <file name prefix used for all the images and drop sprite when magnified>,
identifiedDescriptionName = { <same format as unidentifiedDescriptionName but for magnified items> },
slotCount = <number of slots>,
ClassNum = <View ID - yes the same one that was there item_db>
},
For Weapons, ClassNum = View ID specified in Weapon_IDs table (inside weapontable.lub file). Look [[Custom_Items#Weapon_Sprite_Solution_.28For_New_Clients.29|below]] for details.

You can also put the different values in DescriptionName in separate lines.

Example: Lets say i want to add a weapon to item id 25000 - a One handed sword named Devastator with 3 slots & the image files & drop sprite files are all named Black_Sword.* . Also i want to display a Sword when not magnified.

[25000] = {
unidentifiedDisplayName = "Sword",
unidentifiedResourceName = "¼Òµå",
unidentifiedDescriptionName = { "Unidentified item, can be identified with [Magnifier]." },
identifiedDisplayName = "Devastator",
identifiedResourceName = "Black_Sword",
identifiedDescriptionName = {
"An Unholy Sword that was created with the sole purpose of destruction",
"Class :^777777 Sword^000000",
"Attack :^777777 325^000000",
"Weight :^777777 80^000000",
"Weapon Level :^777777 4^000000",
"Required Level :^777777 100^000000",
"Applicable Job :^777777 Novice, Swordsman Class, Merchant Class, Thief Class^000000"
},
slotCount = 3,
ClassNum = 2
},

= Allocating Items on Client Side =
Your custom item will have 4 (6 in case its a headgear or garment) files:
1) Drop sprite -> Helmet_drop.spr
2) Drop act file -> Helmet_drop.act
3) Item Inventory image -> Helmet_item.bmp
4) Item Collection image -> Helmet_collection.bmp (the one you see on its description window)
5) Headgear View sprite -> Helmet.spr
6) Headgear View act file -> Helmet.act

Lets say i downloaded a custom item called Helmet which serves as a headgear and the above six files were in them.

==Step 1:==
We place the first four files based on what we specified in id2numresnametable.txt (IdentifiedResourceName in Iteminfo.lub).
For our example lets say i used "Helmet" as the resource name :
i) Copy Helmet_drop.spr to [RO Folder]\data\sprite\¾ÆÀÌÅÛ\Helmet.spr
ii) Copy Helmet_drop.act to [RO Folder]\data\sprite\¾ÆÀÌÅÛ\Helmet.act
iii) Copy Helmet_item.bmp to [RO Folder]\data\texture\À¯ÀúÀÎÅÍÆäÀÌ½º\item\Helmet.bmp
iv) Copy Helmet_collection.bmp to [RO Folder]\data\texture\À¯ÀúÀÎÅÍÆäÀÌ½º\collection\Helmet.bmp
==Step 2 (only for Headgears):==
For displaying headgear on the character there will be two additional files (sprite & act) or 4 if the sprite author intended for a separate set of files for male & female. In my example i have considered the first scenario.

The filename for headgear sprite are now specified in accname.lua file (details of which is available in the [[Custom_Items#View_IDs.2C_Having_A_Custom_Headgear_Without_Xray|View IDs Section]])

lets say i used
[ACCESSORY_IDs.HELMET] = "_Helmet",
then we need to:
i) Copy Helmet.spr to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\¿©\¿©_Helmet.spr (Female)
ii) Copy Helmet.act to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\¿©\¿©_Helmet.act
iii) Copy Helmet.spr to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\³²\³²_Helmet.spr (Male)
iv) Copy Helmet.act to [RO Folder]\data\sprite\¾Ç¼¼»ç¸®\³²\³²_Helmet.act

Now it is ready to be used provided you have added entries properly to the lua files.

==Specifications of the files==
1) Drop sprites - ideally have 1 frame & its act file will be just an empty act (only header will be there inside)

2) Equip sprites - typically have 3+ frames to show images for various orientations & its act file will have the info on where to place each frame.

3) Item bmp - 24x24 size 256 bit bmp file.

4) Collection bmp - 75x100 size bmp file (usually 256 bit but there is no restriction)

How to differentiate between sprite files?

Open both sprite files in [http://ratemyserver.net/download_agent.php?type=1&file_num=10 Spr Conview]. The number of frames in the files can be seen at bottom (Sprite: <currentframe>/<total>). If it says Sprite: 1/1 then its a drop sprite and the other is equip sprite.

Sometimes what sprite authors do is they simply copy the original sprite itself to make a drop sprite. In this case you will see both of them as identical when opened in Spr Conview & we don't need to worry about which one is which (since they are the same).

If the process confused you, [http://www.mediafire.com/?8lzt4cbot100w44 here is an example folder], the sprite is done by drkangel. The folder is virus free.

= View IDs, Having A Custom Headgear Without Xray =
Look in your data folder and make sure there is a folder named "lua files", if there is not make it.[http://svn6.assembla.com/svn/ClientSide/Lua_Project/lubs/ Download the most recent lub package] and extract it to your lua files folder in your data folder. [http://svn6.assembla.com/svn/ClientSide/Lua_Project/lua%20files/datainfo/ Download the most recent accname.lua and accessoryid.lua], put it in your datainfo folder that is inside the lua files folder. Now download [http://svn6.assembla.com/svn/ClientSide/Lua_Project/tool/luac5.0.2.exe this lub compiling tool], and put it in the datainfo folder.
Now, Open accessoryid.lua in the datainfo folder with notepad or a text editor of your choice, go all the way down until the names stop. Add your custom gears before the } symbol. You should use a high number just like with your custom item's database ID, or use unused IDs to be sure you won't have to redo them all in the future, or at least for a while. Example:
ACCESSORY_PINKBUNNY_HAIRBAND = 663,
ACCESSORY_GREENBUNNY_HAIRBAND = 664,
ACCESSORY_OLD_ELFEAR = 665,
ACCESSORY_THA_MAERO_MASK = 666,
ACCESSORY_THANATOS_MAI_MASK = 667,
--668 free
ACCESSORY_FISHPIN = 669,
ACCESSORY_CUSTOM_HAT = 900,
}

''You must compile to lub if you leave space between IDs, if you don't plan on compiling to lub, make sure you do not skip any numbers.''

Now open accname.lua, do basically the same thing but just in a different way, and for the sprite. Add your item to the bottom, have it look like the ones above it, except have your items name and the item's sprite name.
[ACCESSORY_IDs.ACCESSORY_PINKBUNNY_HAIRBAND] = "_ÇÎÅ©Åä³¢¸Ó¸®¶ì",
[ACCESSORY_IDs.ACCESSORY_GREENBUNNY_HAIRBAND] = "_±×¸°Åä³¢¸Ó¸®¶ì",
[ACCESSORY_IDs.ACCESSORY_OLD_ELFEAR] = "_°í´ë¿äÁ¤ÀÇ±Í",
[ACCESSORY_IDs.ACCESSORY_THA_MAERO_MASK] = "_Å¸³ªÅä½ºÀÇ½½ÇÄ°¡¸é",
[ACCESSORY_IDs.ACCESSORY_THANATOS_MAI_MASK] = "_Å¸³ªÅä½ºÀÇÁõ¿À°¡¸é",
[ACCESSORY_IDs.ACCESSORY_FISHPIN] = "_¹°°í±âÇÉ",
[ACCESSORY_IDs.ACCESSORY_CUSTOM_HAT] = "_Sprite_Name_Here",
}
Delete the accname.lub and accessoryid.lub. Now that you are done, make sure luac.exe is in your datainfo folder, right click the luac.exe, create a shortcut, right click the shortcut, and click properties, in the target area, add right after the quotes, with the quotes:
-o "accessoryid.lub" "accessoryid.lua"
So that it looks something like this:
"C:\Program Files (x86)\Gravity\RO\data\lua files\datainfo\luac5.0.2.exe" -o "accessoryid.lub" "accessoryid.lua"
Do this also to "accname.lub" except instead of accessoryid in the quotes, do accname. If there is any lua file leftover, you may want to move it somewhere else just for future changes, like My Documents. For future reference, this is also how you turn the other lub files to lua files.

=Modifications=
==Sprite Replacement==
To replace a headgear with your customized headgear, just delete one of the items you want, and replace your customised item ID with that id.

Lets say you have something like this:
15000,Angel_Wing,Angel Wing,4,,10,10,0,,1,0,0,3,0,0,0,0,0,{},{},{}
And there's an item you wont need, such as:
2220,Hat,Hat,5,1000,,200,,2,,0,10477567,2,256,,0,1,16,{},{},{}
Well, to replace it, just delete everything in the hat line but its ID, and paste there your custom item, all the line but the ID. Should be like this:
'''2220''',Hat,Hat,5,1000,,200,,2,,0,10477567,2,256,,0,1,16,{},{},{}
15000,'''Angel_Wing,Angel Wing,4,,10,10,0,,1,0,0,3,0,0,0,0,0,{},{},{}'''
'''2220,Angel_Wing,Angel Wing,4,,10,10,0,,1,0,0,3,0,0,0,0,0,{},{},{}'''
All you need to do now is changing the View ID to the Hat, and change your file names to its name. You can find them on the idnum2resnametable.txt Search for 2220 and the gibberish besides it, w/o the # # is the file name, then rename it to your custom item name.

Remember to add the files to data\sprite\¾ÆÀÌÅÛ (Icon sprite) and both data\sprite\¾Ç¼¼»ç¸®\³² (Male Item Sprite) and data\sprite\¾Ç¼¼»ç¸®\¿© (Female Item Sprite). Remember, these 2 last item names, must have either a ³²_ for male or ¿©_ for female, at the beginning of the name, both .spr and .act. Also, don't forget to change the other files:

idnum2itemdisplaynametable.txt , idnum2itemdesctable.txt , idnum2itemdesctable.txt , num2itemdesctable.txt , num2itemdisplaynametable.txt , num2itemresnametable.txt and itemslotcounttable.txt

Use these files if you want to replace sprites, they will be useful.
* '''actOR:''' with the actor you modify the act file, which is the one who tells the client where does the weapon go and what does it have to do and at a certain moment.
* '''SPR Conview:''' you can use these to view which sprite is which, and also see sequence per sequence.

==Item Restrictions==
Look on your db folder for a file called item_trade.txt and open it

Now, the pattern for a flag is:

Item ID, TradeMask, GM-Level Override

* '''Item ID''': the ID of your item.
* '''TradeMask''': Testrictions the item will have, such as being dropped, stored or traded. These values can be combined to achieve multiple effects.
1:Item can't be dropped
2:Item can't be traded (nor vended)
4:Item can only be traded with wedded partner
8:Item can't be sold to NPCs
16:Item can't be placed in the cart
32:Item can't be placed in the storage
64:Item can't be placed in the guild storage
* '''GM-Level Override''': This is the minimum GM level a player must have to avoid these restrictions.

==Item Script==
{{duplication
|type=section
|what=[[itemskill]], [[sc_start]] and [[skilleffect]]}}
{{disputed
|type=section
|date=September 2010}}
Okay, I'll update this as I go; otherwise, I wont have anything new to show. First with usable items.

Well, there are 3 types of usables:

1.- Healing items, they have in the type field a 0.

2.- Other uses items, such as fly wings and so, which doesn't heal, but does have an instant effect, they have in the type field a 2.

3.- Usable items, which are skills that requires a target selection, therefore they have a delayed use, and in newer versions the item wont be gone until the target is chosen and the cast has finished. Means, you wont lose the item if the skill hasn't been done. They have in the type field an 11.

Now, for an item skill, the pattern for a skill is:
itemskill <skill id>,<skill level>;
Without <> of course.

Now, we go to our db\skill_db.txt and search for the blessing ID, searching for AL_ or blessing, but first, the structure of a skill:
id,range,hit,inf,element,nk,splash,max,list_num,castcancel,cast_defence_rate,inf2,maxcount,skill_type,blow_count,name,description
Now, the AL_BLESSING or Blessing Skill:
34,9,6,16,0,0x1,0,10,1,yes,0,0,0,magic,0, AL_BLESSING,Blessing
We grab the ID and put it on our code:
itemskill 34,<skill lvl>;
Don't mind the actual level of the skill_db.txt for the skill level part. You can actually put the level you want here below 99, so lets pick 4:
itemskill 34,4;
And finally, insert it on the code.
<pre>,{ itemskill 34,4; },{},{}</pre>

There, we have a Lvl 4 Blessing item skill.

Remember, one space before and one after the script, NOT TAB!

And so on with other skills. Just remember these steps and they should be fine. And remember, itemskill is NOT the same as skill. itemskill will make you CAST that skill, while skill will GIVE you the skill. If you give an item, whether delayed use or normal usable two itemskill commands, only the latter will come into effect, as you cannot cast two skills at the same time.

Now, for Potions.

Instead of using itemskill, we will use itemheal:
,{ itemheal 100,0; },{},{}
The green is the HP, the blue is the SP. To add that random heal amount effect, just pick a set amount, let's say 120, then pick 1 or 2 numbers, up to you. Then, add the rand() command, like this:
,{ itemheal rand(120,9,49),0; },{},{}
Explanation: This item will heal about 49~120 hp and 0 SP. To heal SP you change the 0 to a number. Like this:
,{ itemheal rand(120,9,49),50; },{},{}
It will now heal 50 SP.
Now, for skilleffect and sc_start.

Okay, let's see. Here's a example of an item casting a skill and simulating a skill.
,{ itemskill 34,10; skilleffect 29,0; sc_start 12,140000,5; },{},{}
skilleffect will display on your client a skill visual effect. The pattern is:

skilleffect <skill ID>,<number>;

;skill ID
:Self-explanatory.
;number
:Have you seen those skills that shows up numbers upon casting? Such as heal? Well, putting a number there will display it. But only works on skills with numbers floating.

sc_start has the following pattern:

sc_start <status id>,<duration>,<val1>[,<unit id>];

;status id
:Refer to const.txt in your db folder for all effects. Open it with a text editor then search by either clicking edit, then find, or press and hold the ctrl key, and while still holding it press the f key, then release, and search for "SC_ALL -1". Everything below this is an effect. The effects stop at "e_gasp 0" which are emoticons.
;duration
:Is the amount time in milliseconds (1000 msec = 1 sec) that the status will be active.
;val1
:Typically it's the level of the skill, associated with this status.
;unit id
:Allows to start the status on an other unit, than the attached player. For players this is account id. This parameter is optional, and can be omitted.

Now, for the item I said, it will show you the visual effect of Blessing and cast on you a lvl 5 Agi-Up! skill for 140 seconds.

For more item scripts see script_commands.txt in your doc folder, as well as item_bonus.txt in your doc folder.

==Weapon Sprite Solution (Renewal Clients <= 2012-04-10a & Main Clients <= 2012-07-10a)==
For these clients, Weapons are limited to use a range of Item IDs hardcoded in the clientn for each type.
For e.g.

1265,Bloody_Roar,Bloody Roar,4,,10,1000,120,,1,0,4096,7,2,34,4,75,1,16,{ bonus bIgnoreDefRace,RC_DemiHuman; bonus bFlee,-160; bonus bFlee2,-160; bonus bNoRegen,1; bonus bNoRegen,2; },{},{}
1266,Test,Test,4,4000,2000,10,165,,1,0,4096,7,2,34,3,33,1,16,{}

// 1-Handed Axes
1301,Axe,Axe,4,500,,800,38,,1,3,8803555,7,2,2,1,3,1,6,{}

Here the item 1266 is a custom katar and it does show up as a katar (if you have the proper sprite files ofcourse). but if i use some id like say 22000, client wont display it. So what is the range of item ids you can use? Look below:

* One handed Swords = 1100-1149, 13400-13499
* Two handed Swords = 1150-1199, 21000-21999

* Knives, Daggers etc = 1200-1249, 13000-13099
* Katars = 1250-1299 ; Has 35 free IDs

* One handed Axes = 1300-1349; Has 43 free IDs
* Two handed Axes = 1350-1399; Has 32 free IDs

* One handed Spears = 1400-1449; Has 34 free IDs
* Two Handed Spears = 1450-1471, 1474-1499

* Maces = 1500-1549, 16000-16999
* Books = 1550-1599 ; Has only 2 IDs.
* Knuckles = 1800-1899 ; Has 95 free IDs

* One Handed Staves/Rods = 1600-1699; Has 79 free IDs
* Two Handed Staves/Rods = 1472,1473,2000-2099

* Bows = 1700-1749, 18100-18499
* Guitars = 1900-1949 ; Has 32 free IDs
* Whips = 1950-1999 ; Has 130 free IDs

* Handguns = 13100-13149
* Other guns = 13150-13199

* Ninja weapons = 13300-13399

The number of unused Item IDs left known for a range has also been mentioned above. Best practice to follow check in your range in official db before adding custom weapon.

==Weapon Sprite Solution (For New Clients) ==
For new clients the view id system is also applicable to client. To add a custom weapon you need to first edit a file
called weapontable.lub in your data folder
data/luafiles514/lua files/datainfo/weapontable.lub

I will be adding Oriental_Sword which will be a 1-Handed sword. Open weapontable.lub.
First you will see a table called Weapon_IDs. Take note of the first 30 values in this table - these are the only available Weapon types in the client right now.

Anyways go to the last entry which should be for Wizardy Staff = 97. You can use a view id after that like shown below
WEAPONTYPE_Oriental_Sword = 98,

Come down and you see the next table called WeaponNameTable. Here is where you add your sprite name suffix. 
What do i mean by that? Its the last part in your weapon sprite & act file. Before it used to be _<Item ID>.
data/sprite/<job dependent folder>/<job dependent prefix>_<gender><weapon suffix>.spr

OK Back to topic. so I add my entry like shown below.
[Weapon_IDs.WEAPONTYPE_Oriental_Sword] = "_Oriental"

Lastly come down further in weapontable.lub and you see the last table called Expansion_Weapon_IDs. 
Remember the 30 types i told you to take note of ? here we assign one of those to our custom (like a mapping or connection). 
Since mine is a 1-Handed Sword I specify it like below.
[Weapon_IDs.WEAPONTYPE_Oriental_Sword] = Weapon_IDs.WPCLASS_WEAPONTYPE_SWORD

Now for the most important part. For our client to actually pick up all these details we need to provide the view id which we used in Weapon_IDs table as the ClassNum value in ItemInfo.lua. Check the [[Custom_Items#System.2FItemInfo.lub|ItemInfo.lub format]] shown above for details.

With this your weapon sprite will become visible while attacking.
[[Category:Database]]
[[Category:Data]]
[[Category:Customization]]

Sc start

2016-05-05T19:27:05Z

Asheraf: /* Description */

[[Category:Script_Command]]
==Syntax==
* [[sc_start]] <effect type>,<ticks>,<extra argument>{,<target ID number>};
* [[sc_start2]] <effect type>,<ticks>,<extra argument>,<percent chance>{,<target ID number>};
* [[sc_start4]] <effect type>,<ticks>,<value 1>,<value 2>,<value 3>,<value 4>{,<target ID number>};
* [[sc_end]] <effect type>{,<target ID number>};
==Description==
These command bestow a status effect on the invoking character. This command is
used a lot in the item scripts.

Effect type is a number of effect, {{git|db/constants.conf}} lists the common (mostly
negative) status effect types as constants, starting with 'SC_'. You can also
use this to give someone an effect of a player-cast spell.

Extra argument's meaning differs depending on the effect type, for most effects
caused by a player skill the extra argument means the level of the skill that
would have been used to create that effect, for others it might have no meaning
whatsoever. You can actually bless someone with a 0 bless spell level this way,
which is fun, but weird.

The target ID number, if given, will cause the status effect to appear on a
specified character, instead of the one attached to the running script. This has
not been properly tested.

'[[sc_start2]]' is perfectly equivalent, but unlike '[[sc_start]]', a status change
effect will only occur with a specified percentage chance. 10000 given as the
chance is equivalent to a 100% chance, 0 is a zero.

'[[sc_start4]]' is just like '[[sc_start]]', however it takes four parameters for the
status change instead of one. What these values are depends on the status
change in question. For example, elemental armor defense takes the following
four values:
- val1 is the first element, val2 is the resistance to the element val1.
- val3 is the second element, val4 is the resistance to said element.
eg: [[sc_start4]] SC_ARMOR_ELEMENT,60000,Ele_Fire,20,Ele_Water,-15;

'[[sc_end]]' will remove a specified status effect. If SC_All is used (-1), it will
do a complete removal of all statuses (although permanent ones will re-apply).

You can see the full list of status effects caused by skills in
{{git|src/map/status.h}} - they are currently not fully documented, but most of that
should be rather obvious.

==Examples==
<pre>
// This would poison them for 10 minutes
sc_start SC_POISON,600000,0;

// This will bless someone as if with Bless 10:
sc_start 10,240000,10;
</pre>