Toggle search
Toggle menu
TF2 Classified Wiki
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Creating custom weapons - basics: Difference between revisions

From TF2 Classified Wiki
More actions
← Older edit

Static Fanatic (talk | contribs)

995 edits
mNo edit summary
mNo edit summary
 
(7 intermediate revisions by the same user not shown)
Line 21: Line 21:


== custom_items_game.txt ==
== custom_items_game.txt ==
To begin, create a file named {{code|custom_items_game.txt}} in your {{code|<SteamUserDir>\Team Fortress 2 Classified\tf2classified\custom\<Mod Name>\scripts\items}} directory. This is the file that contains all the information regarding your custom weapons. Please note that you cannot have multiple {{code|custom_items_game.txt}} files loaded simultaneously, so any other mod folders that contain them should be placed in {{code|tf2classified\custom\disabled}} to allow the new custom item schema to load.
To begin, create a file named {{code|custom_items_game.txt}} in the {{code|<SteamUserDir>\Team Fortress 2 Classified\tf2classified\custom\<Mod Name>\scripts\items}} directory. This is the file that contains all the information regarding your custom weapons. Please note that you cannot have multiple {{code|custom_items_game.txt}} files loaded simultaneously, so any other mod folders that contain them should be placed in {{code|tf2classified\custom\disabled}} to allow the new custom item schema to load.


It should be noted that the {{code|custom_items_game.txt}} method is the simplest and objectively best option for defining custom weapons, as it automatically inherits data from the newest version of the vanilla {{code|items_game.txt}} file. It is possible to override the vanilla item schema with one that contains custom weapons, but this method is not recommended as the overriding file must be manually updated each patch for parity with the vanilla {{code|items_game.txt}} file. For you and your players' sake, use the {{code|custom_items_game.txt}} method ''only''.
It should be noted that the {{code|custom_items_game.txt}} method is the simplest and objectively best option for defining custom weapons, as it automatically inherits data from the newest version of the vanilla {{code|items_game.txt}} file. It is possible to override the vanilla item schema with one that contains custom weapons, but this method is not recommended as the overriding file must be manually updated each patch for parity with the vanilla {{code|items_game.txt}} file. For you and your players' sake, use the {{code|custom_items_game.txt}} method ''only''.
Line 480: Line 480:
If you make changes to the custom item schema, use the command {{code|cl_reload_item_schema}} to show the changes in game. {{code|sv_reload_item_schema}} can also be used to update the custom item schema for the whole server in multiplayer.
If you make changes to the custom item schema, use the command {{code|cl_reload_item_schema}} to show the changes in game. {{code|sv_reload_item_schema}} can also be used to update the custom item schema for the whole server in multiplayer.


= List of useful attributes =
= Modifying vanilla weapons =
This is going here temporarily before the table entries from [[List of TF2C item attributes]] are added.
''This section will potentially include a different method for editing vanilla weapons that isn't widely used. In the meantime, please do '''not''' write any other methods here, and use this method with caution if you plan on editing vanilla weapons.''


To modify vanilla items, you can include blank item entries in your custom schema with the same IDs as the ones you want to edit. From there, simply add new parameters, and they will merge with the original item's in game. If the same parameter or attribute is in both the vanilla item entry and the copy, then the copy's version will take priority.


43 – scattergun no reload single (set_scattergun_no_reload_single)
When attempting to override a item entry with the {{code|preset=3|baseitem}} parameter, you may have noticed that every other item with it disappears. To counteract this, include a blank copy of any base item you haven't modified in your custom item schema. It should be noted that any base items added to the vanilla item schema in updates must also be added to your custom schema, otherwise they will fail to appear in game. However, this is a rare occurrence, so constant maintenance won't be necessary.


128 - provide on active (provide_on_active)
Below is an example {{code|custom_items_game.txt}} file that contains empty copies of every item with the {{code|preset=3|baseitem}} parameter as of [[3.0.0]].


280 – override projectile type (override_projectile_type)
<pre>
#base "items_game.txt"


298 – mod ammo per shot (mod_ammo_per_shot)
"items_game"
{
"items"
{
"0" // Bat
{
}
"1" // Bottle
{
}
"2" // Fire Axe
{
}
"3" // Kukri
{
}
"4" // Knife
{
}
"5" // Fists
{
}
"6" // Shovel
{
}
"7" // Wrench
{
}
"8" // Bonesaw
{
}
"9" // Shotgun (Engineer)
{
}
"10" // Shotgun (Soldier)
{
}
"11" // Shotgun (Heavy)
{
}
"12" // Shotgun (Pyro)
{
}
"13" // Scattergun
{
}
"14" // Sniper Rifle
{
}
"15" // Minigun
{
}
"16" // SMG
{
}
"17" // Syringe Gun
{
}
"18" // Rocket Launcher
{
}
"19" // Grenade Launcher
{
}
"20" // Stickybomb Launcher
{
}
"21" // Flame Thrower
{
}
"22" // Pistol (Engineer)
{
}
"23" // Pistol (Scout)
{
}
"24" // Revolver
{
}
"25" // PDA: Teleporter (Construction PDA)
{
}
"26" // Destruction PDA
{
}
"27" // Disguise Kit
{
}
"28" // Builder (Toolbox)
{
}
"29" // Medi Gun
{
}
"30" // Invis Watch
{
}
"735" // Sapper
{
}
"1132" // Spellbook Magazine (Halloween)
{
}
"1152" // Grappling Hook (Mannpower)
{
}
"1155" // PASS Time Jack (PASS Time)
{
}
"2000" // Umbrella
{
}
}
}
</pre>


303 – mod max primary clip override (mod_max_primary_clip_override)
= List of useful attributes =
 
The table below lists generally useful attributes from [[List of TF2C item attributes|this page]].
551 – special taunt (special_taunt)
 
674 – class select override vcd ( class_select_override_vcd)
 
675 - custom projectile model (custom_projectile_model)
 
796 – min_viewmodel_offset (min_viewmodel_offset)
 
2029 - allowed in medieval mode (allowed_in_medieval_mode)
 
2058 – meter_label (meter_label)
 
5011 - extra wearable bodygroup toggle active (extra_wearable_bodygroup_toggle_active)
 
5048 - custom hand viewmodel (custom_hand_viewmodel)
 
5129 – mod burstfire (mod_burstfire)
 
5135 – hidden separator (hidden_separator)
 
5157 – passive reload holstered (passive_reload_holstered)
 
5194 – hide ammo hud (hide_ammo_hud)
 
5199 - banned in medieval mode (banned_in_medieval_mode)
 
5201 - custom disguise sound (custom_disguise_sound)
 
5228 - mod ammo per reload (mod_ammo_per_reload)
 
5229 - set reload single (set_reload_single)
 
5230 - Reload time start (mult_reload_time_start)
 
5231 - Reload time refill (mult_reload_time_refill)
 
5249 - mod use custom ammo type (mod_use_custom_ammo_type)
 
5252 - set sentry bullet (set_sentry_bullet)
 
5253 - set sentry rocket (set_sentry_rocket)
 
5254 - weapon exclusive to holiday (weapon_exclusive_to_holiday)
 
5256 - mod projectiles per shot (mod_projectiles_per_shot)
 
5263 - mod set banner flag model (mod set banner flag model)
 
5264 - custom banner sound (custom_banner_sound)
 
5268 - auto jumping (auto_jumping)
 
5270 - always draw tracer (mod_always_draw_tracer_effect)
 
5271 - never draw tracer (mod_never_draw_tracer_effect)
 
5272 - duck jumping (duck_jumping)


??? - custom_magazine_model
<div style="max-width: 100%; overflow-x: scroll;">
{| class="wikitable sortable grid"
! class="header" style="font-size: 16px;background-color: #583a31;color: white;" | ID
! class="header" style="font-size: 16px;background-color: #583a31;color: white;" | Name
! class="header" style="font-size: 16px;background-color: #583a31;color: white;" | Description
! class="header" style="font-size: 16px;background-color: #583a31;color: white;" | Value Type
! class="header" style="font-size: 16px;background-color: #583a31;color: white;" | Class
! class="header" style="font-size: 16px;background-color: #583a31;color: white;" | Notes
|-
| 43 || scattergun no reload single || Attrib_Scattergun_NoReloadSingle || additive || set_scattergun_no_reload_single || Hidden
|-
| 128 || provide on active || When weapon is active || additive || provide_on_active ||
|-
| 280 || override projectile type || || additive || set_scattergun_no_reload_single || Hidden
Changes the projectile type of the weapon
|-
| 298 || mod ammo per shot || Per Shot: -%''s1'' ammo || additive || mod_ammo_per_shot ||
|-
| 303 || mod max primary clip override ||  || additive || mod_max_primary_clip_override || Hidden
|-
| 551 || special taunt ||  || additive || special_taunt || Hidden
|-
| 674 || class select override vcd || Attrib_Class_Select_Override_VCD || additive || class_select_override_vcd || Hidden
|-
| 675 || custom projectile model ||  || additive || custom_projectile_model || Hidden
Supports Rockets, Pipes, Stickies and Tranquillizer Darts
|-
| 796 || min_viewmodel_offset || || additive || min_viewmodel_offset || Hidden
Used for "tf_use_min_viewmodels 1" to shift the viewmodel's position
|-
| 2029 || allowed in medieval mode ||  ||  || allowed_in_medieval_mode || Hidden
|-
| 2058 || meter_label ||  ||  || meter_label || Hidden
|-
| 5011 || extra wearable bodygroup toggle active || || additive || extra_wearable_bodygroup_toggle_active || Hidden
|-
| 5048 || custom hand viewmodel || || additive || custom_hand_viewmodel ||
Hidden <br>
Uses a string
|-
| 5129 || mod burstfire || Sentry Gun turns +%s'''1'''% faster || additive || mod_burstfire || Note: Uses Wrong Localization string
|-
| 5135 || hidden separator || || || hidden_separator || All attributes in a weapon after this one will be hidden from the tooltip.
|-
| 5157 || passive reload holstered || Passively reloads ammo while holstered || additive || passive_reload_holstered ||
|-
| 5194 || hide ammo hud || || additive || hide_ammo_hud || Hidden
|-
| 5199 || banned in medieval mode || || additive || banned_in_medieval_mode || Hidden
|-       
| 5201 || custom disguise sound || || additive || custom_disguise_sound || Hidden
|-
| 5228 || mod ammo per reload || || additive || mod_ammo_per_reload || Hidden
|-
| 5229 || set reload single || || additive || set_reload_single ||
|-
| 5230 || Reload time start || || inverted percentage || mult_reload_time_start ||
|-
| 5231 || Reload time refill || || inverted percentage || mult_reload_time_refill ||
|-
| 5249 || mod use custom ammo type || || additive || mod_use_custom_ammo_type ||
Hidden <br>
Modes: <br>
1 = Primary Ammo <br>
2 = Secondary Ammo <br>
3 = Metal <br>
4 = Grenades1 <br>
5 = Grenades2
|-
| 5252 || set sentry bullet || || additive || set_sentry_bullet ||
Hidden <br>
Value is the projectile index from "override_projectile_type"
|-
| 5253 || set sentry rocket || || additive || set_sentry_rocket ||
Hidden <br>
Value is the projectile index from "override_projectile_type"
|-
| 5254 || weapon exclusive to holiday || || additive || weapon_exclusive_to_holiday ||
Hidden <br>
Modes: <br>
1 = TF Birthday <br>
2 = Halloween <br>
3 = Christmas <br>
4 = End of the Line <br>
5 = Invasion <br>
6 = Valentines <br>
7 = Pyromania <br>
8 = Full Moon <br>
9 = Halloween OR Full Moon <br>
10 = Halloween OR Full Moon OR Valentines <br>
11 = April Fools <br>
12 = Soldier Day (Rick May Passing) <br>
13 = Summer
|-
| 5256 || mod projectiles per shot || || additive || mod_projectiles_per_shot ||
|-
| 5263 || mod set banner flag model || || additive || mod_set_banner_flag_model || Hidden
|-
| 5264 || custom banner sound || || additive || custom_banner_sound || Hidden
|-
| 5268 || auto jumping || Wearer can automatically jump by holding the jump button || additive || auto_jumping ||
|-
| 5270 || always draw tracer || || additive || mod_always_draw_tracer_effect ||
Hidden <br>
Value is frequency, 1 being always
|-
| 5271 || never draw tracer || || additive || mod_never_draw_tracer_effect || Hidden
|-
| 5272 || duck jumping || Wearer can jump while crouching || additive || duck_jumping ||
|-
| ??? || N/A || N/A || N/A || custom_magazine_model || Requires custom attribute
|}


= See also =
= See also =
Retrieved from "https://wiki.tf2classified.com/Creating_custom_weapons_-_basics"