Creating custom weapons - basics: Difference between revisions

{{todo|Complete every current section and add new ones if applicable.}}

If you're here, chances are you're looking to create your own weapons for ''TF2 Classified''. Whether for use against bots or other players, this guide should hopefully cover the majority of your questions regarding custom weapon creation. If it doesn't, ask for help in the '''#modding-discussion''' channel in the [https://discord.gg/tf2classified official TF2C Discord].

Before going over how to create custom weapons, we first need a functional custom item schema to put them into. The item schema is basically a big list that you append all of your weapons into, and is arguably the single most important file for that reason. It uses [https://developer.valvesoftware.com/wiki/VDF VDF], which is the standard format for storing game-related metadata in Source. If you don't know '''VDF''', don't worry - it won't take long to understand the syntax.

To begin, create a file named {{code|custom_items_game.txt}} in the {{code|<SteamUserDir>\Team Fortress 2 Classified\tf2classified\custom\<Mod Name>\scripts}} directory. This is the file that will contain all of the information regarding your custom weapons. Please note that you cannot have multiple ''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.

[[File:example_02_emptyschema.png]]

: This line is responsible for merging the data from the custom item schema into TF2C's main item schema. Without this, none of TF2C's items, prefabs or attributes will load, which isn't very ideal.

To function, item entries must be placed under the {{code|preset=3|"items"}} parameter, with the exact indentation shown in the upcoming template.

Shown below is a template item entry that contains the essential parameters for most custom weapons. Values in {{code|<>}} brackets are placeholder values that should be replaced by suitable ones.

: The unique ID used by the weapon. Be careful: if shared with another item entry, the custom item schema will fail to load. Try to use high values (ideally >= 10000) to prevent clashes with vanilla item entries.

:: {{code|primary}}

:: {{code|secondary}}

:: {{code|melee}}

:: {{code|pda}}

:: {{code|pda2}}

:: {{code|building}}

:: {{code|action}} {{note|Not visible in the loadout menu}}

:: {{code|utility}} {{note|Not visible in the loadout menu}}

:: {{code|primary}}

:: {{code|primary2}}

:: {{code|secondary}}

:: {{code|secondary2}}

:: {{code|melee}}

:: {{code|melee_allclass}}

:: {{code|pda}}

:: {{code|pda2}}

:: {{code|building}}

:: {{code|item1}}

:: {{code|item2}}

:: {{code|item3}}

:: {{code|item4}}

:: {{code|passtime_ball}}

:: {{code|force_not_used}}

Below is an example item entry for a custom [[Pistol]] with a clip size bonus, a damage penalty and the [[tf:Winger|Winger]]'s fire sounds. Copy it and try modifying it to get a feel for making items. If you're looking for models and soundscripts, try using [https://developer.valvesoftware.com/wiki/Half-Life_Model_Viewer%2B%2B HLMV++] and/or [https://developer.valvesoftware.com/wiki/Hammer%2B%2B Hammer ++], or look at item entries in TF2 and TF2C's item schemas.

[[File:example_04_custompistol.png]]

[[File:example_07_canheadshot.png]]

 

[[File:example_08_headshotvisible.png]]

In your {{code|preset=3|"attributes"}} parameter (the one with the same indentation as {{code|preset=3|"items"}} and {{code|preset=3|"prefabs"}} - I know, it's confusing), copy the above attribute. This is a copy of the {{code|"can headshot"}} attribute that's been simplified for this tutorial.

 

'''IMAGE GOES HERE'''

By adding {{code|"effect_type" "positive"}} to the {{code|"can headshot VISIBLE"}} attribute, we can set the colour to the same blue as other positive attributes. If you want an attribute to be displayed as negative, simply replace {{code|"positive"}} with {{code|"negative"}}. The same goes for neutral attributes - replace {{code|"positive"}} with {{code|"neutral"}}.

[[File:example_05_wingermodel.png]]

[[File:example_06_modelperclass.png]]