View source for Vpk.exe

'''VPK''' ("Valve Pak") files are uncompressed archives used to package game content. Valve's post-[[GCF]] games store [[VMT|material]]s, [[MDL|model]]s, [[particles]], and [[VCD|choreography scenes]] in VPK files. VPK is also used to distribute mods via the the <code>addoninstaller</code> tool that ships with some games.

= Creation =

VPKs can be created with the [[command line]] tool <code>vpk.exe</code>.

The tool can be located in the following folders depending on the game. The tool is not game dependent, however it is suggested that you use the tool that corresponds to the game you are creating the vpk for due to updates/versions.

{|class="standard-table"
! &nbsp;Game || &nbsp;Path to VPK.exe
|- 
| {{tf2}}[[Team Fortress 2]]|| C:\Program Files (x86)\Steam\SteamApps\common\Team Fortress 2\bin
|-
| {{l4d}}[[Left 4 Dead]]|| C:\Program Files (x86)\Steam\SteamApps\common\Left 4 Dead\bin
|}

=Commands=

===Usage:===
::<code>vpk [options] <command> <command arguments ...></code>
::<code>vpk [options] <directory></code>
::<code>vpk [options] <vpkfile></code>
==Create VPK/Add Files== 
; <code>vpk <dirname></code>
: Creates a pack file named <dirname>.vpk. Must be an existing location. The VPK will appear next to the directory. {{tip|Drag a folder onto the tool in Explorer to trigger this command.}}
; <code>vpk a <vpkfile> <filename1> <filename2> ...</code>
: Add file(s).
; <code>a <vpkfile> @<filename></code>
: Adds the files referenced in a "response file" (''not'' response rules). Note the <code>@</code> symbol.
; <code>k vpkfile <keyvalues_filename></code>
: Add files references in a [[keyvalues]] control file. {{bug|They will appear inside the VPK with their full path (<code>C:\etc\</code>) intact - is there a way to avoid this?}}
; <code>vpk <directory></code>
: Create VPK from directory structure. {{note|This is invoked when a directory is dragged onto the VPK tool.}}
==Extract Files==
; <code>vpk x <vpkfile> <filename1> <filename2> ...</code>
: Extract file(s).
; <code>vpk <vpkfile></code>
: Extract all files from VPK.  {{note|This is invoked when a .VPK file is dragged onto the VPK tool.}}
==Display VPK Info==
; <code>vpk l <vpkfile></code>
: List contents of VPK.
; <code>vpk L <vpkfile></code>
: List ''Detailed'' contents of VPK.
==VPK Integrity/Security==
; <code>vpk checksig <vpkfile></code>
: Verify signature of specified VPK file. Requires -k to specify key file to use.
==Misc==
; <code>vpk generate_keypair <keybasename></code>
: Generate public/private key file. Output files will be named ''<keybasemame>.publickey.vdf'' and ''<keybasemame>.privatekey.vdf'' {{note|Remember: your private key should be kept private.}}
==Options==
; {{tip|Please note the case of these options. A capital letter is different than a lowercase letter.}}
; <code>-v</code>
: Verbose output.
; <code>-M</code>
: Produce a multi-chunk VPK. {{note|Required if creating a VPK with key values.}}
:* Each chunk is a file limited to around 200MB.
:* To reduce patch sizes, chunks are never overwritten. New/modified files are instead written to a brand new chunk every time you run the tool. {{note|Multi-chunk generations only works when creating a VPK from a response file.}}{{tip|To inspect a multi-chunk VPK open the '_dir' file.}}
; <code>-P</code>
: Use SteamPipe-friendly incremental build algorithm. Use with 'k' command. For optimal incremental build performance, the control file used for the previous build should exist and be named the same as theinput control file, with '.bak' appended, and each file entryshould have an 'md5' value. The 'md5' field need not be theactual MD5 of the file contents, it is just a unique identifierthat will be compared to determine if the file contents has changedbetween builds.
; <code>-c <size></code>
: Use specified chunk size (in MB). Default is 200.
; <code>-a</code>
: Align files within chunk on n-byte boundary. Default is 1.
; <code>-K</code>
: With commands 'a' or 'k': Sign VPK with specified ''private'' key.
; <code>-k</code>
: With commands 'a' or 'k': Public key that will be distributed and used by third parties to verify signatures.
: With command 'checksig': Check signature using specified key file.

= Examples = 

Listed below are some examples of using the tool and what they will do.

==Creating A Key Value File and VPK==
:1. Create a folder with the correct directory structure and files that you wish to use such as <code>mymod/resource/ui/<file.res></code>
:2. Use the command line in a prompt or a bat: 
::<code>vpk -M -k <name>.publickey.vdf -K <name>.privatekey.vdf "C:\Program Files (x86)\Steam\SteamApps\common\Team Fortress 2\bin\mymod"</code>
:3. In the folder where the vpk tool is located there will now be a public key vdf, a private key vdf, a vpk named mymod_000 and a vpk named mymod_dir. 
::{{note|Never disclose or share your private key vdf or the key. Only share the public key.}}
::* You must distribute your mod with both the mymod_dir and mymod_000 vpks for the keyvalue to work.

= Response File =

A "response file" contains a list of files to be added to a VPK. Paths are relative to the current directory of the <code>vpk</code> tool.

Below is a Python script which generates a response file and then builds a multi-chunk VPK. Put it in your mod folder. You will need to edit the three variables at the top.

<source lang="python">
# User settings (don't use the \ character)
target_folders = [ "materials", "models", "particles", "scenes" ]
file_types = [ "vmt", "vtf", "mdl", "phy", "vtx", "vvd", "pcf", "vcd" ]
vpk_path = "C:/Program Files (x86)/Steam/steamapps/common/SourceFilmmaker/game/bin/vpk.exe"

# Script begins
import os,subprocess
from os.path import join
response_path = join(os.getcwd(),"vpk_list.txt")

out = open(response_path,'w')
len_cd = len(os.getcwd()) + 1

for user_folder in target_folders:
	for root, dirs, files in os.walk(join(os.getcwd(),user_folder)):
		for file in files:
			if len(file_types) and file.rsplit(".")[-1] in file_types:
				out.write(os.path.join(root[len_cd:].replace("/","\\"),file) + "\n")

out.close()

subprocess.call([vpk_path, "-M", "a", "pak01", "@" + response_path])
</source>

=== Excluded files ===

Executable and archive files are discarded by the VPK tool:

 .zip .reg .rar .msi .exe .dll .com .cmd .bat

= See Also =

* [[VPK File Format]] (technical details)
* [[L4D Campaign Add-on Tutorial]]
* [[L4D2 Campaign Add-on Tutorial]]
* [[Releasing A Portal 2 Map]]
* [[Swarm Campaign Add-on Tutorial]]

[[Category:Modding]]