How do I make Weapon items? - Catman-232/Homebrewery GitHub Wiki
Edit 2025/08/03 : This guide is going to be overhauled soon.
I'll make a proper guide out of this like the other item types eventually but if you can follow one of those, you should be able to intuit how to work these weapon param files.
A better technical breakdown of the properties can be found here: https://github.com/Catman-232/Homebrewery/wiki/Properties-that-only-Weapons-have
This is what the Template item params looks like
{
"weaponType": "Dexterity_Ranged_2H",
"_weaponHoldClipIndex": 1,
"weaponMesh": "katar_07",
"_weaponProjectileSet": "bow",
"_textureColorAdjust": {
"_hue": 0.0,
"_saturation": 1.0,
"_brightness": 0.0,
"_contrast": 1.0
},
"_drawSound": "Catman-Homebrewery-SFX-FryingPan-DrawSound",
"_hitSound": "Catman-Homebrewery-SFX-FryingPan-HitSound",
"_swingSound": "Catman-Homebrewery-SFX-FryingPan-SwingSound",
"_itemName": "This text is the Weapon's display name",
"_itemDescription": "This text goes in the space beneath the Weapon's name"
}
Sounds from the pan just for examples sake.
weaponType (name) & _weaponHoldClipIndex (number)
Unarmed0isUnarmed(No shit!)
Dexterity_Melee_2H0isFist Weapons
Strength_Melee_1H0isSword1isMace
Strength_Melee_2H0isHammer1isGreat Weapon2isPolearm
Dexterity_Ranged_2H0isBow1isShotgun
Mind_Ranged_1H0isScepter
Mind_Ranged_2H0isMagic Bell
_weaponProjectileSet values:
arrowarrow_naturearrow_piercearrow_shadowarrow_waterscepter(ele_fire)_00scepter(ele_fire)_01scepter(ele_normal)scepter(ele_shadow)scepter(ele_shadow)_alt00scepter(ele_water)_00scepter(ele_water)_01slmDiveBatonscepter(wizscepter)bell_coldgeistbell_colossusTonebell_normalbell_shadowmagitekBurstGun
Sound effects are referenced similar to how custom model parts are, you need an SFX folder in your content pack, the name of the folder and the name of the file are used in the import process. So for example Catman-Homebrewery-SFX-FryingPan-SwingSound means the content pack "Catman-Homebrewery" (HB itself in this case), the "SFX" folder, a "FryingPan" folder inside SFX, and an mp3 file called "SwingSound" inside that FryingPan folder.
The MP3 files must be named correcly to establish context:
Swing sound aliases:
"swing", "onswing", "swingsound", "onswingsound"
Draw sound aliases:
"draw", "ondraw", "unsheath", "drawsound", "ondrawsound", "unsheathsound"
Hitsound aliases:
"hit", "onhit", "strike", "hitsound", "onhitsound", "strikesound"
Due to jank with how the game registers hits, the hitsounds do not currently play, but they are being imported! I need to figure out how to make them play clientsided when you actually do score a hit, since the server is the authority of whether you hit or not, which makes it hard to tell when to actually play the sounds when you are a client.
Vanilla weaponMesh names:
_geistScythe_big_heavyWeapon_greatsword01_heavyWeapon_greatsword01_alt00_axeHammer_01_heavyMelee_hammer01_axeHammer_02_axeHammer_03_axeHammer_04_axeHammer_04HB(It's called _axeHammer_05 in the resources container but the mesh is misnamed with 04, so I had to account for that)_heavyWeapon_axe01_heavyWeapon_axe01HB(In the resources, the previous one's container is heavyaxe_01, while this one is heavyaxe_01_player, but the meshes have the same name anyway, so again I had to account for it)_heavyWeapon_00axe_testweapon.hammerBasic_lightWeapon_mace01_mediumMelee_sword01_mediumMelee_sword02_weapon_blade03_alt00_lightWeapon_blade04_weapon_blade05_weapon_blade05_alt00_weapon_blade06_weapon_blade07sword_test_lightMelee_dagger01katar_01katar_02katar_03katar_04katar_06katar_07katar_08_magicScepter_scepter01_scepter02_scepter02_alt00_scepter03_scepter04_scepter05_scepter06_scepter07_bell_01_bell_02_bell_03_bell_04_bell_05bow_01bow_02bow_02_alt00bow_03bow_04bow_05bow_05_alt00bow_06polearm_01polearm_02_alt00polearm_02_alt01polearm_02polearm_03polearm_04_alt00polearm_04polearm_bardiche_playerDeathKnightSword_weapon_blade03_weapon_blade08polearm_05gun_00