Wolfire Games Wiki - User contributions [en]

Custom Animations

2024-01-09T23:30:19Z

Constance: /* Event Keyframes */ Corrected typo

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

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

Custom Animations

2023-12-03T04:49:24Z

Constance: /* Overview */ Included note about Blender 4.0

==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 att I've tried copying the kack animation
|-
|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.

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

Custom Animations

2023-12-03T04:47:26Z

Constance: /* Bone layers */ Corrected bone layer text

==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?'''

== 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 att I've tried copying the kack animation
|-
|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.

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

File:Animation rig layers.png

2023-12-03T04:46:38Z

Constance: Constance uploaded a new version of File:Animation rig layers.png

Cyan text is only for character rigging.
White text is only for animation.
Green text is only for DEF bones, which are used in animation.

Custom Animations

2023-12-03T04:19:41Z

Constance: /* Bone Influence */ Fixed spacing.

==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?'''

== 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|242px|right|**Pre-Blender 4.0 interface: Past 4.0, bone collections no longer work, as far as I know.** Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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 att I've tried copying the kack animation
|-
|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.

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

Custom Animations

2023-12-03T04:19:18Z

Constance: /* Event Keyframes */ Added bone influence section

==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?'''

== 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|242px|right|**Pre-Blender 4.0 interface: Past 4.0, bone collections no longer work, as far as I know.** Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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 att I've tried copying the kack animation
|-
|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.

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

Custom Animations

2023-11-27T23:16:05Z

Constance: /* Event Keyframes */ Bolded

==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?'''

== 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|242px|right|**Pre-Blender 4.0 interface: Past 4.0, bone collections no longer work, as far as I know.** Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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 animation
|-
|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!

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

Custom Animations

2023-11-27T23:14:25Z

Constance: /* Bone layers */ Reduced size of the outdated bone layers image.

==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?'''

== 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|242px|right|**Pre-Blender 4.0 interface: Past 4.0, bone collections no longer work, as far as I know.** Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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 animation
|-
|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!

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

Custom Animations

2023-11-27T23:13:05Z

Constance: /* Adding an Event Keyframe to your animation */ Keyframe ungrouping note clarified

==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?'''

== 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|485px|right|**Pre-Blender 4.0 interface: Past 4.0, bone collections no longer work, as far as I know.** Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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 animation
|-
|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!

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

Custom Animations

2023-11-27T23:11:57Z

Constance: /* Event Keyframes */ Minor correction

==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?'''

== 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|485px|right|**Pre-Blender 4.0 interface: Past 4.0, bone collections no longer work, as far as I know.** Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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 animation
|-
|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, select it (so its name lights up) and press CTRL + ALT + G. Now the keyframe should be sent to the bottom, for easier editing!

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

Custom Animations

2023-11-27T23:11:11Z

Constance: /* Event Keyframes */ Event keyframe documentation

==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?'''

== 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|485px|right|**Pre-Blender 4.0 interface: Past 4.0, bone collections no longer work, as far as I know.** Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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, 1, inbetween); What matters is their placement.
Some other keyframes require a range from 0 to 1 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 animation
|-
|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, select it (so its name lights up) and press CTRL + ALT + G. Now the keyframe should be sent to the bottom, for easier editing!

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

Custom Animations

2023-11-27T22:56:03Z

Constance: /* Changing the start & end frames */ Included duration note

==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?'''

== 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|485px|right|**Pre-Blender 4.0 interface: Past 4.0, bone collections no longer work, as far as I know.** Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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.
{| class="wikitable"
|-
! Event Name !! Description
|-
|event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_blockprepare || Signals when AI characters should block. These keyframes are usually placed two frames before the impact
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||Will trigger footstep sounds for sneaking, emits AI sound and creates particles while on terrain
|-
|event_rightrunstep||Will trigger footstep sounds for running, emits AI sound and creates particles while on terrain
|-
|event_rightwalkstep||Will trigger footstep sounds for walking, emits AI sound and creates particles while on terrain
|-
|event_rightwallstep||Will trigger footstep sounds for wall running and emits AI sound
|-
|event_golimp||Causes the character to ragdoll into a static pose
|-
|event_grabitem||
|-
|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_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||
|-
|event_unsheatherighthandlefthip||Unsheathes the left hip's item into the right hand
|-
|event_unsheatherighthandrighthi||Unsheathes the right hip's item into the right hand
|}

===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, select it (so its name lights up) and press CTRL + ALT + G. Now the keyframe should be sent to the bottom, for easier editing!

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

Custom Animations

2023-11-27T22:50:10Z

Constance: /* Changing the start & end frames */ Edited image sizes

==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?'''

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

===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|485px|right|**Pre-Blender 4.0 interface: Past 4.0, bone collections no longer work, as far as I know.** Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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.
{| class="wikitable"
|-
! Event Name !! Description
|-
|event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_blockprepare || Signals when AI characters should block. These keyframes are usually placed two frames before the impact
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||Will trigger footstep sounds for sneaking, emits AI sound and creates particles while on terrain
|-
|event_rightrunstep||Will trigger footstep sounds for running, emits AI sound and creates particles while on terrain
|-
|event_rightwalkstep||Will trigger footstep sounds for walking, emits AI sound and creates particles while on terrain
|-
|event_rightwallstep||Will trigger footstep sounds for wall running and emits AI sound
|-
|event_golimp||Causes the character to ragdoll into a static pose
|-
|event_grabitem||
|-
|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_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||
|-
|event_unsheatherighthandlefthip||Unsheathes the left hip's item into the right hand
|-
|event_unsheatherighthandrighthi||Unsheathes the right hip's item into the right hand
|}

===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, select it (so its name lights up) and press CTRL + ALT + G. Now the keyframe should be sent to the bottom, for easier editing!

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

Custom Animations

2023-11-27T22:49:06Z

Constance: /* Changing the start & end frames */ Included instructions on how to set animation duration

==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?'''

== 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|439px|right|How to find the animation controls for exported frame data]]
[[File:Start_end_frames.png|thumb|439px|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.

===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|485px|right|**Pre-Blender 4.0 interface: Past 4.0, bone collections no longer work, as far as I know.** Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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.
{| class="wikitable"
|-
! Event Name !! Description
|-
|event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_blockprepare || Signals when AI characters should block. These keyframes are usually placed two frames before the impact
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||Will trigger footstep sounds for sneaking, emits AI sound and creates particles while on terrain
|-
|event_rightrunstep||Will trigger footstep sounds for running, emits AI sound and creates particles while on terrain
|-
|event_rightwalkstep||Will trigger footstep sounds for walking, emits AI sound and creates particles while on terrain
|-
|event_rightwallstep||Will trigger footstep sounds for wall running and emits AI sound
|-
|event_golimp||Causes the character to ragdoll into a static pose
|-
|event_grabitem||
|-
|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_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||
|-
|event_unsheatherighthandlefthip||Unsheathes the left hip's item into the right hand
|-
|event_unsheatherighthandrighthi||Unsheathes the right hip's item into the right hand
|}

===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, select it (so its name lights up) and press CTRL + ALT + G. Now the keyframe should be sent to the bottom, for easier editing!

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

File:Start end frames.png

2023-11-27T22:47:42Z

Constance: The start & end frames in an animation rig.

The start & end frames in an animation rig.

Custom Animations

2023-11-27T22:45:13Z

Constance: /* Adding an event Keyframe to your animation */ Revised instructions

==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?'''

== 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|439px|right|How to find the animation controls for exported frame data]]

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.

===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|485px|right|**Pre-Blender 4.0 interface: Past 4.0, bone collections no longer work, as far as I know.** Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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.
{| class="wikitable"
|-
! Event Name !! Description
|-
|event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_blockprepare || Signals when AI characters should block. These keyframes are usually placed two frames before the impact
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||Will trigger footstep sounds for sneaking, emits AI sound and creates particles while on terrain
|-
|event_rightrunstep||Will trigger footstep sounds for running, emits AI sound and creates particles while on terrain
|-
|event_rightwalkstep||Will trigger footstep sounds for walking, emits AI sound and creates particles while on terrain
|-
|event_rightwallstep||Will trigger footstep sounds for wall running and emits AI sound
|-
|event_golimp||Causes the character to ragdoll into a static pose
|-
|event_grabitem||
|-
|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_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||
|-
|event_unsheatherighthandlefthip||Unsheathes the left hip's item into the right hand
|-
|event_unsheatherighthandrighthi||Unsheathes the right hip's item into the right hand
|}

===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, select it (so its name lights up) and press CTRL + ALT + G. Now the keyframe should be sent to the bottom, for easier editing!

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

Custom Animations

2023-11-27T22:12:09Z

Constance: /* Overview */ Revised download locations for 2.93+ scripts

==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?'''

== 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|439px|right|How to find the animation controls for exported frame data]]

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.

===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|485px|right|**Pre-Blender 4.0 interface: Past 4.0, bone collections no longer work, as far as I know.** Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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.
{| class="wikitable"
|-
! Event Name !! Description
|-
|event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_blockprepare || Signals when AI characters should block. These keyframes are usually placed two frames before the impact
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||Will trigger footstep sounds for sneaking, emits AI sound and creates particles while on terrain
|-
|event_rightrunstep||Will trigger footstep sounds for running, emits AI sound and creates particles while on terrain
|-
|event_rightwalkstep||Will trigger footstep sounds for walking, emits AI sound and creates particles while on terrain
|-
|event_rightwallstep||Will trigger footstep sounds for wall running and emits AI sound
|-
|event_golimp||Causes the character to ragdoll into a static pose
|-
|event_grabitem||
|-
|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_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||
|-
|event_unsheatherighthandlefthip||Unsheathes the left hip's item into the right hand
|-
|event_unsheatherighthandrighthi||Unsheathes the right hip's item into the right hand
|}

===Adding an event Keyframe to your animation===
# Select the 3rd of the rig's layers from the bottom right, as shown in the Bone Layers section
# Select the appropriate 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, select it (so its name lights up) and press CTRL + ALT + G. Now the keyframe should be sent to the bottom, for easier editing!

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

Custom Animations

2023-11-27T22:01:09Z

Constance: /* Bone layers */ Added bone layer image note

==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 3.4''' and above are in the [https://discord.com/invite/wolfire Wolfire Discord's] #overgrowth_modding channel, in the pinned messages. Look for a file named phoenixblenderscripts.7z (instructions on how to install are included).

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?'''

== 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|439px|right|How to find the animation controls for exported frame data]]

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.

===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|485px|right|**Pre-Blender 4.0 interface: Past 4.0, bone collections no longer work, as far as I know.** Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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.
{| class="wikitable"
|-
! Event Name !! Description
|-
|event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_blockprepare || Signals when AI characters should block. These keyframes are usually placed two frames before the impact
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||Will trigger footstep sounds for sneaking, emits AI sound and creates particles while on terrain
|-
|event_rightrunstep||Will trigger footstep sounds for running, emits AI sound and creates particles while on terrain
|-
|event_rightwalkstep||Will trigger footstep sounds for walking, emits AI sound and creates particles while on terrain
|-
|event_rightwallstep||Will trigger footstep sounds for wall running and emits AI sound
|-
|event_golimp||Causes the character to ragdoll into a static pose
|-
|event_grabitem||
|-
|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_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||
|-
|event_unsheatherighthandlefthip||Unsheathes the left hip's item into the right hand
|-
|event_unsheatherighthandrighthi||Unsheathes the right hip's item into the right hand
|}

===Adding an event Keyframe to your animation===
# Select the 3rd of the rig's layers from the bottom right, as shown in the Bone Layers section
# Select the appropriate 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, select it (so its name lights up) and press CTRL + ALT + G. Now the keyframe should be sent to the bottom, for easier editing!

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

Custom Animations

2023-11-27T21:59:00Z

Constance: /* Bone layers */ Revised bone reveal instructions

==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 3.4''' and above are in the [https://discord.com/invite/wolfire Wolfire Discord's] #overgrowth_modding channel, in the pinned messages. Look for a file named phoenixblenderscripts.7z (instructions on how to install are included).

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?'''

== 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|439px|right|How to find the animation controls for exported frame data]]

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.

===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|485px|right|Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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.
{| class="wikitable"
|-
! Event Name !! Description
|-
|event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_blockprepare || Signals when AI characters should block. These keyframes are usually placed two frames before the impact
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||Will trigger footstep sounds for sneaking, emits AI sound and creates particles while on terrain
|-
|event_rightrunstep||Will trigger footstep sounds for running, emits AI sound and creates particles while on terrain
|-
|event_rightwalkstep||Will trigger footstep sounds for walking, emits AI sound and creates particles while on terrain
|-
|event_rightwallstep||Will trigger footstep sounds for wall running and emits AI sound
|-
|event_golimp||Causes the character to ragdoll into a static pose
|-
|event_grabitem||
|-
|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_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||
|-
|event_unsheatherighthandlefthip||Unsheathes the left hip's item into the right hand
|-
|event_unsheatherighthandrighthi||Unsheathes the right hip's item into the right hand
|}

===Adding an event Keyframe to your animation===
# Select the 3rd of the rig's layers from the bottom right, as shown in the Bone Layers section
# Select the appropriate 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, select it (so its name lights up) and press CTRL + ALT + G. Now the keyframe should be sent to the bottom, for easier editing!

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

Custom Animations

2023-11-27T21:50:25Z

Constance: /* Bone layers */ Corrected DEF bones revealing instructions

==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 3.4''' and above are in the [https://discord.com/invite/wolfire Wolfire Discord's] #overgrowth_modding channel, in the pinned messages. Look for a file named phoenixblenderscripts.7z (instructions on how to install are included).

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?'''

== 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|439px|right|How to find the animation controls for exported frame data]]

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.

===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|485px|right|Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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
# Toggle the rig layers back to normal: The DEF bones are located in the 3rd of the rig's layers from the bottom right '''TODO: ADD IMAGE'''

==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.
{| class="wikitable"
|-
! Event Name !! Description
|-
|event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_blockprepare || Signals when AI characters should block. These keyframes are usually placed two frames before the impact
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||Will trigger footstep sounds for sneaking, emits AI sound and creates particles while on terrain
|-
|event_rightrunstep||Will trigger footstep sounds for running, emits AI sound and creates particles while on terrain
|-
|event_rightwalkstep||Will trigger footstep sounds for walking, emits AI sound and creates particles while on terrain
|-
|event_rightwallstep||Will trigger footstep sounds for wall running and emits AI sound
|-
|event_golimp||Causes the character to ragdoll into a static pose
|-
|event_grabitem||
|-
|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_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||
|-
|event_unsheatherighthandlefthip||Unsheathes the left hip's item into the right hand
|-
|event_unsheatherighthandrighthi||Unsheathes the right hip's item into the right hand
|}

===Adding an event Keyframe to your animation===
# Select the 3rd of the rig's layers from the bottom right, as shown in the Bone Layers section
# Select the appropriate 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, select it (so its name lights up) and press CTRL + ALT + G. Now the keyframe should be sent to the bottom, for easier editing!

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

3D Objects

2023-07-16T22:12:43Z

Constance: /* Shaders */ Added PBR shader info

== 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>envobject #TANGENT</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 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 ====
[[File:Convert_normals_tutorial.mp4|400px|thumb|right|Video tutorial on how to convert normal maps in GIMP]]
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 Substance Designer you need to do this:

# Invert the blue channel
# Swap blue and green channels

You can do this in Photoshop, Substance Designer, or GIMP. Note that Gimp does not work well with alpha channels. On the right is a tutorial on how to convert object space normal maps into tangent space using GIMP.

== 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 ===
{| class="wikitable"
|-
! Tag !! Example use !! Description
|-
! Model
| <pre><Model>Data/Models/MyModel.obj</Model></pre>
|| path to the model file (.obj)
|-
! ColorMap
| <pre><ColorMap>Data/Textures/MyColorMap.tga</ColorMap></pre>
|| path to the color texture file (.tga, .tif or .png)
|-
! NormalMap
| <pre><NormalMap>Data/Textures/MyNormalMap.tga</NormalMap></pre>
|| Path to the normal map texture file (.tga, .tif or .png)
|-
! ShaderName
| <pre><ShaderName>envobject #TANGENT #KEEP_SPEC</ShaderName></pre>
|| What shader to use, see [[#Shaders|shaders]] for more information
|-
! MaterialPath
| <pre><MaterialPath>Data/Materials/DirtyRock.xml</MaterialPath></pre>
|| Path to the material to use, see [[#Materials|materials]] for more information.
|-
! WeightMap
| <pre><WeightMap>Data/Textures/Environments/Rocks/granite_vine_rocks/granite_vine_boulder_overgrown_w.tga</WeightMap></pre>
|| Path to a black and white texture used for determining where each detail texture should be used. Required when using the detailmap4 [[#Shaders|shader]].
|-
! TranslucencyMap
| <pre><TranslucencyMap>Data/Textures/Environments/cat_props/banner_t.tga</TranslucencyMap></pre>
|| Path to a color texture used for translucency, meaning light that shines through the object. 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. Optional when using the plant [[#Shaders|shader]].
|-
! WindMap
| <pre><WindMap>Data/Textures/Environments/cat_props/banner_w.tga</WindMap></pre>
|| Path to a black and white texture used to define the intensity of a vertex wind effect. If unspecified it defaults to 1.0 (active) across the entire surface. Optional when using the plant [[#Shaders|shader]].
|-
! DetailMaps
| <pre><DetailMaps>
<DetailMap colorpath="Data/Textures/Terrain/DetailTextures/gray_rock.tga" normalpath="Data/Textures/Terrain/DetailTextures/gray_rock_normal.tga" materialpath="Data/Materials/rocks.xml" />
...
</DetailMaps></pre>
|| Contains exactly 4 <DetailMap> tags describing textures and materials that will be tiled across the model using the <WeightMap> tag's texture. Required when using the detailmap4 [[#Shaders|shader]].
|-
! DetailObjects
| <pre><DetailObjects>
<DetailObject obj_path="Data/Objects/Plants/Groundcover/Groundcover1.xml" weight_path="Data/Textures/Environments/Rocks/granite_vine_rocks/granite_vine_boulder_overgrown_vine_mask.tga" normal_conform="0.9" density="10" min_embed="0" max_embed="0.4" min_scale="0.7" max_scale="2" view_distance="40" jitter_degrees="10" overbright="0" />
</DetailObjects></pre>
|| Contains one or more <DetailObject> tags, each describing how to randomly distribute some object across the surface. Can be used for grass, small rocks etc.
|-
! flags
| <pre><flags no_collision=true double_sided=true/></pre>
|| Used to set boolean values on the object (see [[#Flags|flags]])
|-
! GroundOffset
| <pre><GroundOffset>0.5</GroundOffset></pre>
|| Moves the object up/down by the set amount when the object is created
|}

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

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

==== Materials ====
These are the materials that can be assigned to objects using the <code><MaterialPath></code> [[#Tags|tag]]. You can find the materials in <code>../Overgrowth/Data/Materials/</code>. The material affects what particles spawn when a character runs on the surface, what sound footsteps make on the surface, how easily weapons stick in the surface, and more.

* default
* dirt
* dirtytock
* drygrass
* grass
* gravel
* ice
* rock
* rocks
* sand
* snow
* wood

=== Flags ===
Flags are entered as boolean attributes ("true" or "false") in a [[#Tags|tag]] called "flags" under the "Object" tag. 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.
|}

==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 in the same place as the render mesh]]
[[Image:HullObject.jpg|thumb|Hull mesh should be in the same place as the render mesh]]
{| class="wikitable"
|-
! Suffix !! Description
|-
! YourObject_COL.obj
| Contains simplified geometry for physics calculations.
|-
! YourObjectHULL.obj
| Same as _COL but has extra info, used for weapons.
|}

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

===Physics objects (_COL)===
Simplified geometry such as boxes and 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 ==
Overgrowth uses an "uber shader" approach to shader management, which means that there is one huge shader that almost everything in the game uses. So instead of choosing a shader for your object, you can set "flags" with your object that the game will use to change how it's rendered.

The flags are put in the <ShaderName> tag after the shader name. Here is an example:

<ShaderName>envobject #TANGENT #KEEP_SPEC</ShaderName>

"#TANGENT" and "#KEEP_SPEC" in this example are flags.

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 flags allow you to use more than these two required textures, and some flags change how the required textures are used. '''TODO:''' Are there any default textures that can be used and what are they?

Here is the channel designations of the ColorMap and NormalMap textures:

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

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

Any deviation from these designations or new textures caused by any flag in the table below can be seen in the ''Channel/Texture Changes'' column.

{| class="wikitable"
|-
! Tag !! Channel/Texture Changes !! Description
|-
! #TANGENT
|
|| The normal map is used as an object space normal map by default, with this flag it's used as a tangent space normal map instead.
|-
! #KEEP_SPEC
|
'''NormalMap''' 
'''A''' - Smoothness
|| Instead of using the alpha channel of the normal map as a color tint mask, as is the default, that channel is used as a smoothness map. The object can still be tinted, you just can't control what parts get tinted.
|-
! #DETAILMAP4
|
'''WeightMap''' 
'''R''' - The first detail texture 
'''G''' - The second detail texture 
'''B''' - The third detail texture

'''DetailMap colorpath''' 
'''RGB''' - Color

'''DetailMap normalpath''' 
'''RGB''' - Normal
|| Allows for repeating up to 4 different textures over a model so it looks more detailed up close. This also means you can scale the model up or down with less obvious texture stretching.

* The WeightMap is used to decide which DetailMap texture to put where on the object
* Each DetailMap has its own color texture, normal texture and material
* See the [[#Tags|tags]] heading for information about how to specify the DetailMaps
|-
! #BASE_TANGENT
|
|| '''TODO:''' What does this do?
|-
! #AXIS_UV
|
|| '''TODO:''' What does this do?
|-
! #AXIS_BLEND
|
|| '''TODO:''' What does this do?
|-
! #NO_DECALS
|
|| No decals shows up on this object.
|-
! #WHY_DOES_THIS_WORK
|
|| '''TODO:''' What does this do?
|-
! #INVISIBLE
|
|| This object will not be rendered.
|-
! #ALPHA
|
'''ColorMap''' 
'''A''' - Transparency
|| [[Image:CubemapAlpha.jpg|thumb|#ALPHA flag in action]]
Makes the alpha channel of the ColorMap work as transparency instead of reflectivity
|-
! #PLANT
|
'''ColorMap''' 
'''A (reflectivity)''' - No effect

'''NormalMap''' 
'''A (color tint mask)''' - No effect

'''WindMap''' 
'''R''' - Wind intensity 

'''TranslucencyMap''' 
'''RGB''' - Translucency color 
|| [[Image:Translucency.jpg|thumb|#PLANT flag in action together with the #ALPHA flag]]
* Enables use of a WindMap which makes the object move in the wind
* Enables use of a TranslucencyMap which makes it look like light can shine through the surface
* Disables reflectivity
* Disables color tint mask
|-
! #WATER
|
|| '''TODO:''' What does this do?
|-
! #METALNESS_PBR
|
'''Colormap''' 
'''A''' - Metalness 

'''Normalmap''' 
'''A''' - Roughness 

|| With this shader tag, you can make PBR objects in Overgrowth!
|}

=== Color Tint Mask ===
This mask is located in the alpha channel of the normal map, and determines what parts of the object should be tinted when using the [[Editor_Interface#Color_Picker|color picker]]. Black parts are not affected, the brighter the texel the more it is affected by tinting.

== See also==
* [[Custom Characters]]
* [[Custom Weapons & Items]]

Configuring Overgrowth

2023-07-09T23:48:43Z

Constance: Removed SUMLauncher note, as the tool is outdated.

You can edit most settings by pressing the Settings button on the main menu or on the pause menu. There are even more settings available from the "Settings" top menu bar on the main menu.

If you need to edit the config without starting the game, you can change your configuration by modifying your '''config.txt'''. Just below you can see the location of this file on each operating system.

==Config File Location==

The configuration file is created when Overgrowth is started for the first time.

To view or edit your config file, find your operating system in the list below and follow the shown path.

'''Windows'''

<code>My Documents\Wolfire\Overgrowth\Data\config.txt</code>

''Note:'' NOT Program Files\Wolfire\Overgrowth\Data!

'''Mac'''

<code>Macintosh HD/Users/~/Library/Application Support/Overgrowth/Data/config.txt</code>

where ~ is your username.

''Note:'' If you are using Lion, your library folder is hidden by default... in the finder, click the "Go" menu, then Press Option, and Library will appear in the list.

'''Linux'''

<code>~/.local/share/Overgrowth/Data/config.txt</code>

==Settings==

===General Settings===
{| class="wikitable"
|-
! Setting !! Default Value !! Description
|-
! screenwidth
| 800 || The game's horizontal resolution.
|-
! screenheight
| 600 || The game's vertical resolution.
|-
! fullscreen
| false || Determines whether to run in full screen or windowed mode.
|-
! vsync
| false || Limits the framerate to match the user's monitor refresh rate (smooths out the framerate).
|-
! simple_shadows
| 1 || Disables dynamic shadows if set to 1.
|-
! blood
|1 || Disable or enable blood
|-
! blood_color
| 0.4 0 0 || The color of blood in the game in R, G, B. Each value should be between 0 and 1.
|-
! multisample
| 0 || Determines the level of anti-aliasing (smooths out jagged edges). Should be 1, 2, 4 or 8.
|-
! anisotropy
| 0 || Determines the level of anisotropic filtering (increases the quality of textures drawn far away and at an angle). Should be 1, 2, 4 or 8.
|-
! motion_blur_amount
| 0 || How much motion blur to apply, should be between 0 and 1.
|-
! post_effects
| true || Determines whether to use post effects.
|-
! shaders
| true || Determines whether to use shaders.
|-
! texture_reduce
| 0 || Determines the level to which the texture resolutions should be reduced (higher numbers means lower resolution).
|-
! texture_minimize_ram
| 1 || '''TODO: What does this do?'''
|-
! full_level_unload
| true || '''TODO: What does this do?'''
|-
! gamma_correct
| true || Determines whether to use gamma correction.
|-
! fps_label
| false || Determines whether to display the current fps (frames per second) on screen.
|-
! sound_label
| false || Determines whether to display all active sounds on screen.
|-
! visible_raycasts
| false || Determines whether to display lines representing all AIs' visibility.
|-
! visible_sound_spheres
| false || Determines whether to display spheres representing the distance sounds travel (such as running).
|-
! editor_mode
| false || Determines whether to start the game in play mode (false) or editor mode (true).
|-
! invert_y_mouse_look
| false || Determines whether to invert the y-axis controls (looking up/down).
|-
! use_raw_input
| true || Use raw mouse input, solves mouse issues for some people.
|-
! invert_y_gamepad_look
| false || Determines whether to invert the y-axis controls (looking up/down).
|-
! tet_mesh_lighting
| 0 || If set to 1, use the pre-baked tetrahedral mesh global illumination. '''TODO: Does this work?'''
|-
! light_volume_lighting
| false || Use ambient light volume lighting if available.
|-
! global_time_scale_mult
| 1.0 || How fast the game should run. Can be set to above and below the min./max. values of the ingame settings. '''TODO: Hardcoded min/max values?'''
|-
! game_difficulty
| 1.0 || How hard the game should be, higher is harder.
|-
! tutorials
| true || Helpful messages are displayed in the game.
|-
! difficulty_set
| false || '''TODO: What does this do?'''
|-
! volume_shadows
| false || Use experimental volume shadow graphics tech.
|-
! ssao
| false || Use experimental screen space ambient occlusion graphics tech.
|-
! auto_ledge_grab
| true || The player character will automatically grab ledges when they can. If false you need to hold right click to grab ledges.
|-
! particle_field
| true || Show particle fields in the game. '''TODO: Does this affect CPU particle fields, GPU particle fields, or both?'''
|-
! custom_level_shaders
| true || Use shaders made for specific levels to add things like snow, wetness near water etc.
|-
! disable_fog
| false || Disables atmoshperic fog.
|-
! simple_fog
| false || Extra simple fog calculations for low-end graphics cards.
|-
! no_auto_nav_mesh
| false || Disables automatic nav mesh generation. '''TODO: Verify that this is what it does'''
|-
! no_texture_convert
| false || Skip converting textures to .dds format to save VRAM. '''TODO: Verify that this is what it does'''
|-
! gl_load_s3tc
| true || '''TODO: What does this do?'''
|-
! skip_loading_pause
| false || You don't have to press left click to start the level after it has been loaded.
|-
! brightness
| 1 || Increase or decrease the brightness of the game.
|-
! use_soundtrack_limiter
| true || Better handling of music volume when transitioning between tracks.
|-
! master_volume
| 0.8 || Overall loudness of all game audio.
|-
! music_volume
| 0.4 || Loudness of game music.
|-
! media_mode
| false || Determines whether to disable the in-game interface.
|-
! baked_shadows
| true || (Deprecated) Determines whether to use the pre-baked shadows (true) or cascaded shadow maps (false).
|-
! debug_key_presses
| false || '''TODO: What does this do? How are key presses debugged when this is on?'''
|-
! block_cheating_progress
| true || Disables unlocking levels when cheats are active, like when in the editor.
|-
! auto_camera
| false || Determines whether to have the camera automatically return to a position behind the player. Only affects the player controlled with keyboard and mouse in local multiplayer with splitscreen, will be true for the other players.
|-
! split_screen
| false || Determines if the game view should be split or not when there is more than one player.
|-
! chase_camera_fov
| 90.0 || The field of view of the camera when playing the game.
|-
! editor_camera_fov
| 90.0 || The default field of view of the camera when in the editor.
|-
! report_case_errors
| false || Reports capitalization errors in the log when they are found. '''TODO: Does this work?'''
|-
! background_process_pool
| false || Use background processes for things like calculating the nav mesh. '''TODO: Is this accurate?'''
|-
! main_menu
| true || Show main menu when starting the game. If false it will load the level at the path in the debug_load_level setting.
|-
! debug_load_level
| Project60/16_red_desert.xml || If main_menu is set to false, the level at this path will load when the game is started.
|-
! mouse_sensitivity
| 0.5 || Determines how far the camera in the game rotates when the mouse moves.
|-
! gpu_skinning
| false || Use the graphics card to skin characters. This should be false to avoid any issues.
|-
! detail_objects
| 1 || Determines if 3D grass models, small rocks etc. are displayed on the terrain.
|-
! seamless_cubemaps
| true || Make cubemaps display seamlessly. '''TODO: When is this useful?'''
|-
! debug_keys
| true || Enables use of debug keys, such as F for laser eyes. '''TODO: Does this still work?'''
|-
! shader_dir_path
| Data/GLSL/ || Where the game looks for shaders. '''TODO: Does this work?'''
|-
! debug_show_ai_state
| false || '''TODO: What does this do?'''
|-
! debug_show_ai_path
| false || Show lines to every NPC's destination.
|-
! debug_draw_window
| false || Show debug window in the top left.
|-
! albedo_only
| false || Display only color of objects, without any lighting etc.
|-
! no_decals
| false || Disable rendering of decals.
|-
! single_pass_shadow_cascade
| false || Render all real-time shadows in a single pass. '''TODO: Does this still work?'''
|-
! shader_debug
| false || '''TODO: What does this do?'''
|-
! opengl_callback_errors
| true || '''TODO: What does this do?'''
|-
! opengl_callback_error_dialog
| false || '''TODO: What does this do?'''
|-
! occlusion_query
| true || '''TODO: What does this do?'''
|-
! dump_include_scripts
| false || '''TODO: What does this do?'''
|-
! allow_game_dir_save
| false || If true, the editor encourages you to save in the working directory instead of the game directory.
|-
! level_backup_count
| 10 || The maximum number of backups to save for each level. Backups can be found in working_dir/Overgrowth/Data/Levels/backups/.
|-
! no_reflection_capture
| 0 || If set to 1, all reflections are disabled.
|-
! has_detected_settings
| false || '''TODO: What does this do?'''
|-
! save_as_crunch
| false || Use the crunch library to convert textures. '''TODO: Does this do anything?'''
|-
! check_for_workshop_membership
| true || '''TODO: What does this do?'''
|-
! enable_live_update
| true || Enables automatic texture and script reloading when a change is detected.
|-
! level_load_stress
| false || '''TODO: What does this do?'''
|-
! detail_object_decals
| 1 || Apply decals to detail objects such as grass, small rocks etc.
|-
! asdebugger_enabled
| 0 || Activate the AngelScript debugger. '''TODO: What does this do more exactly?'''
|-
! asdebugger_break_on_script_change
| 0 || '''TODO: What does this do?'''
|-
! menu_show_asdebugger_contexts
| 0 || '''TODO: What does this do?'''
|-
! extra_data_path
| || Path to a directory containing a second Data folder that you want the game to use.
|}

===Keyboard and Mouse===
{| class="wikitable"
|-
! key[quit]
| esc || Exits from player mode into editor mode, and opens a menu allowing the user to return to the main menu.
|-
! key[slow]
| tab || Toggles slow motion.
|-
! key[fast]
| \ || '''TODO: Does this do anything?'''
|-
! key[crouch]
| lshift || Causes the player to crouch.
|-
! key[jump]
| space || Causes the player to jump.
|-
! key[show_timing]
| f2 || '''TODO: What does this do?'''
|-
! key[screenshot]
| f7 || Captures a screenshot (saved in ''/Data/Screenshots/'')
|-
! key[transparent_screenshot]
| f8 || Captures a screenshot in .png format where the sky and terrain is transparent.
|-
! key[console]
| ` || Deprecated, it pauses the game. But that doesn't have anything to do with the console.
|-
! key[left]
| a || Causes the player to move to the left.
|-
! key[right]
| d || Causes the player to move to the right.
|-
! key[up]
| w || Causes the player to move forward.
|-
! key[down]
| s || Causes the player to move backward.
|-
! key[item]
| e || Causes the player to sheathe or unsheathe a weapon.
|-
! key[drop]
| q || Causes the player to pick up a weapon. Holding left shift, looking down and pressing Q drops the held weapon.
|-
! key[skip_dialogue]
| return || Skips the currently active dialogue.
|-
! key[rclick]
| rshift || Alternate key used for "right clicking".
|}

=== Xbox controller ===
{| class="wikitable"
|-
! xbox_look_sensitivity
| 1.5 || Supposed to be the sensitivity of an attached Xbox controller, however it does nothing.
|-
! xbox[lookx]
| R_STICK_X || Xbox axis mapped for looking along the x-axis.
|-
! xbox[looky]
| R_STICK_Y || Xbox axis mapped for looking along the y-axis.
|-
! xbox[movex]
| R_STICK_X || Xbox axis mapped for movement along the x-axis.
|-
! xbox[movey]
| R_STICK_Y || Xbox axis mapped for movement along the y-axis.
|-
! xbox[jump]
| RB || Xbox jump button.
|-
! xbox[crouch]
| LB || Xbox crouch button.
|-
! xbox[attack]
| RT || Xbox attack button.
|-
! xbox[grab]
| LT || Xbox grab button.
|-
! xbox[item]
| A || Xbox item button.
|-
! xbox[drop]
| X || Xbox drop button.
|-
! xbox[skip_dialogue]
| START || Xbox skip currently acive dialogue.
|-
! xbox[quit]
| BACK || Xbox bring up menu or go back in menu.
|}

===Generic Controller===
{| class="wikitable"
|-
! controller[movex]
| axis1 || Controller axis mapped for movement along the x-axis.
|-
! controller[movey]
| axis2 || Controller axis mapped for movement along the y-axis.
|-
! controller[lookx]
| axis3 || Controller axis mapped for looking along the x-axis.
|-
! controller[looky]
| axis4 || Controller axis mapped for looking along the y-axis.
|-
! controller[jump]
| button11 || Controller jump button.
|-
! controller[crouch]
| button10 || Controller crouch button.
|-
! controller[item]
| button1 || Controller item button.
|-
! controller[drop]
| button3 || Controller drop button.
|-
! controller[attack]
| axis6>0.5 || Controller attack "button" (default mapping is set to an axis being less than half full in a negative direction).
|-
! controller[grab]
| axis5>0.5 || Controller grab "button" (default mapping is set to an axis being greater than half full in a positive direction).
|}

===Editor Hotkeys===

These keys only work when the editor is active. To activate the editor, press F1 when any level is loaded.

For more in-depth information on how to use the editor, read the [[Editor Interface]] article.

{| class="wikitable"
|-
! bind[pause]
| ` || Toggles freezing the time.
|-
! bind_win[quit]
| alt+f4 || Turns off the game.
|-
! bind_unix[quit]
| cmd+q || Turns off the game on Linux.
|-
! bind[back]
| esc || Opens or closes the menu, goes back in menu if it can.
|-
! bind[clone_transform]
| alt || Hold to clone an object when you transform (move, rotate or scale) it.
|-
! bind[snap_transform]
| ctrl || Hold to snap transformations to certain increments.
|-
! bind[force_rotate]
| r || Hold to activate the rotate tool.
|-
! bind[force_scale]
| e || Hold to activate the scale tool.
|-
! bind[force_translate]
| t || Hold to activate the move tool.
|-
! bind[normal_transform]
| shift || Hold to rotate/scale/translate on alternate axies.
|-
! bind[edit_script_params]
| u || Toggles showing the ''Selected'' window.
|-
! bind[single_selected]
| i || Toggles showing the ''Single Selected'' window.
|-
! bind[edit_color]
| cmd+p || Toggles the ''Color Picker'' window.
|-
! bind[search_scenegraph]
| cmd+f || Opens the ''Scenegraph'' window and focuses its search field.
|-
! bind[scenegraph]
| y || Opens the ''Scenegraph'' window.
|-
! bind[toggle_player]
| cmd+shift+p || Toggles whether the selected spawn points are player controlled or NPCs.
|-
! bind[toggle_object_editing]
| cmd+1 || Toggles whether you can edit static meshes.
|-
! bind[toggle_decal_editing]
| cmd+2 || Toggles whether you can edit decals.
|-
! bind[toggle_hotspot_editing]
| cmd+3 || Toggles whether you can edit gameplay objects.
|-
! bind[open_spawner]
| cmd+l || Deprecated, does nothing.
|-
! bind[save_level]
| cmd+s || Saves the level.
|-
! bind[save_selected_items]
| cmd+shift+s || Saves the selected items as a [[Prefabs|prefab]].
|-
! bind[cut]
| cmd+x || Saves the selected objects to the clipboard and then removes them.
|-
! bind[paste]
| cmd+v || Pastes whatever objects are in the clipboard on the mouse location.
|-
! bind[copy]
| cmd+c || Saves the selected objects to the clipboard.
|-
! bind[undo]
| cmd+z || Reverts the most recent edit.
|-
! bind[redo]
| cmd+shift+z || Reverts the most recently undo.
|-
! bind[enable_imposter]
| cmd+i || Deprecated, does nothing. '''TODO: Is this accurate?'''
|-
! bind[disable_imposter]
| cmd+shift+i || Deprecated, does nothing. '''TODO: Is this accurate?'''
|-
! bind[connect]
| alt || Hold and left click to connect the selected object to the clicked object. Is used for ''nav connection'' hotspots, ''Path Point'' hotspots, weapons etc.
|-
! bind[disconnect]
| shift+alt || Hold and left click to break an existing connection between the selected object and the clicked object.
|-
! bind[group]
| cmd+g || Groups the selected objects.
|-
! bind[ungroup]
| cmd+shift+g || Ungroups the selected group.
|-
! bind[box_select]
| b || Hold and left click and drag to create a selection box. When you release left click, all objects in the box are selected.
|-
! bind[deselect_all]
| q || Deselects any selected objects.
|-
! bind[select_all]
| cmd+a || Select all objects in the level.
|-
! bind[select_similar]
| cmd+shift+a || Select all objects that are similar to the selected object.
|-
! bind[add_to_selection]
| shift || Hold while selecting objects to add them to the selection.
|-
! bind[bake_gi]
| cmd+j || Deprecated, does nothing.
|-
! bind[kill_selected]
| cmd+k || Kill the selected character and instantly save its ragdoll position. Press the button combination again once the character has fallen to save the resting pose.
|-
! bind[print_objects]
| f11 || Print the selected objects to the log. '''TODO: Is this accurate?'''
|-
! bind[toggle_level_load_stress]
| f10 || '''TODO: Is this used? Maybe used in conjunction with the ''level_load_stress'' config setting?'''
|-
! bind[new_level]
| cmd+n || Does nothing.
|-
! bind[open_level]
| cmd+o || Does nothing.
|-
! bind[frame_selected]
| f || Frames the selected object so it's visible in the camera. Hold this button and rotate the camera to orbit around the object.
|-
! bind[frame_selected_force]
| shift+f || Same as frame_selected, but puts the camera closer.
|-
! bind[refresh]
| f5 || '''TODO: What does this do?'''
|}

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

==Controller Setup==

Most common controllers should work out of the box for Overgrowth. The control scheme is different from most games, but works well for Overgrowth's gameplay. If you want to change the controls you need to edit the config file. First make sure the game is turned off. Then find and open your [[#Config_File_Location|config file]], then edit the bindings in that file for [[#Xbox_controller|Xbox controller]] if you use that, otherwise [[#Generic_Controller|generic controller]].

After making your desired changes, save the file and open the game.

If you have problems with your controller on Mac, check out [http://forums.wolfire.com/viewtopic.php?f=13&t=12631 Anton's guide].

===Advanced Controller Setup===

If for some reason your controller isn't working properly with the game, here are some instructions for Windows 7 that might help you out:

First, make sure your controller is plugged in to your computer.

Next, open the start menu and click on ''Control Panel'' (located on the right side). Once opened, make sure the view is set to ''Large Icons'' (switchable in the upper right corner). Select ''Devices and Printers''.

You should see your controller listed under ''Devices''. Right click it, and select ''Game Controller Settings''. The ''Game Controllers'' window will appear. Make sure your controller is selected, then click on ''Properties''.

Once again, a new window should appear - make sure that the view is set to the ''Test'' tab. In this view, you will be able to determine which physical button is mapped to each virtual button. Play around with your controller to confirm that everything is working properly, and take note of the button mappings.

Now navigate to and open up your '''config.txt''' file (as described above). Rearrange the mappings in the file to match your desired controller setup.

Once you have everything modified, save the '''config.txt''' file and launch Overgrowth in order to test the new configuration.

Editor Interface

2023-05-18T03:33:31Z

Constance: /* Object Selection */ Added select similar

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

[[Image:Editor_Overview.png|right|600px|thumb|caption|The Overgrowth level editor]]
This page details all the interface elements and actions in the Overgrowth level editor.

The level editor lets you create new levels or even whole campaigns. This is the same editor we used to make the Overgrowth and Lugaru stories.

You can use the level editor to edit any existing level in the game.

== Activating the editor ==
{{#ev:youtube
|eS3RujmDQ2M
|
|right
|Level editor basics
|frame
|start=15
}}

==== To activate the editor: ====
* Create a new level ('''File''' -> '''New''')
* Open an existing level and press <kbd>'''F1'''</kbd>

If the editor is active while playing a level, you can open up the editor window again by pressing the <kbd>'''Esc'''</kbd> key.

You can deactivate the editor by hitting <kbd>'''F1'''</kbd> a second time.

==== Troubleshooting: ====
If you can't get the editor to activate, there are a few things you can try:
* If you have a laptop, try holding the <kbd>'''fn'''</kbd> key while pressing <kbd>'''F1'''</kbd>
* Mash all the modifier keys a few times to make sure they're not stuck down - <kbd>'''ctrl'''</kbd>, <kbd>'''alt'''</kbd>, <kbd>'''shift'''</kbd>, <kbd>'''command'''</kbd>, etc
* Make sure you have all other programs closed, in case one of them is conflicting with the <kbd>'''F1'''</kbd> hotkey
* If some "Help" program comes up when you hit <kbd>'''F1'''</kbd> (such as "HP Help"), edit its settings to disable the hotkey. Or just ''uninstall it'' (because it is bloatware)
 

== Camera Movement ==
{| class="wikitable"
|-
! Control !! Behavior
|-
! W
| Moves camera forward
|-
! S
| Moves camera backward
|-
! A
| Moves camera left
|-
! D
| Moves camera right
|-
! Shift + W
| Moves camera up
|-
! Shift + S
| Moves camera down
|-
! Left click and drag
| Rotates the camera
|}

== Object Selection ==

Here are the different ways you can select objects.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Select single object
| double-left-click on object || Selects clicked on object and deselects all other objects. If the object is part of a group, the whole group is selected. A box around the object indicates that it is selected.
|-
! Toggle-select objects
| shift + double-left-click on objects || Toggles selection of clicked on object. Preserves existing selections.
|-
! Box select objects
| left-click + right-click + drag, or left-click + 'b' + drag || Selects all objects whose centers lie within box drawn on screen. Deselects all other objects.
|-
! Box add to selection
| shift + left-click + right-click + drag, or shift + left-click + 'b' + drag || Adds all objects whose centers lie within the drawn box to the selection. Preserves existing selection.
|-
! Select decal or object that is under another decal
| mouse wheel up/down || When you have 2 or more objects or decals on top of each other, you can select at least 1 decal or object, put your mouse cursor on top of the one you want to select, then use the scroll wheel to switch your selection between the objects.
|-
! Select all
| cmd-a || Selects all objects.
|-
! Select similar
| cmd + shift + a || Selects objects of the same type as the currently selected object.
|-
! Deselect all
| double-left-click away from all objects, or press Q || Deselects all objects.
|}

[[Image:Editor-selection-debug-info.png|right|thumb|caption|Debug window]]

'''Note: ''' If the Debug window is open ('''Top Bar''' -> '''Windows''' -> '''Debug Window'''), then when you select an object some useful information will appear. It shows you what xml file the object is created from, its unique object id, and what type of object it is.

 

== Transformations ==

For all transformations:

* In order to transform an object you must first select it.
* Hold ctrl to make movements snap to half-meter increments.
* Hold alt to clone and transform the selected objects, leaving the original objects behind.
* Left-click transforms objects on all axis. Right-click transforms on the two axis that are perpendicular to the side of the bounding box you click on. Holding shift and right click locks the transformation to the axis parallel to the bounding box face you click on.
* Groups are transformed around the group center. Ungrouped objects, even if multiple are selected and transformed at once, are transformed around their own individual centers.

=== Translation ===

Hover mouse over central region of a bounding box' face, or hold 't'.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Camera relative
| left-click + drag || Translates clicked on object along plane parallel to the screen.
|-
! Locked to plane
| right-click + drag || Translates clicked on object along plane of clicked on face.
|-
! Locked to line
| shift + right-click + drag || Translates clicked on object along normal of clicked on face.
|-
! force decal(s) to map only one object/group
| hold i || selected decal will only map with that object that is directly underneath your mouse
|-
! force decal(s) to project only on selected objects
| press o || selected decal will only map with that object that is directly underneath your mouse
|-
! projection box/angle
| press p || to make projection box for decal
|}

=== Scale ===

Hover mouse near bounding box corners, or hold 'e'.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! All dimensions
| left-click + drag || Scales clicked on object in all dimensions (x, y, and z) at once.
|-
! Locked to plane
| right-click + drag || Extends clicked on object along plane of clicked on face.
|-
! Locked to line
| shift + right-click + drag || Extrudes clicked on object along normal of clicked on face.
|}

=== Mirror ===

Just use the right-click scale tool, and scale down the object until it flips and its mirror image begins scaling up!

=== Rotation ===

Hover mouse near bounding box edges but away from the corners, or hold 'r'.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Free
| left-click + drag || Rotates clicked on object as if you are pushing the surface of a ball.
|-
! Locked to axis
| right-click + drag || Rotates clicked on object about normal of clicked on face.
|}

==Editor/Debug Keys==

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Toggle editor mode
| F1 || Enables level editor. Press again to exit.
|-
! Activate play mode
| 8 || Spawns you in the level so you can play it. If there already is a player character you will control that, otherwise a player character spawn is created on the editor camera automatically.
|-
! Restore characters
| X || Restores all characters on the level to full health, wakes up any "unconscious" ones, and removes all blood from the environment.
|-
! Reload level
| L || Restarts the current level.
|-
! Change character
| 1-7 || Changes the playable character into one of seven possible characters. 1 cycles through rabbit guard, bandit, and turner models, 2 cycles through civilian rabbit models, 3 cycles through cat models, 4 cycles through rat models, 5 cycles through wolves, 6 through dogs, and the seventh is Rabbot 2.0.
|-
! Active ragdoll
| Z || Puts player character into active ragdoll mode where they will try to protect themselves as they fall. Is active as long as you hold the button.
|-
! Pain ragdoll
| N || Makes the player fall to the ground in agony, until you let go of the button.
|-
! Floppy ragdoll
| M || Makes the player fall to the ground, limp, until the button is released.
|-
! Voice Test
| V || Plays a test voice.
|-
! Toggle combat AI
| C || Toggles whether the characters in the level will attack each other if they are on different teams.
|-
! Slit throat
| , || The controlled character suffers a neck wound with blood gushing from it.
|-
! Slow time
| Tab || Slows down the whole game.
|-
! Freeze time
| ` || Freezes the game. This is useful for posing characters for item placement. '''Note''': The game must be unfrozen to change between controlling the player and editor mode.
|-
! Insta-kill
| F || Instantly kills and knocks back nearby NPC's with a death ray.
|-
! Experimental Key
| B || Makes you invisible.
|}

== Debug Window ==
[[Image:Editor-selection-debug-info.png|right|thumb|caption|Debug window]]
Just below the top bar menu, on the left side, is a space for debug information.

This window is only visible if you have the Debug Window enabled ('''Top Bar''' -> '''Windows''' -> '''Debug Window''').

It will tell you information about the selected object, checkpoint progress (if checkpoints are enabled in this level), and a warning if the nav mesh needs to be updated.

 

== Editor menu ==
The bar across the top of the window is the editor menu. Many editor functions can be found here, but some functions can only be reached via hotkeys for now.

'Cmd' refers to the '⌘' key on Macs, and the 'ctrl' key on PCs.

=== File menu ===
Contains file operations for loading and saving levels.

[[Image:Editor-file-menu.png|right|thumb|caption|The editor "file" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! New Level
| - || Opens a new empty level in the editor.
|-
! Open Level...
| - || Opens a file browser where you can pick what level to load (starts in Data/Levels directory).
|-
! Open Local Level...
| - || Opens a file browser where you can pick what level to load (starts in last used directory).
|-
! Open Recent
| - || Re-open one of the most recently opened levels in the editor.
|-
! Open Campaign Level
| - || Open one of the levels from the main Overgrowth story mode.
|-
! Save Level
| cmd+s || Overwrites the currently opened level file with any changes you made.
|-
! Save As...
| - || Opens a file browser where you can pick a new or existing file to save the level to.
|-
! Back to main menu
| - || Leave the editor and return to the main menu.
|-
! Quit
| alt+f4 || Quit the game.
|}

 

=== Edit menu ===
Contains basic editing functions. Also contains properties for the level.

[[Image:Editor-edit-menu.png|right|thumb|caption|The editor "edit" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Undo
| cmd+z || Undo the most recent action.
|-
! Redo
| cmd+shift+z || Redo the most recent action.
|-
! Cut
| cmd+x || Puts the selection into the clipboard and removes the selected objects.
|-
! Copy
| cmd+c || Puts the selection into the clipboard.
|-
! Paste
| cmd+v || Pastes the clipboard on the cursor position.
|-
! Select All
| cmd+a || Select all of the objects in the level.
|-
! Deselect All
| q || Clear the current selection.
|-
! Reload All Prefabs
| - || Force a reload of all prefab objects in the level.
|-
! Set Level Params...
| - || Set global level parameters (sun settings, sky, fog, HDR, etc).
|-
! Set Level Script...
| - || Select what script to use for this level.
|-
! Set Sky Texture...
| - || Opens a file browser where you can pick what sky texture to use.
|-
! Edit static meshes
| cmd+1 || Toggle ability to select non-moving objects (rocks, etc).
|-
! Edit decals
| cmd+2 || Toggle ability to select decals.
|-
! Edit gameplay objects
| cmd+3 || Toggle ability to select characters, hotspots, etc.
|-
! Edit lighting
| - || Toggle ability to select lights.
|-
! Play level
| 8 || Enter play mode.
|-
! Media mode
| - || Enter a disembodied camera mode, for taking screenshots and videos.
|}

=== Selected menu ===
Contains operations for working with the current selected objects.

[[Image:Editor-selected-menu.png|right|thumb|caption|The editor "selected" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Go To Selected
| f || Move the camera to frame the selected objects.
|-
! Delete
| backspace || Delete the selected objects from the level.
|-
! Group
| cmd+g || Merge the selected objects into a group.
|-
! Ungroup
| cmd+shift+g || Break up all groups that are selected.
|-
! Set Selection Script Params...
| - || Open up the selected object window, and expand the "Script Params" section for the selected objects.
|-
! Save Selection...
| cmd+shift+s || Open up the file browser to save the selection as an object template.
Object templates can be loaded like any other object. Script params, transform, and connections are saved.
If you save over a template, it won't be updated in any level it is placed in.
|-
! Prefab Save
| - || Save any changes to the selected prefab to a file, or create a new prefab file from the selection.
Object prefabs can be loaded like any other object. Script params, transform, and connections are saved.
If you save over a prefab, it will automatically be updated in all levels it is placed in.
|-
! Prefab Save As...
| - || Open a file browser to save the selection as a new prefab file.
Object prefabs can be loaded like any other object. Script params, transform, and connections are saved.
If you save over a prefab, it will automatically be updated in all levels it is placed in.
|}

=== Load menu ===
Contains operations for loading and spawning objects into the level.

[[Image:Editor-load-menu.png|right|thumb|caption|The editor "load" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Load item...
| - || Open a file browser to pick an item to spawn in. After loading, click in the level to spawn the object.
|-
! Open recent...
| - || Pick an item you've recently spawned to spawn another instance. After loading, click in the level to spawn the object.
|-
! <Rest of menu>
| - || Search or click on an item from a list to spawn in. After loading, click in the level to spawn the object.
Hover over an item to see a thumbnail preview of the item.
|}

 

=== Nav Mesh menu ===
Tools for nav mesh generation, loading, saving and viewing.

[[Image:Editor-navmesh-menu.png|right|thumb|caption|The editor "nav mesh" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Create
| - || Generates a new navigation mesh.
|-
! Save
| - || Save the current nav mesh to disk.
|-
! Load
| - || Load a previously saved nav mesh from disk.
|-
! View mesh
| - || Toggle preview render of the nav mesh.
|-
! View collision
| - || Toggle preview render of the collision mesh the nav mesh is based on.
|-
! View hints
| - || Toggle preview render of navmesh_hint objects (which are collision that is only visible to the nav mesh generator).
|-
! View region
| - || Toggle preview render of navmesh_region objects (which restricts mesh generation to within its volume).
|-
! View jump nodes
| - || Toggle preview render of navmesh_connection objects (jump nodes).
|-
! Cell Size
| - || Change the width of cells in the nav mesh
smaller: handles smaller gaps, slower to build.
|-
! Cell Height
| - || Change the height of cells in the nav mesh
smaller: finer control on ramps, slower to build.
|-
! Agent Height
| - || Change the height of fake player used to create nav mesh
smaller: handles lower overhangs, more likely to be unreachable by real characters.
|-
! Agent Radius
| - || Change the width of fake player used to create nav mesh
smaller: handles smaller gaps, more likely to be unreachable by real characters.
|-
! Agent Max Climb
| - || Change the max height of blocks that fake player will climb to create nav mesh
too high: real characters can't climb it.
|-
! Agent Max Slope
| - || Change the max angle of ramps that fake player will walk up to create nav mesh
too high: real characters will go up steep hills.
|}

=== Dialogue menu ===
Tools for [[dialogue]] editing.

[[Image:Editor-dialogue-menu.png|right|thumb|caption|The editor "dialogue" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Edit Selected
| o || Start editing the selected dialogue (make sure you select it first!).
|-
! Load Dialogue
| - || Load a previously saved dialogue text file.
|-
! New Dialogue
| - || Create a new dialogue object (click this, then click to place it in the level).
|}

 

=== Windows menu ===
Launch various editor windows, color picker, and debug windows.

[[Image:Editor-windows-menu.png|right|thumb|caption|The editor "windows" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Scenegraph
| y || Open level properties, and a searchable list of items in the level.
Hint: Click items in the list to select/deselect them, and hit F to view the selected items.
|-
! Selected
| u || Open the properties for the selected objects.
|-
! [[#Color_Picker|Color Picker]]
| cmd+p || Open the Color Picker to let you tint objects.
|-
! [[Collision Painting|Collision Paint]]
| - || Open the Collision Paint menu to let you edit physics properties on objects or individual surfaces.
|-
! Performance
| - || Open a window to monitor performance, and view a list of loaded file assets/loaded textures, for debugging.
|-
! Save
| - || Open a window to view data in the save file, for debugging.
|-
! State
| - || Open a window to view a hierarchy of loaded script contexts, for debugging.
|-
! Sound
| - || Open a window to view a list of loaded sounds, for debugging.
|-
! Debug Window
| - || Open a window to view debug text (shows various game and editor state).
|}

== Functions Without Buttons ==
Some functions are only reachable via hotkeys, here are a list of those.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Make player-controlled
| Shift+Cmd+P || Toggles whether a character is controlled by a human or by AI. A human-controlled character's spawn box has a green outline, an AI-controlled character's box has white outlines. If two characters are set to be human-controlled Overgrowth will start in split-screen mode the next time game-play is resumed from editor mode. The second player will be controllable via a USB controller.
|-
! [[#Spawn_Dead|Spawn Dead]]
| Cmd+K or Ctrl+K (with character spawn selected) || Makes selected characters spawn dead. It will spawn at the point it went into ragdoll mode (which may cause it to spawn "dead" while standing up). If you want to update the pose for the dead body then move the body, select the spawn point, and hit the hotkey again to save its new position.
|-
! [[#Spawn_Alive|Spawn Alive]]
| K (with character spawn selected) || Makes selected characters spawn alive.
|}

== Parameters ==
Every object as well as the level itself has several parameters. The most basic ones that all objects have are '''Name''', '''Translation''', '''Scale''' and '''Rotation'''. Other parameters you might find on an object are color tints and [[Script Parameters]].

There are several ways to edit these parameters for an object. The fastest and easiest way to do it for a single object is by using the '''Single Selected''' window (press I to open it), which shows all of the parameters for the most recently selected object.

If you want to view or edit the parameters of several specific objects you can use the [[#Selected Window|Selected Window]].

To view and edit parameters for all the objects in the level, as well as the parameters for the level itself, use the [[#Scenegraph Window|Scenegraph Window]].

== Selected Window ==
[[Image:Editor-selection-windows.png|right|thumb|caption|Selected Window (object parameters)]]

The Selected Window (or parameter editor) lets you change different parameters depending on which objects you have selected.

You can bring up the parameter editor for an object (or set of objects) by selecting them and pressing the U key, or clicking Top Bar -> Windows -> Selected.

Here is a description of what each parameter does:

{| class="wikitable"
|-
! Parameter !! Description
|-
! Name
| Give an object a custom name, so you can find it in the scenegraph window (see below), or let a custom script find those objects so they can do special things to them.
|-
! Transform
| Adjust the position, rotation, and scale of the objects manually. There is also a button to reset the rotation (which is useful when creating object prefabs).
|-
! Color Palette
| Tint objects, or make them super bright. If the character provides a mutli-part color palette, set different colors on different parts.
|-
! Script Params
| Custom parameters used by scripts. Each different object type can define their own script params. See [[Script Parameters]] page for descriptions of all parameters.
|}

 

== Scenegraph Window ==
[[Image:Editor-scenegraph-window.png|right|thumb|caption|Scenegraph Window (level parameters)]]

The Scenegraph Window (or parameter editor) lets you change global level parameters, as well as find objects in the level.

Open up the Scenegraph for the current level by pressing the Y key, or clicking Top Bar -> Windows -> Scenegraph. Let's go through each part of the Scenegraph window from top to bottom.

=== Level ===
If you expand the '''Level''' entry at the very top of the window you will find some parameters that can be changed:
{| class="wikitable"
|-
! Parameter !! Description
|-
! Loading Screen Image
| A path to an image that's shown while loading the level
|-
! Sun Position
| The position of the sun in the sky
|-
! Sun Color
| Tints the color of the sun, useful for sunrises and sunsets
|-
! Sun Intensity
| Controls how dark the shadows are
|}

For a description of the level script parameters, see the [[Script Parameters]] page.

=== Search field ===
Below the '''Level''' entry at the very top there is a search field. Write in this field to search for objects in the level. This searches in many of the objects' fields. You can for instance search for something written in the '''Name''' parameter of an object, object IDs, object paths, types and more.

=== Flat ===
The '''Flat''' checkbox controls how the Scenegraph list is displayed.

If it's not checked you can expand groups to see the relations between objects in the graph.

If it's checked you can no longer see group relationships, but you can instead expand each individual object to change any parameters associated with it.

=== Named Only ===
If this is checked the Scenegraph list with only display objects that have been named. You can name an object by selecting it, bringing up the '''Single Selected''' window by pressing I, and then writing something in the '''Name''' field.

== Color Picker ==
[[Image:Editor-new-color-picker.png|right|thumb|caption|A crete block with its color altered by the color picker.]]
The Color Picker is used to tint the color of selected objects.

It is opened by pressing cmd+p, or Top Bar -> Windows -> ColorPicker.

The color picker consists of a color-gradient box, a rainbow slider, the RGB values, and an overbrightness slider. Increasing overbrightness makes the color brighter, and makes it glow in the dark.

For characters, the color picker will let you set the color of different parts of the character. This is only available if the character was built to support a multi-color palette (not all of them do).

'''TODO''': Update screenshot on the right

 

== Sun Editor ==
[[Image:Sun_editor.jpg|right|thumb|caption|The sun editor]]

The sun allows you to cast dynamic, single-directional light throughout a level. 
You can use it to simulate either a sun (more direct light) or a moon (more ambient light)

See [[Lighting#Sunlight|the documentation on the lighting page]] for more information.

 

== Dialogue Editor ==

The [[Dialogue Editor]] is used to create scenes with different camera angles, text and poses. It is commonly used to give context and progress the story in a level.

This is a big enough subject to warrant its own article, which can be found [[Dialogue Editor|here]].

== Spawn Corpse ==
Sometimes you want to have a dead character in your level. The obvious solution would be to export a new model of a dead character and place it in the level. However, that's a lot of work, and the character wouldn't be dynamic, and it would take a lot of work to make changes to it.

Luckily there is a system in the engine for making any character spawn as a corpse. Here are instructions for how to use that system:

[[Image:spawn_corpse.jpg|right|thumb|caption|Making a corpse]]
# Spawn the character you want to spawn as a corpse.
# Select its spawn box and press cmd or ctrl + K to make it spawn as a corpse, which will kill it. At this point the corpse will spawn standing up when you restart the level with L, we'll fix that in the following steps.
# Enter play mode by pressing 8, go close to the corpse and hold right click to drag it around until you're satisfied with the pose.
# Now exit play mode by pressing escape, select the character's spawn box and press cmd+K again to update the pose of the corpse.
# Press L to restart the level and verify that it worked.

If you want to make a corpse to spawn alive again, select its spawn point and press K.

Editor Interface

2023-05-18T03:31:12Z

Constance: /* Dialogue menu */ Made hotkey lowercase

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

[[Image:Editor_Overview.png|right|600px|thumb|caption|The Overgrowth level editor]]
This page details all the interface elements and actions in the Overgrowth level editor.

The level editor lets you create new levels or even whole campaigns. This is the same editor we used to make the Overgrowth and Lugaru stories.

You can use the level editor to edit any existing level in the game.

== Activating the editor ==
{{#ev:youtube
|eS3RujmDQ2M
|
|right
|Level editor basics
|frame
|start=15
}}

==== To activate the editor: ====
* Create a new level ('''File''' -> '''New''')
* Open an existing level and press <kbd>'''F1'''</kbd>

If the editor is active while playing a level, you can open up the editor window again by pressing the <kbd>'''Esc'''</kbd> key.

You can deactivate the editor by hitting <kbd>'''F1'''</kbd> a second time.

==== Troubleshooting: ====
If you can't get the editor to activate, there are a few things you can try:
* If you have a laptop, try holding the <kbd>'''fn'''</kbd> key while pressing <kbd>'''F1'''</kbd>
* Mash all the modifier keys a few times to make sure they're not stuck down - <kbd>'''ctrl'''</kbd>, <kbd>'''alt'''</kbd>, <kbd>'''shift'''</kbd>, <kbd>'''command'''</kbd>, etc
* Make sure you have all other programs closed, in case one of them is conflicting with the <kbd>'''F1'''</kbd> hotkey
* If some "Help" program comes up when you hit <kbd>'''F1'''</kbd> (such as "HP Help"), edit its settings to disable the hotkey. Or just ''uninstall it'' (because it is bloatware)
 

== Camera Movement ==
{| class="wikitable"
|-
! Control !! Behavior
|-
! W
| Moves camera forward
|-
! S
| Moves camera backward
|-
! A
| Moves camera left
|-
! D
| Moves camera right
|-
! Shift + W
| Moves camera up
|-
! Shift + S
| Moves camera down
|-
! Left click and drag
| Rotates the camera
|}

== Object Selection ==

Here are the different ways you can select objects.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Select single object
| double-left-click on object || Selects clicked on object and deselects all other objects. If the object is part of a group, the whole group is selected. A box around the object indicates that it is selected.
|-
! Toggle-select objects
| shift + double-left-click on objects || Toggles selection of clicked on object. Preserves existing selections.
|-
! Box select objects
| left-click + right-click + drag, or left-click + 'b' + drag || Selects all objects whose centers lie within box drawn on screen. Deselects all other objects.
|-
! Box add to selection
| shift + left-click + right-click + drag, or shift + left-click + 'b' + drag || Adds all objects whose centers lie within the drawn box to the selection. Preserves existing selection.
|-
! Select decal or object that is under another decal
| mouse wheel up/down || When you have 2 or more objects or decals on top of each other, you can select at least 1 decal or object, put your mouse cursor on top of the one you want to select, then use the scroll wheel to switch your selection between the objects.
|-
! Select all
| cmd-a || Selects all objects.
|-
! Deselect all
| double-left-click away from all objects, or press Q || Deselects all objects.
|}

[[Image:Editor-selection-debug-info.png|right|thumb|caption|Debug window]]

'''Note: ''' If the Debug window is open ('''Top Bar''' -> '''Windows''' -> '''Debug Window'''), then when you select an object some useful information will appear. It shows you what xml file the object is created from, its unique object id, and what type of object it is.

 

== Transformations ==

For all transformations:

* In order to transform an object you must first select it.
* Hold ctrl to make movements snap to half-meter increments.
* Hold alt to clone and transform the selected objects, leaving the original objects behind.
* Left-click transforms objects on all axis. Right-click transforms on the two axis that are perpendicular to the side of the bounding box you click on. Holding shift and right click locks the transformation to the axis parallel to the bounding box face you click on.
* Groups are transformed around the group center. Ungrouped objects, even if multiple are selected and transformed at once, are transformed around their own individual centers.

=== Translation ===

Hover mouse over central region of a bounding box' face, or hold 't'.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Camera relative
| left-click + drag || Translates clicked on object along plane parallel to the screen.
|-
! Locked to plane
| right-click + drag || Translates clicked on object along plane of clicked on face.
|-
! Locked to line
| shift + right-click + drag || Translates clicked on object along normal of clicked on face.
|-
! force decal(s) to map only one object/group
| hold i || selected decal will only map with that object that is directly underneath your mouse
|-
! force decal(s) to project only on selected objects
| press o || selected decal will only map with that object that is directly underneath your mouse
|-
! projection box/angle
| press p || to make projection box for decal
|}

=== Scale ===

Hover mouse near bounding box corners, or hold 'e'.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! All dimensions
| left-click + drag || Scales clicked on object in all dimensions (x, y, and z) at once.
|-
! Locked to plane
| right-click + drag || Extends clicked on object along plane of clicked on face.
|-
! Locked to line
| shift + right-click + drag || Extrudes clicked on object along normal of clicked on face.
|}

=== Mirror ===

Just use the right-click scale tool, and scale down the object until it flips and its mirror image begins scaling up!

=== Rotation ===

Hover mouse near bounding box edges but away from the corners, or hold 'r'.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Free
| left-click + drag || Rotates clicked on object as if you are pushing the surface of a ball.
|-
! Locked to axis
| right-click + drag || Rotates clicked on object about normal of clicked on face.
|}

==Editor/Debug Keys==

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Toggle editor mode
| F1 || Enables level editor. Press again to exit.
|-
! Activate play mode
| 8 || Spawns you in the level so you can play it. If there already is a player character you will control that, otherwise a player character spawn is created on the editor camera automatically.
|-
! Restore characters
| X || Restores all characters on the level to full health, wakes up any "unconscious" ones, and removes all blood from the environment.
|-
! Reload level
| L || Restarts the current level.
|-
! Change character
| 1-7 || Changes the playable character into one of seven possible characters. 1 cycles through rabbit guard, bandit, and turner models, 2 cycles through civilian rabbit models, 3 cycles through cat models, 4 cycles through rat models, 5 cycles through wolves, 6 through dogs, and the seventh is Rabbot 2.0.
|-
! Active ragdoll
| Z || Puts player character into active ragdoll mode where they will try to protect themselves as they fall. Is active as long as you hold the button.
|-
! Pain ragdoll
| N || Makes the player fall to the ground in agony, until you let go of the button.
|-
! Floppy ragdoll
| M || Makes the player fall to the ground, limp, until the button is released.
|-
! Voice Test
| V || Plays a test voice.
|-
! Toggle combat AI
| C || Toggles whether the characters in the level will attack each other if they are on different teams.
|-
! Slit throat
| , || The controlled character suffers a neck wound with blood gushing from it.
|-
! Slow time
| Tab || Slows down the whole game.
|-
! Freeze time
| ` || Freezes the game. This is useful for posing characters for item placement. '''Note''': The game must be unfrozen to change between controlling the player and editor mode.
|-
! Insta-kill
| F || Instantly kills and knocks back nearby NPC's with a death ray.
|-
! Experimental Key
| B || Makes you invisible.
|}

== Debug Window ==
[[Image:Editor-selection-debug-info.png|right|thumb|caption|Debug window]]
Just below the top bar menu, on the left side, is a space for debug information.

This window is only visible if you have the Debug Window enabled ('''Top Bar''' -> '''Windows''' -> '''Debug Window''').

It will tell you information about the selected object, checkpoint progress (if checkpoints are enabled in this level), and a warning if the nav mesh needs to be updated.

 

== Editor menu ==
The bar across the top of the window is the editor menu. Many editor functions can be found here, but some functions can only be reached via hotkeys for now.

'Cmd' refers to the '⌘' key on Macs, and the 'ctrl' key on PCs.

=== File menu ===
Contains file operations for loading and saving levels.

[[Image:Editor-file-menu.png|right|thumb|caption|The editor "file" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! New Level
| - || Opens a new empty level in the editor.
|-
! Open Level...
| - || Opens a file browser where you can pick what level to load (starts in Data/Levels directory).
|-
! Open Local Level...
| - || Opens a file browser where you can pick what level to load (starts in last used directory).
|-
! Open Recent
| - || Re-open one of the most recently opened levels in the editor.
|-
! Open Campaign Level
| - || Open one of the levels from the main Overgrowth story mode.
|-
! Save Level
| cmd+s || Overwrites the currently opened level file with any changes you made.
|-
! Save As...
| - || Opens a file browser where you can pick a new or existing file to save the level to.
|-
! Back to main menu
| - || Leave the editor and return to the main menu.
|-
! Quit
| alt+f4 || Quit the game.
|}

 

=== Edit menu ===
Contains basic editing functions. Also contains properties for the level.

[[Image:Editor-edit-menu.png|right|thumb|caption|The editor "edit" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Undo
| cmd+z || Undo the most recent action.
|-
! Redo
| cmd+shift+z || Redo the most recent action.
|-
! Cut
| cmd+x || Puts the selection into the clipboard and removes the selected objects.
|-
! Copy
| cmd+c || Puts the selection into the clipboard.
|-
! Paste
| cmd+v || Pastes the clipboard on the cursor position.
|-
! Select All
| cmd+a || Select all of the objects in the level.
|-
! Deselect All
| q || Clear the current selection.
|-
! Reload All Prefabs
| - || Force a reload of all prefab objects in the level.
|-
! Set Level Params...
| - || Set global level parameters (sun settings, sky, fog, HDR, etc).
|-
! Set Level Script...
| - || Select what script to use for this level.
|-
! Set Sky Texture...
| - || Opens a file browser where you can pick what sky texture to use.
|-
! Edit static meshes
| cmd+1 || Toggle ability to select non-moving objects (rocks, etc).
|-
! Edit decals
| cmd+2 || Toggle ability to select decals.
|-
! Edit gameplay objects
| cmd+3 || Toggle ability to select characters, hotspots, etc.
|-
! Edit lighting
| - || Toggle ability to select lights.
|-
! Play level
| 8 || Enter play mode.
|-
! Media mode
| - || Enter a disembodied camera mode, for taking screenshots and videos.
|}

=== Selected menu ===
Contains operations for working with the current selected objects.

[[Image:Editor-selected-menu.png|right|thumb|caption|The editor "selected" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Go To Selected
| f || Move the camera to frame the selected objects.
|-
! Delete
| backspace || Delete the selected objects from the level.
|-
! Group
| cmd+g || Merge the selected objects into a group.
|-
! Ungroup
| cmd+shift+g || Break up all groups that are selected.
|-
! Set Selection Script Params...
| - || Open up the selected object window, and expand the "Script Params" section for the selected objects.
|-
! Save Selection...
| cmd+shift+s || Open up the file browser to save the selection as an object template.
Object templates can be loaded like any other object. Script params, transform, and connections are saved.
If you save over a template, it won't be updated in any level it is placed in.
|-
! Prefab Save
| - || Save any changes to the selected prefab to a file, or create a new prefab file from the selection.
Object prefabs can be loaded like any other object. Script params, transform, and connections are saved.
If you save over a prefab, it will automatically be updated in all levels it is placed in.
|-
! Prefab Save As...
| - || Open a file browser to save the selection as a new prefab file.
Object prefabs can be loaded like any other object. Script params, transform, and connections are saved.
If you save over a prefab, it will automatically be updated in all levels it is placed in.
|}

=== Load menu ===
Contains operations for loading and spawning objects into the level.

[[Image:Editor-load-menu.png|right|thumb|caption|The editor "load" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Load item...
| - || Open a file browser to pick an item to spawn in. After loading, click in the level to spawn the object.
|-
! Open recent...
| - || Pick an item you've recently spawned to spawn another instance. After loading, click in the level to spawn the object.
|-
! <Rest of menu>
| - || Search or click on an item from a list to spawn in. After loading, click in the level to spawn the object.
Hover over an item to see a thumbnail preview of the item.
|}

 

=== Nav Mesh menu ===
Tools for nav mesh generation, loading, saving and viewing.

[[Image:Editor-navmesh-menu.png|right|thumb|caption|The editor "nav mesh" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Create
| - || Generates a new navigation mesh.
|-
! Save
| - || Save the current nav mesh to disk.
|-
! Load
| - || Load a previously saved nav mesh from disk.
|-
! View mesh
| - || Toggle preview render of the nav mesh.
|-
! View collision
| - || Toggle preview render of the collision mesh the nav mesh is based on.
|-
! View hints
| - || Toggle preview render of navmesh_hint objects (which are collision that is only visible to the nav mesh generator).
|-
! View region
| - || Toggle preview render of navmesh_region objects (which restricts mesh generation to within its volume).
|-
! View jump nodes
| - || Toggle preview render of navmesh_connection objects (jump nodes).
|-
! Cell Size
| - || Change the width of cells in the nav mesh
smaller: handles smaller gaps, slower to build.
|-
! Cell Height
| - || Change the height of cells in the nav mesh
smaller: finer control on ramps, slower to build.
|-
! Agent Height
| - || Change the height of fake player used to create nav mesh
smaller: handles lower overhangs, more likely to be unreachable by real characters.
|-
! Agent Radius
| - || Change the width of fake player used to create nav mesh
smaller: handles smaller gaps, more likely to be unreachable by real characters.
|-
! Agent Max Climb
| - || Change the max height of blocks that fake player will climb to create nav mesh
too high: real characters can't climb it.
|-
! Agent Max Slope
| - || Change the max angle of ramps that fake player will walk up to create nav mesh
too high: real characters will go up steep hills.
|}

=== Dialogue menu ===
Tools for [[dialogue]] editing.

[[Image:Editor-dialogue-menu.png|right|thumb|caption|The editor "dialogue" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Edit Selected
| o || Start editing the selected dialogue (make sure you select it first!).
|-
! Load Dialogue
| - || Load a previously saved dialogue text file.
|-
! New Dialogue
| - || Create a new dialogue object (click this, then click to place it in the level).
|}

 

=== Windows menu ===
Launch various editor windows, color picker, and debug windows.

[[Image:Editor-windows-menu.png|right|thumb|caption|The editor "windows" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Scenegraph
| y || Open level properties, and a searchable list of items in the level.
Hint: Click items in the list to select/deselect them, and hit F to view the selected items.
|-
! Selected
| u || Open the properties for the selected objects.
|-
! [[#Color_Picker|Color Picker]]
| cmd+p || Open the Color Picker to let you tint objects.
|-
! [[Collision Painting|Collision Paint]]
| - || Open the Collision Paint menu to let you edit physics properties on objects or individual surfaces.
|-
! Performance
| - || Open a window to monitor performance, and view a list of loaded file assets/loaded textures, for debugging.
|-
! Save
| - || Open a window to view data in the save file, for debugging.
|-
! State
| - || Open a window to view a hierarchy of loaded script contexts, for debugging.
|-
! Sound
| - || Open a window to view a list of loaded sounds, for debugging.
|-
! Debug Window
| - || Open a window to view debug text (shows various game and editor state).
|}

== Functions Without Buttons ==
Some functions are only reachable via hotkeys, here are a list of those.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Make player-controlled
| Shift+Cmd+P || Toggles whether a character is controlled by a human or by AI. A human-controlled character's spawn box has a green outline, an AI-controlled character's box has white outlines. If two characters are set to be human-controlled Overgrowth will start in split-screen mode the next time game-play is resumed from editor mode. The second player will be controllable via a USB controller.
|-
! [[#Spawn_Dead|Spawn Dead]]
| Cmd+K or Ctrl+K (with character spawn selected) || Makes selected characters spawn dead. It will spawn at the point it went into ragdoll mode (which may cause it to spawn "dead" while standing up). If you want to update the pose for the dead body then move the body, select the spawn point, and hit the hotkey again to save its new position.
|-
! [[#Spawn_Alive|Spawn Alive]]
| K (with character spawn selected) || Makes selected characters spawn alive.
|}

== Parameters ==
Every object as well as the level itself has several parameters. The most basic ones that all objects have are '''Name''', '''Translation''', '''Scale''' and '''Rotation'''. Other parameters you might find on an object are color tints and [[Script Parameters]].

There are several ways to edit these parameters for an object. The fastest and easiest way to do it for a single object is by using the '''Single Selected''' window (press I to open it), which shows all of the parameters for the most recently selected object.

If you want to view or edit the parameters of several specific objects you can use the [[#Selected Window|Selected Window]].

To view and edit parameters for all the objects in the level, as well as the parameters for the level itself, use the [[#Scenegraph Window|Scenegraph Window]].

== Selected Window ==
[[Image:Editor-selection-windows.png|right|thumb|caption|Selected Window (object parameters)]]

The Selected Window (or parameter editor) lets you change different parameters depending on which objects you have selected.

You can bring up the parameter editor for an object (or set of objects) by selecting them and pressing the U key, or clicking Top Bar -> Windows -> Selected.

Here is a description of what each parameter does:

{| class="wikitable"
|-
! Parameter !! Description
|-
! Name
| Give an object a custom name, so you can find it in the scenegraph window (see below), or let a custom script find those objects so they can do special things to them.
|-
! Transform
| Adjust the position, rotation, and scale of the objects manually. There is also a button to reset the rotation (which is useful when creating object prefabs).
|-
! Color Palette
| Tint objects, or make them super bright. If the character provides a mutli-part color palette, set different colors on different parts.
|-
! Script Params
| Custom parameters used by scripts. Each different object type can define their own script params. See [[Script Parameters]] page for descriptions of all parameters.
|}

 

== Scenegraph Window ==
[[Image:Editor-scenegraph-window.png|right|thumb|caption|Scenegraph Window (level parameters)]]

The Scenegraph Window (or parameter editor) lets you change global level parameters, as well as find objects in the level.

Open up the Scenegraph for the current level by pressing the Y key, or clicking Top Bar -> Windows -> Scenegraph. Let's go through each part of the Scenegraph window from top to bottom.

=== Level ===
If you expand the '''Level''' entry at the very top of the window you will find some parameters that can be changed:
{| class="wikitable"
|-
! Parameter !! Description
|-
! Loading Screen Image
| A path to an image that's shown while loading the level
|-
! Sun Position
| The position of the sun in the sky
|-
! Sun Color
| Tints the color of the sun, useful for sunrises and sunsets
|-
! Sun Intensity
| Controls how dark the shadows are
|}

For a description of the level script parameters, see the [[Script Parameters]] page.

=== Search field ===
Below the '''Level''' entry at the very top there is a search field. Write in this field to search for objects in the level. This searches in many of the objects' fields. You can for instance search for something written in the '''Name''' parameter of an object, object IDs, object paths, types and more.

=== Flat ===
The '''Flat''' checkbox controls how the Scenegraph list is displayed.

If it's not checked you can expand groups to see the relations between objects in the graph.

If it's checked you can no longer see group relationships, but you can instead expand each individual object to change any parameters associated with it.

=== Named Only ===
If this is checked the Scenegraph list with only display objects that have been named. You can name an object by selecting it, bringing up the '''Single Selected''' window by pressing I, and then writing something in the '''Name''' field.

== Color Picker ==
[[Image:Editor-new-color-picker.png|right|thumb|caption|A crete block with its color altered by the color picker.]]
The Color Picker is used to tint the color of selected objects.

It is opened by pressing cmd+p, or Top Bar -> Windows -> ColorPicker.

The color picker consists of a color-gradient box, a rainbow slider, the RGB values, and an overbrightness slider. Increasing overbrightness makes the color brighter, and makes it glow in the dark.

For characters, the color picker will let you set the color of different parts of the character. This is only available if the character was built to support a multi-color palette (not all of them do).

'''TODO''': Update screenshot on the right

 

== Sun Editor ==
[[Image:Sun_editor.jpg|right|thumb|caption|The sun editor]]

The sun allows you to cast dynamic, single-directional light throughout a level. 
You can use it to simulate either a sun (more direct light) or a moon (more ambient light)

See [[Lighting#Sunlight|the documentation on the lighting page]] for more information.

 

== Dialogue Editor ==

The [[Dialogue Editor]] is used to create scenes with different camera angles, text and poses. It is commonly used to give context and progress the story in a level.

This is a big enough subject to warrant its own article, which can be found [[Dialogue Editor|here]].

== Spawn Corpse ==
Sometimes you want to have a dead character in your level. The obvious solution would be to export a new model of a dead character and place it in the level. However, that's a lot of work, and the character wouldn't be dynamic, and it would take a lot of work to make changes to it.

Luckily there is a system in the engine for making any character spawn as a corpse. Here are instructions for how to use that system:

[[Image:spawn_corpse.jpg|right|thumb|caption|Making a corpse]]
# Spawn the character you want to spawn as a corpse.
# Select its spawn box and press cmd or ctrl + K to make it spawn as a corpse, which will kill it. At this point the corpse will spawn standing up when you restart the level with L, we'll fix that in the following steps.
# Enter play mode by pressing 8, go close to the corpse and hold right click to drag it around until you're satisfied with the pose.
# Now exit play mode by pressing escape, select the character's spawn box and press cmd+K again to update the pose of the corpse.
# Press L to restart the level and verify that it worked.

If you want to make a corpse to spawn alive again, select its spawn point and press K.

Editor Interface

2023-05-18T03:30:36Z

Constance: /* Windows menu */ Removed unused single selected bind

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

[[Image:Editor_Overview.png|right|600px|thumb|caption|The Overgrowth level editor]]
This page details all the interface elements and actions in the Overgrowth level editor.

The level editor lets you create new levels or even whole campaigns. This is the same editor we used to make the Overgrowth and Lugaru stories.

You can use the level editor to edit any existing level in the game.

== Activating the editor ==
{{#ev:youtube
|eS3RujmDQ2M
|
|right
|Level editor basics
|frame
|start=15
}}

==== To activate the editor: ====
* Create a new level ('''File''' -> '''New''')
* Open an existing level and press <kbd>'''F1'''</kbd>

If the editor is active while playing a level, you can open up the editor window again by pressing the <kbd>'''Esc'''</kbd> key.

You can deactivate the editor by hitting <kbd>'''F1'''</kbd> a second time.

==== Troubleshooting: ====
If you can't get the editor to activate, there are a few things you can try:
* If you have a laptop, try holding the <kbd>'''fn'''</kbd> key while pressing <kbd>'''F1'''</kbd>
* Mash all the modifier keys a few times to make sure they're not stuck down - <kbd>'''ctrl'''</kbd>, <kbd>'''alt'''</kbd>, <kbd>'''shift'''</kbd>, <kbd>'''command'''</kbd>, etc
* Make sure you have all other programs closed, in case one of them is conflicting with the <kbd>'''F1'''</kbd> hotkey
* If some "Help" program comes up when you hit <kbd>'''F1'''</kbd> (such as "HP Help"), edit its settings to disable the hotkey. Or just ''uninstall it'' (because it is bloatware)
 

== Camera Movement ==
{| class="wikitable"
|-
! Control !! Behavior
|-
! W
| Moves camera forward
|-
! S
| Moves camera backward
|-
! A
| Moves camera left
|-
! D
| Moves camera right
|-
! Shift + W
| Moves camera up
|-
! Shift + S
| Moves camera down
|-
! Left click and drag
| Rotates the camera
|}

== Object Selection ==

Here are the different ways you can select objects.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Select single object
| double-left-click on object || Selects clicked on object and deselects all other objects. If the object is part of a group, the whole group is selected. A box around the object indicates that it is selected.
|-
! Toggle-select objects
| shift + double-left-click on objects || Toggles selection of clicked on object. Preserves existing selections.
|-
! Box select objects
| left-click + right-click + drag, or left-click + 'b' + drag || Selects all objects whose centers lie within box drawn on screen. Deselects all other objects.
|-
! Box add to selection
| shift + left-click + right-click + drag, or shift + left-click + 'b' + drag || Adds all objects whose centers lie within the drawn box to the selection. Preserves existing selection.
|-
! Select decal or object that is under another decal
| mouse wheel up/down || When you have 2 or more objects or decals on top of each other, you can select at least 1 decal or object, put your mouse cursor on top of the one you want to select, then use the scroll wheel to switch your selection between the objects.
|-
! Select all
| cmd-a || Selects all objects.
|-
! Deselect all
| double-left-click away from all objects, or press Q || Deselects all objects.
|}

[[Image:Editor-selection-debug-info.png|right|thumb|caption|Debug window]]

'''Note: ''' If the Debug window is open ('''Top Bar''' -> '''Windows''' -> '''Debug Window'''), then when you select an object some useful information will appear. It shows you what xml file the object is created from, its unique object id, and what type of object it is.

 

== Transformations ==

For all transformations:

* In order to transform an object you must first select it.
* Hold ctrl to make movements snap to half-meter increments.
* Hold alt to clone and transform the selected objects, leaving the original objects behind.
* Left-click transforms objects on all axis. Right-click transforms on the two axis that are perpendicular to the side of the bounding box you click on. Holding shift and right click locks the transformation to the axis parallel to the bounding box face you click on.
* Groups are transformed around the group center. Ungrouped objects, even if multiple are selected and transformed at once, are transformed around their own individual centers.

=== Translation ===

Hover mouse over central region of a bounding box' face, or hold 't'.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Camera relative
| left-click + drag || Translates clicked on object along plane parallel to the screen.
|-
! Locked to plane
| right-click + drag || Translates clicked on object along plane of clicked on face.
|-
! Locked to line
| shift + right-click + drag || Translates clicked on object along normal of clicked on face.
|-
! force decal(s) to map only one object/group
| hold i || selected decal will only map with that object that is directly underneath your mouse
|-
! force decal(s) to project only on selected objects
| press o || selected decal will only map with that object that is directly underneath your mouse
|-
! projection box/angle
| press p || to make projection box for decal
|}

=== Scale ===

Hover mouse near bounding box corners, or hold 'e'.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! All dimensions
| left-click + drag || Scales clicked on object in all dimensions (x, y, and z) at once.
|-
! Locked to plane
| right-click + drag || Extends clicked on object along plane of clicked on face.
|-
! Locked to line
| shift + right-click + drag || Extrudes clicked on object along normal of clicked on face.
|}

=== Mirror ===

Just use the right-click scale tool, and scale down the object until it flips and its mirror image begins scaling up!

=== Rotation ===

Hover mouse near bounding box edges but away from the corners, or hold 'r'.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Free
| left-click + drag || Rotates clicked on object as if you are pushing the surface of a ball.
|-
! Locked to axis
| right-click + drag || Rotates clicked on object about normal of clicked on face.
|}

==Editor/Debug Keys==

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Toggle editor mode
| F1 || Enables level editor. Press again to exit.
|-
! Activate play mode
| 8 || Spawns you in the level so you can play it. If there already is a player character you will control that, otherwise a player character spawn is created on the editor camera automatically.
|-
! Restore characters
| X || Restores all characters on the level to full health, wakes up any "unconscious" ones, and removes all blood from the environment.
|-
! Reload level
| L || Restarts the current level.
|-
! Change character
| 1-7 || Changes the playable character into one of seven possible characters. 1 cycles through rabbit guard, bandit, and turner models, 2 cycles through civilian rabbit models, 3 cycles through cat models, 4 cycles through rat models, 5 cycles through wolves, 6 through dogs, and the seventh is Rabbot 2.0.
|-
! Active ragdoll
| Z || Puts player character into active ragdoll mode where they will try to protect themselves as they fall. Is active as long as you hold the button.
|-
! Pain ragdoll
| N || Makes the player fall to the ground in agony, until you let go of the button.
|-
! Floppy ragdoll
| M || Makes the player fall to the ground, limp, until the button is released.
|-
! Voice Test
| V || Plays a test voice.
|-
! Toggle combat AI
| C || Toggles whether the characters in the level will attack each other if they are on different teams.
|-
! Slit throat
| , || The controlled character suffers a neck wound with blood gushing from it.
|-
! Slow time
| Tab || Slows down the whole game.
|-
! Freeze time
| ` || Freezes the game. This is useful for posing characters for item placement. '''Note''': The game must be unfrozen to change between controlling the player and editor mode.
|-
! Insta-kill
| F || Instantly kills and knocks back nearby NPC's with a death ray.
|-
! Experimental Key
| B || Makes you invisible.
|}

== Debug Window ==
[[Image:Editor-selection-debug-info.png|right|thumb|caption|Debug window]]
Just below the top bar menu, on the left side, is a space for debug information.

This window is only visible if you have the Debug Window enabled ('''Top Bar''' -> '''Windows''' -> '''Debug Window''').

It will tell you information about the selected object, checkpoint progress (if checkpoints are enabled in this level), and a warning if the nav mesh needs to be updated.

 

== Editor menu ==
The bar across the top of the window is the editor menu. Many editor functions can be found here, but some functions can only be reached via hotkeys for now.

'Cmd' refers to the '⌘' key on Macs, and the 'ctrl' key on PCs.

=== File menu ===
Contains file operations for loading and saving levels.

[[Image:Editor-file-menu.png|right|thumb|caption|The editor "file" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! New Level
| - || Opens a new empty level in the editor.
|-
! Open Level...
| - || Opens a file browser where you can pick what level to load (starts in Data/Levels directory).
|-
! Open Local Level...
| - || Opens a file browser where you can pick what level to load (starts in last used directory).
|-
! Open Recent
| - || Re-open one of the most recently opened levels in the editor.
|-
! Open Campaign Level
| - || Open one of the levels from the main Overgrowth story mode.
|-
! Save Level
| cmd+s || Overwrites the currently opened level file with any changes you made.
|-
! Save As...
| - || Opens a file browser where you can pick a new or existing file to save the level to.
|-
! Back to main menu
| - || Leave the editor and return to the main menu.
|-
! Quit
| alt+f4 || Quit the game.
|}

 

=== Edit menu ===
Contains basic editing functions. Also contains properties for the level.

[[Image:Editor-edit-menu.png|right|thumb|caption|The editor "edit" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Undo
| cmd+z || Undo the most recent action.
|-
! Redo
| cmd+shift+z || Redo the most recent action.
|-
! Cut
| cmd+x || Puts the selection into the clipboard and removes the selected objects.
|-
! Copy
| cmd+c || Puts the selection into the clipboard.
|-
! Paste
| cmd+v || Pastes the clipboard on the cursor position.
|-
! Select All
| cmd+a || Select all of the objects in the level.
|-
! Deselect All
| q || Clear the current selection.
|-
! Reload All Prefabs
| - || Force a reload of all prefab objects in the level.
|-
! Set Level Params...
| - || Set global level parameters (sun settings, sky, fog, HDR, etc).
|-
! Set Level Script...
| - || Select what script to use for this level.
|-
! Set Sky Texture...
| - || Opens a file browser where you can pick what sky texture to use.
|-
! Edit static meshes
| cmd+1 || Toggle ability to select non-moving objects (rocks, etc).
|-
! Edit decals
| cmd+2 || Toggle ability to select decals.
|-
! Edit gameplay objects
| cmd+3 || Toggle ability to select characters, hotspots, etc.
|-
! Edit lighting
| - || Toggle ability to select lights.
|-
! Play level
| 8 || Enter play mode.
|-
! Media mode
| - || Enter a disembodied camera mode, for taking screenshots and videos.
|}

=== Selected menu ===
Contains operations for working with the current selected objects.

[[Image:Editor-selected-menu.png|right|thumb|caption|The editor "selected" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Go To Selected
| f || Move the camera to frame the selected objects.
|-
! Delete
| backspace || Delete the selected objects from the level.
|-
! Group
| cmd+g || Merge the selected objects into a group.
|-
! Ungroup
| cmd+shift+g || Break up all groups that are selected.
|-
! Set Selection Script Params...
| - || Open up the selected object window, and expand the "Script Params" section for the selected objects.
|-
! Save Selection...
| cmd+shift+s || Open up the file browser to save the selection as an object template.
Object templates can be loaded like any other object. Script params, transform, and connections are saved.
If you save over a template, it won't be updated in any level it is placed in.
|-
! Prefab Save
| - || Save any changes to the selected prefab to a file, or create a new prefab file from the selection.
Object prefabs can be loaded like any other object. Script params, transform, and connections are saved.
If you save over a prefab, it will automatically be updated in all levels it is placed in.
|-
! Prefab Save As...
| - || Open a file browser to save the selection as a new prefab file.
Object prefabs can be loaded like any other object. Script params, transform, and connections are saved.
If you save over a prefab, it will automatically be updated in all levels it is placed in.
|}

=== Load menu ===
Contains operations for loading and spawning objects into the level.

[[Image:Editor-load-menu.png|right|thumb|caption|The editor "load" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Load item...
| - || Open a file browser to pick an item to spawn in. After loading, click in the level to spawn the object.
|-
! Open recent...
| - || Pick an item you've recently spawned to spawn another instance. After loading, click in the level to spawn the object.
|-
! <Rest of menu>
| - || Search or click on an item from a list to spawn in. After loading, click in the level to spawn the object.
Hover over an item to see a thumbnail preview of the item.
|}

 

=== Nav Mesh menu ===
Tools for nav mesh generation, loading, saving and viewing.

[[Image:Editor-navmesh-menu.png|right|thumb|caption|The editor "nav mesh" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Create
| - || Generates a new navigation mesh.
|-
! Save
| - || Save the current nav mesh to disk.
|-
! Load
| - || Load a previously saved nav mesh from disk.
|-
! View mesh
| - || Toggle preview render of the nav mesh.
|-
! View collision
| - || Toggle preview render of the collision mesh the nav mesh is based on.
|-
! View hints
| - || Toggle preview render of navmesh_hint objects (which are collision that is only visible to the nav mesh generator).
|-
! View region
| - || Toggle preview render of navmesh_region objects (which restricts mesh generation to within its volume).
|-
! View jump nodes
| - || Toggle preview render of navmesh_connection objects (jump nodes).
|-
! Cell Size
| - || Change the width of cells in the nav mesh
smaller: handles smaller gaps, slower to build.
|-
! Cell Height
| - || Change the height of cells in the nav mesh
smaller: finer control on ramps, slower to build.
|-
! Agent Height
| - || Change the height of fake player used to create nav mesh
smaller: handles lower overhangs, more likely to be unreachable by real characters.
|-
! Agent Radius
| - || Change the width of fake player used to create nav mesh
smaller: handles smaller gaps, more likely to be unreachable by real characters.
|-
! Agent Max Climb
| - || Change the max height of blocks that fake player will climb to create nav mesh
too high: real characters can't climb it.
|-
! Agent Max Slope
| - || Change the max angle of ramps that fake player will walk up to create nav mesh
too high: real characters will go up steep hills.
|}

=== Dialogue menu ===
Tools for [[dialogue]] editing.

[[Image:Editor-dialogue-menu.png|right|thumb|caption|The editor "dialogue" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Edit Selected
| O || Start editing the selected dialogue (make sure you select it first!).
|-
! Load Dialogue
| - || Load a previously saved dialogue text file.
|-
! New Dialogue
| - || Create a new dialogue object (click this, then click to place it in the level).
|}

 

=== Windows menu ===
Launch various editor windows, color picker, and debug windows.

[[Image:Editor-windows-menu.png|right|thumb|caption|The editor "windows" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Scenegraph
| y || Open level properties, and a searchable list of items in the level.
Hint: Click items in the list to select/deselect them, and hit F to view the selected items.
|-
! Selected
| u || Open the properties for the selected objects.
|-
! [[#Color_Picker|Color Picker]]
| cmd+p || Open the Color Picker to let you tint objects.
|-
! [[Collision Painting|Collision Paint]]
| - || Open the Collision Paint menu to let you edit physics properties on objects or individual surfaces.
|-
! Performance
| - || Open a window to monitor performance, and view a list of loaded file assets/loaded textures, for debugging.
|-
! Save
| - || Open a window to view data in the save file, for debugging.
|-
! State
| - || Open a window to view a hierarchy of loaded script contexts, for debugging.
|-
! Sound
| - || Open a window to view a list of loaded sounds, for debugging.
|-
! Debug Window
| - || Open a window to view debug text (shows various game and editor state).
|}

== Functions Without Buttons ==
Some functions are only reachable via hotkeys, here are a list of those.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Make player-controlled
| Shift+Cmd+P || Toggles whether a character is controlled by a human or by AI. A human-controlled character's spawn box has a green outline, an AI-controlled character's box has white outlines. If two characters are set to be human-controlled Overgrowth will start in split-screen mode the next time game-play is resumed from editor mode. The second player will be controllable via a USB controller.
|-
! [[#Spawn_Dead|Spawn Dead]]
| Cmd+K or Ctrl+K (with character spawn selected) || Makes selected characters spawn dead. It will spawn at the point it went into ragdoll mode (which may cause it to spawn "dead" while standing up). If you want to update the pose for the dead body then move the body, select the spawn point, and hit the hotkey again to save its new position.
|-
! [[#Spawn_Alive|Spawn Alive]]
| K (with character spawn selected) || Makes selected characters spawn alive.
|}

== Parameters ==
Every object as well as the level itself has several parameters. The most basic ones that all objects have are '''Name''', '''Translation''', '''Scale''' and '''Rotation'''. Other parameters you might find on an object are color tints and [[Script Parameters]].

There are several ways to edit these parameters for an object. The fastest and easiest way to do it for a single object is by using the '''Single Selected''' window (press I to open it), which shows all of the parameters for the most recently selected object.

If you want to view or edit the parameters of several specific objects you can use the [[#Selected Window|Selected Window]].

To view and edit parameters for all the objects in the level, as well as the parameters for the level itself, use the [[#Scenegraph Window|Scenegraph Window]].

== Selected Window ==
[[Image:Editor-selection-windows.png|right|thumb|caption|Selected Window (object parameters)]]

The Selected Window (or parameter editor) lets you change different parameters depending on which objects you have selected.

You can bring up the parameter editor for an object (or set of objects) by selecting them and pressing the U key, or clicking Top Bar -> Windows -> Selected.

Here is a description of what each parameter does:

{| class="wikitable"
|-
! Parameter !! Description
|-
! Name
| Give an object a custom name, so you can find it in the scenegraph window (see below), or let a custom script find those objects so they can do special things to them.
|-
! Transform
| Adjust the position, rotation, and scale of the objects manually. There is also a button to reset the rotation (which is useful when creating object prefabs).
|-
! Color Palette
| Tint objects, or make them super bright. If the character provides a mutli-part color palette, set different colors on different parts.
|-
! Script Params
| Custom parameters used by scripts. Each different object type can define their own script params. See [[Script Parameters]] page for descriptions of all parameters.
|}

 

== Scenegraph Window ==
[[Image:Editor-scenegraph-window.png|right|thumb|caption|Scenegraph Window (level parameters)]]

The Scenegraph Window (or parameter editor) lets you change global level parameters, as well as find objects in the level.

Open up the Scenegraph for the current level by pressing the Y key, or clicking Top Bar -> Windows -> Scenegraph. Let's go through each part of the Scenegraph window from top to bottom.

=== Level ===
If you expand the '''Level''' entry at the very top of the window you will find some parameters that can be changed:
{| class="wikitable"
|-
! Parameter !! Description
|-
! Loading Screen Image
| A path to an image that's shown while loading the level
|-
! Sun Position
| The position of the sun in the sky
|-
! Sun Color
| Tints the color of the sun, useful for sunrises and sunsets
|-
! Sun Intensity
| Controls how dark the shadows are
|}

For a description of the level script parameters, see the [[Script Parameters]] page.

=== Search field ===
Below the '''Level''' entry at the very top there is a search field. Write in this field to search for objects in the level. This searches in many of the objects' fields. You can for instance search for something written in the '''Name''' parameter of an object, object IDs, object paths, types and more.

=== Flat ===
The '''Flat''' checkbox controls how the Scenegraph list is displayed.

If it's not checked you can expand groups to see the relations between objects in the graph.

If it's checked you can no longer see group relationships, but you can instead expand each individual object to change any parameters associated with it.

=== Named Only ===
If this is checked the Scenegraph list with only display objects that have been named. You can name an object by selecting it, bringing up the '''Single Selected''' window by pressing I, and then writing something in the '''Name''' field.

== Color Picker ==
[[Image:Editor-new-color-picker.png|right|thumb|caption|A crete block with its color altered by the color picker.]]
The Color Picker is used to tint the color of selected objects.

It is opened by pressing cmd+p, or Top Bar -> Windows -> ColorPicker.

The color picker consists of a color-gradient box, a rainbow slider, the RGB values, and an overbrightness slider. Increasing overbrightness makes the color brighter, and makes it glow in the dark.

For characters, the color picker will let you set the color of different parts of the character. This is only available if the character was built to support a multi-color palette (not all of them do).

'''TODO''': Update screenshot on the right

 

== Sun Editor ==
[[Image:Sun_editor.jpg|right|thumb|caption|The sun editor]]

The sun allows you to cast dynamic, single-directional light throughout a level. 
You can use it to simulate either a sun (more direct light) or a moon (more ambient light)

See [[Lighting#Sunlight|the documentation on the lighting page]] for more information.

 

== Dialogue Editor ==

The [[Dialogue Editor]] is used to create scenes with different camera angles, text and poses. It is commonly used to give context and progress the story in a level.

This is a big enough subject to warrant its own article, which can be found [[Dialogue Editor|here]].

== Spawn Corpse ==
Sometimes you want to have a dead character in your level. The obvious solution would be to export a new model of a dead character and place it in the level. However, that's a lot of work, and the character wouldn't be dynamic, and it would take a lot of work to make changes to it.

Luckily there is a system in the engine for making any character spawn as a corpse. Here are instructions for how to use that system:

[[Image:spawn_corpse.jpg|right|thumb|caption|Making a corpse]]
# Spawn the character you want to spawn as a corpse.
# Select its spawn box and press cmd or ctrl + K to make it spawn as a corpse, which will kill it. At this point the corpse will spawn standing up when you restart the level with L, we'll fix that in the following steps.
# Enter play mode by pressing 8, go close to the corpse and hold right click to drag it around until you're satisfied with the pose.
# Now exit play mode by pressing escape, select the character's spawn box and press cmd+K again to update the pose of the corpse.
# Press L to restart the level and verify that it worked.

If you want to make a corpse to spawn alive again, select its spawn point and press K.

Editor Interface

2023-05-18T03:27:02Z

Constance: /* Dialogue menu */ Included edit selected hotkey

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

[[Image:Editor_Overview.png|right|600px|thumb|caption|The Overgrowth level editor]]
This page details all the interface elements and actions in the Overgrowth level editor.

The level editor lets you create new levels or even whole campaigns. This is the same editor we used to make the Overgrowth and Lugaru stories.

You can use the level editor to edit any existing level in the game.

== Activating the editor ==
{{#ev:youtube
|eS3RujmDQ2M
|
|right
|Level editor basics
|frame
|start=15
}}

==== To activate the editor: ====
* Create a new level ('''File''' -> '''New''')
* Open an existing level and press <kbd>'''F1'''</kbd>

If the editor is active while playing a level, you can open up the editor window again by pressing the <kbd>'''Esc'''</kbd> key.

You can deactivate the editor by hitting <kbd>'''F1'''</kbd> a second time.

==== Troubleshooting: ====
If you can't get the editor to activate, there are a few things you can try:
* If you have a laptop, try holding the <kbd>'''fn'''</kbd> key while pressing <kbd>'''F1'''</kbd>
* Mash all the modifier keys a few times to make sure they're not stuck down - <kbd>'''ctrl'''</kbd>, <kbd>'''alt'''</kbd>, <kbd>'''shift'''</kbd>, <kbd>'''command'''</kbd>, etc
* Make sure you have all other programs closed, in case one of them is conflicting with the <kbd>'''F1'''</kbd> hotkey
* If some "Help" program comes up when you hit <kbd>'''F1'''</kbd> (such as "HP Help"), edit its settings to disable the hotkey. Or just ''uninstall it'' (because it is bloatware)
 

== Camera Movement ==
{| class="wikitable"
|-
! Control !! Behavior
|-
! W
| Moves camera forward
|-
! S
| Moves camera backward
|-
! A
| Moves camera left
|-
! D
| Moves camera right
|-
! Shift + W
| Moves camera up
|-
! Shift + S
| Moves camera down
|-
! Left click and drag
| Rotates the camera
|}

== Object Selection ==

Here are the different ways you can select objects.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Select single object
| double-left-click on object || Selects clicked on object and deselects all other objects. If the object is part of a group, the whole group is selected. A box around the object indicates that it is selected.
|-
! Toggle-select objects
| shift + double-left-click on objects || Toggles selection of clicked on object. Preserves existing selections.
|-
! Box select objects
| left-click + right-click + drag, or left-click + 'b' + drag || Selects all objects whose centers lie within box drawn on screen. Deselects all other objects.
|-
! Box add to selection
| shift + left-click + right-click + drag, or shift + left-click + 'b' + drag || Adds all objects whose centers lie within the drawn box to the selection. Preserves existing selection.
|-
! Select decal or object that is under another decal
| mouse wheel up/down || When you have 2 or more objects or decals on top of each other, you can select at least 1 decal or object, put your mouse cursor on top of the one you want to select, then use the scroll wheel to switch your selection between the objects.
|-
! Select all
| cmd-a || Selects all objects.
|-
! Deselect all
| double-left-click away from all objects, or press Q || Deselects all objects.
|}

[[Image:Editor-selection-debug-info.png|right|thumb|caption|Debug window]]

'''Note: ''' If the Debug window is open ('''Top Bar''' -> '''Windows''' -> '''Debug Window'''), then when you select an object some useful information will appear. It shows you what xml file the object is created from, its unique object id, and what type of object it is.

 

== Transformations ==

For all transformations:

* In order to transform an object you must first select it.
* Hold ctrl to make movements snap to half-meter increments.
* Hold alt to clone and transform the selected objects, leaving the original objects behind.
* Left-click transforms objects on all axis. Right-click transforms on the two axis that are perpendicular to the side of the bounding box you click on. Holding shift and right click locks the transformation to the axis parallel to the bounding box face you click on.
* Groups are transformed around the group center. Ungrouped objects, even if multiple are selected and transformed at once, are transformed around their own individual centers.

=== Translation ===

Hover mouse over central region of a bounding box' face, or hold 't'.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Camera relative
| left-click + drag || Translates clicked on object along plane parallel to the screen.
|-
! Locked to plane
| right-click + drag || Translates clicked on object along plane of clicked on face.
|-
! Locked to line
| shift + right-click + drag || Translates clicked on object along normal of clicked on face.
|-
! force decal(s) to map only one object/group
| hold i || selected decal will only map with that object that is directly underneath your mouse
|-
! force decal(s) to project only on selected objects
| press o || selected decal will only map with that object that is directly underneath your mouse
|-
! projection box/angle
| press p || to make projection box for decal
|}

=== Scale ===

Hover mouse near bounding box corners, or hold 'e'.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! All dimensions
| left-click + drag || Scales clicked on object in all dimensions (x, y, and z) at once.
|-
! Locked to plane
| right-click + drag || Extends clicked on object along plane of clicked on face.
|-
! Locked to line
| shift + right-click + drag || Extrudes clicked on object along normal of clicked on face.
|}

=== Mirror ===

Just use the right-click scale tool, and scale down the object until it flips and its mirror image begins scaling up!

=== Rotation ===

Hover mouse near bounding box edges but away from the corners, or hold 'r'.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Free
| left-click + drag || Rotates clicked on object as if you are pushing the surface of a ball.
|-
! Locked to axis
| right-click + drag || Rotates clicked on object about normal of clicked on face.
|}

==Editor/Debug Keys==

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Toggle editor mode
| F1 || Enables level editor. Press again to exit.
|-
! Activate play mode
| 8 || Spawns you in the level so you can play it. If there already is a player character you will control that, otherwise a player character spawn is created on the editor camera automatically.
|-
! Restore characters
| X || Restores all characters on the level to full health, wakes up any "unconscious" ones, and removes all blood from the environment.
|-
! Reload level
| L || Restarts the current level.
|-
! Change character
| 1-7 || Changes the playable character into one of seven possible characters. 1 cycles through rabbit guard, bandit, and turner models, 2 cycles through civilian rabbit models, 3 cycles through cat models, 4 cycles through rat models, 5 cycles through wolves, 6 through dogs, and the seventh is Rabbot 2.0.
|-
! Active ragdoll
| Z || Puts player character into active ragdoll mode where they will try to protect themselves as they fall. Is active as long as you hold the button.
|-
! Pain ragdoll
| N || Makes the player fall to the ground in agony, until you let go of the button.
|-
! Floppy ragdoll
| M || Makes the player fall to the ground, limp, until the button is released.
|-
! Voice Test
| V || Plays a test voice.
|-
! Toggle combat AI
| C || Toggles whether the characters in the level will attack each other if they are on different teams.
|-
! Slit throat
| , || The controlled character suffers a neck wound with blood gushing from it.
|-
! Slow time
| Tab || Slows down the whole game.
|-
! Freeze time
| ` || Freezes the game. This is useful for posing characters for item placement. '''Note''': The game must be unfrozen to change between controlling the player and editor mode.
|-
! Insta-kill
| F || Instantly kills and knocks back nearby NPC's with a death ray.
|-
! Experimental Key
| B || Makes you invisible.
|}

== Debug Window ==
[[Image:Editor-selection-debug-info.png|right|thumb|caption|Debug window]]
Just below the top bar menu, on the left side, is a space for debug information.

This window is only visible if you have the Debug Window enabled ('''Top Bar''' -> '''Windows''' -> '''Debug Window''').

It will tell you information about the selected object, checkpoint progress (if checkpoints are enabled in this level), and a warning if the nav mesh needs to be updated.

 

== Editor menu ==
The bar across the top of the window is the editor menu. Many editor functions can be found here, but some functions can only be reached via hotkeys for now.

'Cmd' refers to the '⌘' key on Macs, and the 'ctrl' key on PCs.

=== File menu ===
Contains file operations for loading and saving levels.

[[Image:Editor-file-menu.png|right|thumb|caption|The editor "file" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! New Level
| - || Opens a new empty level in the editor.
|-
! Open Level...
| - || Opens a file browser where you can pick what level to load (starts in Data/Levels directory).
|-
! Open Local Level...
| - || Opens a file browser where you can pick what level to load (starts in last used directory).
|-
! Open Recent
| - || Re-open one of the most recently opened levels in the editor.
|-
! Open Campaign Level
| - || Open one of the levels from the main Overgrowth story mode.
|-
! Save Level
| cmd+s || Overwrites the currently opened level file with any changes you made.
|-
! Save As...
| - || Opens a file browser where you can pick a new or existing file to save the level to.
|-
! Back to main menu
| - || Leave the editor and return to the main menu.
|-
! Quit
| alt+f4 || Quit the game.
|}

 

=== Edit menu ===
Contains basic editing functions. Also contains properties for the level.

[[Image:Editor-edit-menu.png|right|thumb|caption|The editor "edit" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Undo
| cmd+z || Undo the most recent action.
|-
! Redo
| cmd+shift+z || Redo the most recent action.
|-
! Cut
| cmd+x || Puts the selection into the clipboard and removes the selected objects.
|-
! Copy
| cmd+c || Puts the selection into the clipboard.
|-
! Paste
| cmd+v || Pastes the clipboard on the cursor position.
|-
! Select All
| cmd+a || Select all of the objects in the level.
|-
! Deselect All
| q || Clear the current selection.
|-
! Reload All Prefabs
| - || Force a reload of all prefab objects in the level.
|-
! Set Level Params...
| - || Set global level parameters (sun settings, sky, fog, HDR, etc).
|-
! Set Level Script...
| - || Select what script to use for this level.
|-
! Set Sky Texture...
| - || Opens a file browser where you can pick what sky texture to use.
|-
! Edit static meshes
| cmd+1 || Toggle ability to select non-moving objects (rocks, etc).
|-
! Edit decals
| cmd+2 || Toggle ability to select decals.
|-
! Edit gameplay objects
| cmd+3 || Toggle ability to select characters, hotspots, etc.
|-
! Edit lighting
| - || Toggle ability to select lights.
|-
! Play level
| 8 || Enter play mode.
|-
! Media mode
| - || Enter a disembodied camera mode, for taking screenshots and videos.
|}

=== Selected menu ===
Contains operations for working with the current selected objects.

[[Image:Editor-selected-menu.png|right|thumb|caption|The editor "selected" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Go To Selected
| f || Move the camera to frame the selected objects.
|-
! Delete
| backspace || Delete the selected objects from the level.
|-
! Group
| cmd+g || Merge the selected objects into a group.
|-
! Ungroup
| cmd+shift+g || Break up all groups that are selected.
|-
! Set Selection Script Params...
| - || Open up the selected object window, and expand the "Script Params" section for the selected objects.
|-
! Save Selection...
| cmd+shift+s || Open up the file browser to save the selection as an object template.
Object templates can be loaded like any other object. Script params, transform, and connections are saved.
If you save over a template, it won't be updated in any level it is placed in.
|-
! Prefab Save
| - || Save any changes to the selected prefab to a file, or create a new prefab file from the selection.
Object prefabs can be loaded like any other object. Script params, transform, and connections are saved.
If you save over a prefab, it will automatically be updated in all levels it is placed in.
|-
! Prefab Save As...
| - || Open a file browser to save the selection as a new prefab file.
Object prefabs can be loaded like any other object. Script params, transform, and connections are saved.
If you save over a prefab, it will automatically be updated in all levels it is placed in.
|}

=== Load menu ===
Contains operations for loading and spawning objects into the level.

[[Image:Editor-load-menu.png|right|thumb|caption|The editor "load" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Load item...
| - || Open a file browser to pick an item to spawn in. After loading, click in the level to spawn the object.
|-
! Open recent...
| - || Pick an item you've recently spawned to spawn another instance. After loading, click in the level to spawn the object.
|-
! <Rest of menu>
| - || Search or click on an item from a list to spawn in. After loading, click in the level to spawn the object.
Hover over an item to see a thumbnail preview of the item.
|}

 

=== Nav Mesh menu ===
Tools for nav mesh generation, loading, saving and viewing.

[[Image:Editor-navmesh-menu.png|right|thumb|caption|The editor "nav mesh" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Create
| - || Generates a new navigation mesh.
|-
! Save
| - || Save the current nav mesh to disk.
|-
! Load
| - || Load a previously saved nav mesh from disk.
|-
! View mesh
| - || Toggle preview render of the nav mesh.
|-
! View collision
| - || Toggle preview render of the collision mesh the nav mesh is based on.
|-
! View hints
| - || Toggle preview render of navmesh_hint objects (which are collision that is only visible to the nav mesh generator).
|-
! View region
| - || Toggle preview render of navmesh_region objects (which restricts mesh generation to within its volume).
|-
! View jump nodes
| - || Toggle preview render of navmesh_connection objects (jump nodes).
|-
! Cell Size
| - || Change the width of cells in the nav mesh
smaller: handles smaller gaps, slower to build.
|-
! Cell Height
| - || Change the height of cells in the nav mesh
smaller: finer control on ramps, slower to build.
|-
! Agent Height
| - || Change the height of fake player used to create nav mesh
smaller: handles lower overhangs, more likely to be unreachable by real characters.
|-
! Agent Radius
| - || Change the width of fake player used to create nav mesh
smaller: handles smaller gaps, more likely to be unreachable by real characters.
|-
! Agent Max Climb
| - || Change the max height of blocks that fake player will climb to create nav mesh
too high: real characters can't climb it.
|-
! Agent Max Slope
| - || Change the max angle of ramps that fake player will walk up to create nav mesh
too high: real characters will go up steep hills.
|}

=== Dialogue menu ===
Tools for [[dialogue]] editing.

[[Image:Editor-dialogue-menu.png|right|thumb|caption|The editor "dialogue" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Edit Selected
| O || Start editing the selected dialogue (make sure you select it first!).
|-
! Load Dialogue
| - || Load a previously saved dialogue text file.
|-
! New Dialogue
| - || Create a new dialogue object (click this, then click to place it in the level).
|}

 

=== Windows menu ===
Launch various editor windows, color picker, and debug windows.

[[Image:Editor-windows-menu.png|right|thumb|caption|The editor "windows" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Scenegraph
| y || Open level properties, and a searchable list of items in the level.
Hint: Click items in the list to select/deselect them, and hit F to view the selected items.
|-
! Selected
| u || Open the properties for the selected objects.
|-
! Single Selected
| i || Open the properties for a single selected object. This menu doesn't require you to drill down to edit properties.
|-
! [[#Color_Picker|Color Picker]]
| cmd+p || Open the Color Picker to let you tint objects.
|-
! [[Collision Painting|Collision Paint]]
| - || Open the Collision Paint menu to let you edit physics properties on objects or individual surfaces.
|-
! Performance
| - || Open a window to monitor performance, and view a list of loaded file assets/loaded textures, for debugging.
|-
! Save
| - || Open a window to view data in the save file, for debugging.
|-
! State
| - || Open a window to view a hierarchy of loaded script contexts, for debugging.
|-
! Sound
| - || Open a window to view a list of loaded sounds, for debugging.
|-
! Debug Window
| - || Open a window to view debug text (shows various game and editor state).
|}

== Functions Without Buttons ==
Some functions are only reachable via hotkeys, here are a list of those.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Make player-controlled
| Shift+Cmd+P || Toggles whether a character is controlled by a human or by AI. A human-controlled character's spawn box has a green outline, an AI-controlled character's box has white outlines. If two characters are set to be human-controlled Overgrowth will start in split-screen mode the next time game-play is resumed from editor mode. The second player will be controllable via a USB controller.
|-
! [[#Spawn_Dead|Spawn Dead]]
| Cmd+K or Ctrl+K (with character spawn selected) || Makes selected characters spawn dead. It will spawn at the point it went into ragdoll mode (which may cause it to spawn "dead" while standing up). If you want to update the pose for the dead body then move the body, select the spawn point, and hit the hotkey again to save its new position.
|-
! [[#Spawn_Alive|Spawn Alive]]
| K (with character spawn selected) || Makes selected characters spawn alive.
|}

== Parameters ==
Every object as well as the level itself has several parameters. The most basic ones that all objects have are '''Name''', '''Translation''', '''Scale''' and '''Rotation'''. Other parameters you might find on an object are color tints and [[Script Parameters]].

There are several ways to edit these parameters for an object. The fastest and easiest way to do it for a single object is by using the '''Single Selected''' window (press I to open it), which shows all of the parameters for the most recently selected object.

If you want to view or edit the parameters of several specific objects you can use the [[#Selected Window|Selected Window]].

To view and edit parameters for all the objects in the level, as well as the parameters for the level itself, use the [[#Scenegraph Window|Scenegraph Window]].

== Selected Window ==
[[Image:Editor-selection-windows.png|right|thumb|caption|Selected Window (object parameters)]]

The Selected Window (or parameter editor) lets you change different parameters depending on which objects you have selected.

You can bring up the parameter editor for an object (or set of objects) by selecting them and pressing the U key, or clicking Top Bar -> Windows -> Selected.

Here is a description of what each parameter does:

{| class="wikitable"
|-
! Parameter !! Description
|-
! Name
| Give an object a custom name, so you can find it in the scenegraph window (see below), or let a custom script find those objects so they can do special things to them.
|-
! Transform
| Adjust the position, rotation, and scale of the objects manually. There is also a button to reset the rotation (which is useful when creating object prefabs).
|-
! Color Palette
| Tint objects, or make them super bright. If the character provides a mutli-part color palette, set different colors on different parts.
|-
! Script Params
| Custom parameters used by scripts. Each different object type can define their own script params. See [[Script Parameters]] page for descriptions of all parameters.
|}

 

== Scenegraph Window ==
[[Image:Editor-scenegraph-window.png|right|thumb|caption|Scenegraph Window (level parameters)]]

The Scenegraph Window (or parameter editor) lets you change global level parameters, as well as find objects in the level.

Open up the Scenegraph for the current level by pressing the Y key, or clicking Top Bar -> Windows -> Scenegraph. Let's go through each part of the Scenegraph window from top to bottom.

=== Level ===
If you expand the '''Level''' entry at the very top of the window you will find some parameters that can be changed:
{| class="wikitable"
|-
! Parameter !! Description
|-
! Loading Screen Image
| A path to an image that's shown while loading the level
|-
! Sun Position
| The position of the sun in the sky
|-
! Sun Color
| Tints the color of the sun, useful for sunrises and sunsets
|-
! Sun Intensity
| Controls how dark the shadows are
|}

For a description of the level script parameters, see the [[Script Parameters]] page.

=== Search field ===
Below the '''Level''' entry at the very top there is a search field. Write in this field to search for objects in the level. This searches in many of the objects' fields. You can for instance search for something written in the '''Name''' parameter of an object, object IDs, object paths, types and more.

=== Flat ===
The '''Flat''' checkbox controls how the Scenegraph list is displayed.

If it's not checked you can expand groups to see the relations between objects in the graph.

If it's checked you can no longer see group relationships, but you can instead expand each individual object to change any parameters associated with it.

=== Named Only ===
If this is checked the Scenegraph list with only display objects that have been named. You can name an object by selecting it, bringing up the '''Single Selected''' window by pressing I, and then writing something in the '''Name''' field.

== Color Picker ==
[[Image:Editor-new-color-picker.png|right|thumb|caption|A crete block with its color altered by the color picker.]]
The Color Picker is used to tint the color of selected objects.

It is opened by pressing cmd+p, or Top Bar -> Windows -> ColorPicker.

The color picker consists of a color-gradient box, a rainbow slider, the RGB values, and an overbrightness slider. Increasing overbrightness makes the color brighter, and makes it glow in the dark.

For characters, the color picker will let you set the color of different parts of the character. This is only available if the character was built to support a multi-color palette (not all of them do).

'''TODO''': Update screenshot on the right

 

== Sun Editor ==
[[Image:Sun_editor.jpg|right|thumb|caption|The sun editor]]

The sun allows you to cast dynamic, single-directional light throughout a level. 
You can use it to simulate either a sun (more direct light) or a moon (more ambient light)

See [[Lighting#Sunlight|the documentation on the lighting page]] for more information.

 

== Dialogue Editor ==

The [[Dialogue Editor]] is used to create scenes with different camera angles, text and poses. It is commonly used to give context and progress the story in a level.

This is a big enough subject to warrant its own article, which can be found [[Dialogue Editor|here]].

== Spawn Corpse ==
Sometimes you want to have a dead character in your level. The obvious solution would be to export a new model of a dead character and place it in the level. However, that's a lot of work, and the character wouldn't be dynamic, and it would take a lot of work to make changes to it.

Luckily there is a system in the engine for making any character spawn as a corpse. Here are instructions for how to use that system:

[[Image:spawn_corpse.jpg|right|thumb|caption|Making a corpse]]
# Spawn the character you want to spawn as a corpse.
# Select its spawn box and press cmd or ctrl + K to make it spawn as a corpse, which will kill it. At this point the corpse will spawn standing up when you restart the level with L, we'll fix that in the following steps.
# Enter play mode by pressing 8, go close to the corpse and hold right click to drag it around until you're satisfied with the pose.
# Now exit play mode by pressing escape, select the character's spawn box and press cmd+K again to update the pose of the corpse.
# Press L to restart the level and verify that it worked.

If you want to make a corpse to spawn alive again, select its spawn point and press K.

Editor Interface

2023-05-18T03:25:06Z

Constance: /* Object Selection */ Included Q bind

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

[[Image:Editor_Overview.png|right|600px|thumb|caption|The Overgrowth level editor]]
This page details all the interface elements and actions in the Overgrowth level editor.

The level editor lets you create new levels or even whole campaigns. This is the same editor we used to make the Overgrowth and Lugaru stories.

You can use the level editor to edit any existing level in the game.

== Activating the editor ==
{{#ev:youtube
|eS3RujmDQ2M
|
|right
|Level editor basics
|frame
|start=15
}}

==== To activate the editor: ====
* Create a new level ('''File''' -> '''New''')
* Open an existing level and press <kbd>'''F1'''</kbd>

If the editor is active while playing a level, you can open up the editor window again by pressing the <kbd>'''Esc'''</kbd> key.

You can deactivate the editor by hitting <kbd>'''F1'''</kbd> a second time.

==== Troubleshooting: ====
If you can't get the editor to activate, there are a few things you can try:
* If you have a laptop, try holding the <kbd>'''fn'''</kbd> key while pressing <kbd>'''F1'''</kbd>
* Mash all the modifier keys a few times to make sure they're not stuck down - <kbd>'''ctrl'''</kbd>, <kbd>'''alt'''</kbd>, <kbd>'''shift'''</kbd>, <kbd>'''command'''</kbd>, etc
* Make sure you have all other programs closed, in case one of them is conflicting with the <kbd>'''F1'''</kbd> hotkey
* If some "Help" program comes up when you hit <kbd>'''F1'''</kbd> (such as "HP Help"), edit its settings to disable the hotkey. Or just ''uninstall it'' (because it is bloatware)
 

== Camera Movement ==
{| class="wikitable"
|-
! Control !! Behavior
|-
! W
| Moves camera forward
|-
! S
| Moves camera backward
|-
! A
| Moves camera left
|-
! D
| Moves camera right
|-
! Shift + W
| Moves camera up
|-
! Shift + S
| Moves camera down
|-
! Left click and drag
| Rotates the camera
|}

== Object Selection ==

Here are the different ways you can select objects.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Select single object
| double-left-click on object || Selects clicked on object and deselects all other objects. If the object is part of a group, the whole group is selected. A box around the object indicates that it is selected.
|-
! Toggle-select objects
| shift + double-left-click on objects || Toggles selection of clicked on object. Preserves existing selections.
|-
! Box select objects
| left-click + right-click + drag, or left-click + 'b' + drag || Selects all objects whose centers lie within box drawn on screen. Deselects all other objects.
|-
! Box add to selection
| shift + left-click + right-click + drag, or shift + left-click + 'b' + drag || Adds all objects whose centers lie within the drawn box to the selection. Preserves existing selection.
|-
! Select decal or object that is under another decal
| mouse wheel up/down || When you have 2 or more objects or decals on top of each other, you can select at least 1 decal or object, put your mouse cursor on top of the one you want to select, then use the scroll wheel to switch your selection between the objects.
|-
! Select all
| cmd-a || Selects all objects.
|-
! Deselect all
| double-left-click away from all objects, or press Q || Deselects all objects.
|}

[[Image:Editor-selection-debug-info.png|right|thumb|caption|Debug window]]

'''Note: ''' If the Debug window is open ('''Top Bar''' -> '''Windows''' -> '''Debug Window'''), then when you select an object some useful information will appear. It shows you what xml file the object is created from, its unique object id, and what type of object it is.

 

== Transformations ==

For all transformations:

* In order to transform an object you must first select it.
* Hold ctrl to make movements snap to half-meter increments.
* Hold alt to clone and transform the selected objects, leaving the original objects behind.
* Left-click transforms objects on all axis. Right-click transforms on the two axis that are perpendicular to the side of the bounding box you click on. Holding shift and right click locks the transformation to the axis parallel to the bounding box face you click on.
* Groups are transformed around the group center. Ungrouped objects, even if multiple are selected and transformed at once, are transformed around their own individual centers.

=== Translation ===

Hover mouse over central region of a bounding box' face, or hold 't'.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Camera relative
| left-click + drag || Translates clicked on object along plane parallel to the screen.
|-
! Locked to plane
| right-click + drag || Translates clicked on object along plane of clicked on face.
|-
! Locked to line
| shift + right-click + drag || Translates clicked on object along normal of clicked on face.
|-
! force decal(s) to map only one object/group
| hold i || selected decal will only map with that object that is directly underneath your mouse
|-
! force decal(s) to project only on selected objects
| press o || selected decal will only map with that object that is directly underneath your mouse
|-
! projection box/angle
| press p || to make projection box for decal
|}

=== Scale ===

Hover mouse near bounding box corners, or hold 'e'.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! All dimensions
| left-click + drag || Scales clicked on object in all dimensions (x, y, and z) at once.
|-
! Locked to plane
| right-click + drag || Extends clicked on object along plane of clicked on face.
|-
! Locked to line
| shift + right-click + drag || Extrudes clicked on object along normal of clicked on face.
|}

=== Mirror ===

Just use the right-click scale tool, and scale down the object until it flips and its mirror image begins scaling up!

=== Rotation ===

Hover mouse near bounding box edges but away from the corners, or hold 'r'.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Free
| left-click + drag || Rotates clicked on object as if you are pushing the surface of a ball.
|-
! Locked to axis
| right-click + drag || Rotates clicked on object about normal of clicked on face.
|}

==Editor/Debug Keys==

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Toggle editor mode
| F1 || Enables level editor. Press again to exit.
|-
! Activate play mode
| 8 || Spawns you in the level so you can play it. If there already is a player character you will control that, otherwise a player character spawn is created on the editor camera automatically.
|-
! Restore characters
| X || Restores all characters on the level to full health, wakes up any "unconscious" ones, and removes all blood from the environment.
|-
! Reload level
| L || Restarts the current level.
|-
! Change character
| 1-7 || Changes the playable character into one of seven possible characters. 1 cycles through rabbit guard, bandit, and turner models, 2 cycles through civilian rabbit models, 3 cycles through cat models, 4 cycles through rat models, 5 cycles through wolves, 6 through dogs, and the seventh is Rabbot 2.0.
|-
! Active ragdoll
| Z || Puts player character into active ragdoll mode where they will try to protect themselves as they fall. Is active as long as you hold the button.
|-
! Pain ragdoll
| N || Makes the player fall to the ground in agony, until you let go of the button.
|-
! Floppy ragdoll
| M || Makes the player fall to the ground, limp, until the button is released.
|-
! Voice Test
| V || Plays a test voice.
|-
! Toggle combat AI
| C || Toggles whether the characters in the level will attack each other if they are on different teams.
|-
! Slit throat
| , || The controlled character suffers a neck wound with blood gushing from it.
|-
! Slow time
| Tab || Slows down the whole game.
|-
! Freeze time
| ` || Freezes the game. This is useful for posing characters for item placement. '''Note''': The game must be unfrozen to change between controlling the player and editor mode.
|-
! Insta-kill
| F || Instantly kills and knocks back nearby NPC's with a death ray.
|-
! Experimental Key
| B || Makes you invisible.
|}

== Debug Window ==
[[Image:Editor-selection-debug-info.png|right|thumb|caption|Debug window]]
Just below the top bar menu, on the left side, is a space for debug information.

This window is only visible if you have the Debug Window enabled ('''Top Bar''' -> '''Windows''' -> '''Debug Window''').

It will tell you information about the selected object, checkpoint progress (if checkpoints are enabled in this level), and a warning if the nav mesh needs to be updated.

 

== Editor menu ==
The bar across the top of the window is the editor menu. Many editor functions can be found here, but some functions can only be reached via hotkeys for now.

'Cmd' refers to the '⌘' key on Macs, and the 'ctrl' key on PCs.

=== File menu ===
Contains file operations for loading and saving levels.

[[Image:Editor-file-menu.png|right|thumb|caption|The editor "file" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! New Level
| - || Opens a new empty level in the editor.
|-
! Open Level...
| - || Opens a file browser where you can pick what level to load (starts in Data/Levels directory).
|-
! Open Local Level...
| - || Opens a file browser where you can pick what level to load (starts in last used directory).
|-
! Open Recent
| - || Re-open one of the most recently opened levels in the editor.
|-
! Open Campaign Level
| - || Open one of the levels from the main Overgrowth story mode.
|-
! Save Level
| cmd+s || Overwrites the currently opened level file with any changes you made.
|-
! Save As...
| - || Opens a file browser where you can pick a new or existing file to save the level to.
|-
! Back to main menu
| - || Leave the editor and return to the main menu.
|-
! Quit
| alt+f4 || Quit the game.
|}

 

=== Edit menu ===
Contains basic editing functions. Also contains properties for the level.

[[Image:Editor-edit-menu.png|right|thumb|caption|The editor "edit" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Undo
| cmd+z || Undo the most recent action.
|-
! Redo
| cmd+shift+z || Redo the most recent action.
|-
! Cut
| cmd+x || Puts the selection into the clipboard and removes the selected objects.
|-
! Copy
| cmd+c || Puts the selection into the clipboard.
|-
! Paste
| cmd+v || Pastes the clipboard on the cursor position.
|-
! Select All
| cmd+a || Select all of the objects in the level.
|-
! Deselect All
| q || Clear the current selection.
|-
! Reload All Prefabs
| - || Force a reload of all prefab objects in the level.
|-
! Set Level Params...
| - || Set global level parameters (sun settings, sky, fog, HDR, etc).
|-
! Set Level Script...
| - || Select what script to use for this level.
|-
! Set Sky Texture...
| - || Opens a file browser where you can pick what sky texture to use.
|-
! Edit static meshes
| cmd+1 || Toggle ability to select non-moving objects (rocks, etc).
|-
! Edit decals
| cmd+2 || Toggle ability to select decals.
|-
! Edit gameplay objects
| cmd+3 || Toggle ability to select characters, hotspots, etc.
|-
! Edit lighting
| - || Toggle ability to select lights.
|-
! Play level
| 8 || Enter play mode.
|-
! Media mode
| - || Enter a disembodied camera mode, for taking screenshots and videos.
|}

=== Selected menu ===
Contains operations for working with the current selected objects.

[[Image:Editor-selected-menu.png|right|thumb|caption|The editor "selected" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Go To Selected
| f || Move the camera to frame the selected objects.
|-
! Delete
| backspace || Delete the selected objects from the level.
|-
! Group
| cmd+g || Merge the selected objects into a group.
|-
! Ungroup
| cmd+shift+g || Break up all groups that are selected.
|-
! Set Selection Script Params...
| - || Open up the selected object window, and expand the "Script Params" section for the selected objects.
|-
! Save Selection...
| cmd+shift+s || Open up the file browser to save the selection as an object template.
Object templates can be loaded like any other object. Script params, transform, and connections are saved.
If you save over a template, it won't be updated in any level it is placed in.
|-
! Prefab Save
| - || Save any changes to the selected prefab to a file, or create a new prefab file from the selection.
Object prefabs can be loaded like any other object. Script params, transform, and connections are saved.
If you save over a prefab, it will automatically be updated in all levels it is placed in.
|-
! Prefab Save As...
| - || Open a file browser to save the selection as a new prefab file.
Object prefabs can be loaded like any other object. Script params, transform, and connections are saved.
If you save over a prefab, it will automatically be updated in all levels it is placed in.
|}

=== Load menu ===
Contains operations for loading and spawning objects into the level.

[[Image:Editor-load-menu.png|right|thumb|caption|The editor "load" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Load item...
| - || Open a file browser to pick an item to spawn in. After loading, click in the level to spawn the object.
|-
! Open recent...
| - || Pick an item you've recently spawned to spawn another instance. After loading, click in the level to spawn the object.
|-
! <Rest of menu>
| - || Search or click on an item from a list to spawn in. After loading, click in the level to spawn the object.
Hover over an item to see a thumbnail preview of the item.
|}

 

=== Nav Mesh menu ===
Tools for nav mesh generation, loading, saving and viewing.

[[Image:Editor-navmesh-menu.png|right|thumb|caption|The editor "nav mesh" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Create
| - || Generates a new navigation mesh.
|-
! Save
| - || Save the current nav mesh to disk.
|-
! Load
| - || Load a previously saved nav mesh from disk.
|-
! View mesh
| - || Toggle preview render of the nav mesh.
|-
! View collision
| - || Toggle preview render of the collision mesh the nav mesh is based on.
|-
! View hints
| - || Toggle preview render of navmesh_hint objects (which are collision that is only visible to the nav mesh generator).
|-
! View region
| - || Toggle preview render of navmesh_region objects (which restricts mesh generation to within its volume).
|-
! View jump nodes
| - || Toggle preview render of navmesh_connection objects (jump nodes).
|-
! Cell Size
| - || Change the width of cells in the nav mesh
smaller: handles smaller gaps, slower to build.
|-
! Cell Height
| - || Change the height of cells in the nav mesh
smaller: finer control on ramps, slower to build.
|-
! Agent Height
| - || Change the height of fake player used to create nav mesh
smaller: handles lower overhangs, more likely to be unreachable by real characters.
|-
! Agent Radius
| - || Change the width of fake player used to create nav mesh
smaller: handles smaller gaps, more likely to be unreachable by real characters.
|-
! Agent Max Climb
| - || Change the max height of blocks that fake player will climb to create nav mesh
too high: real characters can't climb it.
|-
! Agent Max Slope
| - || Change the max angle of ramps that fake player will walk up to create nav mesh
too high: real characters will go up steep hills.
|}

=== Dialogue menu ===
Tools for [[dialogue]] editing.

[[Image:Editor-dialogue-menu.png|right|thumb|caption|The editor "dialogue" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Edit Selected
| - || Start editing the selected dialogue (make sure you select it first!).
|-
! Load Dialogue
| - || Load a previously saved dialogue text file.
|-
! New Dialogue
| - || Create a new dialogue object (click this, then click to place it in the level).
|}

 

=== Windows menu ===
Launch various editor windows, color picker, and debug windows.

[[Image:Editor-windows-menu.png|right|thumb|caption|The editor "windows" menu]]

{| class="wikitable"
|-
! Button !! Hotkey !! Effect
|-
! Scenegraph
| y || Open level properties, and a searchable list of items in the level.
Hint: Click items in the list to select/deselect them, and hit F to view the selected items.
|-
! Selected
| u || Open the properties for the selected objects.
|-
! Single Selected
| i || Open the properties for a single selected object. This menu doesn't require you to drill down to edit properties.
|-
! [[#Color_Picker|Color Picker]]
| cmd+p || Open the Color Picker to let you tint objects.
|-
! [[Collision Painting|Collision Paint]]
| - || Open the Collision Paint menu to let you edit physics properties on objects or individual surfaces.
|-
! Performance
| - || Open a window to monitor performance, and view a list of loaded file assets/loaded textures, for debugging.
|-
! Save
| - || Open a window to view data in the save file, for debugging.
|-
! State
| - || Open a window to view a hierarchy of loaded script contexts, for debugging.
|-
! Sound
| - || Open a window to view a list of loaded sounds, for debugging.
|-
! Debug Window
| - || Open a window to view debug text (shows various game and editor state).
|}

== Functions Without Buttons ==
Some functions are only reachable via hotkeys, here are a list of those.

{| class="wikitable"
|-
! Action !! Control !! Behavior
|-
! Make player-controlled
| Shift+Cmd+P || Toggles whether a character is controlled by a human or by AI. A human-controlled character's spawn box has a green outline, an AI-controlled character's box has white outlines. If two characters are set to be human-controlled Overgrowth will start in split-screen mode the next time game-play is resumed from editor mode. The second player will be controllable via a USB controller.
|-
! [[#Spawn_Dead|Spawn Dead]]
| Cmd+K or Ctrl+K (with character spawn selected) || Makes selected characters spawn dead. It will spawn at the point it went into ragdoll mode (which may cause it to spawn "dead" while standing up). If you want to update the pose for the dead body then move the body, select the spawn point, and hit the hotkey again to save its new position.
|-
! [[#Spawn_Alive|Spawn Alive]]
| K (with character spawn selected) || Makes selected characters spawn alive.
|}

== Parameters ==
Every object as well as the level itself has several parameters. The most basic ones that all objects have are '''Name''', '''Translation''', '''Scale''' and '''Rotation'''. Other parameters you might find on an object are color tints and [[Script Parameters]].

There are several ways to edit these parameters for an object. The fastest and easiest way to do it for a single object is by using the '''Single Selected''' window (press I to open it), which shows all of the parameters for the most recently selected object.

If you want to view or edit the parameters of several specific objects you can use the [[#Selected Window|Selected Window]].

To view and edit parameters for all the objects in the level, as well as the parameters for the level itself, use the [[#Scenegraph Window|Scenegraph Window]].

== Selected Window ==
[[Image:Editor-selection-windows.png|right|thumb|caption|Selected Window (object parameters)]]

The Selected Window (or parameter editor) lets you change different parameters depending on which objects you have selected.

You can bring up the parameter editor for an object (or set of objects) by selecting them and pressing the U key, or clicking Top Bar -> Windows -> Selected.

Here is a description of what each parameter does:

{| class="wikitable"
|-
! Parameter !! Description
|-
! Name
| Give an object a custom name, so you can find it in the scenegraph window (see below), or let a custom script find those objects so they can do special things to them.
|-
! Transform
| Adjust the position, rotation, and scale of the objects manually. There is also a button to reset the rotation (which is useful when creating object prefabs).
|-
! Color Palette
| Tint objects, or make them super bright. If the character provides a mutli-part color palette, set different colors on different parts.
|-
! Script Params
| Custom parameters used by scripts. Each different object type can define their own script params. See [[Script Parameters]] page for descriptions of all parameters.
|}

 

== Scenegraph Window ==
[[Image:Editor-scenegraph-window.png|right|thumb|caption|Scenegraph Window (level parameters)]]

The Scenegraph Window (or parameter editor) lets you change global level parameters, as well as find objects in the level.

Open up the Scenegraph for the current level by pressing the Y key, or clicking Top Bar -> Windows -> Scenegraph. Let's go through each part of the Scenegraph window from top to bottom.

=== Level ===
If you expand the '''Level''' entry at the very top of the window you will find some parameters that can be changed:
{| class="wikitable"
|-
! Parameter !! Description
|-
! Loading Screen Image
| A path to an image that's shown while loading the level
|-
! Sun Position
| The position of the sun in the sky
|-
! Sun Color
| Tints the color of the sun, useful for sunrises and sunsets
|-
! Sun Intensity
| Controls how dark the shadows are
|}

For a description of the level script parameters, see the [[Script Parameters]] page.

=== Search field ===
Below the '''Level''' entry at the very top there is a search field. Write in this field to search for objects in the level. This searches in many of the objects' fields. You can for instance search for something written in the '''Name''' parameter of an object, object IDs, object paths, types and more.

=== Flat ===
The '''Flat''' checkbox controls how the Scenegraph list is displayed.

If it's not checked you can expand groups to see the relations between objects in the graph.

If it's checked you can no longer see group relationships, but you can instead expand each individual object to change any parameters associated with it.

=== Named Only ===
If this is checked the Scenegraph list with only display objects that have been named. You can name an object by selecting it, bringing up the '''Single Selected''' window by pressing I, and then writing something in the '''Name''' field.

== Color Picker ==
[[Image:Editor-new-color-picker.png|right|thumb|caption|A crete block with its color altered by the color picker.]]
The Color Picker is used to tint the color of selected objects.

It is opened by pressing cmd+p, or Top Bar -> Windows -> ColorPicker.

The color picker consists of a color-gradient box, a rainbow slider, the RGB values, and an overbrightness slider. Increasing overbrightness makes the color brighter, and makes it glow in the dark.

For characters, the color picker will let you set the color of different parts of the character. This is only available if the character was built to support a multi-color palette (not all of them do).

'''TODO''': Update screenshot on the right

 

== Sun Editor ==
[[Image:Sun_editor.jpg|right|thumb|caption|The sun editor]]

The sun allows you to cast dynamic, single-directional light throughout a level. 
You can use it to simulate either a sun (more direct light) or a moon (more ambient light)

See [[Lighting#Sunlight|the documentation on the lighting page]] for more information.

 

== Dialogue Editor ==

The [[Dialogue Editor]] is used to create scenes with different camera angles, text and poses. It is commonly used to give context and progress the story in a level.

This is a big enough subject to warrant its own article, which can be found [[Dialogue Editor|here]].

== Spawn Corpse ==
Sometimes you want to have a dead character in your level. The obvious solution would be to export a new model of a dead character and place it in the level. However, that's a lot of work, and the character wouldn't be dynamic, and it would take a lot of work to make changes to it.

Luckily there is a system in the engine for making any character spawn as a corpse. Here are instructions for how to use that system:

[[Image:spawn_corpse.jpg|right|thumb|caption|Making a corpse]]
# Spawn the character you want to spawn as a corpse.
# Select its spawn box and press cmd or ctrl + K to make it spawn as a corpse, which will kill it. At this point the corpse will spawn standing up when you restart the level with L, we'll fix that in the following steps.
# Enter play mode by pressing 8, go close to the corpse and hold right click to drag it around until you're satisfied with the pose.
# Now exit play mode by pressing escape, select the character's spawn box and press cmd+K again to update the pose of the corpse.
# Press L to restart the level and verify that it worked.

If you want to make a corpse to spawn alive again, select its spawn point and press K.

User:Constance

2023-05-18T03:07:11Z

Constance: defeated the curse of the red text

My name is Constance.

I'm a developer for Overgrowth at Wolfire Games. I made Therium-2, and other such things.

Let me know if there's any documentation you especially want me to cover, and I'll do my best.

3D Objects

2023-05-18T03:03:08Z

Constance: /* Converting normal maps */ Increased video size

== 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>envobject #TANGENT</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 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 ====
[[File:Convert_normals_tutorial.mp4|400px|thumb|right|Video tutorial on how to convert normal maps in GIMP]]
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 Substance Designer you need to do this:

# Invert the blue channel
# Swap blue and green channels

You can do this in Photoshop, Substance Designer, or GIMP. Note that Gimp does not work well with alpha channels. On the right is a tutorial on how to convert object space normal maps into tangent space using GIMP.

== 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 ===
{| class="wikitable"
|-
! Tag !! Example use !! Description
|-
! Model
| <pre><Model>Data/Models/MyModel.obj</Model></pre>
|| path to the model file (.obj)
|-
! ColorMap
| <pre><ColorMap>Data/Textures/MyColorMap.tga</ColorMap></pre>
|| path to the color texture file (.tga, .tif or .png)
|-
! NormalMap
| <pre><NormalMap>Data/Textures/MyNormalMap.tga</NormalMap></pre>
|| Path to the normal map texture file (.tga, .tif or .png)
|-
! ShaderName
| <pre><ShaderName>envobject #TANGENT #KEEP_SPEC</ShaderName></pre>
|| What shader to use, see [[#Shaders|shaders]] for more information
|-
! MaterialPath
| <pre><MaterialPath>Data/Materials/DirtyRock.xml</MaterialPath></pre>
|| Path to the material to use, see [[#Materials|materials]] for more information.
|-
! WeightMap
| <pre><WeightMap>Data/Textures/Environments/Rocks/granite_vine_rocks/granite_vine_boulder_overgrown_w.tga</WeightMap></pre>
|| Path to a black and white texture used for determining where each detail texture should be used. Required when using the detailmap4 [[#Shaders|shader]].
|-
! TranslucencyMap
| <pre><TranslucencyMap>Data/Textures/Environments/cat_props/banner_t.tga</TranslucencyMap></pre>
|| Path to a color texture used for translucency, meaning light that shines through the object. 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. Optional when using the plant [[#Shaders|shader]].
|-
! WindMap
| <pre><WindMap>Data/Textures/Environments/cat_props/banner_w.tga</WindMap></pre>
|| Path to a black and white texture used to define the intensity of a vertex wind effect. If unspecified it defaults to 1.0 (active) across the entire surface. Optional when using the plant [[#Shaders|shader]].
|-
! DetailMaps
| <pre><DetailMaps>
<DetailMap colorpath="Data/Textures/Terrain/DetailTextures/gray_rock.tga" normalpath="Data/Textures/Terrain/DetailTextures/gray_rock_normal.tga" materialpath="Data/Materials/rocks.xml" />
...
</DetailMaps></pre>
|| Contains exactly 4 <DetailMap> tags describing textures and materials that will be tiled across the model using the <WeightMap> tag's texture. Required when using the detailmap4 [[#Shaders|shader]].
|-
! DetailObjects
| <pre><DetailObjects>
<DetailObject obj_path="Data/Objects/Plants/Groundcover/Groundcover1.xml" weight_path="Data/Textures/Environments/Rocks/granite_vine_rocks/granite_vine_boulder_overgrown_vine_mask.tga" normal_conform="0.9" density="10" min_embed="0" max_embed="0.4" min_scale="0.7" max_scale="2" view_distance="40" jitter_degrees="10" overbright="0" />
</DetailObjects></pre>
|| Contains one or more <DetailObject> tags, each describing how to randomly distribute some object across the surface. Can be used for grass, small rocks etc.
|-
! flags
| <pre><flags no_collision=true double_sided=true/></pre>
|| Used to set boolean values on the object (see [[#Flags|flags]])
|-
! GroundOffset
| <pre><GroundOffset>0.5</GroundOffset></pre>
|| Moves the object up/down by the set amount when the object is created
|}

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

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

==== Materials ====
These are the materials that can be assigned to objects using the <code><MaterialPath></code> [[#Tags|tag]]. You can find the materials in <code>../Overgrowth/Data/Materials/</code>. The material affects what particles spawn when a character runs on the surface, what sound footsteps make on the surface, how easily weapons stick in the surface, and more.

* default
* dirt
* dirtytock
* drygrass
* grass
* gravel
* ice
* rock
* rocks
* sand
* snow
* wood

=== Flags ===
Flags are entered as boolean attributes ("true" or "false") in a [[#Tags|tag]] called "flags" under the "Object" tag. 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.
|}

==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 in the same place as the render mesh]]
[[Image:HullObject.jpg|thumb|Hull mesh should be in the same place as the render mesh]]
{| class="wikitable"
|-
! Suffix !! Description
|-
! YourObject_COL.obj
| Contains simplified geometry for physics calculations.
|-
! YourObjectHULL.obj
| Same as _COL but has extra info, used for weapons.
|}

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

===Physics objects (_COL)===
Simplified geometry such as boxes and 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 ==
Overgrowth uses an "uber shader" approach to shader management, which means that there is one huge shader that almost everything in the game uses. So instead of choosing a shader for your object, you can set "flags" with your object that the game will use to change how it's rendered.

The flags are put in the <ShaderName> tag after the shader name. Here is an example:

<ShaderName>envobject #TANGENT #KEEP_SPEC</ShaderName>

"#TANGENT" and "#KEEP_SPEC" in this example are flags.

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 flags allow you to use more than these two required textures, and some flags change how the required textures are used. '''TODO:''' Are there any default textures that can be used and what are they?

Here is the channel designations of the ColorMap and NormalMap textures:

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

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

Any deviation from these designations or new textures caused by any flag in the table below can be seen in the ''Channel/Texture Changes'' column.

{| class="wikitable"
|-
! Tag !! Channel/Texture Changes !! Description
|-
! #TANGENT
|
|| The normal map is used as an object space normal map by default, with this flag it's used as a tangent space normal map instead.
|-
! #KEEP_SPEC
|
'''NormalMap''' 
'''A''' - Smoothness
|| Instead of using the alpha channel of the normal map as a color tint mask, as is the default, that channel is used as a smoothness map. The object can still be tinted, you just can't control what parts get tinted.
|-
! #DETAILMAP4
|
'''WeightMap''' 
'''R''' - The first detail texture 
'''G''' - The second detail texture 
'''B''' - The third detail texture

'''DetailMap colorpath''' 
'''RGB''' - Color

'''DetailMap normalpath''' 
'''RGB''' - Normal
|| Allows for repeating up to 4 different textures over a model so it looks more detailed up close. This also means you can scale the model up or down with less obvious texture stretching.

* The WeightMap is used to decide which DetailMap texture to put where on the object
* Each DetailMap has its own color texture, normal texture and material
* See the [[#Tags|tags]] heading for information about how to specify the DetailMaps
|-
! #BASE_TANGENT
|
|| '''TODO:''' What does this do?
|-
! #AXIS_UV
|
|| '''TODO:''' What does this do?
|-
! #AXIS_BLEND
|
|| '''TODO:''' What does this do?
|-
! #NO_DECALS
|
|| No decals shows up on this object.
|-
! #WHY_DOES_THIS_WORK
|
|| '''TODO:''' What does this do?
|-
! #INVISIBLE
|
|| This object will not be rendered.
|-
! #ALPHA
|
'''ColorMap''' 
'''A''' - Transparency
|| [[Image:CubemapAlpha.jpg|thumb|#ALPHA flag in action]]
Makes the alpha channel of the ColorMap work as transparency instead of reflectivity
|-
! #PLANT
|
'''ColorMap''' 
'''A (reflectivity)''' - No effect

'''NormalMap''' 
'''A (color tint mask)''' - No effect

'''WindMap''' 
'''R''' - Wind intensity 

'''TranslucencyMap''' 
'''RGB''' - Translucency color 
|| [[Image:Translucency.jpg|thumb|#PLANT flag in action together with the #ALPHA flag]]
* Enables use of a WindMap which makes the object move in the wind
* Enables use of a TranslucencyMap which makes it look like light can shine through the surface
* Disables reflectivity
* Disables color tint mask
|-
! #WATER
|
|| '''TODO:''' What does this do?
|}

=== Color Tint Mask ===
This mask is located in the alpha channel of the normal map, and determines what parts of the object should be tinted when using the [[Editor_Interface#Color_Picker|color picker]]. Black parts are not affected, the brighter the texel the more it is affected by tinting.

== See also==
* [[Custom Characters]]
* [[Custom Weapons & Items]]

3D Objects

2023-05-18T03:02:46Z

Constance: /* Converting normal maps */ Corrected video position

== 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>envobject #TANGENT</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 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 ====
[[File:Convert_normals_tutorial.mp4|200px|thumb|right|Video tutorial on how to convert normal maps in GIMP]]
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 Substance Designer you need to do this:

# Invert the blue channel
# Swap blue and green channels

You can do this in Photoshop, Substance Designer, or GIMP. Note that Gimp does not work well with alpha channels. On the right is a tutorial on how to convert object space normal maps into tangent space using GIMP.

== 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 ===
{| class="wikitable"
|-
! Tag !! Example use !! Description
|-
! Model
| <pre><Model>Data/Models/MyModel.obj</Model></pre>
|| path to the model file (.obj)
|-
! ColorMap
| <pre><ColorMap>Data/Textures/MyColorMap.tga</ColorMap></pre>
|| path to the color texture file (.tga, .tif or .png)
|-
! NormalMap
| <pre><NormalMap>Data/Textures/MyNormalMap.tga</NormalMap></pre>
|| Path to the normal map texture file (.tga, .tif or .png)
|-
! ShaderName
| <pre><ShaderName>envobject #TANGENT #KEEP_SPEC</ShaderName></pre>
|| What shader to use, see [[#Shaders|shaders]] for more information
|-
! MaterialPath
| <pre><MaterialPath>Data/Materials/DirtyRock.xml</MaterialPath></pre>
|| Path to the material to use, see [[#Materials|materials]] for more information.
|-
! WeightMap
| <pre><WeightMap>Data/Textures/Environments/Rocks/granite_vine_rocks/granite_vine_boulder_overgrown_w.tga</WeightMap></pre>
|| Path to a black and white texture used for determining where each detail texture should be used. Required when using the detailmap4 [[#Shaders|shader]].
|-
! TranslucencyMap
| <pre><TranslucencyMap>Data/Textures/Environments/cat_props/banner_t.tga</TranslucencyMap></pre>
|| Path to a color texture used for translucency, meaning light that shines through the object. 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. Optional when using the plant [[#Shaders|shader]].
|-
! WindMap
| <pre><WindMap>Data/Textures/Environments/cat_props/banner_w.tga</WindMap></pre>
|| Path to a black and white texture used to define the intensity of a vertex wind effect. If unspecified it defaults to 1.0 (active) across the entire surface. Optional when using the plant [[#Shaders|shader]].
|-
! DetailMaps
| <pre><DetailMaps>
<DetailMap colorpath="Data/Textures/Terrain/DetailTextures/gray_rock.tga" normalpath="Data/Textures/Terrain/DetailTextures/gray_rock_normal.tga" materialpath="Data/Materials/rocks.xml" />
...
</DetailMaps></pre>
|| Contains exactly 4 <DetailMap> tags describing textures and materials that will be tiled across the model using the <WeightMap> tag's texture. Required when using the detailmap4 [[#Shaders|shader]].
|-
! DetailObjects
| <pre><DetailObjects>
<DetailObject obj_path="Data/Objects/Plants/Groundcover/Groundcover1.xml" weight_path="Data/Textures/Environments/Rocks/granite_vine_rocks/granite_vine_boulder_overgrown_vine_mask.tga" normal_conform="0.9" density="10" min_embed="0" max_embed="0.4" min_scale="0.7" max_scale="2" view_distance="40" jitter_degrees="10" overbright="0" />
</DetailObjects></pre>
|| Contains one or more <DetailObject> tags, each describing how to randomly distribute some object across the surface. Can be used for grass, small rocks etc.
|-
! flags
| <pre><flags no_collision=true double_sided=true/></pre>
|| Used to set boolean values on the object (see [[#Flags|flags]])
|-
! GroundOffset
| <pre><GroundOffset>0.5</GroundOffset></pre>
|| Moves the object up/down by the set amount when the object is created
|}

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

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

==== Materials ====
These are the materials that can be assigned to objects using the <code><MaterialPath></code> [[#Tags|tag]]. You can find the materials in <code>../Overgrowth/Data/Materials/</code>. The material affects what particles spawn when a character runs on the surface, what sound footsteps make on the surface, how easily weapons stick in the surface, and more.

* default
* dirt
* dirtytock
* drygrass
* grass
* gravel
* ice
* rock
* rocks
* sand
* snow
* wood

=== Flags ===
Flags are entered as boolean attributes ("true" or "false") in a [[#Tags|tag]] called "flags" under the "Object" tag. 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.
|}

==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 in the same place as the render mesh]]
[[Image:HullObject.jpg|thumb|Hull mesh should be in the same place as the render mesh]]
{| class="wikitable"
|-
! Suffix !! Description
|-
! YourObject_COL.obj
| Contains simplified geometry for physics calculations.
|-
! YourObjectHULL.obj
| Same as _COL but has extra info, used for weapons.
|}

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

===Physics objects (_COL)===
Simplified geometry such as boxes and 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 ==
Overgrowth uses an "uber shader" approach to shader management, which means that there is one huge shader that almost everything in the game uses. So instead of choosing a shader for your object, you can set "flags" with your object that the game will use to change how it's rendered.

The flags are put in the <ShaderName> tag after the shader name. Here is an example:

<ShaderName>envobject #TANGENT #KEEP_SPEC</ShaderName>

"#TANGENT" and "#KEEP_SPEC" in this example are flags.

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 flags allow you to use more than these two required textures, and some flags change how the required textures are used. '''TODO:''' Are there any default textures that can be used and what are they?

Here is the channel designations of the ColorMap and NormalMap textures:

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

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

Any deviation from these designations or new textures caused by any flag in the table below can be seen in the ''Channel/Texture Changes'' column.

{| class="wikitable"
|-
! Tag !! Channel/Texture Changes !! Description
|-
! #TANGENT
|
|| The normal map is used as an object space normal map by default, with this flag it's used as a tangent space normal map instead.
|-
! #KEEP_SPEC
|
'''NormalMap''' 
'''A''' - Smoothness
|| Instead of using the alpha channel of the normal map as a color tint mask, as is the default, that channel is used as a smoothness map. The object can still be tinted, you just can't control what parts get tinted.
|-
! #DETAILMAP4
|
'''WeightMap''' 
'''R''' - The first detail texture 
'''G''' - The second detail texture 
'''B''' - The third detail texture

'''DetailMap colorpath''' 
'''RGB''' - Color

'''DetailMap normalpath''' 
'''RGB''' - Normal
|| Allows for repeating up to 4 different textures over a model so it looks more detailed up close. This also means you can scale the model up or down with less obvious texture stretching.

* The WeightMap is used to decide which DetailMap texture to put where on the object
* Each DetailMap has its own color texture, normal texture and material
* See the [[#Tags|tags]] heading for information about how to specify the DetailMaps
|-
! #BASE_TANGENT
|
|| '''TODO:''' What does this do?
|-
! #AXIS_UV
|
|| '''TODO:''' What does this do?
|-
! #AXIS_BLEND
|
|| '''TODO:''' What does this do?
|-
! #NO_DECALS
|
|| No decals shows up on this object.
|-
! #WHY_DOES_THIS_WORK
|
|| '''TODO:''' What does this do?
|-
! #INVISIBLE
|
|| This object will not be rendered.
|-
! #ALPHA
|
'''ColorMap''' 
'''A''' - Transparency
|| [[Image:CubemapAlpha.jpg|thumb|#ALPHA flag in action]]
Makes the alpha channel of the ColorMap work as transparency instead of reflectivity
|-
! #PLANT
|
'''ColorMap''' 
'''A (reflectivity)''' - No effect

'''NormalMap''' 
'''A (color tint mask)''' - No effect

'''WindMap''' 
'''R''' - Wind intensity 

'''TranslucencyMap''' 
'''RGB''' - Translucency color 
|| [[Image:Translucency.jpg|thumb|#PLANT flag in action together with the #ALPHA flag]]
* Enables use of a WindMap which makes the object move in the wind
* Enables use of a TranslucencyMap which makes it look like light can shine through the surface
* Disables reflectivity
* Disables color tint mask
|-
! #WATER
|
|| '''TODO:''' What does this do?
|}

=== Color Tint Mask ===
This mask is located in the alpha channel of the normal map, and determines what parts of the object should be tinted when using the [[Editor_Interface#Color_Picker|color picker]]. Black parts are not affected, the brighter the texel the more it is affected by tinting.

== See also==
* [[Custom Characters]]
* [[Custom Weapons & Items]]

3D Objects

2023-05-18T03:02:34Z

Constance: /* Converting normal maps */ Included normal map conversion tutorial video

== 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>envobject #TANGENT</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 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 ====
[[File:Convert_normals_tutorial.mp4|200px|thumb|left|Video tutorial on how to convert normal maps in GIMP]]
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 Substance Designer you need to do this:

# Invert the blue channel
# Swap blue and green channels

You can do this in Photoshop, Substance Designer, or GIMP. Note that Gimp does not work well with alpha channels. On the right is a tutorial on how to convert object space normal maps into tangent space using GIMP.

== 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 ===
{| class="wikitable"
|-
! Tag !! Example use !! Description
|-
! Model
| <pre><Model>Data/Models/MyModel.obj</Model></pre>
|| path to the model file (.obj)
|-
! ColorMap
| <pre><ColorMap>Data/Textures/MyColorMap.tga</ColorMap></pre>
|| path to the color texture file (.tga, .tif or .png)
|-
! NormalMap
| <pre><NormalMap>Data/Textures/MyNormalMap.tga</NormalMap></pre>
|| Path to the normal map texture file (.tga, .tif or .png)
|-
! ShaderName
| <pre><ShaderName>envobject #TANGENT #KEEP_SPEC</ShaderName></pre>
|| What shader to use, see [[#Shaders|shaders]] for more information
|-
! MaterialPath
| <pre><MaterialPath>Data/Materials/DirtyRock.xml</MaterialPath></pre>
|| Path to the material to use, see [[#Materials|materials]] for more information.
|-
! WeightMap
| <pre><WeightMap>Data/Textures/Environments/Rocks/granite_vine_rocks/granite_vine_boulder_overgrown_w.tga</WeightMap></pre>
|| Path to a black and white texture used for determining where each detail texture should be used. Required when using the detailmap4 [[#Shaders|shader]].
|-
! TranslucencyMap
| <pre><TranslucencyMap>Data/Textures/Environments/cat_props/banner_t.tga</TranslucencyMap></pre>
|| Path to a color texture used for translucency, meaning light that shines through the object. 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. Optional when using the plant [[#Shaders|shader]].
|-
! WindMap
| <pre><WindMap>Data/Textures/Environments/cat_props/banner_w.tga</WindMap></pre>
|| Path to a black and white texture used to define the intensity of a vertex wind effect. If unspecified it defaults to 1.0 (active) across the entire surface. Optional when using the plant [[#Shaders|shader]].
|-
! DetailMaps
| <pre><DetailMaps>
<DetailMap colorpath="Data/Textures/Terrain/DetailTextures/gray_rock.tga" normalpath="Data/Textures/Terrain/DetailTextures/gray_rock_normal.tga" materialpath="Data/Materials/rocks.xml" />
...
</DetailMaps></pre>
|| Contains exactly 4 <DetailMap> tags describing textures and materials that will be tiled across the model using the <WeightMap> tag's texture. Required when using the detailmap4 [[#Shaders|shader]].
|-
! DetailObjects
| <pre><DetailObjects>
<DetailObject obj_path="Data/Objects/Plants/Groundcover/Groundcover1.xml" weight_path="Data/Textures/Environments/Rocks/granite_vine_rocks/granite_vine_boulder_overgrown_vine_mask.tga" normal_conform="0.9" density="10" min_embed="0" max_embed="0.4" min_scale="0.7" max_scale="2" view_distance="40" jitter_degrees="10" overbright="0" />
</DetailObjects></pre>
|| Contains one or more <DetailObject> tags, each describing how to randomly distribute some object across the surface. Can be used for grass, small rocks etc.
|-
! flags
| <pre><flags no_collision=true double_sided=true/></pre>
|| Used to set boolean values on the object (see [[#Flags|flags]])
|-
! GroundOffset
| <pre><GroundOffset>0.5</GroundOffset></pre>
|| Moves the object up/down by the set amount when the object is created
|}

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

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

==== Materials ====
These are the materials that can be assigned to objects using the <code><MaterialPath></code> [[#Tags|tag]]. You can find the materials in <code>../Overgrowth/Data/Materials/</code>. The material affects what particles spawn when a character runs on the surface, what sound footsteps make on the surface, how easily weapons stick in the surface, and more.

* default
* dirt
* dirtytock
* drygrass
* grass
* gravel
* ice
* rock
* rocks
* sand
* snow
* wood

=== Flags ===
Flags are entered as boolean attributes ("true" or "false") in a [[#Tags|tag]] called "flags" under the "Object" tag. 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.
|}

==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 in the same place as the render mesh]]
[[Image:HullObject.jpg|thumb|Hull mesh should be in the same place as the render mesh]]
{| class="wikitable"
|-
! Suffix !! Description
|-
! YourObject_COL.obj
| Contains simplified geometry for physics calculations.
|-
! YourObjectHULL.obj
| Same as _COL but has extra info, used for weapons.
|}

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

===Physics objects (_COL)===
Simplified geometry such as boxes and 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 ==
Overgrowth uses an "uber shader" approach to shader management, which means that there is one huge shader that almost everything in the game uses. So instead of choosing a shader for your object, you can set "flags" with your object that the game will use to change how it's rendered.

The flags are put in the <ShaderName> tag after the shader name. Here is an example:

<ShaderName>envobject #TANGENT #KEEP_SPEC</ShaderName>

"#TANGENT" and "#KEEP_SPEC" in this example are flags.

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 flags allow you to use more than these two required textures, and some flags change how the required textures are used. '''TODO:''' Are there any default textures that can be used and what are they?

Here is the channel designations of the ColorMap and NormalMap textures:

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

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

Any deviation from these designations or new textures caused by any flag in the table below can be seen in the ''Channel/Texture Changes'' column.

{| class="wikitable"
|-
! Tag !! Channel/Texture Changes !! Description
|-
! #TANGENT
|
|| The normal map is used as an object space normal map by default, with this flag it's used as a tangent space normal map instead.
|-
! #KEEP_SPEC
|
'''NormalMap''' 
'''A''' - Smoothness
|| Instead of using the alpha channel of the normal map as a color tint mask, as is the default, that channel is used as a smoothness map. The object can still be tinted, you just can't control what parts get tinted.
|-
! #DETAILMAP4
|
'''WeightMap''' 
'''R''' - The first detail texture 
'''G''' - The second detail texture 
'''B''' - The third detail texture

'''DetailMap colorpath''' 
'''RGB''' - Color

'''DetailMap normalpath''' 
'''RGB''' - Normal
|| Allows for repeating up to 4 different textures over a model so it looks more detailed up close. This also means you can scale the model up or down with less obvious texture stretching.

* The WeightMap is used to decide which DetailMap texture to put where on the object
* Each DetailMap has its own color texture, normal texture and material
* See the [[#Tags|tags]] heading for information about how to specify the DetailMaps
|-
! #BASE_TANGENT
|
|| '''TODO:''' What does this do?
|-
! #AXIS_UV
|
|| '''TODO:''' What does this do?
|-
! #AXIS_BLEND
|
|| '''TODO:''' What does this do?
|-
! #NO_DECALS
|
|| No decals shows up on this object.
|-
! #WHY_DOES_THIS_WORK
|
|| '''TODO:''' What does this do?
|-
! #INVISIBLE
|
|| This object will not be rendered.
|-
! #ALPHA
|
'''ColorMap''' 
'''A''' - Transparency
|| [[Image:CubemapAlpha.jpg|thumb|#ALPHA flag in action]]
Makes the alpha channel of the ColorMap work as transparency instead of reflectivity
|-
! #PLANT
|
'''ColorMap''' 
'''A (reflectivity)''' - No effect

'''NormalMap''' 
'''A (color tint mask)''' - No effect

'''WindMap''' 
'''R''' - Wind intensity 

'''TranslucencyMap''' 
'''RGB''' - Translucency color 
|| [[Image:Translucency.jpg|thumb|#PLANT flag in action together with the #ALPHA flag]]
* Enables use of a WindMap which makes the object move in the wind
* Enables use of a TranslucencyMap which makes it look like light can shine through the surface
* Disables reflectivity
* Disables color tint mask
|-
! #WATER
|
|| '''TODO:''' What does this do?
|}

=== Color Tint Mask ===
This mask is located in the alpha channel of the normal map, and determines what parts of the object should be tinted when using the [[Editor_Interface#Color_Picker|color picker]]. Black parts are not affected, the brighter the texel the more it is affected by tinting.

== See also==
* [[Custom Characters]]
* [[Custom Weapons & Items]]

File:Convert normals tutorial.mp4

2023-05-18T03:00:35Z

Constance: How to convert normal maps into tangent space for objects in Overgrowth.

How to convert normal maps into tangent space for objects in Overgrowth.

Custom Animations

2023-05-17T04:26:37Z

Constance: /* Adding an event Keyframe to your animation */ Included ungrouping note

==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 3.4''' and above are in the [https://discord.com/invite/wolfire Wolfire Discord's] #overgrowth_modding channel, in the pinned messages. Look for a file named phoenixblenderscripts.7z (instructions on how to install are included).

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?'''

== 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|439px|right|How to find the animation controls for exported frame data]]

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.

===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|485px|right|Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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
# Go to the Object Data Properties tab (the one that looks like a character) in the Properties window
# Hold down SHIFT and toggle the third layer from the bottom right
# Once you're done, move your mouse to the 3D Viewport and press A to select everything
# Press ALT + H to unhide everything
# Toggle the rig layers back to normal: The DEF bones are located in the 3rd of the rig's layers from the bottom right '''TODO: ADD IMAGE'''

==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.
{| class="wikitable"
|-
! Event Name !! Description
|-
|event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_blockprepare || Signals when AI characters should block. These keyframes are usually placed two frames before the impact
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||Will trigger footstep sounds for sneaking, emits AI sound and creates particles while on terrain
|-
|event_rightrunstep||Will trigger footstep sounds for running, emits AI sound and creates particles while on terrain
|-
|event_rightwalkstep||Will trigger footstep sounds for walking, emits AI sound and creates particles while on terrain
|-
|event_rightwallstep||Will trigger footstep sounds for wall running and emits AI sound
|-
|event_golimp||Causes the character to ragdoll into a static pose
|-
|event_grabitem||
|-
|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_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||
|-
|event_unsheatherighthandlefthip||Unsheathes the left hip's item into the right hand
|-
|event_unsheatherighthandrighthi||Unsheathes the right hip's item into the right hand
|}

===Adding an event Keyframe to your animation===
# Select the 3rd of the rig's layers from the bottom right, as shown in the Bone Layers section
# Select the appropriate 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, select it (so its name lights up) and press CTRL + ALT + G. Now the keyframe should be sent to the bottom, for easier editing!

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

Custom Animations

2023-05-17T04:22:28Z

Constance: /* Selecting different poses */ Changed image size

==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 3.4''' and above are in the [https://discord.com/invite/wolfire Wolfire Discord's] #overgrowth_modding channel, in the pinned messages. Look for a file named phoenixblenderscripts.7z (instructions on how to install are included).

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?'''

== 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|439px|right|How to find the animation controls for exported frame data]]

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.

===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|485px|right|Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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
# Go to the Object Data Properties tab (the one that looks like a character) in the Properties window
# Hold down SHIFT and toggle the third layer from the bottom right
# Once you're done, move your mouse to the 3D Viewport and press A to select everything
# Press ALT + H to unhide everything
# Toggle the rig layers back to normal: The DEF bones are located in the 3rd of the rig's layers from the bottom right '''TODO: ADD IMAGE'''

==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.
{| class="wikitable"
|-
! Event Name !! Description
|-
|event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_blockprepare || Signals when AI characters should block. These keyframes are usually placed two frames before the impact
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||Will trigger footstep sounds for sneaking, emits AI sound and creates particles while on terrain
|-
|event_rightrunstep||Will trigger footstep sounds for running, emits AI sound and creates particles while on terrain
|-
|event_rightwalkstep||Will trigger footstep sounds for walking, emits AI sound and creates particles while on terrain
|-
|event_rightwallstep||Will trigger footstep sounds for wall running and emits AI sound
|-
|event_golimp||Causes the character to ragdoll into a static pose
|-
|event_grabitem||
|-
|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_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||
|-
|event_unsheatherighthandlefthip||Unsheathes the left hip's item into the right hand
|-
|event_unsheatherighthandrighthi||Unsheathes the right hip's item into the right hand
|}

===Adding an event Keyframe to your animation===
# Select the 3rd of the rig's layers from the bottom right, as shown in the Bone Layers section
# Select the appropriate 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)

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

Custom Animations

2023-05-17T04:17:07Z

Constance: /* Overview */ Hid the 2.55 tutorial in its own link, by the 2.55 download.

==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 3.4''' and above are in the [https://discord.com/invite/wolfire Wolfire Discord's] #overgrowth_modding channel, in the pinned messages. Look for a file named phoenixblenderscripts.7z (instructions on how to install are included).

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?'''

== 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|496px|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|439px|right|How to find the animation controls for exported frame data]]

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.

===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|485px|right|Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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
# Go to the Object Data Properties tab (the one that looks like a character) in the Properties window
# Hold down SHIFT and toggle the third layer from the bottom right
# Once you're done, move your mouse to the 3D Viewport and press A to select everything
# Press ALT + H to unhide everything
# Toggle the rig layers back to normal: The DEF bones are located in the 3rd of the rig's layers from the bottom right '''TODO: ADD IMAGE'''

==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.
{| class="wikitable"
|-
! Event Name !! Description
|-
|event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_blockprepare || Signals when AI characters should block. These keyframes are usually placed two frames before the impact
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||Will trigger footstep sounds for sneaking, emits AI sound and creates particles while on terrain
|-
|event_rightrunstep||Will trigger footstep sounds for running, emits AI sound and creates particles while on terrain
|-
|event_rightwalkstep||Will trigger footstep sounds for walking, emits AI sound and creates particles while on terrain
|-
|event_rightwallstep||Will trigger footstep sounds for wall running and emits AI sound
|-
|event_golimp||Causes the character to ragdoll into a static pose
|-
|event_grabitem||
|-
|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_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||
|-
|event_unsheatherighthandlefthip||Unsheathes the left hip's item into the right hand
|-
|event_unsheatherighthandrighthi||Unsheathes the right hip's item into the right hand
|}

===Adding an event Keyframe to your animation===
# Select the 3rd of the rig's layers from the bottom right, as shown in the Bone Layers section
# Select the appropriate 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)

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

Custom Animations

2023-05-17T04:15:39Z

Constance: Moved Bone Layers section upwards

==Overview==

{{#ev:youtube
|CuFKEvTyYRw
|
|right
|Constance's animation tutorial for Blender 2.55
|frame
|start=0
}}

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

The scripts needed for using '''Blender 3.4''' and above are in the [https://discord.com/invite/wolfire Wolfire Discord's] #overgrowth_modding channel, in the pinned messages. Look for a file named phoenixblenderscripts.7z (instructions on how to install are included).

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?'''

== 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|496px|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|439px|right|How to find the animation controls for exported frame data]]

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.

===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|485px|right|Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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
# Go to the Object Data Properties tab (the one that looks like a character) in the Properties window
# Hold down SHIFT and toggle the third layer from the bottom right
# Once you're done, move your mouse to the 3D Viewport and press A to select everything
# Press ALT + H to unhide everything
# Toggle the rig layers back to normal: The DEF bones are located in the 3rd of the rig's layers from the bottom right '''TODO: ADD IMAGE'''

==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.
{| class="wikitable"
|-
! Event Name !! Description
|-
|event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_blockprepare || Signals when AI characters should block. These keyframes are usually placed two frames before the impact
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||Will trigger footstep sounds for sneaking, emits AI sound and creates particles while on terrain
|-
|event_rightrunstep||Will trigger footstep sounds for running, emits AI sound and creates particles while on terrain
|-
|event_rightwalkstep||Will trigger footstep sounds for walking, emits AI sound and creates particles while on terrain
|-
|event_rightwallstep||Will trigger footstep sounds for wall running and emits AI sound
|-
|event_golimp||Causes the character to ragdoll into a static pose
|-
|event_grabitem||
|-
|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_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||
|-
|event_unsheatherighthandlefthip||Unsheathes the left hip's item into the right hand
|-
|event_unsheatherighthandrighthi||Unsheathes the right hip's item into the right hand
|}

===Adding an event Keyframe to your animation===
# Select the 3rd of the rig's layers from the bottom right, as shown in the Bone Layers section
# Select the appropriate 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)

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

Custom Animations

2023-05-17T04:14:24Z

Constance: /* Unhiding DEF Bones */ Corrected error and included note about IK & FK

==Overview==

{{#ev:youtube
|CuFKEvTyYRw
|
|right
|Constance's animation tutorial for Blender 2.55
|frame
|start=0
}}

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

The scripts needed for using '''Blender 3.4''' and above are in the [https://discord.com/invite/wolfire Wolfire Discord's] #overgrowth_modding channel, in the pinned messages. Look for a file named phoenixblenderscripts.7z (instructions on how to install are included).

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?'''

== 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|496px|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|439px|right|How to find the animation controls for exported frame data]]

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.

===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!'''

==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.
{| class="wikitable"
|-
! Event Name !! Description
|-
|event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_blockprepare || Signals when AI characters should block. These keyframes are usually placed two frames before the impact
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||Will trigger footstep sounds for sneaking, emits AI sound and creates particles while on terrain
|-
|event_rightrunstep||Will trigger footstep sounds for running, emits AI sound and creates particles while on terrain
|-
|event_rightwalkstep||Will trigger footstep sounds for walking, emits AI sound and creates particles while on terrain
|-
|event_rightwallstep||Will trigger footstep sounds for wall running and emits AI sound
|-
|event_golimp||Causes the character to ragdoll into a static pose
|-
|event_grabitem||
|-
|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_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||
|-
|event_unsheatherighthandlefthip||Unsheathes the left hip's item into the right hand
|-
|event_unsheatherighthandrighthi||Unsheathes the right hip's item into the right hand
|}

===Adding an event Keyframe to your animation===
# Select the 3rd of the rig's layers from the bottom right.'''TODO: ADD IMAGE''' The bones should be named <code>DEF-<Bonename></code>
# Select the appropriate 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)

=== Bone layers ===
[[File:Animation_rig_layers.png|thumb|485px|right|Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.]]
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
# Go to the Object Data Properties tab (the one that looks like a character) in the Properties window
# Hold down SHIFT and toggle the third layer from the bottom right
# Once you're done, move your mouse to the 3D Viewport and press A to select everything
# Press ALT + H to unhide everything
# Toggle the rig layers back to normal: The DEF bones are located in the 3rd of the rig's layers from the bottom right '''TODO: ADD IMAGE'''

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

Custom Animations

2023-05-17T04:04:17Z

Constance: Facelifted page.

==Overview==

{{#ev:youtube
|CuFKEvTyYRw
|
|right
|Constance's animation tutorial for Blender 2.55
|frame
|start=0
}}

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

The scripts needed for using '''Blender 3.4''' and above are in the [https://discord.com/invite/wolfire Wolfire Discord's] #overgrowth_modding channel, in the pinned messages. Look for a file named phoenixblenderscripts.7z (instructions on how to install are included).

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?'''

== 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|496px|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|439px|right|How to find the animation controls for exported frame data]]

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.

===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!'''

==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.
{| class="wikitable"
|-
! Event Name !! Description
|-
|event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_blockprepare || Signals when AI characters should block. These keyframes are usually placed two frames before the impact
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||Will trigger footstep sounds for sneaking, emits AI sound and creates particles while on terrain
|-
|event_rightrunstep||Will trigger footstep sounds for running, emits AI sound and creates particles while on terrain
|-
|event_rightwalkstep||Will trigger footstep sounds for walking, emits AI sound and creates particles while on terrain
|-
|event_rightwallstep||Will trigger footstep sounds for wall running and emits AI sound
|-
|event_golimp||Causes the character to ragdoll into a static pose
|-
|event_grabitem||
|-
|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_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||
|-
|event_unsheatherighthandlefthip||Unsheathes the left hip's item into the right hand
|-
|event_unsheatherighthandrighthi||Unsheathes the right hip's item into the right hand
|}

===Adding an event Keyframe to your animation===
# Select the 3rd of the rig's layers from the bottom right.'''TODO: ADD IMAGE''' The bones should be named <code>DEF-<Bonename></code>
# Select the appropriate 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)

=== Unhiding DEF Bones ===
In order to add event keyframes, you must first select a DEF bone. In the 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
# Go to the Object Data Properties tab (the one that looks like a character)
# Hold down SHIFT and toggle every layer on (to be safe)
# Once you're done, move your mouse to the 3D Viewport and press A to select everything
# Press ALT + H to unhide everything
# Toggle the rig layers back to normal: The DEF bones are located in the 3rd of the rig's layers from the bottom right '''TODO: ADD IMAGE'''

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

Custom Animations

2023-05-17T03:48:27Z

Constance: Added 3.4 documentation and tutorial

==Overview==

{{#ev:youtube
|CuFKEvTyYRw
|
|right
|Constance's animation tutorial for Blender 2.55
|frame
|start=0
}}

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

The scripts needed for using '''Blender 3.4''' and above are in the [https://discord.com/invite/wolfire Wolfire Discord's] #overgrowth_modding channel, in the pinned messages. Look for a file named phoenixblenderscripts.7z

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

== 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
# Middle 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===

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?''' [[File:Dopesheet_pose_select.png|left|The button found on the dopesheet toolbar for selecting different poses]]

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===

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.

===Exporting an animation===

# Create your custom animation in Blender
# Set the metadata for your animation in the sidebar of the 3D Viewport, as pictured [[File:Rig_params.gif|left|How to find the animation controls]]
#* 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!'''

==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.
{| class="wikitable"
|-
! Event Name !! Description
|-
|event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_blockprepare || Signals when to block to AI characters. These keyframes are usually placed two frames before the impact
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||Will trigger footstep sounds for sneaking, emits AI sound and creates particles while on terrain
|-
|event_rightrunstep||Will trigger footstep sounds for running, emits AI sound and creates particles while on terrain
|-
|event_rightwalkstep||Will trigger footstep sounds for walking, emits AI sound and creates particles while on terrain
|-
|event_rightwallstep||Will trigger footstep sounds for wall running and emits AI sound
|-
|event_golimp||Causes the character to ragdoll into a static pose
|-
|event_grabitem||
|-
|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_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||
|-
|event_unsheatherighthandlefthip||Unsheathes the left hip's item into the right hand
|-
|event_unsheatherighthandrighthi||Unsheathes the right hip's item into the right hand
|}

===Adding an event Keyframe to your animation===
# Select the 3rd of the rig's layers from the bottom right.'''TODO: ADD IMAGE''' The bones should be named <code>DEF-<Bonename></code>
# Select the appropriate 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)

=== Unhiding DEF Bones ===
In order to add event keyframes, you must first select a DEF bone. In the 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
# Go to the Object Data Properties tab (the one that looks like a character)
# Hold down SHIFT and toggle every layer on (to be safe)
# Once you're done, move your mouse to the 3D Viewport and press A to select everything
# Press ALT + H to unhide everything
# Toggle the rig layers back to normal: The DEF bones are located in the 3rd of the rig's layers from the bottom right '''TODO: ADD IMAGE'''

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

File:Dopesheet pose select.png

2023-05-17T03:36:59Z

Constance: How to select a pose in the dopesheet.

How to select a pose in the dopesheet.

File:Rig params.gif

2023-05-17T03:35:55Z

Constance: How to access the skeleton parameters for custom properties and timeline data.

How to access the skeleton parameters for custom properties and timeline data.

File:Animation rig layers.png

2023-05-17T03:08:42Z

Constance: Cyan text is only for character rigging. White text is only for animation. Green text is only for DEF bones, which are used in animation.

Cyan text is only for character rigging.
White text is only for animation.
Green text is only for DEF bones, which are used in animation.

Custom Animations

2023-05-17T03:00:02Z

Constance: Added unhiding DEF bones section, added Selecting a Pose section, labelled event keyframes (possibly incorrectly)

Custom Animations

2023-05-17T02:03:05Z

Constance: /* Overview */ Additional line break.

==Overview==
{{#ev:youtube
|CuFKEvTyYRw
|
|right
|Constance's animation tutorial
|frame
|start=0
}}

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

The scripts needed for using '''Blender 3.4''' and above are in the [https://discord.com/invite/wolfire Wolfire Discord's] #overgrowth_modding channel, in the pinned messages. Look for a file named phoenixblenderscripts.7z

===Exporting an animation===

# Create your custom animation in Blender
# Set the metadata for your animation in the properties sidebar of the skeleton '''TODO: ADD IMAGE'''
#* 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)'''

==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.
{| class="wikitable"
|-
! Event Name !! Description
|-
| event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||
|-
|event_rightrunstep||Will trigger footstepsound, particles and IK ?
|-
|event_rightwalkstep||
|-
|event_rightwallstep||
|-
|event_golimp||
|-
|event_grabitem||
|-
|event_heldweaponswap||
|-
|event_rightweaponrelease||
|-
|event_sheatherighthandlefthip||
|-
|event_sheatherighthandrighthip||
|-
|event_throatcut||
|-
|event_unsheatherighthandlefthip||
|-
|event_unsheatherighthandrighthi||
|}

===Adding an event Keyframe to your animation===
# Select the 3rd of the rig's layers from the bottom right.'''TODO: ADD IMAGE''' The bones should be named <code>DEF-<Bonename></code>
# Select the appropriate 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)

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

Custom Animations

2023-05-17T02:02:40Z

Constance: /* Overview */ I swear it's bold this time.

==Overview==
{{#ev:youtube
|CuFKEvTyYRw
|
|right
|Constance's animation tutorial
|frame
|start=0
}}

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].
The scripts needed for using '''Blender 3.4''' and above are in the [https://discord.com/invite/wolfire Wolfire Discord's] #overgrowth_modding channel, in the pinned messages. Look for a file named phoenixblenderscripts.7z

===Exporting an animation===

# Create your custom animation in Blender
# Set the metadata for your animation in the properties sidebar of the skeleton '''TODO: ADD IMAGE'''
#* 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)'''

==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.
{| class="wikitable"
|-
! Event Name !! Description
|-
| event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||
|-
|event_rightrunstep||Will trigger footstepsound, particles and IK ?
|-
|event_rightwalkstep||
|-
|event_rightwallstep||
|-
|event_golimp||
|-
|event_grabitem||
|-
|event_heldweaponswap||
|-
|event_rightweaponrelease||
|-
|event_sheatherighthandlefthip||
|-
|event_sheatherighthandrighthip||
|-
|event_throatcut||
|-
|event_unsheatherighthandlefthip||
|-
|event_unsheatherighthandrighthi||
|}

===Adding an event Keyframe to your animation===
# Select the 3rd of the rig's layers from the bottom right.'''TODO: ADD IMAGE''' The bones should be named <code>DEF-<Bonename></code>
# Select the appropriate 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)

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

Custom Animations

2023-05-17T02:02:12Z

Constance: /* Overview */ Actually fixed bold text.

==Overview==
{{#ev:youtube
|CuFKEvTyYRw
|
|right
|Constance's animation tutorial
|frame
|start=0
}}

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].
The scripts needed for using ''Blender 3.4'' and above are in the [https://discord.com/invite/wolfire Wolfire Discord's] #overgrowth_modding channel, in the pinned messages. Look for a file named phoenixblenderscripts.7z

===Exporting an animation===

# Create your custom animation in Blender
# Set the metadata for your animation in the properties sidebar of the skeleton '''TODO: ADD IMAGE'''
#* 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)'''

==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.
{| class="wikitable"
|-
! Event Name !! Description
|-
| event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||
|-
|event_rightrunstep||Will trigger footstepsound, particles and IK ?
|-
|event_rightwalkstep||
|-
|event_rightwallstep||
|-
|event_golimp||
|-
|event_grabitem||
|-
|event_heldweaponswap||
|-
|event_rightweaponrelease||
|-
|event_sheatherighthandlefthip||
|-
|event_sheatherighthandrighthip||
|-
|event_throatcut||
|-
|event_unsheatherighthandlefthip||
|-
|event_unsheatherighthandrighthi||
|}

===Adding an event Keyframe to your animation===
# Select the 3rd of the rig's layers from the bottom right.'''TODO: ADD IMAGE''' The bones should be named <code>DEF-<Bonename></code>
# Select the appropriate 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)

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

Custom Animations

2023-05-17T02:01:48Z

Constance: /* Overview */ Fixed bold text.

==Overview==
{{#ev:youtube
|CuFKEvTyYRw
|
|right
|Constance's animation tutorial
|frame
|start=0
}}

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].
The scripts needed for using *Blender 3.4* and above are in the [https://discord.com/invite/wolfire Wolfire Discord's] #overgrowth_modding channel, in the pinned messages. Look for a file named phoenixblenderscripts.7z

===Exporting an animation===

# Create your custom animation in Blender
# Set the metadata for your animation in the properties sidebar of the skeleton '''TODO: ADD IMAGE'''
#* 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)'''

==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.
{| class="wikitable"
|-
! Event Name !! Description
|-
| event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||
|-
|event_rightrunstep||Will trigger footstepsound, particles and IK ?
|-
|event_rightwalkstep||
|-
|event_rightwallstep||
|-
|event_golimp||
|-
|event_grabitem||
|-
|event_heldweaponswap||
|-
|event_rightweaponrelease||
|-
|event_sheatherighthandlefthip||
|-
|event_sheatherighthandrighthip||
|-
|event_throatcut||
|-
|event_unsheatherighthandlefthip||
|-
|event_unsheatherighthandrighthi||
|}

===Adding an event Keyframe to your animation===
# Select the 3rd of the rig's layers from the bottom right.'''TODO: ADD IMAGE''' The bones should be named <code>DEF-<Bonename></code>
# Select the appropriate 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)

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

Custom Animations

2023-05-17T02:01:20Z

Constance: /* Overview */ Added note about 2.93 Blender scripts.

==Overview==
{{#ev:youtube
|CuFKEvTyYRw
|
|right
|Constance's animation tutorial
|frame
|start=0
}}

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].
The scripts needed for using **Blender 3.4** and above are in the [https://discord.com/invite/wolfire Wolfire Discord's] #overgrowth_modding channel, in the pinned messages. Look for a file named phoenixblenderscripts.7z

===Exporting an animation===

# Create your custom animation in Blender
# Set the metadata for your animation in the properties sidebar of the skeleton '''TODO: ADD IMAGE'''
#* 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)'''

==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.
{| class="wikitable"
|-
! Event Name !! Description
|-
| event_attackimpact || Will trigger the actual impact while attacking a character
|-
|event_attackblocked||
|-
|event_rightcrouchwalkstep||
|-
|event_rightrunstep||Will trigger footstepsound, particles and IK ?
|-
|event_rightwalkstep||
|-
|event_rightwallstep||
|-
|event_golimp||
|-
|event_grabitem||
|-
|event_heldweaponswap||
|-
|event_rightweaponrelease||
|-
|event_sheatherighthandlefthip||
|-
|event_sheatherighthandrighthip||
|-
|event_throatcut||
|-
|event_unsheatherighthandlefthip||
|-
|event_unsheatherighthandrighthi||
|}

===Adding an event Keyframe to your animation===
# Select the 3rd of the rig's layers from the bottom right.'''TODO: ADD IMAGE''' The bones should be named <code>DEF-<Bonename></code>
# Select the appropriate 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)

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

Particle Effects

2022-07-12T21:32:50Z

Constance: /* OGV-Based */ Added note declaring .ogv to be deprecated.

There isn't much information released about Overgrowth's particle system. Running or jumping on the ground creates small dust clouds at the characters' feet, and particle streams were added in [http://blog.wolfire.com/2011/04/Overgrowth-a128-video-changelog A128] along with blood dripping. Particles are controlled through scripts, examples below.

==Simple Particle Example==
<pre>
MakeParticle("Data/Particles/impactfast.xml",pos,vec3(0.0f));
</pre>

==Particle Stream Example==

<pre>
float blood_force = sin(time*_spurt_frequency)*0.5f+0.5f;
uint32 id = MakeParticle("Data/Particles/blooddrop.xml",bleed_pos,(head_transform*vec3(0.0f,blood_amount*blood_force,0.0f)+this_mo.velocity));
if(last_blood_particle_id != 0){
ConnectParticles(last_blood_particle_id, id);
}
last_blood_particle_id = id;
</pre>

==File Structure==
There appear to be two different kinds of particles. Both are defined by an .xml file, however, one version is based on a video file, while the other is based on a static texture.

===OGV-Based===
One Particle Effect is based on .ogv files found under Data/Textures/anims/ (though they are not referenced as .ogv but as .xml files in the Particle XML)

This format is deprecated and no longer works.


<pre>
<?xml version="1.0" ?>
<particle>
<textures animation_effect = "Data/Textures/anims/bigexplosion.xml"
shader = "theorabluescreen"
soft_shader = "theorabluescreensoft"/>
<size val="40.0"/>
<color red = "1.0"
green = "1.0"
blue = "1.0"
alpha = "1.0"/>
<behavior inertia="1.0" gravity="0.0" wind="0.0" size_decay_rate="0.0" opacity_decay_rate="0.0"/>
<no_rotation />
</particle>
</pre>

'''<textures/>''' - This tag has 3 attributes.
* animation_effect - this is the only attribute specific to ogv-based particles and references the file path, starting from the Data folder, to a video file. ''NOTE: for some reason, as of a209, the files referenced are xml format, however all files under Data/Textures/anims/ are ogv format. Is the reference is a typo?''
* shader - the name (not including file extension, typically .frag) of the shader in folder Data/GLSL/
* soft_shader - The shader used when soft particles are on, usually just the name of the shader with the word "soft" appended to the end.

'''<size/>''' - This tag uses the attribute "val" (floating point number) to specify the size of the particle. Can also be defined by "min" and "max" attributes, see Texture-Based Particle below ''NOTE: Units are unknown''

'''<color/>''' - This tag has a varying number of attributes, one for each channel (RGB + Alpha), while the Alpha Channel may be defined as a range, requiring two attributes, alpha_min and alpha_max ''Range? perhaps floating point values from 0.0 to 1.0''

'''<behavior/>''' - This tag has 5 attributes.
* inertia - If this is 1.0 the particle retains all speed, the lower the value the more the particle slows down over time
* gravity - Degree with which a downwards gravitational force acts upon the particle
* wind - Degree with which wind effects the particle vector
* size_decay_rate - Rate at which the size of the particle decreases per second.
* opacity_decay_rate - Rate at which the alpha channel values of the particle decreases in seconds.

===Texture-Based===


<pre>
<?xml version="1.0" ?>
<particle>
<textures color_map = "Data/Textures/smoke.tga"
normal_map = "Data/Textures/smoke_normal.tga"
shader = "litsprite"
soft_shader = "litspritesoft"/>
<size min = "0.4" max = "0.7"/>
<color red = "0.5"
green = "0.5"
blue = "0.5"
alpha_min = "0.5" alpha_max = "1.0"/>
<behavior inertia="0.9" gravity="0.0" wind="1.0" size_decay_rate="0.0" opacity_decay_rate="0.0"/>
<quadratic_expansion speed="4.0"/>
<quadratic_dispersion persistence="1.0"/>
</particle>
</pre>

'''<textures/>''' - With texture-based particles, the "animation_effect" attribute has been replaced by two different ones
* color_map - Path to a file in .tga format. ''Note: Constraints? Do textures need to be square, does their size need to be a power of two?
* normal_map - Path to a file in .tga format.

= Relevant blog posts =

[http://blog.wolfire.com/2010/12/Overgrowth-graphics-overview A summary] of most blog posts explaining Overgrowth's graphical features, focusing on more technical details. There are additional links below, some of which are not mentioned in the summary.

http://blog.wolfire.com/2008/12/object-lighting-part-1/
http://blog.wolfire.com/2010/02/Gamma-correct-lighting

http://blog.wolfire.com/2009/09/character-rim-lighting/
http://blog.wolfire.com/2009/10/character-normal-maps/
http://blog.wolfire.com/2009/09/soft-normal-maps-for-fur/

http://blog.wolfire.com/2009/09/trees-in-the-breeze/
http://blog.wolfire.com/2010/10/Imposters

http://blog.wolfire.com/2009/05/decals-editor-part-one/
http://blog.wolfire.com/2009/05/decals-editor-part-two/
http://blog.wolfire.com/2009/06/decals-editor-part-three/

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

Lighting

2022-07-12T21:24:52Z

Constance: /* Gotchas */

{{stub}}

'''TODO''': Cover other level parameters, such as HDR points, saturation, and sky brightness. These parameters are covered in the [[Script Parameters]] page, so might want to take care to not duplicate too much of the information and maybe include a link to that page 
'''TODO''': Expand sun section to say how to get a "sun" and a "moon" effect

== Sunlight ==
The sun allows you to cast dynamic, single-directional light throughout a level. 
You can use it to simulate either a sun (more direct light) or a moon (more ambient light)

 
[[Image:Sun_editor.jpg|left|thumb|The sun editor]]
{{#ev:youtube
|DUaBoNEUcVI
|
|right
|Editing the sun and sky
|frame
|start=267
}}

 
=== How to adjust the sun ===
* Select the sun in the sky (double click it)
* Move it by clicking on the middle and dragging it around
* Change the color by dragging the dot around the outer ring
* Change the intensity by clicking ''just'' outside the outer ring and dragging it

To deselect the sun, double click well outside of the sun editor ('''Note''': the normal Q for "deselect all" isn't working right now)

=== How to edit the parameters directly ===
If you have problems clicking it, or would prefer a numeric editor:
* Press the <kbd>'''Y'''</kbd> key to open the Scenegraph
* Expand '''level''' to find the Sun parameters

 

== Reflection Capture ==

Reflection capture objects are used for ambient lighting, reflections, and the color of the fog in each direction.

There are two kinds of reflection capture objects, ''Global Reflection'' and ''Local Reflection''. Both can be found under '''Load''' -> '''Lighting'''. A global reflection capture can be turned into a local one and vice versa by setting its ''Global'' script parameter to 1 or not.

=== Gotchas ===
Reflection captures are updated when moved, and each new result builds on the results of the previous reflection capture. This can be used to achieve some desired effect, but can also make it harder to get what you want sometimes. Try playing around with changing the brightness of the sky, amount of fog etc. to get different effects.

Certain [[Shader_And_Weather_Effects|level shaders]] will cause an issue where the sky will increase in brightness. To avoid this, disable the level shader temporarily. If the shader is important to include in the reflection capture, you can update it a single time by adjusting its position slightly within the Selected window.

=== Global reflection ===
Global reflection captures are used for the entire level, and each level should have exactly one. Since it affects the entire level it is often placed in a location that represents some sort of "average" lighting for the level.

=== Local reflection ===
Local reflection captures are used to change what the reflections look like in a specific region of the level. These are useful if there are caves or other types of areas where the ambient lighting changes significantly from the rest of the level. Move, rotate and scale the object to decide what part of the level should be affected.

== Point lights ==
Point lights allow you to cast omni-directional light from a point in the level.
{{#ev:youtube
|wOL0LJBRcas
|
|right
|Adding and editing point lights
|frame
|start=64
}}

=== Adding a dynamic light: ===
* '''Top Bar''' -> '''Load''' -> '''Lighting''' -> '''Dynamic Light'''
* The cursor will turn into a plus symbol
* Click in level to place the dynamic light

=== Changing the size of a dynamic light ===
* Select the light - <code>'''double click'''</code>
* Hold <code>'''E'''</code> while clicking and dragging on its bounding box.

Note that this only changes the light's area of influence, not how much light it outputs. 

=== Making a dynamic light brighter ===
* Select the light - <code>'''double click'''</code>
* Open the color picker - <code>'''Ctrl + P'''</code> (<code>'''Command + P'''</code> on mac)
* Change the <code>'''Overbright'''</code> setting

=== Adjusting dynamic light color: ===
* Select the light
* Hit <code>'''CTRL + P'''</code> (<code>'''command + P'''</code> on mac) to open the '''Color Picker'''.
* Adjust the color with the color selector, or '''RGB''' at the bottom.

=== Shaping the dynamic light ===
Dynamic lights are always spherical right now.
If you need an "area light" effect that isn't a sphere, there are a few options:
* Use [[Lighting#Shadow_decals|Shadow Decals]] to shape the light (you have to enable this in the level first. See [[Lighting#Dynamic_lights_and_shadows|this section below]])
* Place multiple dynamic light objects
* Some combination of both of the above

Be careful to both look at how the lights affect static objects in the scene, and how they affect characters that walk through them.

 

== Shadow decals ==
Shadows from sunlight are taken care of automatically.

However this only allows one level of shadowing. This doesn't handle ambient occlusion (shadowing of indirect light reflections).

Shadow [[Custom Decals|decals]] ("Ambient Shadows") allow you to manually place decals which simulate this ambient occlusion effect. 
This can help you visually anchor objects more realistically in the scene, and replicate effects like darkening around corners, and inside cubbyholes.

 
{{#ev:youtube
|wOL0LJBRcas
|
|right
|Adding and editing ambient shadows
|frame
|start=15
}}

[[File:Ambient shadow decals.png|600px|Ambient Shadow Decals's effect on light]]

 
=== Adding a shadow decal: ===

* ''Top Bar -> Load -> Lighting -> Ambient Shadow''. 
* The cursor will turn into a plus symbol. 
* Now click in level to place the ambient shadow decal.

=== Resizing a shadow decal: ===

Double click the ambient shadow decal, and hold E while clicking and dragging on its bounding box (or while shift + right-clicking and dragging on a side to only stretch in that direction). 
This will let you increase the spread of its effect.

'''Note''': Ambient shadow decals will not create shadows if they in direct light. This is because they're for simulating indirect shadowing. Direct shadowing is already handled by placing objects in the world.

 

== Dynamic lights and shadows ==

By default, no objects cast shadows from dynamic point lights (besides the sun). This is for performance reasons.

Normally ambient shadow decals also will not create shadow from dynamic point lights, because that would be shading direct light, and they don't work that way.

However you can use the <code>'''#SHADOW_POINT_LIGHTS'''</code> level Custom Shader to make it so shadow decals can shape point lights, so you can manually simulate this shadowing.

 
[[File:Shadow point lights shader disabled.png|400px|without #SHADOW_POINT_LIGHTS]]
[[File:Shadow_point_lights_shader.png|400px|#SHADOW_POINT_LIGHTS Custom Shader setting]]
[[File:Shadow_point_lights_shader_enabled.png|400px|with #SHADOW_POINT_LIGHTS]]

 
=== Making shadow decals affect dynamic lights: ===

* Hit <kbd>'''Y'''</kbd> to open the level's scenegraph
* Expand Script Params
* Add a <code>'''Custom Shader'''</code> param
* Hit <code>Enter</code> (not <code>tab</code>!)
* Type <code>'''#SHADOW_POINT_LIGHTS'''</code> in the value column and hit enter

This will make ambient shadows affect the direct light from dynamic lights, an let you sculpt the light they cast, or let you create manual shadows.

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