Weapon Suppressor Creation – Arma Reforger

From Bohemia Interactive Community
Revision as of 17:31, 5 December 2024 by Reyhard (talk | contribs)
Jump to navigation Jump to search
💬
Overview

This tutorial covers following topics:

  • Preparing the 3D model and ensuring correct orientation.
  • Configuring the suppressor as an accessory in the game.
  • Creating the suppressor prefab and configuring its components.
  • Integrating the suppressor with a weapon.
ⓘ
This tutorial guides you through the process of creating a custom suppressor (muzzle attachment) for a weapon in Arma Reforger . The steps are structured similarly to the Weapon Optic Creation tutorial and cover asset preparation, configuration, and integration with a weapon.
📥
Sources files for this tutorial can be found on Arma Reforger Samples Github repository

Prerequisites

  • Basic understanding of Enfusion Engine and Arma Reforger modding.
  • Access to a 3D modeling tool that can export FBX files.
  • Familiarity with scripting in Enforce Script .
  • A mod tag or identifier (e.g., SampleMod_NewWeapon) for naming conventions.
  • Required tools and software:
    • Enfusion Workbench .
    • Enfusion Blender Tools (EBT) (optional but recommended for Blender users).

Structure Preparation

While sticking to official structure is not mandatory and there are no engine restrictions asset wise about it, it is recommended to follow guidelines listed here - Data (file) structure - to ensure that all automation plugins are parsing your assets correctly and make it later easy to navigate.

Therefore, your first task will be preparing following file structure

Preparing the Suppressor Asset

Model Orientation

Ensuring proper model orientation is crucial for correct attachment and in-game behavior. According to the Arma Reforger: FBX Import guidelines:

  • Blender and 3ds Max Users :
    • The model should point along the positive Y-axis .
  • Maya Users :
    • The model should point along the positive Z-axis .

If importing a model from another source (e.g., Arma 3), you may need to rotate it by 90 degrees to align correctly.

Object Naming

Follow these naming conventions to ensure proper import and functioning:

  • Level of Detail (LOD) Suffixes :
    • Use _LOD0, _LOD1, etc., to indicate different LODs.
    • Example: Suppressor_LOD0, Suppressor_LOD1.

Proper naming ensures that the engine correctly interprets your model's components during the import process. For a full list of naming conventions and detailed explanations, refer to the Arma Reforger: FBX Import - Naming Conventions page.

Adding Snap Points

Snap points are essential for correctly attaching the suppressor to weapons. For suppressor, it will be necessary to only add one empty object - snap_weapon. This can be achieved in those few steps:

  1. Create an Empty Object :
    • In Blender, add an Empty object of type Plain Axes .
    • Place it at the point where the suppressor will attach to the weapon.
  2. Name the Empty Object :
    • Set the name to snap_weapon.
  3. Align the Empty Object :
    • Ensure the empty object's orientation matches the weapon's attachment point.
    • The forward direction (front) should align along:
      • Positive Y-axis in Blender/3ds Max.
      • Positive Z-axis in Maya.
  4. Check Orientation :
    • Verify that the snap_weapon aligns accurately with the suppressor's model.

For detailed guidance, see Weapon Slots and Bones .

📖
Recommended read: Slot/snap points concept is described in Weapon Creation documentation

Collision Mesh

Creating an efficient collision mesh optimizes performance and ensures accurate physical interactions.

Choosing Collider Shape

Select the appropriate collider shape based on your suppressor's geometry. The collision mesh doesn't have to be a specific type; you can choose from various collider shapes depending on what best fits your suppressor:

  • Common Collider Types :
    • Box Collider
    • Convex Collider
    • Cylinder Collider
    • Sphere Collider
    • Capsule Collider
    • TriMesh Collider
  • Naming Colliders :
    • Name your colliders with appropriate prefixes to indicate their type.
    • While specific prefixes like UBX_, UCX_, etc., are typically used, focus on selecting the collider that best suits your model's shape
📖
Recommended read: More details about Inventory Configuration can be found on Weapon Optic Creation documentation

Simplifying the Collider

  • Keep It Simple : Use the simplest shape that accurately represents the suppressor.
  • Performance Consideration: Simplified colliders reduce computational overhead.
  • Avoid Complex Meshes : Complex collision meshes can negatively impact performance.

Assigning Layer Preset and Game Material

Assign appropriate properties to your collider:

  • Layer Preset : ItemFireView
    • This layer preset is appropriate for weapon attachments and ensures correct interactions in the game.
  • Game Material : weapon_metal.gamemat
    • This material provides appropriate physical properties and sound effects for metal weapon components.
How to Assign
  1. In Your 3D Software :
  2. In Enfusion Workbench Import Settings :
    • If not set in the 3D software, you can assign them during import.
    • In the Import Settings , select your collider.


Exporting the Model

Export your model to the FBX format suitable for Enfusion.

  • Using Enfusion Blender Toolkit (EBT) FBX Exporter (Optional):
    • Simplifies export and ensures compatibility.
    • Automatically imports & registers FBX in Workbench and enables "Export Scene Hierarchy".
  • Without EBT :

Texturing the Suppressor

Apply textures to give your suppressor the desired appearance.

Enfusion Materials Creation

  • If the import of the model went fine, new Enfusion Materials (.emat files) should be created in the Data folder next to the model.
  • These new materials are named based on the material names in your 3D software.
  • By default, they use the MatPBRMaterial shader.

Assigning Textures

  1. Prepare Textures :
    • Assuming you have already created PBR textures (Base Color, Normal Map, etc.) using a tool like Substance Painter.
    • You can use the BCR+NMO export preset shared on GitHub:
  2. Import Textures into the Game :
    • Place your exported textures (e.g., Suppressor_BCR.tga, Suppressor_NMO.tga) into the appropriate folder within your mod's Data directory.
  3. Assign Textures to Materials :
    • In the Enfusion Workbench, navigate to the .emat files created during the import.
    • Open each material and assign the corresponding textures to the appropriate fields:
      • BCR Map :
        • Assign your Base Color Roughness texture (_BCR).
      • NMO Map :
        • Assign your Normal Map (_NMO).
    • For detailed information on texture types and how to use them, refer to Arma Reforger: Textures .
  4. Verify Material Settings :
    • Ensure that all material properties are set correctly.
    • Adjust parameters like Metallic , Roughness , and Specular as needed.

Testing the Textures

  • Preview the Model :
    • Use Enfusion Workbench to ensure textures appear correctly.
  • Check for Issues :
    • Look for texture stretching, UV mapping errors, or material issues.
  • Adjust as Necessary :
    • Make corrections in your 3D software or texture editor if needed.


Creating the Attachment Script Class

Attachment config classes in Arma Reforger establish compatibility between weapons and their attachments. Any attachment using a specific attachment class will be compatible with any weapon that references that class. This system ensures that only appropriate attachments can be mounted on specific weapons, maintaining realism and game balance.

In many cases, existing attachment classes can be used. For example, muzzle attachment classes for 5.45 mm or 5.56 mm calibers are already defined in the game's vanilla data. However, since our Sample Weapon uses a 6.5 mm barrel, and this caliber doesn't exist in the vanilla data, we need to create a new attachment class specifically for it. This ensures that only attachments intended for 6.5 mm barrels can be mounted on the weapon.


If you intend to make i.e. suppressor suitable for M16, then you could skip that part and move to Creating the Suppressor Prefab part.

ⓘ
Existing vanilla muzzle attachment classes can be found in the Attachments_muzzle.c script file.

Setting Up the Attachment Config Class

To add a new attachment config class, you'll create a new script file in one of your mod's game script folders. For example, you can use the Scripts/Game/Attachments/Muzzles folder. If this folder doesn't exist, you'll need to create it manually.

Naming Conventions

Scripts in Arma Reforger don't use metafiles and can be overwritten if another mod uses the same script name and path. To prevent conflicts, it's recommended to use a unique naming convention for your script files and classes, such as prefixing them with your mod's tag.

  • Use the TAG_ Prefix:
    • Prefix your script file names and class names with a unique tag to prevent naming conflicts.
    • In this case, the tag is SampleMod_NewWeapon.
  • Script File:
    • Use a clear and descriptive filename that includes your mod's tag.
    • Example: SampleMod_NewWeapon_Attachments_Muzzle.c
  • Class Names:
    • Attachment Config Class: Defines the configuration class for your muzzle attachment.
      • Example: AttachmentMuzzle65_39Class
    • Attachment Class: Inherits from AttachmentMuzzle.
      • Example: AttachmentMuzzle65_39

Creating the Script File

Create the Script File

  1. Navigate to Your Script Directory:
    • Go to /Scripts/Game/Attachments/Muzzles/ within your mod folder.
    • If these folders don't exist, create them accordingly.
  2. Create a New Script File:
    • Right-click in the Muzzles folder and select New Script .
    • Name the file SampleMod_NewWeapon_Attachments_Muzzle.c.
    • Ensure the file extension is .c.

Define the Attachment Config Class

Open the newly created script file and define your classes exactly as follows:

class AttachmentMuzzle65_39Class {} AttachmentMuzzle65_39Class AttachmentMuzzle65_39Source; class AttachmentMuzzle65_39 : AttachmentMuzzle { };

Recompiling Scripts

After creating the script, recompile the game scripts:

  • In Script Editor :
    • Use Compile and Reload Scripts (⇧ Shift + F7).
  • In World Editor :
    • Use Reload Game Scripts (Ctrl + R).


By following these steps, you've successfully created a new attachment config class for your 6.5 mm suppressor. This class will ensure proper compatibility between your suppressor and the Sample Weapon , while preventing incompatible attachments from being mounted.

📖
Recommended read: For more information on how attachment classes and inheritance affect compatibility, refer to the Weapon Optic Creation: Attachments Configuration documentation

Creating the Suppressor Prefab

Create Suppressor Prefab

When creating a suppressor prefab in Arma Reforger, it is recommended to inherit from the existing base suppressor prefab. The base suppressor prefab can be found at Prefabs\Weapons\Core\Suppressor_base.et. This prefab contains most of the necessary configurations for suppressor attachments.

ⓘ
In this article, Enfusion links are used. With those links it is possible to open specific resource just by simply clicking on that link. Enfusion links has to be manually activated in Workbench options (Workbench -> Options -> Workbench -> Register "enfusion://" protocol) before it can be used

To begin, navigate to Prefabs\Weapons\Core in the Resource Browser and locate the Suppressor_base.et prefab. Right-click on this prefab and select Inherit in... from the context menu.

✩
Other method involves duplicating some already existing prefab - this might be handy if you are creating something similar to already existing weapons or don't want to add manually components. For instance if you are making some new AK74 suppressor variant, you could use Duplicate to "addon name" function on Suppressor_PBS4_base.et and then modify parameters of such new prefab.

When prompted to name your new prefab, consider adding a _base suffix to maintain consistency and clarity, especially if you plan to have multiple variants of the suppressor. For example, if your suppressor is named "Suppressor_SampleSuppressor_01," you might name the prefab Suppressor_SampleSuppressor_01_base.et . After creating the inherited prefab, move it to a more appropriate location, such as the Prefabs\Weapons\Attachments\Muzzle\Suppressor_SampleSuppressor_01 directory.

ⓘ
Inheriting from the base suppressor prefab ensures that essential components and configurations are included, saving you time and reducing the potential for errors.


Creating a Child Prefab

In addition to the base prefab, it's advisable to create a child prefab without the _base suffix. This child prefab will inherit from your base suppressor prefab (SampleSuppressor_01_base.et ) and will be named SampleSuppressor_01.et .

To create this child prefab:

  1. Right-click on your base suppressor prefab (Suppressor_SampleSuppressor_01_base.et ) and select Inherit .
  2. Name the new prefab without the _base suffix (e.g., Suppressor_SampleSuppressor_01.et ).
  3. Move this prefab to the appropriate directory alongside your base prefab.

This child prefab will initially be empty and won't hold any unique information. However, it serves an important purpose, especially when reskins or additional variants are present. For example, you might create another variant called Suppressor_SampleSuppressor_01_camo.et for a camouflage version of the suppressor. Suppressor_SampleSuppressor_01_camo should inherit from Suppressor_SampleSuppressor_01_base.et as well. By making changes to the base prefab (SampleSuppressor_01_base.et ), those changes automatically propagate to all child prefabs, including Suppressor_SampleSuppressor_01.et and Suppressor_SampleSuppressor_01_camo.et . This organizational structure makes it easier to manage and update your assets consistently.


Once your prefabs are set up, you can start editing the base prefab to configure your suppressor. Open the prefab in Prefab Edit Mode by selecting it and clicking the Prefab Edit Mode button.

Edit the Suppressor Prefab

Configure components within your new prefab.

Configure MeshObject

  • Assign your suppressor's mesh to the MeshObject component.

Configure InventoryItemComponent

Next, configure the suppressor's inventory properties:

  1. Select the InventoryItemComponent .
  2. Modify the Item Display Name to change how the suppressor appears in the inventory.
  3. Adjust the Item Phys Attributes to change storage properties like weight and size.
  4. Under Custom Attributes , adjust the PreviewRenderAttributes to change the suppressor's visibility in the inventory preview
📖
Recommended read: More details about Inventory Configuration can be found on Weapon Optic Creation documentation

Configure WeaponAttachmentAttributes

In Custom Attributes of InventoryItemComponent:

  • WeaponAttachmentAttributes is already inherited from the base prefab.
  • Set Attachment Type :
    • Assign class of your suppressor (i.e.AttachmentMuzzle65_39 )
      • Default, inherited selection can be changed by clicking on Attachment Type class with Right Mouse Button and selecting Change Class option from the context menu
    • This parameter controls where the suppressor can be attached.

Configure SCR_WeaponAttachmentSuppressor Component

Now, configure the suppressor's attachment properties:

  1. Select the SCR_WeaponAttachmentSuppresor component.
  2. Attachment Type : Set this to the class you created earlier for the suppressor attachment point.
  3. Muzzle Speed Coefficient : Adjust this value to reflect the effect of the suppressor on bullet velocity. Suppressors often increase bullet speed due to the extended barrel effect.
  4. Muzzle Dispersion Factor : Modify this to account for changes in bullet spread when the suppressor is attached.
  5. Extra Obstruction Length : Increase this value to simulate the added length of the suppressor, affecting the weapon's obstruction values in the WeaponComponent .
  6. Recoil Coefficients :
    • Linear Factors : Adjust to simulate changes in linear recoil.
    • Angular Factors : Adjust to simulate changes in angular recoil.
    • Turn Factors : Adjust to simulate changes in weapon turn dynamics due to the suppressor's weigh

Configuring the SCR_MuzzleEffectComponent

Set up the muzzle effect to represent the suppressor's visual effects when firing:

  1. Select the SCR_MuzzleEffectComponent
  2. Particle Effect : Assign a suitable particle effect (e.g., MuzzleFlash_Suppressor.ptc ) to represent the suppressed muzzle flash.
  3. Effect Position :
    • Click on the Set Class button and select EntitySlotInfo .
    • Name it appropriately (e.g., SuppressorEnd ).
    • Adjust the Offset so the effect is positioned at the suppressor's muzzle end.
  4. Reset On Fire : Disable this parameter to prevent the effect from resetting after each shot, creating a continuous smoke effect.

Configure Attachment Obstruction (Optional)

Configuring attachment obstruction ensures that certain attachments cannot be used simultaneously and that some attachments require others to be present. The SCR_WeaponAttachmentObstructionAttributes is already inherited from the parent suppressor prefab, so you do not need to add it manually.

To configure obstruction attributes:

  1. Navigate to SCR_WeaponAttachmentObstructionAttributes:
    • In your prefab's Custom Attributes , locate the SCR_WeaponAttachmentObstructionAttributes entry.
  2. Adjust Parameters as Needed:
    • Attachment Type
      • Class of attachment which following rules applies to
    • Obstructed Attachment Types:
      • List attachment types that cannot be mounted at the same time as this suppressor.
      • For example, you might list muzzle devices or bayonets that are incompatible with the suppressor.
    • Required Attachment Types:
      • List attachment types that must be present for this suppressor to be attachable.
      • For instance, if your suppressor requires a specific muzzle adapter or flash hider, include that attachment type here. Example: An M9 Bayonet requires the A2 Flash Hider to be mounted first, as it attaches to the flash hider rather than directly to the barrel.

By configuring these attributes, you control which attachments can be used together and establish dependencies between attachments. This ensures that weapon customization behaves realistically and prevents players from combining incompatible attachments.

Adjust ActionsManagerComponent (Optional)

Depending on how your suppressor is positioned, you might need to adjust the positions of user and muzzle actions:

  1. Select the ActionsManagerComponent .
  2. Within the Action Context , locate the user and muzzle actions.
  3. Modify their Offset in the Position property to align them correctly with the suppressor's position

Localization

Lastly, it's recommended to localize your suppressor asset:

  • This ensures the suppressor's name is displayed correctly in the inspection menu and other UI elements.
  • Localize the Item Display Name using instruction listed on Arma Reforger:Mod Localisation page.

Integrating the Suppressor with a Weapon

Configure the Weapon's Muzzle Component

To enable your weapon to accept and properly function with your newly created suppressor, you need to configure the weapon's components accordingly.

Configuring the Weapon's Muzzle Component

First, open your weapon prefab (SampleWeapon_01_base.et ) in Prefab Edit Mode .

Add an AttachmentSlotComponent

  1. Select the MuzzleComponent:
    • In the Entity Tree , expand your weapon entity and locate the MuzzleComponent.
  2. Add AttachmentSlotComponent as Child Component of Muzzle Component

Configure the AttachmentSlotComponent

With the AttachmentSlotComponent selected, configure its properties:

  1. Pivot ID:
    • Set the Pivot ID to the weapon's muzzle slot.
      • This is typically slot_barrel_muzzle.
    • This ensures the attachment point aligns with the muzzle end of the weapon.
  2. Child Pivot ID:
    • Set the Child Pivot ID to snap_weapon.
    • This specifies where the attachment (suppressor) will snap onto the weapon. This bone/empty object should exist in attachment itself. If its not prevent, then Scene Root will be used
  3. Attachment Point Type:
    • Assign the attachment point type to match your suppressor's attachment class.
      • Click on the Attachment Point Type property.
      • Select Change Class from the context menu.
      • Search for AttachmentMuzzle65_39 (the class you created earlier).
      • Select it to assign it to the attachment point.
  4. Show in Inspection:
    • Enable the Show in Inspection option.
    • This allows the attachment slot to be visible when inspecting the weapon in-game.

Add SCR_WeaponStatsManagerComponent

To ensure the weapon correctly handles parameter adjustments and sound switching when the suppressor is attached, you need to add the SCR_WeaponStatsManagerComponent.

  1. Add SCR_WeaponStatsManagerComponent Component
  2. No Additional Configuration Needed:
    • The SCR_WeaponStatsManagerComponent doesn't have any parameters other than Enabled .
    • Simply adding this component is sufficient.
    • This component is crucial for handling parameter adjustments and sound switching when attachments like suppressors are used.


ⓘ
The SCR_WeaponStatsManagerComponent manages changes to the weapon's stats and sounds when attachments are added or removed. For more detailed information, you can refer to the Weapon Stats Modifying Attachments documentation.

Updating the WeaponSoundComponent

To ensure that the weapon produces the correct sounds when the suppressor is attached, you need to update the WeaponSoundComponent.

  1. Select the WeaponSoundComponent:
    • In the Entity Tree, locate and select the WeaponSoundComponent.
  2. Add Suppressed Sounds:
    • In the Properties panel, find the Filenames property.
    • Add the Suppressed Firing Sound:
      • Click on the Add Element button (often a + icon) next to the Filenames array to add a new sound file.
      • Assign the suppressed firing sound file to this new element.
        • Choose an appropriate sound file (e.g., {5D9EB1EFB7097850}Sounds/Weapons/Rifles/AK-74/Weapons_Rifles_AK-74_Shot_Suppressed_SuperSonic.acp).
    • Configure the Filenames:
      • Ensure that both the normal and suppressed firing sounds are included in the Filenames array.
      • The WeaponSoundComponent will automatically handle the sound selection based on the weapon's state and attachments.
ⓘ
The WeaponSoundComponent uses the Filenames array to determine which sounds to play when the weapon is fired. It will automatically switch between the normal and suppressed firing sounds depending on whether the suppressor is attached. The order of the sound files in the Filenames array does not affect which sound is played. What matters, is presence of SOUND_SUPPRESSED_SHOT node.

Testing Your Suppressor

Thorough testing ensures functionality aligns with expectations.

  • Attachment Verification :
    • Attach and detach the suppressor.
  • Alignment Check :
    • Confirm correct alignment with the weapon's muzzle.
  • Functionality Test :
    • Fire the weapon with the suppressor.
    • Check muzzle effects, sounds, recoil, and accuracy.
  • Attachment Obstruction Test :
    • Verify incompatible attachments cannot be mounted simultaneously.
  • Required Attachments Test :
    • Ensure required attachments are necessary for mounting.
  • Inventory Inspection :
    • Confirm the suppressor's name and preview display correctly.
Retrieved from "https://community.bistudio.com/wiki?title=Arma_Reforger:Weapon_Suppressor_Creation&oldid=370407"