AutoBSPpackingTool
Jump to navigation
Jump to search
| Checkbox | File(s) |
|---|---|
| .nav (navigation mesh) | /maps/<mapname>.nav
|
| .ain (info_node) | /maps/graphs/<mapname>.ain
|
| .txt (map description) | /maps/<mapname>.txt
|
| .txt (soundscape) | /scripts/soundscapes_<mapname>.txt
|
| .txt (soundscript) | /maps/<mapname>_level_sounds.txt
|
| .cache (soundcache) | /maps/soundcache/<mapname>.cache
|
| .txt (retake bombplants) | /maps/<mapname>_retake.txt
|
| .txt (camera positions) | /maps/<mapname>_cameras.txt
|
| .txt (map story) | /maps/<mapname>_story.txt
|
| .txt (radar information) | /resource/overviews/<mapname>.txt
|
| .dds (radar image) | /resource/overviews/<mapname>_radar_spectate.dds (and vertical sections)
|
| .svg (map icon) | /materials/panorama/images/map_icons/map_icon_<mapname>.svg
|
| .png (map background) | /materials/panorama/images/map_icons/screenshots/1080p/<mapname>.png
|
| .kv (player models) | /maps/<mapname>.kv
|
| .kv3 (bots behaviour) | /scripts/<any mentioned in scripts or .vmf>.kv3
|
| .png (dz spawn mask) | /maps/<mapname>_spawnmask.png
|
| .png (dz deployment map) | /materials/panorama/images/survival/spawnselect/map_<mapname>.png
|
| .vtf (dz tablet map) | /materials/models/weapons/v_models/tablet/tablet_radar_<mapname>.vtf
|
AutoBSPpackingTool is a third party tool made for Template:Game name developers and mappers. It automatically detects and packs almost every possible custom file that can be used in a map (.bsp file).
Currently the program supports only some games, the list of which you can find below, but support for more games will be added in the future.
Features
- Detects materials, textures, models, sounds (.wav, .mp3, .ogg), skyboxes.
- Detects materials and textures used in models (including skins) and also detects $includemodel parameter.
- Recognizes patch materials.
- Detects .nav (navigation mesh), .ain (info_node), .txt (map description), .txt (soundscape), .txt (soundscript), .cache (soundcache), .txt (retake bombplants), .txt (camera positions), .txt (map story), .txt (radar information), .dds (radar images), .svg (map icon), .png (map background), .kv (player models), .kv3 (bots behaviour), .png (dz spawn mask), .png (dz deployment map), .vtf (dz tablet map).
- Detects sounds referenced in soundscape and soundscript files.
- Detects scripts (.nut and .cfg).
- Detects models, sounds and other scripts inside detected scripts if they are named with their file extension (.mdl, .wav, .mp3, .ogg, .cfg, .nut).
- Also finds .vmf files specified in func_instances and packs their data too.
- Can either pack all the found files into .bsp or save a file with a list of all detected custom files.
Warning:
- The program does not detect scripts with a space in the path (so does Hammer).
- The program does not detect sounds referenced in scripts with a space in the path.
Information
- The program is written in C# and requires Microsoft .NET Framework 4.0 or higher.
- You should put the program in an individual folder, because it will create a cache folder and some necessary files in the directory .exe file is in.
- The program creates a .bsp.backup file before packing.
- The program checks for an update on startup.
- It shows a notification when packing is finished.
- It will be better if you pack your custom content referenced in scripts by yourself, because there are a lot of situations in which it is impossible to detect custom content used in scripts.
- The program uses vpk.exe and bspzip.exe, so you must have the SDK tools installed and the game itself you want to pack files for.
Supported games
- Template:Game name (full support)
- Template:Game name (test support)
- Template:Game name (test support)
Options
- -vmf <path>
- Set path to .vmf file.
- -bsp <path>
- Set path to .bsp file (if not specified, a file with a list of all detected custom files will be saved in the cache folder).
- -game <index | gamefolder | path>
- Select what game to use. Index is a number of game in supported games list starting from 0 (the order of the games in the list may change in the future, so it is better to use the game folder name or the path to it).
- Examples: 0, 1, csgo, garrysmod, C:/Program Files (x86)/Steam/steamapps/common/Counter-Strike Global Offensive/csgo.
- -log
- Create a log file. If this option is enabled and any argument is invalid, a cmd_exit_reason.log file will be created in the cache folder.
- -notify
- Show a notification when packing is finished.
- -cachedir <path>
- Override default cache folder path (<the directory .exe file is in>/cache/).
Usage with Hammer
You can add Hammer configuration to pack all the custom files right after compile. Follow this steps if you want to.
1) Add a new compile configuration in the expert compile mode.
2) Set its name to [AutoBSPpackingTool] - Pack data or whatever you want.
3) Set the Command to the path where this program is located.
- Example: C:\Users\user\Downloads\AutoBSPpackingTool.exe
4) Set the Parameters to: -vmf $path\$file.vmf -bsp $bspdir\$file.bsp -game $gamedir -notify and add other arguments if you want.
5) Done! Now press Go! and wait until the notification appears.