Weapon Creation – Arma Reforger

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "https://enfusionengine.com/api/redirect?to=" to "")
(Remove subpages' content)
Tag: Replaced
Line 1: Line 1:
{{TOC|side}}
{{TOC|side}}
==Goals of this tutorial==
== Tutorial Goal ==
In this tutorial you will learn about:
In this tutorial you will learn about:


*Importing your first FBX file
* Importing your first FBX file
*Adding sockets & skeleton
* Adding sockets & skeleton
*How to configure new weapon
* How to configure new weapon


{{Feature|informative|If you '''don't have any experience with Workbench''' yet, it is recommended to '''go through [[Arma_Reforger:Weapon_Modding|modded weapon tutorial]]''' to familiarize with some of the concepts present in the '''Workbench'''}}
{{Feature|informative|If you '''don't have any experience with Workbench''' yet, it is recommended to '''go through [[Arma Reforger:Weapon Modding|modded weapon tutorial]]''' to familiarize with some of the concepts present in the '''Workbench'''.}}
{{Messagebox|Sources files for this tutorial can be found on
{{Messagebox|Sources files for this tutorial can be found at '''{{Link|https://github.com/BohemiaInteractive/Arma-Reforger-Samples/tree/main/SampleMod_NewWeapon|Arma Reforger Samples Github repository}}'''.|📥|orange}}
[https://github.com/BohemiaInteractive/Arma-Reforger-Samples/tree/main/SampleMod_NewWeapon '''Arma Reforger Samples Github repository''']|📥|orange}}


==Adding new weapon==
== Add New Weapon ==
{{Feature|informative|Preparation phase consist of things like:
{{Feature|informative|Preparation phase consist of things like:


* '''Preparing basic structure'''
* '''Preparing basic structure'''
* '''Preparing mesh'''
* '''Preparing mesh'''
* '''Exporting mesh'''}}
* '''Exporting mesh'''
 
==Preparing structure==
While keeping to official structure is not mandatory and there are no engine restrictions asset wise about it, it's recommended to follow guidelines listed here - [[Arma_Reforger:Directory_Structure|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
 
[[Image:armareforger-new-weapon-file-structure.png|1200px]]
 
==Preparing mesh==
 
This tutorial will try to cover procedure for plugging in new weapon into Enfusion Workbench. While tutorial might be more focused on Blender users, other software users shouldn't be worried since most of the things are working very similar in other programs.
 
===Object orientation===
One of the most important thing to begin with is making sure that your '''model is properly orientated.''' As per [[Arma_Reforger:FBX_Import#Alignment|Arma Reforger:FBX Import]] page:
 
{{Feature|informative|Everything must be oriented as pointing '''along/towards the Y+ axis in Blender and 3dsMax and along Z+ axis in Maya'''}}
 
That means, when you are '''importing A3 weapon you need to rotate it by 90 degrees to the left.'''
 
===Cutting object to parts===
Most likely model that you might already have few bits already present in the mesh. Since Enfusion allows you to assemble weapon from multiple parts, we will split our mesh into multiple separate objects to achieve much higher customization of weapon.
 
[[Image:armareforger-new-weapon-cutting-parts.gif|600px]]
 
In this case, sample contains two parts which could be potentially moved to separate files, letting you to have 3 variants in total quite easily. As marked on above video, grip & iron sights were moved to separate FBX files. Magazine was already separated for that particular mesh so only remaining thing to do is adding slot points for those accessories.
 
===Naming of objects===
When it comes to naming, there are few important rules to keep in mind.
 
#'''_LODx''' suffix is used to indicate '''Level of Details'''
#'''UBX_, UCX_, USP_, UCS_, UCL_, UTM_''' prefixes are used to mark '''Colliders'''
#'''OCC_''' prefix is used for '''Geometry Occluders'''
 
Beside that, there are also some additional guidelines regarding naming of the objects - '''[[Arma Reforger:Weapon Slots And Bones|slot/snap points naming convention]]''' - itself which don't have effect on how mesh is processed by engine (like those mentioned above) but are there to '''have consistency'''. It's also worth to note that some of base weapon prefabs are using some of those names '''by default''' (they can be of course changed but it's strongly advised to follow those rules nevertheless).
 
===Adding slots/snap points===
If you had experience with Arma 3 modding, then whole concept of having slots & snap points should be fairly familiar to you. Those dummy objects are serving as ''memory points -'' there is one major difference though - you no longer have to place two points to make an axis. Instead, rotation of dummy object is used.
 
In Blender, you can use one of the '''empty objects''' like '''Plain Axis''' to create those helper points.
 
[[Image:armareforger-new-weapon-empty-snap.jpg|300px|right]]
[[Image:armareforger-new-weapon-empty-create.png|300px]]
 
''Please notice Plain Axis gizmo - this is the orientation of the model. Make sure that your empty object is '''properly aligned'''''
 
[[Image:armareforger-new-weapon-empty-rotate.png|600px]]
 
{{Clear}}
{{Feature|informative|One easy method to have slot & snap points correctly aligned is to create first slot points, when the mesh is still in one piece, and then copy paste mesh & empty socket to new empty scene. After that only thing left is to rename '''''slot_XX''''' to '''''snap_XX''''' .}}
 
On '''Sample Weapon''', following slots were created:
 
*'''slot_ironsight_front & slot_ironsight_rear -''' slots for picattinny mounted ironsights
*'''slot_magazine -''' slot for magazine well
*'''slot_optics -''' slot for top mounted optics
*'''slot_underbarrel -''' slot for bottom mounted accessories like bipod
 
Additional, following empty objects were created for various components:
 
*'''snap_hand_right -''' helper point for weapon deployment
*'''barrel_chamber & barrel_muzzle -''' those points are used in '''MuzzleComponent''' to determine location & direction where bullet is spawned
*'''eye -''' point for aiming down sight view. Used in '''SightsComponent'''
 
[[File:armareforger-new-weapon-slots-overview.png|alt=|1211x1211px]]{{Clear}}
 
===Colliders & material names===
Colliders are special type of objects which are used to calculate various kinds of collisions - be it physic simulation or tracing of bullet penetration. There are few rules regarding those colliders and most of them listed  [[Arma_Reforger:FBX_Import#Collider_usage|FBX Import - Colliders usage]] page.<gallery mode="nolines" widths="553" heights="250">
File:armareforger-new-weapon-colliders-geo.png|Collider with '''Weapon''' Layer Preset
File:armareforger-new-weapon-colliders-firegeo.png|Collider with '''FireGeo''' Layer Preset
</gallery>
 
'''Weapon requires at least one collider with''' '''Weapon [[Arma Reforger:Collision Layer|layer preset]]''' - if you don't have it, then '''weapon actions like equip will be missing from it'''. If your geometry is simple enough, it is possible to just use one collider for both weapon & fire geometry collision. Otherwise it might be necessary to have two colliders:
 
*One for '''Weapon''' collision - should be very simple collider (i.e. convex)
*Another for '''FireGeo''' collision - can be more detailed, trimesh can be used to provide best experience available.
 
When importing asset from previous Arma game - like in this example - you are most likely going to have already convex components ready from '''Geometry, Fire Geometry, View Geometry''' or '''Geometry Physx LODs''' and in this case automatically '''Fire Geometry LOD from Arma 3 were used as FireGeo''' and '''mesh from Geometry LOD''' was used for '''Weapon''' layer.
 
Now you might ask how to assign '''Layer Presets.''' If you are using Blender, there is small handy tool - [[Arma Reforger:Enfusion Blender Tools: Objects Tools|Objects Tool]] - which is part of [[Arma Reforger:Enfusion Blender Tools|Enfusion Blender Tools]] to assist you with assigning correct game materials & layer presets on colliders.Otherwise, take a look at [[Arma Reforger:FBX Import#Setting Layer Preset on colliders .28usage parameter.29|FBX Import]] page where there are instructions how to set that parameter in 3DS Max or Maya.{{Feature|informative|You can use [[Arma_Reforger:Enfusion_Blender_Tools#Model_Quality_Assurance|Model Quality Assurance]]  to verify if your colliders are convex by '''checking UCX Collider''' option.}}
 
===Setting skeleton & rigging mesh===
 
==== Creating skeleton ====
Whether it's new model or mesh imported from P3D, most likely it will be necessary to prepare skeleton. In '''Blender''' skeletons are called '''[https://docs.blender.org/manual/en/latest/animation/armatures/index.html Armatures]''' and their creation process is quite straightforward. Starting with [https://docs.blender.org/manual/en/latest/animation/armatures/introduction.html#your-first-armature creation of '''Armature itself''']''',''' this can be done by selecting '''Armature''' option from '''Add''' menu in top section of the viewport while being in '''Object''' mode.
 
[[File:armareforger-new-weapon-adding-armature.gif]]{{Feature|important|It is recommended to keep your armature called '''Armature''' since in such scenario, you will avoid artificial bone in skeleton hierarchy when mesh is imported in Workbench. While it might be not causing any issue on rifles, it is basically a '''necessary thing when importing character related gear'''.}}Once its created, you might notice that root bone is quite large and might wish to resize it - to do so, switch to '''Edit Mode''' and select that '''Bone''' and then reduce its size to some reasonable level.
 
[[File:armareforger-new-weapon-scale-bone.gif]]{{Feature|important|Armature should be located at '''0,0,0 point and use 1.0 scale'''. Otherwise you might encounter some problems when trying to animate it in Blender at later stage.}}Next step will be rotation of this bone towards the '''front of the weapon''' and then renaming it to '''w_root''' - this bone will serve us a '''root bone''' of this mesh.
 
[[File:armareforger-new-weapon-rotating-naming-bone.gif]]
 
==== Creating bones ====
After basics of armature are done, it is time to add bones for all animated parts on the weapon. While in '''Edit Mode''' and with '''Armature''' selected, it is possible to add new bones through either:
 
* '''Add→Single Bone''' option in top bar of viewport
* By [https://docs.blender.org/manual/en/latest/animation/armatures/bones/editing/duplicate.html duplicating bone] already present in the armature - like '''w_root'''
 
If you choose the first option, then it will be necessary to resize & rotate the new bone to the desired size. Duplication doesn't have this problem, so it was chosen to create the fire mode switch bone - '''w_fire_mode'''. It is also important to keep the hierarchy of bones in order, and in this case it means that all bones responsible for moving parts of the weapon - '''like w_fire_mode''' -  should be '''parented to w_root'''. This can be done selecting bone in '''Edit Mode and then changing Parent property in Relations section of Bone properties''' tab.
 
[[File:armareforger-new-weapon-duplicating-bones.gif]]{{Feature|informative|Consider setting bones visibility to '''In Front''' - this will help with placement of the bones. <br>[[Image:armareforger-new-weapon-set-bone-in-front.png]]
}}
}}


There are also few thing to keep in mind when creating bones and below is list of those things:


* Bones will serve as axis for any further motion so try to place them in '''spots which would result in reasonable motion''', like center of '''fire selector pivot point''' or '''center of bolt'''.
== Structure Preparation ==
* '''Keep Y+''' orientation of the bones - this might be especially handy is some action is using center of bone for actions
* While it's not necessary, it is recommended to use vanilla [[Arma Reforger:Weapon Slots And Bones#Bones|'''naming convention for bones''']] - this will be especially useful when dealing with animation export, since vanilla animation export profiles expects such bone names.
** ''It is still possible to use custom names but this might require custom export profiles - more about it will mentioned in chapter covering animation of weapon''
With this knowledge in mind, it should be possible to create rest of the bones like '''w_trigger''', '''w_charging_handle''' and '''w_bolt.'''


[[File:armareforger-new-weapon-bones-end-result.png|1349x1349px]]
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 - [[Arma_Reforger:Directory_Structure|Data (file) structure]] - to ensure that all automation plugins are parsing your assets correctly and make it later easy to navigate.


==== Skinning mesh ====
Therefore, your first task will be preparing following file structure
Skinning of the mesh depends on the software that you are using and if you don't know how to do it in software of your choice, it is recommended '''to search for some tutorials on the web what skinning of bones is'''. {{Feature|informative|If you '''imported  model from P3D''' via Enfusion Blender Tools then most likely you will have some vertex groups already - in this case you can try to '''rename those so they match skeleton bone names.'''}}{{Messagebox|'''Recommended read''': Official Blender documentation - ''' [https://docs.blender.org/manual/en/latest/modeling/meshes/properties/vertex_groups/assigning_vertex_group.html '''Assigning a Vertex Group''']|📖|lightgrey}}If you are using '''Blender''', here you can find short instruction how to quickly setup skinning on object. In example below, '''w_bolt''' bone will be set


# Switch to '''Object Mode'''
[[Image:armareforger-new-weapon-file-structure.png|1200px]]
# Select object which you want to skin - in this it is '''body_02_LOD0'''
# In '''[https://docs.blender.org/manual/en/latest/modeling/modifiers/introduction.html#interface Modifiers Properties]''' tab, add '''[https://docs.blender.org/manual/en/latest/modeling/modifiers/deform/armature.html Armature]''' modifier via '''Add Modifier''' button
# In '''Object Data Properties''' expand [https://docs.blender.org/manual/en/latest/modeling/meshes/properties/vertex_groups/vertex_groups.html '''Vertex Group''' panel]
# Switch to '''[https://docs.blender.org/manual/en/latest/editors/3dview/modes.html Edit Mode]''' and then activate '''face''' '''selection mode'''
# Select faces which should belong to bolt
# In '''Vertex Group section, click on''' plus button to '''[https://docs.blender.org/manual/en/latest/modeling/meshes/properties/vertex_groups/assigning_vertex_group.html#creating-vertex-groups Add Vertex Group]'''
# Double click with '''Left Mouse Button''' on it and change name of that new vertex group from '''Group''' to '''w_bolt'''
# Click on '''Assign''' button in '''Vertex Groups''' section (assuming you still have selected bolt faces in viewport) - this will assign your current selection in viewport to '''w_bolt''' vertex group with full influence (''influence is controlled by '''[https://docs.blender.org/manual/en/latest/modeling/meshes/properties/vertex_groups/vertex_weights.html Weight]''' property'')any log
 
[[File:armareforger-new-weapon-set-skinning.gif]]
 
At this stage '''w_bolt''' bone should be successfully rigged but that is not the end of the process!{{Feature|important|Below section applies to any 3D software!}}When creating skinned objects, '''Enfusion Workbench''' expects that the whole object is skinned to some bone. {{Icon|warning}}'''Otherwise importer will try to "fix" it by skinning remaining faces to some root bone and in console log you will see below message:{{Icon|warning}}'''
 
<code style="display: block">RESOURCES (W): Missing some mesh skinning weights (Object_LOD0). Weighting them to root</code>
 
 
 
In Blender realms, this means that any object which '''Armature''' modifier, must be fully skinned to some existing bone through vertex groups. In this case it means that all faces, '''beside those which belongs to''' '''w_bolt''' vertex group, on '''body_02_LOD0'''  object has to be skinned to '''w_root''' bone'''.''' In this case it was done by selecting faces belonging to '''w_bolt''' and then [https://docs.blender.org/manual/en/latest/interface/keymap/industry_compatible.html#selection inverting the selection via CTRL+I shortcut]. After that, new vertex group called '''w_root''' was created and current selection was assigned to it via  '''Assign''' button'''.'''
 
[[File:armareforger-new-weapon-set-skinning-root.gif]]
 
====Rigging colliders====
If you have some animated collider please keep in mind that '''only trimesh colliders can be skinned'''. In all other cases you have to use '''100% weight'''.
 
In Blender it gets even bit more tricky and '''Object Relations''' (in '''''Object tab''''') have to be used if you want connect non trimesh collider to some skeleton bone.
 
[[Image:armareforger-new-weapon-relations.png|400px]]{{Feature|informative|It is also recommended to parent slots on the weapon to the '''Armature''' - it is not necessary to parent it to w_root bone though. This should make it easier to snap magazine in reload sequence for instance}}
 
==FBX export settings==
 
Most of the general rules can be found on '''[[Arma_Reforger:FBX_Import#FBX_Export|FBX Import page]]''' . In principle, when exporting from i.e. 3DS Max, you have to make sure that you are exporting in '''binary format in version 2014/2015'''. Furthermore, '''Triangulation''' & '''Preserve Edge Orientation should be turned off.'''
 
'''Blender''' wise, there are 3 most important things to keep in mind when exporting FBX
{| class="wikitable"
|'''1. Object Types''':
 
For animated object like weapon you need to have checked on at least:
 
'''Empty -''' which handles all snap points
 
'''Armature''' '''-''' exports skeleton of your weapon
 
'''Mesh -''' self explanatory
| rowspan="3" |[[Image:armareforger-new-weapon-export-blender2.png|200px]]
|-
|'''2. Custom Properties''':
 
Without this option all custom properties like '''LayerPresets''' would be lost!
|-
|'''3. Leaf bones''':
 
Leaf bones are completely unnecessary in Enfusion and it's better to have that option '''turned off'''
|}
 
==Preparing textures==
 
When importing textures of weapon from previous Real Virtuality games like Arma 3 there is no real automated or simple method of conversion spec-gloss textures to PBR (''[https://en.wikipedia.org/wiki/Physically_based_rendering Physicial Based Rendering]'') Metal Rough ones - current industry standard. Therefore in most cases it's much easier to do textures from scratch in i.e. Substance Painter (.
 
There are tons of materials on the internet how to create proper PBR texture and it's highly recommend to search for it via some popular search engines. In case of Substance Painter, it is worth to take a look at  [https://substance3d.adobe.com/tutorials/courses/the-pbr-guide-part-1 Substance Painter PBR guide]
 
If you still want to try convert '''RV spec gloss textures to PBR''', you can try to follow [https://www.mod-fusion.com/post/converting-a2-a3-dayz-textures-to-pbr-for-reforger Converting A2/A3/Dayz textures to PBR for Reforger] tutorial.{{Messagebox|'''Recommended read:''' [[Arma_Reforger:Textures|'''Textures''']]|📖|lightgrey}}
 
==Importing Mesh==
{{Feature|informative|In this chapter following topics will be explained
 
* '''Importing new model'''
* '''Importing textures'''}}
 
==Importing & registering new model==
 
Once mesh was successfully prepared and all selections, sockets & snap points are in place, it's time to try our asset in game. Majority of the process is already pretty well described on [[Arma Reforger:FBX Import#Import process in the Workbench|'''FBX import - Import process in the Workbench page''']].
 
In principle, all you have to do is click with right mouse button on your FBX files and select '''Register and Import''' option from the context menu
 
[[Image:armareforger-new-weapon-mesh-register.gif|alt=]]
 
===Checking colliders & materials===
After initial import was done it's time to make sure that materials & colliders are using proper materials & colliders. By default, Enfusion will try to assign material based on the name of the assigned texture in mesh. If it fails to find such texture, new dummy material (see area marked in orange on screen below) will be created next to the FBX model.
 
There are 2 typical errors when it comes to collider configuration:
[[File:armareforger-new-weapon-collider-errors.png|thumb|left|794x794px|Colliders errors example]]
{{Feature|important|Make sure that you have "usage" property defined in collider object properties.
[[Image:armareforger-fbx-layers-blender-1.png|200px]]
 
More info about it can be found on [[Arma_Reforger:FBX_Import]]}}
 
{{Feature|important|Make sure that correct material is assigned to all colliders
[[Image:armareforger-new-weapon-colliders-material.png|200px]]
 
More info about it can be found on [[Arma_Reforger:FBX_Import]]}}
 
{{Clear}}
 
===Skeleton & hierarchy===
[[File:armareforger-new-weapon-import-settings.png|alt=|thumb|392x392px|Import Settings tab]]Next we will take care of bones - in this case, magazine object has only empty objects (snap point) and to import them, checking of '''Export Scene Hierarchy in Miscellaneous section of Import Settings tab should be enough'''. 
 
In case of '''skinned assets like rifles''', '''Export Skinning''' option should be used instead'''.''' It might be also good to know that '''Export Scene Hierarchy is''' not necessary when '''Export Skinning''' option is selected.
 
Below process of setting '''Export Scene Scene Hierarchy on magazine''' is showcased and then analogical process of using of '''Export Skinning''' on '''SampleWeapon_01.xob''' is presented. 
 
If for some reason you don't see bones icon on '''SampleWeapon_01.xob even after checking Export Skinning''' and reimporting resource, make sure that you have properly skinned your model in 3D software of your choice.
 
[[File:armareforger-new-weapon-scene-hierarchy.gif|alt=|none|frame|Importing '''hierarchy''' on magazine]]
[[File:armareforger-new-weapon-importing-skinning.gif|none|frame|Importing '''skinning''' on weapon]]
{{Feature|informative|Changes made in '''Import Settings''' tab are only applied to model after '''manually reimporting model''' via '''Reimport resource (PC)''' button.}}
 
==Importing textures==
 
In principle, you can use same procedures as the ones described on [[Arma_Reforger:Weapon_Modding#From_Scratch|Weapon Modding]] page. {{Messagebox|'''Recommended read:''' [[Arma_Reforger:Textures|'''Textures''']]|📖|lightgrey}}By default, '''Workbench''' should already '''create some of the materials based on their material name in FBX''', so in case of [enfusion://ResourceManager/~SampleMod_NewWeapon:Assets/Weapons/Rifles/SampleWeapon_01/SampleWeapon_01.xob SampleWeapon_01.xob], there should be already some emats which needs to be properly configured.
 
*'''SampleWeapon_01_Camo1.emat''' material with two textures
**'''SampleWeapon_01_Camo1_BCR -''' Base color + Roughness
**'''SampleWeapon_01_Camo1_NMO -''' Normal map
*'''SampleWeapon_01_Camo2.emat''' also with two textures
**'''SampleWeapon_01_Camo2_BCR -''' Base color + Roughness
**'''SampleWeapon_01_Camo2_NMO -''' Normal map
[[File:armareforger-new-weapon-materials.png]]
 
Since in this example, magazine is sharing textures with rifle itself, it is necessary to adjust textures over there. To do so, double click on [enfusion://ResourceManager/~SampleMod_NewWeapon:Assets/Weapons/Magazines/SampleWeapon_01/Magazine_65x39c_SampleWeapon_01_30rnd.xob '''XOB file of magazine'''] to open it in new '''Resource Manager''' tab. After that, it is possible to set up materials which were previously created for the weapon itself.
 
Materials can be assigned in 2 ways:
 
*Drag and dropping desired material on material icon in '''Materials''' tab
** This action will automatically reimport model with selected material
*Changing '''Material Assign''' in '''Visual section''' of '''Import Settings'''
**It will be necessary to click on '''Reimport resource (PC)''' button after applying changes
 
Below is showcase of first method:
 
[[File:armareforger-new-weapon-adjusting-magazine-xob.gif|alt=]]
== Weapon configuration ==
{{Feature|1=informative|2=In this chapter we will learn how fuel is simulated in game and we will change following things:
 
* '''Creating new rifle prefab'''
* '''Configuring basic weapon parameters'''}}
==Basic weapon configuration==
 
===Basic weapon prefab setup===
When making prefabs of weapons it's recommended to inherit from one of the already existing prefabs located in '''''Prefabs\Weapons\Core -''''' those prefabs should have most of the necessary configuration for various kinds of weapons.
 
In this case we will use [enfusion://ResourceManager/~ArmaReforger:Prefabs/Weapons/Core/Rifle_Base.et '''Rifle_Base.et'''] as parent prefab. To do so, navigate in '''Resource Browser''' attached to '''World Editor''' to '''''Prefabs\Weapons\Core''''' & locate [enfusion://ResourceManager/~ArmaReforger:Prefabs/Weapons/Core/Rifle_Base.et '''Rifle_Base.et'''] prefab. Once you are there, click with right mouse button on that prefab and select [[Arma_Reforger:Data_Modding_Basics#Using_.22Inherit_Prefab_in_Addon.22_function|'''Inherit Prefab in Addon''']] from context menu. When asked about new name of prefab, consider calling this new prefab ''nameofweapon_base -'' this might be especially useful when you plan to have multiple variants of weapon, since it will help you to keep your structure nice and clean. After new inherited prefab is created, relocate it to some more fitting location like ''Prefabs/Weapons/Rifles'' folder.
 
[[File:armareforger-new-weapon-creating-inherited-prefab.gif]]
 
{{Feature|informative|Other method involves duplicating some already existing prefab - this might be handy if you are creating something similar to already existing weapons. For instance if you are making some new M16 variant, you could use [[Arma_Reforger:Data_Modding_Basics#Using_.22Duplicate_to....22_function|'''Duplicate to "addon name"''']] function on [enfusion://ResourceManager/~ArmaReforger:Prefabs/Weapons/Rifles/M16/Rifle_M16A2_base.et '''Rifle_M16A2_base.et'''] and then modify parameters of such new prefab.}}
 
After new prefab is created, it is possible to start modifying it. It can be done by either by opening prefab in [[Arma Reforger:Prefabs Basics#Opening prefab in Prefab Edit Mode|'''Prefab Edit Mode''']] button or by [[Arma Reforger:Prefabs Basics#Creating entity prefab in World Editor|'''placing prefab manually in''' '''World Editor''']]. In this tutorial '''Prefab Edit Mode''' was used to edit the ''SampleWeapon_01_base.et'' prefab.
 
Once prefab is loaded, first step would be assigning correct model - in this case it is '''''SampleWeapon_01.xob''''' - to '''MeshObject''' component.
[[File:armareforger-new-weapon-meshobject.png|alt=|thumb|367x367px|'''MeshObject''' component with assigned weapon model]]
 
If you inherited from core weapon type like [enfusion://ResourceManager/~ArmaReforger:Prefabs/Weapons/Core/Rifle_Base.et '''Rifle_Base.et''']  then you will need to add few components listed below. In case of duplication of existing prefab, it might be still worth to adjust data in those components before moving to next section of this tutorial, since some of the values might need to be adjusted, like for example '''damage''' in '''SCR_MeleeWeaponProperties'''.
 
* '''RigidBody''' - this component is responsible for all kind of collisions and without it will be impossible to pick up weapon.
** Once component is created it will be necessary to check '''Model Geometry''' parameter so its '''enabled'''
* '''SCR_MeleeWeaponProperties -''' this component defines how much damage does this weapon when its used in melee fight
** For rifles '''Damage''' value of 45 is a good starting point - for smaller weapon feel free to use lower value
[[File:armareforger-new-weapon-adding-components.gif]]
 
Additional, it might be also worth adding another '''CaseEjectingEffectComponent''' to '''Muzzle Component,''' which is going to emit muzzle smoke. To do so, click with '''Right Mouse Button''' on '''MuzzleComponent''' and select from context menu option '''Add child component''' and select '''CaseEjectingEffectComponent'''  from the list.
[[File:armareforger-new-weapon-case-ejecting-component.png|thumb|Configuration of '''CaseEjectingEffectComponent''']]
[[File:armareforger-new-weapon-adding-child-components.gif]]
 
In component itself, following changes will be required:
 
* Assign fitting particle effect to '''Particle Effect''' field - i.e. [enfusion://ResourceManager/~ArmaReforger:Particles/Weapon/Smoke_M16A2.ptc Smoke_M16A2.ptc]
* In '''Effect Position''' parameter click on '''set class''' button and pick '''EntitySlotInfo''' class and call it for instance Muzzle
** Inside '''Effect Position''', change '''Pivot ID''' to '''barrel_muzzle'''
* Change '''Has Sound''' parameter to '''disabled''' state
Additionally, you might also want to adjust''':'''
 
* '''What kind of cartridges are ejected by the weapon''' - this is defined in '''CaseEjectingEffectComponent''' -  over here you can select from many particle effects like for instance [enfusion://ResourceManager/~ArmaReforger:Particles/Weapon/Casing_556x45.ptc Casing_556x45.ptc] and assign them to '''Particle Effect''' property
* '''Muzzle effect of the weapon''' - this is controlled by '''Particle Effect''' parameter in '''SCR_MuzzleEffectComponent -''' again, you can pick from some existing effects like [enfusion://ResourceManager/~ArmaReforger:Particles/Weapon/Muzzle_AK74.ptc Muzzle_AK74.ptc] or create your own effects like mentioned in [[Arma Reforger:Weapon Modding#Particle Effects Change|Weapon Modding]] documentation
{{Clear}}
 
===Changing inventory parameters ===
[[File:armareforger-new-weapon-storage-component.png|thumb|760x760px|'''SCR_WeaponAttachmentsStorageComponent''']]
In '''SCR_WeaponAttachmentsStorageComponent''' it is possible to adjust some of the basic item properties related to inventory but there is also one section which is used for defining weapon IK pose (''RV veterans might find it similar to handAnims parameter).'' Animation IK pose is not going to be described in this paragraph though so let's move to inventory configuration.
 
{{Feature|important|Using vanilla animation graph will most likely result in malformed weapon, if you are not '''EXACTLY SAME''' bone positions as vanilla weapon.
<br>
It is still possible to use vanilla character animations and create custom weapon animations. More about animations can be found on [[Arma_Reforger:Weapon_Animation|Weapon Animation]] page although it is strongly recommend to finish this part of the tutorial first!}}When looking at '''SCR_WeaponAttachmentsStorageComponent''', multiple '''Attributes''' can be observed like:
 
*'''Item Display Name''' - as name suggest, here it is possible to change Name and Description (on-hover tool tip visible in in-game inventory)
*'''Item Phys Attributes''' - various physical attributes of the item like mass, volume, etc
*'''Item Animation Attributes''' - here are defined item IK poses defined
 
Besides these attributes, there are also '''Custom Attributes''' where it is possible to change e.g. '''Item Inspection Anim''' or the character's maximum speed when a given item is equipped, or '''PreviewRenderAttributes''', which controls the weapon preview in the inventory menu - if your weapon has an odd size, it might be necessary to adjust the camera parameters there.
 
In Reforger, inventory system is no '''longer using pictures''' to for model thumbnails but instead, '''3D models are rendered inside inventory''' '''menu'''. How this item is rendered inside inventory is controlled by '''PreviewRenderAttributes,''' where you have bunch of camera controls''',''' and In case of '''SampleWeapon_01_base.et''', some tweaks to will be required to the camera distance. Since this bullpup weapon is smaller than regular rifles, it looks quite small in inventory menu. To fix this, navigate to '''PreviewRenderAttributes class in Custom Attributes''' and change  '''Camera Distance To Item''' parameter from '''1 to 0.8.'''
[[File:armareforger-new-weapon-preview-render.png|none|thumb|470x470px|'''PreviewRenderAttributes''' inside '''SCR_WeaponAttachmentsStorageComponent''']]
 
{{Feature|important|To refresh preview renders in play mode, it might be necessary to reload all data with {{Controls|1=Shift|2=R}}) shortcut in '''World Editor'''. If its not working, try to '''restart Workbench'''}}
This will put camera closer to the weapon so in inventory menu, weapon should fill whole tile it has available. <gallery mode="nolines" widths="150" heights="133">
File:armareforger-new-weapon-inventory-view-before.png|'''Camera Distance To Item''' set to '''1'''
File:armareforger-new-weapon-inventory-after.png|'''Camera Distance To Item''' set to '''0.8'''
</gallery>
 
In '''Rifle_Base''' prefab, '''Item Phys Attributes''' is not configured and it is necessary to use '''"set class"''' button next to that property. Pressing this button will show additional section where you can freely change parameters.
 
For this '''Sample Weapon,''' following changes were done:
 
* In '''Item Display Name''' section, '''Name''' property was changed to name of the weapon - in this case it is just "''Sample Weapon''"{{Messagebox|'''Tip''': If you already want to configure your display name in a way, where it can be translated, consider looking at [[Arma_Reforger:Mod_Localisation|Mod Localisation]] page|✩|#88cc88}}
 
*'''In Item Phys Attributes''' :
**'''Weight''' parameter was adjusted to somehow match the weight of real weapon without any accessories (including magazine). This '''parameter is using''' '''kilograms''' and in this example it was set to 4kg
**'''Size Setup Strategy''' was setup to '''Volume.''' This means that size of that object will be calculated using '''Item Volume''' .
**'''Item Volume''' [in cm3] defines how much space in inventory takes that object. In this example it is set to '''2500''' just to showcase how it works, normally, 3000 is used for machine guns, while rifle like AK74 has this value set to '''1500'''
Additionally, it will be also necessary to add one entry to '''Custom Attributes'''. This can be done by clicking on '''arrow icon (1)''' to the right of it and then selecting '''ItemOneHandAnimAttributes''' class. This class controls the behavior of the weapon when it is held with one hand only - i.e. when the gadget is equipped - and in most cases the default values are good enough for rifles.{{Clear}}
 
=== Configuring actions ===
 
==== Adding new context ====
[[File:armareforger-new-weapon-action-contexts-optic.gif|left|alt=|thumb|649x649px|Adding new '''Action Contexts''']]
Interactions with weapon in game world, like being able to take weapon from ground or performing some actions in inspect menu, are controlled by '''ActionsManagerComponent'''. [enfusion://ResourceManager/~ArmaReforger:Prefabs/Weapons/Core/Rifle_Base.et '''Rifle_Base.et'''] prefab should already have most of the '''Action Contexts''' and '''Additional Actions''' configured although if your weapon is capable of mounting some optic - like '''Sample Weapon -''' it might be necessary to add another context for handling '''optic related actions it.'''
 
To do add new '''Action Context, simply click on plus icon next to it''' and then inside of it (''by default it should be called UserActionContext''), locate '''Context Name''' property and type in '''optic.''' After that click on '''set class''' button next to '''Position''' property and select '''PointInfo''' class - this will be used to adjust position where the action is located. {{Clear}}
 
=== Adjusting action contexts ===
 
==== Using ActionsManagerComponent debugs ====
Once all contexts are in place, it will be most likely to do some adjustments to the context properties like tweaking position or radius where action is available. Typing in seemingly magic values and then checking it in play mode might be bit time consuming so that is why it is recommended to use some of the existing debugs to speed up configuration process.
[[File:armareforger-new-weapon-action-manager-debug.png|thumb|417x417px|'''ActionsManagerComponent''' custom debugs]]
After clicking on '''ActionManagerComponent'''  with '''Right Mouse Button''' in '''Object Properties''' window, you should see multiple debugs listed in '''Custom''' section like:
 
* '''Draw context(s) diagnostics for selected entity only -''' toggle if debug should be available only for selected entity - mutual exclusive with below debug
* '''Draw context(s) diagnostics for all entities -''' toggle if debug should be available only for all entities in the world - mutual exclusive with above debug
* '''Toggle context(s) transform gizmo visualization -''' show little gizmos next to context action
* '''Toggle context(s) radius visualization -''' show radius of all action contexts
* '''Toggle context(s) visibility angle visualization -''' toggle angle visibility of actions. Only active for non '''Omnidirectional''' action contexts (can be used to have actions which are i.e. available from side of the weapon)
* '''Create user action context(s) from bones -''' small tool for creating multiple action contexts (see [[Arma Reforger:Car Creation#Creating action contexts|Car Creation]] documentation for more details)
 
In this case, it will be enough to enable contexts '''transform visualization.''' At later stage, it will be also handy to enable '''radius visualization''' when adjusting '''Radius parameter.''' Once it is enabled, '''World Editor''' viewport should look like this:
 
[[File:armareforger-new-weapon-default-action-debugs.png|521x521px]]
 
As you can notice, most of the actions are located at '''center of the model''' and need to be moved to more logical places.{{Feature|informative|If you have some issue with actions visibility, you might also try to check in game debugs for [[Arma_Reforger:Diag_Menu#User_Actions|User Actions]]}}
 
{{Feature|important|Remember that user actions are only going to only if you have [[Arma_Reforger:Weapon_Creation#Colliders_.26_material_names|proper colliders with Weapon layer present]] and [[Arma_Reforger:Weapon_Creation#Basic_weapon_prefab_setup|RigidBody has Model Geometry enabled]]}}{{Clear}}
 
==== Changing location of action contexts ====
It might seem that adjusting of action contexts position is a tedious job but thankfully it is possible to adjust their position directly in viewport using gizmos. To do so, go to selected '''Action Context''' - in this case it will be '''firemode''' - and click once on one of the fields in '''Offset''' parameter. After that, you should see a gizmo snapped to this action context, which can be freely adjusted.
 
[[File:armareforger-new-weapon-action-contexts-viewport-tweaking.gif]]
 
Additionally it is also possible to use '''Pivot ID''' to snap action to one of the bones or snap points. Even after Pivot ID is selected, it is still possible to do some tweaks manually using '''Offset''' parameter (including tweaking it in viewport)
 
[[File:armareforger-new-weapon-action-contexts-viewport-tweaking-pivot.gif]]
 
After all '''Action Contexts''' are set, weapon in viewport should look like this:
 
[[File:armareforger-new-weapon-actions-final.png]]
 
==== Adjusting radius of action contexts ====
Last step will be adjusting radius of actions. '''Default''' action context is used for instance for picking up weapon from the ground so preferable it should cover the whole gun. Most of the actions which are inherited from '''Rifle_Base.et''' prefab have already reduced radius but since '''optic''' was created action context was created from scratch, it might still need some tweaking. Default value of '''Radius''' parameter on '''optic''' action context will cause that this action will fight for attention with all other actions and might also appear to early. To fix this, simply reducing '''Radius''' from '''0.3 to 0.1''' should effectively fix this issue'''.'''
 
===Configuring weapon characteristics ===
[[File:armareforger-new-weapon-adjusting-fire-modes.png|thumb|Adjusting '''Fire Modes''' in '''MuzzleComponent''']]
 
 
Most of the weapon firing characteristic can be changed in '''MuzzleComponent''' which is child of '''WeaponComponent'''. Over there, it is possible to '''Fire Modes, Dispersion, Bullet Init Speed Coef, Magazines''' and others. In this segment, focus would be but on getting '''fire modes''' set correctly, which were already partially covered in '''[[Arma Reforger:Weapon Modding#Components Parameters|Weapon Modding]]''' tutorial.
 
Starting with '''Fire Modes''', '''Rifle_Base''' prefab has by default fire modes - '''Safe''' & '''Single''' fire mode, therefore it is assumed that any rifle has a safe mode. If it's not the case for the asset that you are preparing, then it might be necessary to create new base prefab based of '''Weapon_Base''' prefab - this scenario is not going to be described here though.
 
For purpose of this tutorial, '''Sample Weapon''' is equipped with three fire modes - '''safe, single & full auto'''. Since parent prefab has only two fire modes, a new one has to be added through '''➕ sign (1)''' on the right side of the '''Fire Modes''' property. Once it's there, it can be filled with proper data.
 
'''BaseFireMode''' with '''Max''' '''Burst''' set to 1 will work as single fire mode'''.''' On newly added '''BaseFireMode, Max Burst''' should be set to '''-1''' - this fire mode will work as '''full auto mode'''.
 
Burst fire weapons can be configured by setting '''Max Burst''' property to something above 1. In this case, new property will appear - '''Burst Type'''. Over there it is possible to select 3 types of burst fire:
 
*'''Uninterruptible''' - once player presses fire button, weapon will fire exactly the amount of shots defined in '''Max Burst''' (unless weapon runs out of ammo)
*'''Interruptible''' - burst fire will be interrupted once player release fire button. Burst memory is present ( https://en.wikipedia.org/wiki/Burst_mode_(weapons) )
*'''InterruptibleAndReseting''' - same as above but without burst memory
{{Clear}}
===Configuring weapon behavior===
Weapon '''recoil''' is in configured on of the sub classes of '''Weapon Aim Modifiers. Rifle_Base''' prefab is missing '''RecoilWeaponAimModifier & ZeroingWeaponAimModifier''' subclasses in '''Weapon Aim Modifiers''', therefore those have to be added to it. While '''ZeroingWeaponAimModifier''' doesn't need any tweaks, '''RecoilWeaponAimModifier''' class will have to be set from scratch by hand. As reference, either '''pictures below''' or [enfusion://ResourceManager/~ArmaReforger:Prefabs/Weapons/Rifles/AK74/Rifle_AK74_base.et AK74] prefab can be used as reference.<gallery mode="nolines" widths="455" heights="273">
File:armareforger-new-weapon-recoil-data-linear.png
File:armareforger-new-weapon-recoil-data-angular.png
File:armareforger-new-weapon-recoil-data-turn-offset.png
</gallery>
[[File:armareforger-new-weapon-recoil-combined.gif|thumb|Combined recoil effect]]
When tweaking recoil values, following table might be useful to get general concept of what '''Linear, Angular & Turn Offset Data''' does. Tooltips above parameters should provide enough information on how to set data.
{| class="wikitable"
!Recoil
|'''X'''
|'''Y'''
|'''Z'''
|-
!Linear
 
(1u=1m)
|[[File:armareforger-new-weapon-recoil-linear-x2.gif]]
|[[File:armareforger-new-weapon-recoil-linear-y.gif]]
|[[File:armareforger-new-weapon-recoil-linear-z.gif]]
|-
!Angular
(1u=1°)
|[[File:armareforger-new-weapon-recoil-angular-x.gif|269x269px]]
|[[File:armareforger-new-weapon-recoil-angular-y.gif]]
|[[File:armareforger-new-weapon-recoil-angular-z.gif]]
|-
!Offset
 
(1u=1rad)
|[[File:armareforger-new-weapon-recoil-offset-x.gif]]
|[[File:armareforger-new-weapon-recoil-offset-y.gif]]
|''not used, should be left to 0''
|}
 
===Setting zeroing adjustments===
First, you need to setup '''SightsComponent''' and fill in '''Sights Ranges''' with desired zeroings of your weapon. The position of the camera when you aim down sights is controlled by '''Sights Position''' and if you have the '''eye''' snap point placed in the correct spot, then no further adjustments to it should be necessary.
 
Sample weapon setup is bit special since iron sights are mounted on RIS rail and are not integrated part of the weapon. They also have only one zeroing mod set to '''300 meters''' so its not a good example to show how iron sights should be set.
 
Because of that, here is more general explanation how zeroing works using '''AK74 as an example'''. Unlike in Arma 3, weapons in Reforger are '''not using magic ballistic computer''' which is automatically adjusting angle of bullet which leaves the barrel but zeroing is [https://en.wikipedia.org/wiki/Iron_sights working just like in real life]. Bullets are affected by '''gravity and air friction''', so if the target is a little farther away, it's necessary to aim higher if you still want to hit your target, and that's basically how mechanical iron sights work. In principle, [https://en.wikipedia.org/wiki/Iron_sights iron sights] are forcing you to look at certain angle which corresponds to ballistic curve of bullet.
 
[[File:armareforger-new-weapon-zeroing-ak.png|1029x1029px]]
 
Setting points for the proper rotation of iron sights would be a tedious process, but fortunately there is an automated way built into '''Workbench''' to assist you in this process.{{Feature|important|Remember - iron sights will be zeroed to just one particular bullet time, which is assigned in Magazine . If your iron sights are misbehaving, make sure that you are using correct ballistic data for your ammunition.}}To use it, following things has to be done:
 
* Click with {{Controls|1=RMB}}on '''SightsComponent''' and select '''Toggle sight point diag''' from context menu - this will show position of '''sights point which zeroing generator will use.'''
* In '''SightsComponent''', set class '''PointInfo''' (via set class) on '''Sights Point Front & Sights Point Rear''' parameters
* Adjust position of '''Sights Point Front''' so it sits on tip of front iron sight. You can use view port gizmo to do so after clicking on '''Offset''' parameter inside '''Sights Point Front.''' You can also use '''snap points''' and assign them in '''Pivot ID''' if you prefer to do so
* Adjust position of '''Sights Point Rear''' so it sits on tip of rear iron sight.
* Make sure that both front & rear points are in one line
* In '''Zeroing Generator property''' in '''Sights Component,''' set class to '''BaseZeroingGenerator'''
 
[[File:armareforger-new-weapon-sights-debug.png|633x633px]]
[[File:armareforger-new-weapon-ak74-zeroing-plank.png|thumb|260x260px|AK74 tangent sight]]
Next on the list preparing a list of all available zeroing modes. AK74 iron sights can be zeroed between 100 & 1000 meters and first zeroing mode is a 'battle zero' — a fixed preset configured for a likely combat distance. By aiming at an enemy's center of mass, one may be certain that the trajectory of the projectile will make contact, neither overflying or falling short. This means that in total there '''11''' '''zeroing modes.'''
 
Zeroing modes are listed inside of '''Sights Ranges''' array in '''SightsComponent.''' Using ➕'''button''' next to that parameter, add '''11 entries in that array''',which will represents all available zeroing modes.
 
Each '''SightRangeInfo''' has '''Range parameter - which need to be filled manually - and Weapon Position''' class - which is generated by '''zeroing generator'''. In '''Range''',  '''X''' value represents '''animation source value''' & '''Y''' represents '''desired zeroing range in meters''' (note that this value is also shared by UI).
 
Zeroing animation (which is not going to be created yet) goes from 0 to 1, where first entry in '''Sights Range''' array is '''0''' and last one is '''1'''. Since there are 11 zeroing modes, interval between each zeroing mode can be set to '''0.1''' - this was calculated by using following equation '''1/(number of frames - 1).'''
 
This means that you should have following zeroing modes:
{| class="wikitable"
|+Zeroing Modes Table
!Animation Source Value
!Range [m]
|-
|0
|440
|-
|0.1
|100
|-
|0.2
|200
|-
|0.3
|300
|-
|0.4
|400
|-
|0.5
|500
|-
|0.6
|600
|-
|0.7
|700
|-
|0.8
|800
|-
|0.9
|900
|-
|1.0
|1000
|}
{{Feature|warning|Zeroing generator '''doesn't work in Prefab Edit Mode!''' [[Arma_Reforger:Prefabs_Basics#Creating_entity_prefab_in_World_Editor|Place your weapon in World Editor in regular mode]] instead!}}Once you have filled '''Sights Ranges''' you can click with right mouse button on '''Sights Component''' & then select from context menu "'''Process zeroing data'''". Generator will ask which muzzle you want to process and in most cases '''first muzzle''' will be the only choice. After confirming selection, generator will automatically calculate necessary offsets for '''Weapon Positions''' and store those generated values the currently selected weapon '''entity'''. Therefor, it will be necessary to use '''[[Arma Reforger:Prefabs Basics#Using Apply to prefab button|Apply to prefab]]''' button and save current world afterwards.
 
At this stage we won't bother with animating iron sights and we will get back to it once there is animation graph set in. 
 
=== Creating new ammo ===
 
==== Basic configuration ====
[[File:armareforger-new-weapon-ammo-projectile-models.png|alt=Projectile configuration|thumb|532x532px|Projectile configuration]]
Depending on the type of ammo are you preparing, there are few '''core prefabs''' for various types of ammunition located in Prefabs/Weapons/Core folder. In general, there are three suggested approaches:
 
* Creating new prefab inheriting from [enfusion://ResourceManager/~ArmaReforger:Prefabs/Weapons/Core/Ammo_Bullet_Base.et Ammo_Bullet_Base.et]  via [[Arma Reforger:Data Modding Basics#Using .22Inherit Prefab in Addon.22 function|'''Inherit Prefab in Addon''']] functionality
* Duplicating one of existing ammo prefabs via [[Arma Reforger:Data Modding Basics#Using .22Duplicate to....22 function|'''Duplicate in''']] option - this might be useful for instance on rockets, if i.e. you don't want to use some of the components but still want to keep some of the configuration from it
* [[Arma Reforger:Prefabs Basics#Creating inherited prefab|Inheriting from one of existing prefabs]] - this can be used if you are trying to do some variant of existing ammo. This method could be for example used when you [enfusion://ResourceManager/~ArmaReforger:Prefabs/Weapons/Ammo/Ammo_545x39_Ball_7N6.et 5.45x39 7N6] vanilla bullet if you would like to do newer variant of that bullet (for instance [https://en.wikipedia.org/wiki/5.45%C3%9739mm#Basic_specifications 7N10]) with slightly changed characteristics
 
In this tutorial, '''Sample Weapon''' is supposed to use a variant of [https://en.wikipedia.org/wiki/6.5mm_Grendel 6.5 Grendel] ammo but unlike in A3, this round won't be caseless to show how to configure '''spent cartridge ejection'''. Because of that, '''inheriting from [enfusion://ResourceManager/~ArmaReforger:Prefabs/Weapons/Core/Ammo_Bullet_Base.et Ammo_Bullet_Base.et]''' was selected for configuration of this new bullet.
 
When trying to configure a bullet that exists in real life, it is good to gather as much reference material as possible. The Arma 3 variant of the 6.5x39mm is a fictional bullet, so as an inspiration, [https://www.lapua.com/product/65-mm-fmjbt-bullet-b343-93-g-144-gr/ Lapua FMJ BT 144gr round]  with 6.5x39mm dimensions (instead of 6.5x38mm) was used, since there is decent amount of information available for it.
 
After creating new inherited prefab called '''Ammo_65x39_FMJBT.et''', first step will be creating '''Ammo''' folder in '''Prefabs/Weapons''' folder and then moving '''Ammo_65x39_FMJBT.et''' prefab from '''Prefabs/Weapons/Core''' to '''Ammo''' folder.
 
Once prefab is in correct place, you can start editing it in '''World Editor''' by for example entering into [[Arma Reforger:Prefabs Basics#Prefab edit mode|Prefab Edit mode]].
 
In Prefab itself, there are two things you will want to adjust before moving on to more complex topics. First one will be adjusting things in '''Projectile''' itself like changing following parameters:
 
* In '''Projectile Model''' assign model of the bullet itself - this model is visible after it is being fired
* In '''Cartridge Model''' assign model of the cartridge (bullet+case). '''Right now it is not being rendered in game''' though, unless loose bullet is placed in '''World Editor'''.
 
If you don't have models for neither '''Projectile''' or '''Cartridge Model''' , then you can use of the existing ones. In this case [enfusion://ResourceManager/~ArmaReforger:Assets/Weapons/Ammo/Bullets/762x51/Bullet_762x51_M62.xob Bullet_762x51_M62.xob]  and  [enfusion://ResourceManager/~ArmaReforger:Assets/Weapons/Ammo/Bullets/762x51/Cartridge_762x51_M62.xob Cartridge_762x51_M62.xob] were used since they are closest thing which matches Lapua FMJ BT round.
 
Next, go to '''InventoryItemComponent''' and click on '''set class''' button next to '''Item Phys Attributes.''' Over there you will set inventory values which could be useful when i.e. taking single rounds (''which normally in the game doesn't happen)'' try to tweak following parameters:
 
* '''Weight''' - weight of the cartridge in kilograms - in this case it was set to 22 grams - '''influences weight of the magazine'''
* '''Size Setup Strategy''' - change it to '''Volume'''
* '''Item Volume''' - set it up to your linking. 7 is a good starting point
* '''Size -''' change it to '''SLOT_1x1'''
 
[[File:armareforger-new-weapon-ammo-inventory.png|frameless|557x557px]]
 
==== Configuring ballistic properties ====
 
==== Configuring damage ====
 
==== Configuring AI properties ====
 
===Creating new Magazine Well===
 
Magazine wells are classes, which help to establish multi weapon (& mods) magazine compatibility. Any magazine which is using selected class will be usable in any other weapon, which is using exactly same magazine well.
 
In '''Arma Reforger''', there are already '''plenty of magazine wells available''' but since this sample weapon is using rather unique magazine well, a new one has to be created.{{Messagebox|'''Recommended read''':  [[Arma_Reforger:Script_Editor|'''Script Editor''']] documentation|📖|lightgrey}}New '''magazine well''' can be added to the list by creating a '''new script file''' in one of the '''game script folders''' (f.e. ''Scripts/Game/Weapon'' folder can be used - if you don't have such folder, then you need to create it manually). There are no requirements to the name of the script file but it is suggested to use '''MagazineWell_''' prefix naming convention where prefix is name of your addon. Such setup is sort of necessary since unlike models or prefabs, '''scripts don't use metafiles,''' and they [[Arma Reforger:Data Modding Basics#Moddability table|can be replaced by placing file with exact name and relative location as original one]]. Once script is created and opened in '''Script Editor''', the only remaining thing is to create a new class which inherits from '''BaseMagazineWell'''.
<enforce>
// Script File
class MagazineWell65x39C_SampleWeaponClass {}
MagazineWell65x39C_SampleWeaponClass MagazineWell65x39C_SampleWeaponSource;
 
class MagazineWell65x39C_SampleWeapon : BaseMagazineWell
{
}
</enforce>
 
In example above, new magazine well is called '''MagazineWell65x39C_SampleWeapon.'''
 
After magazine well is created, it will be necessary to recompile all game scripts via either '''Compile and Reload Scripts''' ({{Controls|1=Shift|2=F7}}) option in '''Script Editor''' or '''Reload Game Scripts''' ({{Controls|1=Ctrl|2=R}}) in '''World Editor'''.
 
Once scripts are compiled it should be possible to assign that class in '''Magazine Well''' property found both in '''MagazineComponent''' of magazine and '''MuzzleComponent''' of weapon. If there is already some class assigned in '''Magazine Well''' property, then you can still change it by clicking on it with {{Controls|1=RMB}}and selecting '''change class''' option from the context menu.
 
===Basic magazine prefab setup===
 
New magazine prefab can be easily created by inheriting from [enfusion://ResourceManager/~ArmaReforger:Prefabs/Weapons/Core/Magazine_Base.et '''Magazine_Base.et'''] prefab. Once new prefab inheriting from [enfusion://ResourceManager/~ArmaReforger:Prefabs/Weapons/Core/Magazine_Base.et '''Magazine_Base.et'''] is prepared, it is possible to assign magazine model in '''MeshObject.'''
 
Next step will be modification of magazine related properties in '''MagazineComponent'''. Over there, it is possible to set things like ammo which is used or capacity of magazine.
 
In '''InventoryItemComponent,''' similar to main weapon, it is possible to change inventory related properties like name or weight. In this example, values were set as on picture below. 
 
===Adding weapon & magazines to crates===
Once weapon and magazine are ready, it is possible to add those to crates, so they can be picked up either in '''Conflict''' armory or during '''Game Master''' sessions. In principle, there are two types of crates available in game:
 
*'''Arsenal crates''' - those can be either unlimited or be single use. Closely tied to '''playable Factions.''' It is impossible to precisely specify amount of available items.
*'''Regular storage crates''' - using standard storage system, where creator defines exact amount of items, which are available inside of the crate.
 
====Arsenal crates ====
Adding new items to existing '''Faction Arsenals''' crates involves following steps:
 
*Creating override of '''existing Arsenal config''' - either '''[enfusion://ResourceManager/~ArmaReforger:Configs/Arsenal/ArsenalConfig_BLUFOR.conf ArsenalConfig_BLUFOR.conf]''' (''used by US Army''), '''[enfusion://ResourceManager/~ArmaReforger:Configs/Arsenal/ArsenalConfig_INDFOR.conf ArsenalConfig_INDFOR.conf]''' (''used by FIA'') or '''[enfusion://ResourceManager/~ArmaReforger:Configs/Arsenal/ArsenalConfig_OPFOR.conf ArsenalConfig_OPFOR.conf]''' (''used by USSR faction'') - by using '''[[Arma Reforger:Data Modding Basics#Using .22Override in....22 function|Override in "addon name"]]''' functionality
*Open overridden file and adding of new entry to '''Arsenal Items''' array by clicking on plus icon
*'''Assigning prefab of item''', which is supposed to be visible in '''Arsenal''' crate, to '''Item Resource Name''' property. This can be done either by clicking on button with two dots or by dragging and dropping prefab on this field
*Selecting proper '''Item Type & Item Mode''' from the drop down menu.
**For rifles, '''Item Type''' can be set to '''RIFLE''' and '''Item Mode''' to '''WEAPON'''
** For rifle magazines, '''Item Type''' can be set to '''RIFLE''' and '''Item Mode''' to '''AMMUNITION'''
Once those changes are performed, it might be necessary to '''Reload Game Scripts''' or even restart the Workbench. After that, those new items should be visible in existing crates in both '''Game Master''' and '''Conflict''' game mode.
 
====Regular storage crates====
If it is desired to have some specific amount of items, then it is possible to utilize '''UniversalInventoryStorageComponent''' (''or its SCR_ equivalent'') which can be added to basically to any entity with physics enabled.


{{Feature|informative|Process of adding such custom create to in-game editor is not covered here and this subject is pretty well covered on [[Arma_Reforger:Asset_Browser_Mod_Integration|'''Asset Browser Mod Integration''']] page.}}


First step, would be locating prefab where new item should be stored. In this tutorial '''[enfusion://ResourceManager/~ArmaReforger:Prefabs/Props/Military/AmmoBoxes/AmmoBox_545x39_2160rnd.et AmmoBox_545x39_2160rnd.et]''' was [[Arma Reforger:Data Modding Basics#Using .22Duplicate to....22 function|duplicated to addon]] as '''AmmoBox_SampleWeaponMagazines.et''' and then used as an example on how to add new magazines to it. Once that duplicated prefab is present in target addon, following things have to be done:
== Creation Steps ==


*Navigate to '''SCR_UniversalInventoryStorageComponent'''
* {{Link|Arma Reforger:Weapon Creation/Asset Preparation}}
*Add new entry to '''Multi Slots''' array
* {{Link|Arma Reforger:Weapon Creation/Prefab Configuration}}
*Set '''Slot Template''' to '''InventoryStorageSlot''' and assign to it some unique name, i.e. ''Magazines''
* [[Arma Reforger:Weapon Animation Setup|Weapon Animation Setup]] - in this part you will get familiar with the [[Arma Reforger:Animation Editor|Animation Editor]], preparing new animation workspace for weapon by duplicating some existing files and linking this new workspace to the weapon prefab
*Assign magazine prefab to '''Prefab slot''' in this newly created '''Slot Template'''
* [[Arma Reforger:Weapon Animation Basic Creation|Weapon Animation Basic Creation]] - this page covers actual creation of animations in '''Blender''' and their export to Workbench, preparation of weapon IK pose and some basic weapon animation
*Change '''number of items''' present in this slot by modifying '''Num Slots''' value ''(f.e. it can be set to 25)''
* [[Arma Reforger:Weapon Animation Advanced Creation|Weapon Animation Advanced Creation]] - this part describes process of creating more complex animations - additive motion, creation of prone variants of weapon animations, retargeting animations using Reforger source data  and more
<!--
* {{Link|Arma Reforger:Weapon Creation/Animations}}
* {{Link|Arma Reforger:Weapon Creation/Animation Setup}}
* {{Link|Arma Reforger:Weapon Creation/Basic Animation Creation}}
* {{Link|Arma Reforger:Weapon Creation/Advanced Animation Creation}}
-->


After that, this crate should have 25 magazines of your choice inside


== Continuation ==
{{GameCategory|armaR|Modding|Tutorials|Assets}}
{{Feature|informative|'''Next part''' - [[Arma_Reforger:Weapon_Animation|Weapon animations]]}}{{GameCategory|armaR|Modding|Tutorials|Assets}}

Revision as of 13:41, 27 March 2023

Tutorial Goal

In this tutorial you will learn about:

  • Importing your first FBX file
  • Adding sockets & skeleton
  • How to configure new weapon
ⓘ
If you don't have any experience with Workbench yet, it is recommended to go through modded weapon tutorial to familiarize with some of the concepts present in the Workbench.
📥
Sources files for this tutorial can be found at Arma Reforger Samples Github repository.

Add New Weapon

ⓘ
Preparation phase consist of things like:
  • Preparing basic structure
  • Preparing mesh
  • Exporting mesh


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

armareforger-new-weapon-file-structure.png


Creation Steps

Retrieved from "https://community.bistudio.com/wiki?title=Arma_Reforger:Weapon_Creation&oldid=338642"