Skip to main content

Advanced - Gun Mod

Create a gun mod

Note: The prefixes used in the tutorial are "WMD_", which can be replaced with your own prefix, and you will need to change the prefix in the AddressableConfig(Assets/Resources/AddressableConfig) file. Once you have changed the prefix, you will need to fill in your new prefix instead of "WMD_" in the tutorial.

Phase 1: Define your mod#

1. New mod project#

Make sure you have the prerequirements for modding and download a fresh ModToolkit to start.

2. Remove unused content#

Make sure to remove the demo content so that we have a clean project to start with.

  • In the Unity toolbar; click Tools > Destructive > Cleanup All Content.

3. Product name#

Change the product name so that the mod folder name will not conflict with other mods.

  • In the Unity Toolbar: Go to Edit -> Project Settings -> Player.
  • Modify field Product Name to your new mod name. Use the format: YOURPREFIX_MyModName. Example: WMD_ChevalierWeapons

4. Prefix.#

Change the project prefix so that the mod files will not conflict with other mods.

  • In the Unity file browser: Open Assets -> Resources -> AddressableConfig.asset

  • Modify field Prefix to your new prefix name. Use the format: YOURPREFIX_MyModName_. Example: WMD_ChevalierWeapons_

    Note: The prefix used in the tutorial is WMD_. You will need to fill in your new prefix instead of every WMD_ in the tutorial.

5.Generate folder structure using the template wizard.#

  • In the Unity Toolbar: Go to Tools -> Template Wizard.
  • Make sure the inspector window is shown (Template Wizard will show there).
  • Enter a new mod folder name. Example: YourModName
  • Set the Mod Type to: Gun.
  • Fill in the desired ItemInfoConfig fields.
  • Click the Generate Template button to generate the Gun folder structure.

6.Place the model#

  • Drag the newly created prefab from the Weapon folder into the SampleScene (or any scene) and click on the right arrow of the prefab in the Hierarchy window to open it (if you edit the prefab directly, you may not see the hand in step 9 in the scene view).
  • Drag your model of the gun into the prefab hierarchy under the parent object. PlaceModel
    Explanation: Parent object is the top object of the prefab. It will be called the same as the name of your prefab.
    (Example: Prefab file is calledNewModFolderName.prefab. parent object will be called NewModFolderName).
  • Rotate the model and resize the weapon until it feels ok in comparison to the dummy weapon. Transform
  • Under InteractWeapon, click show example weapon again to disable the example weapon.
  • Reference the MeshRenderer from the model to Skill Change Colors. (quick tips: if you want to place multiple renderer at the same time, you can click the lock button to lock the inspector, then drag them all at once) (the Skill Change Colors will be used for change weapon color when it's needed, such as damaged).

7.Add Collider for colliding#

  • Click Add Component to add Mesh Collider.
  • select Convex and change default layer to Interact layer. (quick tips: if you want accurate collision, we recommend Collider Creator in the unity asset store, but it's not free.) collider

8. Define HitInfo and CollisionEffect#

In short, RagdollHitInfoObj defines how a collider deals damage and CollisionEffect defines what's the collision physics material is.

  • Change the values in RagdollHitInfoObj and CollisionEffect as (shown in screenshot) on the Parent Object. (Possible options to enter here are can be found on this page: HitInfo and CollisionEffect.)

HitInfo

  • Then add these components(RagdollHitInfoObj and CollisionEffect) to the handle as well to distinguish hits between blade and handle.

collisionEffect

(Explanation: To learn more about RagdollHitInfoObj and CollisionEffect, please read HitInfo and CollisionEffect.)

9.Add HandAttach for grabbing#

  • HandAttach is already added for you by the template wizard.
  • Explanation: HandAttach describes how your hand grabbing it.

Drag a HandPoseHelper from the path Asset/Toolkit/HandPoseHelper to the scene and set the HandAttach reference to the HandPoseHelper's HandAttach

handPoseHelper

Click on AddDragTool and you can see the hand appear in the scene view.

AddDrawTool

Adjust the angle of the HandAttach according to the hand.

RotateHandAttach

Click RemoveDrawTool to remove the hand.

RemoveHandPoseHelper

7. Add MountPoint for backpack#

MountPoint will determine where it will mount to your inventory slots like belt or back.

  • A MountPoint is already added for you by the template wizard (named MountAttach).
  • Move it to the relative position where it should attach to the backpack.

8. Change weapon handling#

In the InteractWeapon, click Swing Like Pistol. (it'll modify the grab force and hand speed)

9.Set InteractTriggerX#

  • Go to the Parent object
  • Scroll down to InteractTriggerX.
  • Click Script to show script options.
  • Make sure the Lua Script value starts with your prefix. (so WMD_WeaponFlyObjBaseScript should be changed to YOURPREFIX_WeaponFlyObjBaseScript).
  • Make sure the String List > flyObjName value value starts with your prefix. (so WMD_Bullet should be changed to YOURPREFIX_Bullet).

10. shoot position#

ShootPosition determines the position and rotation of where the bullet is fired from.

  • Go to shootPosition transform and change it rotation and position to your preference.

11. Sounds & Effects#

Place your sound files in your Mod's Audio folder, add SoundEffectPlayer to the parent object, set the size of SoundName to 1, fill in Element0 with the prefix + sound "WMD_akshot", and finally reference it to InteractTriggerX's shootSound.

Disable SoundEffectPlayer if you don't need it to play on spawn.

SetSoundPlayer

11. AimWidget#

Add AimWidget to the parent object and reposition it to the muzzle of the gun.

AimWidget

Similarly, select the parent object and lock the panel to set the AimWidget component reference to aimWidget.

SetAimWidget

10.Create bullet#

Your gun will ofcourse need a bullet.

  • A bullet is automatically created for you in the Build > FlyObj folder.
  • Open it and add a custom bullet model to it so it looks good.
  • set up ImpactEffect, here we don't cover the creation of the Effect, just use BasicSpark from the project.，you can copy it to the Effect folder of the mod. ImpactEffect
  • set up ImpactSound, again you need to place the sound file in the Audio folder of the mod. ImpactSound

Phase 2: Prepare to export your mod#

Generating the icon

  • In the Unity Toolbar: Go to Tools -> Icon Generator.
  • Drag the Prefab of your mod (the weapon, avatar, scene) into the field: Game Object To Render.
  • Adjust the settings of the icon to your liking.
  • Click the Save PNG... button.
  • Overwrite the dummy icon in folder ICon of your mod that has been created for you previously. (keep the name as is. Don't change this).
  • Set the Max size to 256 and click Apply to save (yes screenshot shows 128, my bad).

Phase 3: Build the mod#

1. Update all addressables.#

  • Go to AddressableConfig(Assets > Resources > AddressableConfig) or use shortcut: ctrl+shift+e.
  • Click Clear Addressables and Create And Refresh Addressable Name.

Then you will see this tool has already setup addressable path for you in the Addressables Groups window. (Window/Asset Management/Addressables/Groups to open this window)

3. Build#

Click BuildTools > BuildAllBundles to Build.

Once you build it successfully, then you will find your mod in the Assets/Mods. If something errors, please checkout the Console information, unity will tell you what's going wrong. And feel free to ask questions on our discord server.

Phase 4: Test & publish the mod#

1. Install on device#

For PC (Recommend for debugging):

  • Make sure you have Battle Talent installed (Steam).
  • In Unity: Click BuildTools > InstallModOnWindows.

For Quest:

  • Make sure you have Battle Talent installed on your Quest (Quest store).
  • Make sure you've connected your headset correctly.
  • Make sure you've allowed sideloading.(if you are not sure how to do this, you can follow this tutorial: https://www.youtube.com/watch?v=RoIXxIfRNTw)
  • In Unity: Click BuildTools > InstallModOnAndroid.

image-20220713173120535

2. Spot the issues via log panel#

Now that it's installed it's time to see if it's working correctly. See if the console gives you some errors. It'll be opened when you toggle Cheat Menu on.

image-20220713173120535

3. Upload your mod to mod.io#

  1. Zip your mod.
  2. Go to https://battletalent.mod.io/.
  3. Click Add mod.
  4. Authenticate (login).
  5. Fill in the required fields.