Creating and Using Custom Debris - Revision history

Goober at 11:59, 22 May 2022

2022-05-22T11:59:56Z

← Older revision		Revision as of 11:59, 22 May 2022
Line 1:		Line 1:
	{{RF1Tutorial\|Goober}}		{{RF1Tutorial\|Goober (with information provided by rafalh)}}

	Custom debris provides a way to make new [[RED Objects#Clutter\|clutter]] meshes and [[RED Objects#Entity\|entities]] added by mods feel more present and interactive in your world.		Custom debris provides a way to make new [[RED Objects#Clutter\|clutter]] meshes and [[RED Objects#Entity\|entities]] added by mods feel more present and interactive in your world.

Goober: /* Configuring */

2022-05-22T11:58:12Z

Configuring

← Older revision		Revision as of 11:58, 22 May 2022
Line 53:		Line 53:
	*'''Step 4.''' Specify an '''$Explode Anim Radius'''. Self-explanatory, the radius of the vclip as specified in the above line.		*'''Step 4.''' Specify an '''$Explode Anim Radius'''. Self-explanatory, the radius of the vclip as specified in the above line.
	*'''Step 5.''' Specify a '''$Debris Velocity'''. Self-explanatory, the velocity at which debris submeshes fly out from the origin of your clutter object.		*'''Step 5.''' Specify a '''$Debris Velocity'''. Self-explanatory, the velocity at which debris submeshes fly out from the origin of your clutter object.
			*'''Step 6.''' Ensure your clutter's '''$Life''' value is set to a value other than -1 (invulnerable). Debris is only used when an object is destroyed, so you'll never see it if your object is invulnerable.

	[[Category: Red Faction]]		[[Category: Red Faction]]
	[[Category: RF1 Editing]]		[[Category: RF1 Editing]]
	[[Category: Tutorials]]		[[Category: Tutorials]]

Goober: /* Configuring */

2022-05-22T11:56:23Z

Configuring

← Older revision		Revision as of 11:56, 22 May 2022
Line 19:		Line 19:

	==Configuring==		==Configuring==
	I'll cover configuring debris for clutter, but the process is essentially identical for entities (aside from having to be ~~configuring~~ in [[entity.tbl]] rather than [[clutter.tbl]], of course.		I'll cover configuring debris for clutter, but the process is essentially identical for entities (aside from having to be configured in [[entity.tbl]] rather than [[clutter.tbl]], of course.)

	Looking at the [[clutter.tbl]] entry for '''Waste Basket''' (a default clutter class in the game), below in bold are the relevant entries for our purposes. Note that these are all optional settings, so your clutter class may not already have them. If that's the case, you'll need to add them. I've explained each of these options below - all of them can be customized, but if you just want a quick way to get debris working in-game, feel free to copy these settings from the '''Waste Basket''' below and just change the '''$Debris Filename''' to your mesh.		Looking at the [[clutter.tbl]] entry for '''Waste Basket''' (a default clutter class in the game), below in bold are the relevant entries for our purposes. Note that these are all optional settings, so your clutter class may not already have them. If that's the case, you'll need to add them. I've explained each of these options below - all of them can be customized, but if you just want a quick way to get debris working in-game, feel free to copy these settings from the '''Waste Basket''' below and just change the '''$Debris Filename''' to your mesh.

Goober: /* Creating and Importing */

2022-05-22T11:56:00Z

Creating and Importing

← Older revision		Revision as of 11:56, 22 May 2022
Line 12:		Line 12:
	For the purposes of this tutorial, I'm going to assume you're using Blender for modeling and rafalh's [[Rafalh RF Tools#VMesh\|VMesh]] tool for converting it to an RF-compatible format. If you're using the [[Official RF Toolkit#3ds Max Plugins\|3ds Max Plugins]] in the official RF toolkit, the steps for creating and importing the debris mesh will be different, but configuration is the same.		For the purposes of this tutorial, I'm going to assume you're using Blender for modeling and rafalh's [[Rafalh RF Tools#VMesh\|VMesh]] tool for converting it to an RF-compatible format. If you're using the [[Official RF Toolkit#3ds Max Plugins\|3ds Max Plugins]] in the official RF toolkit, the steps for creating and importing the debris mesh will be different, but configuration is the same.
	*'''Step 1.''' When your debris explodes in game, each submesh in your scene is going to fly in the direction it is positioned relative to the origin of the scene (0,0,0). If you want a chunk to fly upward when a clutter mesh dies for example, position that chunk submesh just above the origin in your scene.		*'''Step 1.''' When your debris explodes in game, each submesh in your scene is going to fly in the direction it is positioned relative to the origin of the scene (0,0,0). If you want a chunk to fly upward when a clutter mesh dies for example, position that chunk submesh just above the origin in your scene.
	**'''NOTE:''' It's important to not position any submeshes ''at'' the origin. Doing so will cause ~~they~~ to never appear in game. Each submesh should be offset from the origin in whichever direction you wish for it to fly.		**'''NOTE:''' It's important to not position any submeshes ''at'' the origin. Doing so will cause them to never appear in game. Each submesh should be offset from the origin in whichever direction you wish for it to fly.
	*'''Step 2.''' Ensure your mesh has no armature or animations - debris meshes are static meshes (.v3m).		*'''Step 2.''' Ensure your mesh has no armature or animations - debris meshes are static meshes (.v3m).
	*'''Step 3.''' Export your scene as .gltf from Blender.		*'''Step 3.''' Export your scene as .gltf from Blender.

Goober: /* Creating and Importing */

2022-05-22T11:55:26Z

Creating and Importing

← Older revision		Revision as of 11:55, 22 May 2022
Line 11:		Line 11:
	==Creating and Importing==		==Creating and Importing==
	For the purposes of this tutorial, I'm going to assume you're using Blender for modeling and rafalh's [[Rafalh RF Tools#VMesh\|VMesh]] tool for converting it to an RF-compatible format. If you're using the [[Official RF Toolkit#3ds Max Plugins\|3ds Max Plugins]] in the official RF toolkit, the steps for creating and importing the debris mesh will be different, but configuration is the same.		For the purposes of this tutorial, I'm going to assume you're using Blender for modeling and rafalh's [[Rafalh RF Tools#VMesh\|VMesh]] tool for converting it to an RF-compatible format. If you're using the [[Official RF Toolkit#3ds Max Plugins\|3ds Max Plugins]] in the official RF toolkit, the steps for creating and importing the debris mesh will be different, but configuration is the same.
	*'''Step 1.''' When your debris explodes in game, each submesh in your scene is going to fly in the direction it is positioned relative to the origin of the scene (0,0,0). If you want a chunk to fly upward when a clutter mesh dies for example, position that chunk submesh just above the origin in your scene~~, for example~~.		*'''Step 1.''' When your debris explodes in game, each submesh in your scene is going to fly in the direction it is positioned relative to the origin of the scene (0,0,0). If you want a chunk to fly upward when a clutter mesh dies for example, position that chunk submesh just above the origin in your scene.
	**'''NOTE:''' It's important to not position any submeshes ''at'' the origin. Doing so will cause they to never appear in game. Each submesh should be offset from the origin in whichever direction you wish for it to fly.		**'''NOTE:''' It's important to not position any submeshes ''at'' the origin. Doing so will cause they to never appear in game. Each submesh should be offset from the origin in whichever direction you wish for it to fly.
	*'''Step 2.''' Ensure your mesh has no armature or animations - debris meshes are static meshes (.v3m).		*'''Step 2.''' Ensure your mesh has no armature or animations - debris meshes are static meshes (.v3m).

Goober: /* Creating and Importing */

2022-05-22T11:54:54Z

Creating and Importing

← Older revision		Revision as of 11:54, 22 May 2022
Line 11:		Line 11:
	==Creating and Importing==		==Creating and Importing==
	For the purposes of this tutorial, I'm going to assume you're using Blender for modeling and rafalh's [[Rafalh RF Tools#VMesh\|VMesh]] tool for converting it to an RF-compatible format. If you're using the [[Official RF Toolkit#3ds Max Plugins\|3ds Max Plugins]] in the official RF toolkit, the steps for creating and importing the debris mesh will be different, but configuration is the same.		For the purposes of this tutorial, I'm going to assume you're using Blender for modeling and rafalh's [[Rafalh RF Tools#VMesh\|VMesh]] tool for converting it to an RF-compatible format. If you're using the [[Official RF Toolkit#3ds Max Plugins\|3ds Max Plugins]] in the official RF toolkit, the steps for creating and importing the debris mesh will be different, but configuration is the same.
	*'''Step 1.''' When your debris explodes in game, each submesh ~~(typically referred to as a primitive)~~ in your scene is going to fly in the direction it is positioned relative to the origin of the scene (0,0,0). If you want a chunk to fly upward when a clutter mesh dies for example, position that chunk submesh just above the origin in your scene, for example.		*'''Step 1.''' When your debris explodes in game, each submesh in your scene is going to fly in the direction it is positioned relative to the origin of the scene (0,0,0). If you want a chunk to fly upward when a clutter mesh dies for example, position that chunk submesh just above the origin in your scene, for example.
	**'''NOTE:''' It's important to not position any submeshes ''at'' the origin. Doing so will cause they to never appear in game. Each submesh should be offset from the origin in whichever direction you wish for it to fly.		**'''NOTE:''' It's important to not position any submeshes ''at'' the origin. Doing so will cause they to never appear in game. Each submesh should be offset from the origin in whichever direction you wish for it to fly.
	*'''Step 2.''' Ensure your mesh has no armature or animations - debris meshes are static meshes (.v3m).		*'''Step 2.''' Ensure your mesh has no armature or animations - debris meshes are static meshes (.v3m).

Goober: Created page with "{{RF1Tutorial|Goober}} Custom debris provides a way to make new clutter meshes and entities added by mods feel more present and..."

2022-05-22T11:53:42Z

Created page with "{{RF1Tutorial|Goober}} Custom debris provides a way to make new clutter meshes and entities added by mods feel more present and..."

New page

{{RF1Tutorial|Goober}}

Custom debris provides a way to make new [[RED Objects#Clutter|clutter]] meshes and [[RED Objects#Entity|entities]] added by mods feel more present and interactive in your world.

Firstly, let's differentiate between two terms that are often used interchangeably: '''debris''' and '''corpse'''.
* '''Corpse''' - In RF, this refers to a mesh that replaces a clutter or entity mesh when that object dies. Dead bodies lying on the floor and destroyed computers are examples of corpses.
* '''Debris''' - In RF, this refers to the chunks that fly out from a clutter or entity mesh when that object dies. A good example of debris is the crunched up oil drum that flies away from the point of impact when you shoot an oil drum clutter object.

This tutorial will cover how to create, import, and configure custom '''debris'''.

==Creating and Importing==
For the purposes of this tutorial, I'm going to assume you're using Blender for modeling and rafalh's [[Rafalh RF Tools#VMesh|VMesh]] tool for converting it to an RF-compatible format. If you're using the [[Official RF Toolkit#3ds Max Plugins|3ds Max Plugins]] in the official RF toolkit, the steps for creating and importing the debris mesh will be different, but configuration is the same.
*'''Step 1.''' When your debris explodes in game, each submesh (typically referred to as a primitive) in your scene is going to fly in the direction it is positioned relative to the origin of the scene (0,0,0). If you want a chunk to fly upward when a clutter mesh dies for example, position that chunk submesh just above the origin in your scene, for example.
**'''NOTE:''' It's important to not position any submeshes ''at'' the origin. Doing so will cause they to never appear in game. Each submesh should be offset from the origin in whichever direction you wish for it to fly.
*'''Step 2.''' Ensure your mesh has no armature or animations - debris meshes are static meshes (.v3m).
*'''Step 3.''' Export your scene as .gltf from Blender.
*'''Step 4.''' Using [[Rafalh RF Tools#VMesh|VMesh]], run the conversion command: <code>vmesh MESHNAME.gltf</code>
*'''Step 5.''' Take the resulting .v3m static mesh file and pack it with your mod.

==Configuring==
I'll cover configuring debris for clutter, but the process is essentially identical for entities (aside from having to be configuring in [[entity.tbl]] rather than [[clutter.tbl]], of course.

Looking at the [[clutter.tbl]] entry for '''Waste Basket''' (a default clutter class in the game), below in bold are the relevant entries for our purposes. Note that these are all optional settings, so your clutter class may not already have them. If that's the case, you'll need to add them. I've explained each of these options below - all of them can be customized, but if you just want a quick way to get debris working in-game, feel free to copy these settings from the '''Waste Basket''' below and just change the '''$Debris Filename''' to your mesh.

<blockquote>
$Class Name: "Waste Basket"

$V3D Filename: "wastebasket1.V3D"

'''$Debris Filename: "wastebasket1.V3D"'''

'''$Debris Sound Set: "Tin Hit"'''

$Material: "metal"

$Life: 10

'''$Explode Anim: "Tin Hit Sound"'''

'''$Explode Anim Radius: .4'''

$Flags: ("collide_object")

'''$Debris Velocity: 6'''

$RFE Level1: "Office Stuff"
</blockquote>

'''Configuring your debris:'''
*'''Step 1.''' Specify a '''$Debris Filename'''. This will be the v3m filename of your debris mesh from earlier in this tutorial.
*'''Step 2.''' Specify a '''$Debris Sound Set'''. This controls the sound your debris makes when colliding with the world. It must reference an existing foley class from [[foley.tbl]]
*'''Step 3.''' Specify an '''$Explode Anim'''. This determines the explosion that actually pushes your debris submeshes apart. It must reference an existing vclip class in [[vclip.tbl]]. (it should be a VClip class with the "code_explode" flag)
*'''Step 4.''' Specify an '''$Explode Anim Radius'''. Self-explanatory, the radius of the vclip as specified in the above line.
*'''Step 5.''' Specify a '''$Debris Velocity'''. Self-explanatory, the velocity at which debris submeshes fly out from the origin of your clutter object.

[[Category: Red Faction]]
[[Category: RF1 Editing]]
[[Category: Tutorials]]