View source for Custom Weapons & Items

This article tells you how items in Overgrowth are built. Here the word "item" is being used as a technical term for an object that can be picked up by a character. The most common and most advanced use case for items in Overgrowth is to create weapons with them, so that's what this article focuses on. Whenever the words "weapon xml" is used, we're talking about an item xml file configured as a weapon.

== Overview ==
An item xml file is the file you load in the editor to spawn an item, such as a weapon. The item xml files that come with the game can be found in ../Overgrowth/Data/Items/.

== Weapon XML Details ==
So what does a weapon xml file look like? Here is the item xml file for the flint_knife weapon that comes with the game:
<pre>
<?xml version="1.0" ?>
<item>
    <type>weapon</type>
    <appearance obj_path = "Data/Objects/Weapons/flint_knife.xml"/>
    <grip ik_attach = "rightarm"
          anim = "Data/Animations/r_dogweapongrip.anm"
          hands = "1"/>
    <sheathe ik_attach = "hip"
          anim = "Data/Animations/r_dogweaponsheathed.anm"/>
    <physics mass = "0.4 kg"/>
    <points>
        <pommel x="0" y="-0.081" z="0"/>
        <guard x="0" y="0.10" z="0"/>
        <tip x="0" y="0.33" z="0"/>
    </points>
    <label>knife</label>
    <lines>
        <wood start="pommel" end="guard"/>
        <metal start="guard" end="tip"/>
    </lines>
    <anim_override idle = "Data/Animations/r_knifestancerear.xml"
                   movement = "Data/Animations/r_weaponmovestance.xml"/>
    <attack_override moving = "Data/Attacks/knifeslash.xml"
                     moving_close = "Data/Attacks/knifeslash.xml"
                     stationary = "Data/Attacks/knifeslash.xml"
                     stationary_close = "Data/Attacks/knifeslash.xml"/>
    <range multiply = "0.8"/>
</item>
</pre>

Let's go through what each tag in this file does:
{| class="wikitable"
|-
! Tag !! Example use !! Description
|-
! type
|
<pre><type>weapon</type></pre>
|| Defines what kind of item the object is. Can be ''weapon'', ''collectible'' or ''misc''. '''TODO''': What does each type do?
|-
! appearance 
|
<pre><appearance
    obj_path="Data/Objects/Weapons/MyWeapon.xml"/></pre>
|| Path to the object xml file to use as a visual representation of this item. To find out how to make one of these, read the [[3D_Objects]] article.
|-
! grip
|
<pre><grip
    ik_attach="rightarm"
    anim="Data/Animations/r_dogweapongrip.anm"/></pre>
|| ik_attach defines what bone the object is attached to when it's held. Anim is the place where the weapon will be held at. You create these in blender using one of the existing rigs that comes with the game (preferably the rabbit_rig). '''TODO:''' Check if "Anim is the place where the weapon will be held at" is correct
|-
! sheathe
|
<pre><sheathe
    ik_attach="hip"
    anim="Data/Animations/r_dogweaponsheathed.anm"/></pre>
|| ik_attach defines where to attach the object when sheathed. Anim is the place where the weapon will be sheathed at. You create these in Blender using one of the existing rigs that the game comes with (preferably the rabbit_rig). '''TODO:''' Check if "Anim is the place where the weapon will be sheathed at" is correct
|-
! physics
|
<pre><physics mass="1 kg"/></pre>
|| Changes the pitch of the sound made by the object hitting things. Also changes how overall heavy it is.
|-
! points
|
<pre><points>
    <pommel x="0" y="-0.081" z="0"/>
    <guard x="0" y="0.10" z="0"/>
    <tip x="0" y="0.33" z="0"/>
</points></pre>
|| Defines a number of points on the weapon that can be used with the ''lines'' element to define what material a part of the weapon has.
|-
! lines
|
<pre><lines>
    <wood start="pommel" end="guard"/>
    <metal start="guard" end="tip"/>
</lines></pre>
|| Defines what materials go between what points that are defined in the points tag.
|-
! anim_blend
|
<pre><anim_blend
    idle = "Data/Animations/r_bigdogsword.xml"/></pre>
|| Override the animation for part of a character holding the item. Animation keywords that can be overridden are idle and movement. This is used for for instance two handed weapons, spears and so on, where the default animations don't fit.
|-
! anim_override
|
<pre><anim_override
    idle="Data/Animations/r_weaponidlestance.xml"/></pre>
|| Overrides animations of a character holding the item. Animation keywords that can be overridden are idle, movement, medleftblock, medrightblock, blockflinch and more.
(See [[Custom_Characters#File_3|Custom Characters: File 3]] for the keywords.) This is used for for instance two handed weapons, spears and so on, where the default animations don't fit.
|-
! attack_override
|
<pre><attack_override
    moving="Data/Attacks/knifeslash.xml"
    moving_close="Data/Attacks/knifeslash.xml"
    stationary="Data/Attacks/knifeslash.xml"
    stationary_close="Data/Attacks/knifeslash.xml"/></pre>
|| What attacks should be used with this weapon in different contexts.
|-
! range
|
<pre><range multiply="0.8"/></pre>
|| Multiply multiplies the range with the specified value to make a weapon reach further or shorter.
|}

[[Category: Overgrowth]]
[[Category: Modding]]