Test weapon attachments, balance prices

luttje commented 5 months ago

Add more of the TacRP weapons as items

Currently done:

[x] Colt M1911 (tacrp_ex_m1911)
[x] HK HK243 (tacrp_civ_g36k)
[x] Sphinx 2000 (tacrp_sphinx)
[x] HK USP (tacrp_ex_usp)
[x] DSA FAL SA58 (tacrp_dsa58)
[x] PGM Hécate II (tacrp_ex_hecate)
[x] Springfield M1A (tacrp_m14)
[x] Colt M4A1 (tacrp_ex_m4a1)
[x] Benelli M4 (tacrp_m4star10)
[x] Steyr AUG (tacrp_aug)
[x] IMI Mini Uzi (tacrp_uzi)
[x] SIG SG 551 (tacrp_sg551)
[x] Molot Bekas-16M (tacrp_bekas)
[x] KAC PDW (tacrp_pdw)
[x] HK G36K (tacrp_g36k)
[x] Molot TGS-12 (tacrp_tgs12)
[x] HK UMP45 (tacrp_ex_ump45)
[x] Springfield XD-45 (tacrp_xd45)
[x] PGM Ultima Ratio (tacrp_uratio)
[x] HK P2000 (tacrp_p2000)
[x] Ruger Mini-14 (tacrp_m1)
[x] Kriss Vector (tacrp_superv)
[x] Remington 700 SPS (tacrp_spr)
[x] Skorpion vz. 61 (tacrp_skorpion)
[x] FB Beryl 96 (tacrp_ak47)
[x] HK HK94 (tacrp_civ_mp5)
[x] Colt Canada AR-15 (tacrp_ar15)
[x] SIG P250 (tacrp_p250)
[x] HK MP7 (tacrp_mp7)
[x] HK MP5A3 (tacrp_mp5)
[x] Beretta 92FS Vertec (tacrp_vertec)
[x] Benelli M4 Super 90 (tacrp_m4star10)
[x] Diemaco C8A1 (tacrp_m4)
[x] Daewoo K1A (tacrp_k1a)
[x] FN PS90 (tacrp_civ_p90)
[x] SIG 1911 TACOPS (tacrp_gsr1911)
[x] AI AS50 (tacrp_as50)
[x] HK HK417 (tacrp_hk417)
[x] HK FABARM FP6 (tacrp_fp6)
[x] BT MP9 (tacrp_ex_mp9)
[x] Ingram MAC-10 (tacrp_ex_mac10)
[x] HK HK45 Compact (tacrp_ex_hk45c)
[x] FN P90 (tacrp_p90)
[x] Dual MTX (tacrp_mtx_dual)
[x] HK MG4 (tacrp_mg4)
[x] AMD-65 (tacrp_amd65)
[x] AK-47 (tacrp_ex_ak47)
[x] Glock 17 (tacrp_ex_glock)
[x] KS-23 (tacrp_ks23)

Help would be appreciated, check out these weapons for examples. Should be relatively straight forward to add more.

The following ammo types exist:

"xbowbolt": "5.7x28mm Rounds"

"smg1": "5.56x45mm Rounds"

"ar2": "7.62x39mm"

"357": ".357 Rounds"

"ar2altfire": "Beanbag Pellets"

"pistol": "9x19mm Rounds"

"buckshot": "12 Gauge Buckshot"

"alyxgun": ".45 ACP Rounds"

"airboatgun": ".40 S&W"

As defined here: https://github.com/luttje/gmod-experiment-redux/blob/79c34807a3ebe72bf419cd0f9f63f66b805967ae/schema/libs/sh_ammo.lua#L15

Supposedly ammo always has to map to an existing ammo type or one added with game.AddAmmoType (untested)

More ammo types now exist, check out the schema/libs/sh_ammo.lua file to see them.

You can specify the ammo for a weapon using:

-- Inside the item script, below all other ITEM properties:
ITEM.forcedWeaponCalibre = "12 Gauge" -- where 12 Gauge matches the short name as registered in the sh_ammo.lua

This issue isn't finished yet, we still have to:

[x] Add ammo for all calibres
[x] Set prices for the weapons
[x] Set prices for the attachments
[x] Add melee weapons 4d8b7b52a224133aa47d94ff2d71f2435cb8a40a
[x] Future improvements: balance prices (I've just set them on what 'feels right', but we'll have to play around to see what works)
[ ] Remove redundant weapons (there are duplicates and I'm nut sure if they are redundant, e.g: there's tacrp_civ_p90 and tacrp_p90, of which the former is semi-automatic?)
[x] Test if the flashlight attachment does something weird. In the code I see something about it causing a glare/blinding other players. Let's see if it's too excessive. If not then we should consider adding it to the normal flashlight as well + making an item counter it
[ ] Test attachments to see if they perform as expected (pay special attention to attachments that draw on screen, since I disabled that functionality in TacRP)

I'm going to need help from someone who actually knows guns for this one if we want realism.

luttje commented 4 months ago

For reference: I used this script to quickly generate items for all weapons in TacRP

local allWeapons = weapons.GetList()

function getCategoryFromSubCatType(subCatType)
  if (subCatType == "4Assault Rifle") then
    return "primary"
  elseif (subCatType == "9Anti-Materiel Rifle") then
    return "primary"
  elseif (subCatType == "5Sporter Carbine") then
    return "primary"
  elseif (subCatType == "4Machine Gun") then
    return "primary"
  elseif (subCatType == "5Shotgun") then
    return "primary"
  elseif (subCatType == "6Precision Rifle") then
    return "primary"
  elseif (subCatType == "7Sniper Rifle") then
    return "primary"
  elseif (subCatType == "3Submachine Gun") then
    return "primary"
  elseif (subCatType == "1Sidearm") then
    return "sidearm"
  elseif (subCatType == "2Machine Pistol") then
    return "sidearm"
  end

  return nil -- ignore throwables and equipments for now
end

file.CreateDir("experiment-redux-generated/items")

-- Generate the items to the data folder
for _, weapon in ipairs(allWeapons) do
  if (weapons.IsBasedOn(weapon.ClassName, "tacrp_base")) then
    local category = getCategoryFromSubCatType(weapon.SubCatType)

    if (category == nil) then
      continue
    end

    if (not weapon.Trivia_Caliber) then
      weapon.Trivia_Caliber = "5.56x45mm" -- tacrp_ar15 and tacrp_civ_g36k
      ErrorNoHalt("Weapon " .. weapon.ClassName .. " does not have a Trivia_Caliber field. Using 5.56x45mm for it.\n")
    end

    local script = [[local ITEM = ITEM

ITEM.name = "]] .. weapon.PrintName .. [["
ITEM.description = "]] .. weapon.Description:Replace("\n", "\\n") .. [["
ITEM.price = 8100 -- TODO: Set this value
ITEM.class = "]] .. weapon.ClassName .. [["
ITEM.weaponCategory = "]] .. category .. [["
ITEM.model = "]] .. weapon.WorldModel .. [["
ITEM.width = ]] .. (category == "primary" and 3 or 2) .. [[

ITEM.height = ]] .. (category == "primary" and 2 or 2) .. [[

ITEM.forcedWeaponCalibre = "]] .. weapon.Trivia_Caliber .. [["
]]

    local fileName = weapon.ClassName:Replace("tacrp_", "sh_") .. ".lua.txt"

    local path = "experiment-redux-generated/items/" .. fileName
    file.Write(path, script)
  end
end

Instructions

Copy the script to the garrysmod/lua folder as generate_experiment.lua
Run the script using lua_openscript generate_experiment.lua

Now use the following command inside the experiment-redux-generated/items/ folder to rename the files to lua files:

Linux shell:

find . -type f -name "*.lua.txt" -exec sh -c 'mv "$1" "${1%.txt}"' _ {} \;

Windows Powershell:

Get-ChildItem -Path . -Filter "*.lua.txt" | Rename-Item -NewName { $_.Name -replace '\.txt$' }

The items are ready to be copied to the experiment-redux/plugins/customizable_weaponry/items/customizable_weaponry

luttje commented 4 months ago

This issue isn't finished yet, we still have to:
* [x]  Add ammo for all calibres

* [ ]  Change and balance prices for the weapons

* [ ]  Change and balance prices for the ammo

* [ ]  Remove redundant weapons (there are duplicates and I'm nut sure if they are redundant, e.g: there's `tacrp_civ_p90` and `tacrp_p90`, of which the former is semi-automatic?)
I'm going to need help from someone who actually knows guns for this one if we want realism.

luttje commented 4 months ago

Things to keep an eye out for:

I removed the attachment 'corner-cam', because it relies on TacRP drawing on the HUD. That conflicts with the aesthetics of this gamemode, so I've removed it. There may be other items that draw on the hud. You can tell by the attachment seemingly not doing anything. We'll have to remove those.

luttje commented 3 months ago

Closing this as finished. If anything pops up related to this, feel free to make a new issue.

luttje / gmod-experiment-redux

Test weapon attachments, balance prices #4

Instructions