Wolfire Games Wiki - User contributions [en]

Custom Animations

2024-10-24T21:45:01Z

Akazi: /* Event Keyframes */

==Overview==
Animations for rigged objects in Overgrowth are stored with one of the Phoenix Engine's custom [[Binary_File_Formats|binary file formats]], namely the [[Binary_File_Formats#PHXANM|PHXANM (Phoenix Animation) format]]. To export an animation to a PHXANM (File mask: .anm) file you need to use Wolfire's custom export addon for Blender.

A repackaged version of '''Blender 2.55''' for Windows with the export addon and with the UI set up for this task can be downloaded [https://cdn.wolfire.com/techsupport/Blender-Overgrowth-Win.zip here]. [https://youtu.be/CuFKEvTyYRw You can find a tutorial on how to animate in this version here.]

The scripts needed for using '''Blender 2.93''' and above are located at [https://github.com/WolfireGames/overgrowth/tree/main/Data/BlenderScript/2.93 Overgrowth's Github repository, here.] Download bone_io.zip and io_anm.rar and follow the Readme instructions. You can also check videos.rar for tutorial videos on how to install these scripts, if you need.
These same scripts can also be found in the Overgrowth Modding channel on the Wolfire Discord, under the pinned messages.

The best rig for making animations is rabbit_rig.blend -- This wiki page will assume you are using its default interface. '''TODO: How to switch to different species models?'''

'''NOTE: Blender 4.0+ is NOT compatible with the 2.93 scripts!''' You will get an error while exporting .anm files.

== Creating an animation ==

On the left hand side of your Blender character rig, you'll see a '''Dopesheet'''. If it's too small, you can drag it out and expand the border to see the full toolbar. This dopesheet contains a timeline of every keyframe defined for the animation.

In order to pose a character and make new keyframes, you must first select Pose Mode in the 3D Viewport's toolbar (located by default on its bottom). Then, you can select a bone and change it around. I recommend enabling Object Gizmos in the 3D Viewport's toolbar. Here's a quick reference for Blender 3.4's default interface controls:

# Left click to Select
# Right click to Manipulate
# Scroll wheel click to Orbit camera
# G to Translate selected (or rotate fixed bones)
# R to Rotate selected
# ESC to Cancel current change

Each keyframe contains data for a bone. Its position on the dopesheet dictates when the bone will conform to the pose. If you set the dopesheet's timeline over a keyframe, your changes to the bone will overwrite the current keyframe's data. You can change this behavior by checking the Record button's options on the timeline at the very bottom.

===Selecting different poses===
[[File:Dopesheet_pose_select.png|thumb|260px|right|The button found on the dopesheet toolbar for selecting different poses]]
Click the button pictured on the Dopesheet's toolbar to browse and select the poses included in the character rig. Any rig has a maximum pose limit, which when reached will start recycling old poses. '''Todo: How large is this limit?'''

You can make a new pose by clicking the New Action button next to the pose name. Make sure not to overwrite any useful poses you may have in the rig!

===Changing the start & end frames===
[[File:Rig_params.gif|thumb|239px|right|How to find the animation controls for exported frame data (Click to animate!)]]
[[File:Start_end_frames.png|thumb|340px|right|How to set the animation duration]]

How long your animation lasts depends on the values specified in Blender's Timeline window. In its top right, you can find the Start and End values.
While the Use Preview Range button is toggled, the From Timeline button in the rig parameters will affect your exported animation's frame data.

If your animation duration is too short or too long, your animation might last too long, or it might get cut off.

===Exporting an animation===

# Create your custom animation in Blender
# Set the metadata for your animation in the sidebar of the 3D Viewport, as pictured below
#* Click the '''From Timeline''' button to set the timeline's start & end frames as the start & end points of your animation; '''Note:''' Keyframes outside of this time frame won't be exported.
#* Set the '''Looping''' value to 0 if you don't want your animation to loop. Set it to 1 if you want it to loop. '''Todo: If the value is higher, will it do sth different, like play the animation n times?'''
# With the skeleton selected, press '''File > Export > Phoenix Animation (.anm)''' '''Note: Make sure not to have any IK bones selected while in Pose Mode, or else the script may crash!'''

=== Bone layers ===
[[File:Animation_rig_layers.png|thumb|439px|right|Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used for special keyframes.]]
Sets of bones within the animation rig are hidden underneath several different layers. Each layer contains different bones; By hiding and unhiding specific layers, you can fine tune your available bones as pictured right.

'''FK''' stands for '''Fixed Kinematics''', where each limb's position is manually set and is best used for dynamic animations with lots of movement (like attacks).

'''IK''' stands for '''Inverse Kinematics''', where paws are placed and limbs follow.

To switch between the two modes of animation, you must set the IK property keyframe to 0 (for FK) or 1 (for IK). You can only set this property keyframe on IK bones.

In order to add event keyframes, you must first select a DEF bone. In the animation rigs that are shipped with the game, these bones are hidden. In order to unhide them, you must first:
# Enter Pose Mode in the 3D Viewport
# Press A to select everything
# Press ALT + H to reveal everything, including the DEF bones

After revealing everything, you might find the rig is a bit cluttered with unnecessary bones, like ORG and MCH bones. These are only used for rigging, and not for animation. Select these and press H to hide them individually.

==Event Keyframes==
Event keyframes are used to tell the game at which moment of an animation an event is going to happen. This is used to trigger attack impacts and footstep sounds among other things.
An event is saved as a ''Custom Property'' of a bone in the Blender files shipped with the game. Access these custom properties by clicking on the '''Bone Properties''' tab within the Properties window.

All event keyframes work regardless of what value you assign to them (0.0, 1.0, inbetween); What matters is their placement.
Some other keyframes require a range from 0.0 to 1.0 to work properly. These are noted in this table when applicable.
{| class="wikitable"
|-
! Event Name !! Description
|-
|event_attackimpact || Triggers the actual impact while attacking a character. Works on any DEF bone
|-
|event_blockprepare || Specifies the latest time at which the attack is still blockable, which is also the latest time that it can be canceled as a “feint” by pressing right-click
|-
|event_attackblocked|| Dictates when an attack is blocked in a blocked attack
|-
|event_rightcrouchwalkstep||Triggers footstep sounds for sneaking, emits AI sound and creates particles while on terrain
|-
|event_rightrunstep||Triggers footstep sounds for running, emits AI sound and creates particles while on terrain
|-
|event_rightwalkstep||Triggers footstep sounds for walking, emits AI sound and creates particles while on terrain
|-
|event_rightwallstep||Triggers footstep sounds for wall running and emits AI sound
|-
|event_golimp||Causes the character to ragdoll into an active ragdoll state. Used in throw attacks
|-
|event_grabitem|| Grabs the nearest pickupable item within 90cm of the hand
|-
|event_heldweaponswap||Causes the character to switch the currently held item's handedness
|-
|event_rightweaponrelease||Causes the character to let go of the right hand's currently held item
|-
|event_leftweaponrelease||As above, but for the left hand. Is not included in the animation rig by default; Has to be added
|-
|event_sheatherighthandlefthip||Sheathes the right hand's item to the left hip
|-
|event_sheatherighthandrighthip||Sheathes the right hand's item to the right hip
|-
|event_throatcut|| Slits opponent's throat. Only works with "tethered" characters, like when choking
|-
|event_unsheatherighthandlefthip||Unsheathes the left hip's item into the right hand
|-
|event_unsheatherighthandrighthi||Unsheathes the right hip's item into the right hand
|-
|weap_to_hand_l||Switches weapon to left hand.
|-
|weap_to_hand_r||Switches weapon to right hand.
|-
|ik||Switches from FK (0.0) to IK (1.0). Mostly affects animation interpolation
|-
|shape_fist||Ranges from fist closed (0.0) to wide open (1.0).
|-
|status_cancel||Specifies when the remainder of the animation can be skipped when the player tries to move. Used for "optional" ending bits of attacks. '''TODO: Is this from a 0.0 to 1.0 range?'''
|-
|status_escape||Ranges from 0 to 1. When this is 1, the thrown character can escape from the throw
|-
|status_groundconform||TODO: Might be related to the rolling animation when on slopes. How does this work?
|-
|status_rightarm_blend||Controls how closely the right arm follows the animation. Ranges from 0.0 (default, "floppy") to 1.0 (stiff and exact).
|-
|status_leftarm_blend||^^^, but for the left arm.
|}
If you find properties not listed here, they are most likely used for character rigging or Blender animation (not read by the game).

===Adding an Event Keyframe to your animation===
# Make sure DEF bones are revealed (see Bone layers)
# Select the appropriate DEF bone for the event you want to trigger while being in pose mode
# Set the playhead in the timeline to the moment you want the event to happen
# In the '''Properties''' editor, press '''Bone''' and scroll down to '''Custom Properties'''
# Hover over the property that corresponds to the event you want to trigger and press '''I''' to add a keyframe. (Value doesn't matter)

To ungroup a keyframe in the dopesheet from its parent, select it from the parent's dropdown menu (so the event keyframe's name lights up) and press CTRL + ALT + G. Now the keyframe should be sent to the bottom, for easier editing!

===Bone Influence===
Certain animations have Influence keyframes. Usually, it's something like "Influence (DEF-toe.L : left_leg)". These are to make sure the bone stays on the ground while the animation plays. '''TODO: How else can Influence be used?'''

To add Influence keyframes like this, select the desired bone (usually DEF-toe) and look at the Bone Constraints menu in your Properties. Find the desired bone constraint, right click the value field and click Insert Keyframe.

==Control Bone Contraints==
If you have your hinge contraints set to 0, in you control-bone properties, your in-game dialogue torso and head controls will work correctly.
Setting the value to 1, tightens the hinge all the way.
[[File:hinge_keys.jpg]]
{| class="wikitable"
|hinge (torso)||controls the tightness of the in-game torso widget for dialogue.
|-
|hinge (head)||controls the tightness of the in-game head widget for dialogue.
|-
|hinge (neck)||no neck widget, so helps with head movement?
|-
|hinge (upper_arm.R)||Unsure.
|-
|hinge (upper_arm.L)||Unsure.
|-
|}

==Animating Morph Targets==
'''Todo: Add this section'''
[[Category: Overgrowth]]
[[Category: Modding]]

File:Hinge keys.jpg

2024-10-24T21:41:38Z

Akazi: used for dialogue widget control

used for dialogue widget control

Custom Characters

2017-10-05T17:55:57Z

Akazi: /* Basics */

''based on [http://forums.wolfire.com/viewtopic.php?f=16&t=24827 this] forum post by member Markuss.''

There are two linked .zip file attached to the forum post. they can be found here:

http://www.markstockton.com/misc/Guide2/ExampleMan.zip

http://www.markstockton.com/misc/Guide2/Blender-Overgrowth-Win.zip

This guide assumes you are familiar with [[3D Objects]].

==Basics==

Characters in overgrowth consist of 4 .XML files, an .OBJ file, a .PHXBN file, a .fzx file and a hull .OBJ file. The .PHXBN and .fzx files are created in Blender, the PHXBN file contains the skeleton and skin weighting info. The .fzx file contains the collision information that the ragdolled character uses. The XML files just contain links to themselves and other files. They contain the following:

1 - Links to the .OBJ and .PHXBN files that the engine needs to rig the character.
<pre>
<?xml version="1.0" ?>
<rig bone_path = "Data/Custom/Markuss/ExampleMan/Models/ExampleMan.phxbn"
model_path = "Data/Custom/Markuss/ExampleMan/Models/ExampleMan.obj"/>
</pre>

2 - A regular object file as described in the [[3D_Objects#Basics | 3D reference guide]].
<pre>
<?xml version="1.0"?>
<Object>
<Model>Data/Custom/Markuss/ExampleMan/Models/ExampleMan.obj</Model>
<ColorMap>Data/Custom/Markuss/ExampleMan/Textures/ExampleMan_Color.TGA</ColorMap>
<NormalMap>Data/Custom/Markuss/ExampleMan/Textures/ExampleMan_Norm.TGA</NormalMap>
<ShaderName>cubemapobjchar</ShaderName>
</Object>
</pre>

3 - Links to the first 2 files, and a load of animation files for each action.
<pre>
<?xml version="1.0" ?>
<character>
<appearance obj_path = "Data/Custom/Markuss/ExampleMan/XMLFiles/ExampleMan_Object.xml"
skeleton = "Data/Custom/Markuss/ExampleMan/XMLFiles/ExampleMan_RigFiles.xml"/>
<animations idle = "Data/Animations/r_idle2.xml"
jump = "Data/Animations/r_jump.xml"
roll = "Data/Animations/r_roll.xml"
movement = "Data/Animations/r_movement.xml"
wall = "Data/Animations/r_wall.xml"
ledge = "Data/Animations/r_ledge.anm"
medrightblock = "Data/Animations/r_activeblockmedright.anm"
medleftblock = "Data/Animations/r_activeblockmedleft.anm"
highrightblock = "Data/Animations/r_activeblockhighright.anm"
highleftblock = "Data/Animations/r_activeblockhighleft.anm"
lowrightblock = "Data/Animations/r_activeblocklowright.anm"
lowleftblock = "Data/Animations/r_activeblocklowleft.anm"
blockflinch = "Data/Animations/r_activeblockflinch.anm"/>
<attacks moving_close = "Data/Attacks/haymaker.xml"
stationary_close = "Data/Attacks/thrustpunch.xml"
moving = "Data/Attacks/spinkick.xml"
stationary = "Data/Attacks/frontkick.xml"
moving_low = "Data/Attacks/soccerkick.xml"
low = "Data/Attacks/sweep.xml"
air = "Data/Attacks/legcannon.xml" />
</character>
</pre>

4 - Links to the third file and an AI script, this is the file you choose when loading a character.
<pre>
<?xml version="1.0" ?>
<Actor>
<Character>Data/Custom/Markuss/ExampleMan/XMLFiles/ExampleMan_AnimList.xml</Character>
<ControlScript>enemycontrol.as</ControlScript>
</Actor>
</pre>

==Model and Texture Requirements==
[[Image:ExampleMan_mesh.jpg|thumb|Character Model Faces Z-axis]]
Models have to be triangles only and centered to the middle of the scene with location, rotation and scale set to zero. It should loosely match the pose and proportions of the Overgrowth characters, you can use the following file: ''../Overgrowth/Data/Models/Characters/Rabbit/rabbit.obj''.

If your character is not symmetrical, ignore the center line in the geometry, it has to be the "true" the center of the model, otherwise you will get errors.

There is no character shader that supports tangent space normal maps. If you want to use a tangent space normal map anyway, the cubemap shader can be used. Though doing so will make the object look a bit different in the engine. More information about these shaders can be found in the [[3D_Objects#Shaders|3D Objects]] article.

[[Image:ExampleMan_Norm.jpg|thumb|This is what a Blank/Flat object-space normal map looks like]]

==Blender==
A repackaged version of Blender with the export addons and with the UI set up for making characters can be downloaded at the top of this article. It does not require an install and can be run from its folder. You may need to restart it once to get the export options to show up.

This article is not intended to teach how to use Blender, it only gives the information essential to get a character into the game. If you would like to learn more about Blender, the website cgcookie.com has a good free tutorial video series that will introduce you to the software. With that in mind, here are the basic controls that you will need in Blender:
{| class="wikitable"
|-
! Control !! Function
|-
! Middle mouse
| Orbit
|-
! Shift + middle mouse
| Pan
|-
! Ctrl + middle mouse or scroll wheel
| Zoom
|-
! Right click
| Select object
|-
! Delete or X
| Remove selection
|-
! Shift + right click
| Select more then 1 object
|-
! Ctrl + P
| Bind selected mesh to active skeleton (armature deform)
|-
! Tab
| Toggle between object mode and last active mode
|}

# Replace the white rabbit
#* Press '''File > Import > Wavefront (.obj)''' to import an obj file.
# Bind your own mesh to the skeleton
#* First select the mesh, then shift-select the skeleton to add it to your selection before you press Ctrl + P to bind them.
#Paint weights
#* You may want to look up a tutorial on painting weights in blender.
#* It is recommended that you test your character in engine with automatic weights to check that you have no errors before you start working on a final weight paint. It won’t look pretty, but will let you know early on if the character is going to work in the engine.
# Export your files
#* With skeleton selected in object mode, export as .PHXBN, same for mesh but as .OBJ. Your model needs to be in rest position when doing this.

3D Objects

2017-10-05T17:34:58Z

Akazi: /* Tags */

''based on [http://forums.wolfire.com/viewtopic.php?f=16&t=11227 this] forum post by member Markuss.''
There is a linked .zip file attached to the forum post. it can be found here:
http://www.markstockton.com/misc/Guide/Examples.zip

== Introduction ==
Phoenix uses .xml files to store information about what textures a certain model should use as well as other information such as what shader it should use. This is the file you choose when loading an object. Here is an example object .xml file:

<pre>
<?xml version="1.0" ?>
<Object>
<Model>Data/Mods/example_mod/Data/Models/SimpleObject.obj</Model>
<ColorMap>Data/Mods/example_mod/Data/Textures/SimpleObject_Color.tga</ColorMap>
<NormalMap>Data/Mods/example_mod/Data/Textures/Blank_Norm.tga</NormalMap>
<ShaderName>cubemap</ShaderName>
<MaterialPath>Data/Materials/default.xml</MaterialPath>
</Object>
</pre>

All object .xml files that ship with the game are located in ../Overgrowth/Data/Objects/.

=== Model and Texture Requirements ===
* Only quads and triangles in models
* Models use the Wavefront .obj format
* Textures need to be square
* Texture resolution need to be a power of two (32x32, 64x64, 128x128 and so on)
* The .tga format is recommended for textures, but .png and .tif work also.

==== Converting normal maps ====
The normal maps that you get from some applications might not be instantly usable in the Phoenix engine without some edits. For instance, if you are using an object space normal map from Xnormal you need to do this:

1. Swap blue and green channels
2. Invert red and blue channels

You an do this in Photoshop, Substance Designer or similar. Note that using Gimp for this will destroy your alpha channel, so it is not recommended to use this.

== Object .xml File ==
The object .xml files contain all information about a single object (model) that can be spawned in the engine. This aims to be a full reference over all tags and flags that can be used in an object .xml.

=== Tags ===
''Note: This list is incomplete.''
{| class="wikitable"
|-
! Tag !! Example use !! Description
|-
! Model
| <Model>Data/Models/MyModel.obj</Model> || path to the model file (.obj)
|-
! ColorMap
| <ColorMap>Data/Textures/MyColorMap.tga</ColorMap> || path to the color texture file (.tga, .tif or .png)
|-
! NormalMap
| <NormalMap>Data/Textures/MyNormalMap.tga</NormalMap> || Path to the normal map texture file (.tga, .tif or .png)
|-
! ShaderName
| <ShaderName>cubemapobj</ShaderName> || Name of shader to use from ../Overgrowth/Data/GLSL/ (.frag and .vert)
|-
! MaterialPath
| <MaterialPath>Data/Materials/DirtyRock.xml</MaterialPath> || Path to the material to be used
|-
! flags
| <flags no_collision=true double_sided=true/> || Used to set boolean values on the object (see [[#Flags|flags]])
|}

==== Deprecated tags ====
These tags are deprecated and should not be used.

{| class="wikitable"
|-
! Tag !! Example use !! Description
|-
! ShaderPath
| <ShaderPath>Data/GLSL/cubemapobj</ShaderPath> || path to the shader to use (.frag & .vert), replaced by ShaderName
|}

=== Flags ===
Flags are entered as boolean attributes in an element called "flags" that is located under the "Object" element. For more information about the "flags" tag, look under [[#Tags|tags]]. All flags have a default value of false.

{| class="wikitable"
|-
! Flag !! Description
|-
! no_collision
| Disables physics collisions with this object.
|-
! double_sided
| The backsides of the object gets rendered as well.
|-
! bush_collision
| Makes the object give some resistance when passed through while the object wobbles a bit and generates leaf particles. If a character jumps into this object at high enough speed they will ragdoll.
|}

==Collision/Physics Objects==
The engine automatically generates a simplified physics object from your model but this can be overridden by providing an alternative .OBJ file. The file is placed in the same folder and shares the same name as the original .OBJ file with a suffix:

===Suffixes===
[[Image:PhysicsObject.jpg|thumb|Physics mesh should be placed on top of the render mesh]]
[[Image:HullObject.jpg|thumb|Hull objects are placed over render mesh like physics objects]]
{| class="wikitable"
|-
! Suffix !! Description
|-
! YourObject_COL.obj
| Contains simplified geometry for physics calculations.
|-
! YourObjectHULL.obj
| Same as _COL but has extra info, used with weapons.
|}

Note HULL doesn’t have an underscore to separate it from the file name!

===Physics objects (_COL)===
Simplified geometry such as boxes an cylinders which are used for collision detection, they are aligned to your object based on “relative position” in your 3D program so you should place the physics mesh on top of your render mesh upon export.

===Hull objects (HULL)===
They are very similar to physics objects but are used for items and weapons, the only difference is that they contain a free-floating triangle which defines the object’s center of gravity.

==Shaders==
There are two texture maps that are required for an object to be loaded in the engine. Those are the '''ColorMap''' and the '''NormalMap''' textures. Some shaders allow - but do not require - for additional maps to be specified for different purposes. Shaders with "obj" in their name expect the supplied NormalMap texture to be in object space, those without expect tangent space.

Here are the most common channel designations of the ColorMap and NormalMap textures:

'''ColorMap''' 
'''RGB''' - Color 
'''A''' - Reflectivity

'''NormalMap''' 
'''RGB''' - Normal 
'''A''' - Color tint mask

Any deviations from this standard for any shader in the table below can be seen in the ''Non-standard channel designation'' column. This includes any optional textures.

{| class="wikitable"
|-
! Tag !! Non-standard channel designation !! Description
|-
! cubemap
|
|| Standard shader.
|-
! cubemapobj
|
|| Same as Cubemap but uses object-space normal maps instead of tangent space.
|-
! cubemapobjitem
|
|| Object space version of CubemapItem.
|-
! cubemapalpha
|
'''ColorMap''' 
'''A''' - Transparency

'''NormalMap''' 
'''A''' - Reflectivity
||
[[Image:CubemapAlpha.jpg|thumb|cubemapalpha shader]]
Texels that do not have a transparency of 0.0 or 1.0 have depth sorting issues with each other.
|-
! cubemapobjchar
|
'''NormalMap''' 
'''A''' - Sun fresnel mask
|| Intended for use with characters, shine is sharp, uses object space normals. The sun fresnel effect brightens up the edges of the object when it is between the camera and the sun.
|-
! plant
|
'''ColorMap''' 
'''A''' - Transparency

'''NormalMap''' 
'''A''' - No effect

'''TranslucencyMap''' 
'''RGB''' - Translucency color 
'''A''' - No effect

'''WindMap''' 
'''R''' - Wind mask 
'''GBA''' - No effect
|| [[Image:Translucency.jpg|thumb|plant shader]]
Has transparency like cubemapalpha but no reflectivity.

The '''TranslucencyMap''' texture adds its color to the surface multiplied by the amount of light it receives, this effect ignores the normal of the surface, so if one side receives light from for instance the sun, the other side will also get the color added. If unspecified it defaults to 0.0 (no translucency) across the entire surface.

The '''WindMap''' texture defines intensity of a vertex wind effect. If unspecified it defaults to 1.0 (active) across the entire surface.
|}

==Materials==
These are the materials that can be assigned to objects. These only work on terrains and not on objects placed in the world.

* Cloth_Fabric
* Cloth_Leather
* Default
* Dirt
* DirtyRock
* Drygrass
* Grass
* Gravel
* Rock
* Rocks
* Sand
* Snow
* Wood

==Items==
Items are things that a character can pick up in the game, a large part of the items in the game are weapons. An item .xml file is needed to make an object into an item. The item .xml files that come with the game can be found in ../Overgrowth/Data/Items/. Items are picked up by their center point.

As an example, 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>

===Tags===
{| 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''.
|-
! 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.
|-
! 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).
|-
! 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).
|-
! 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_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 and movement (maybe more). This is used for for instance two handed weapons, spears and so on, where the default animation looks weird.
|-
! 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.
|}