AutoBSPpackingTool: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(update 0.1.0.3)
(Moved Supported Games to top, warnings under Features. Added examples what the program detects. Added table with the files that the program's Checkboxes add.)
Line 1: Line 1:
'''AutoBSPpackingTool''' is a third party tool made for Source developers and mappers. It automatically detects and packs almost every possible custom file that can be used in a map ([[BSP|.bsp file]]).
{{lang|AutoBSPpackingTool}}
[[File:abspt_main.png|thumb|330px|AutoBSPpackingTool interface.]]
[[File:abspt_settings.png|thumb|330px|AutoBSPpackingTool settings.]]
{| class="standard-table mw-collapsible mw-collapsed" style="float:right; clear:right"
<!--|+style="white-space:nowrap; text-align:right"| Explicit files that can be packed, if existent
-->! Checkbox !! File(s)
|-
| .nav (navigation mesh) || <code>/maps/<mapname>.nav</code>
|-
| .ain (info_node) || <code>/maps/graphs/<mapname>.ain</code>
|-
| .txt (map description) || <code>/maps/<mapname>.txt</code>
|-
| .txt (soundscapes) || <code>/scripts/soundscapes_<mapname>.txt</code>
|-
| .cache (soundcache) || <code>/maps/soundcache/<mapname>.cache</code>
|-
| .txt (radar information) || <code>/resource/overviews/<mapname>.txt</code>
|-
| .dds (radar image) || <code>/resource/overviews/<mapname>_radar_spectate.dds</code>
|-
| .svg (map icon) || <code>/materials/panorama/images/map_icons/<mapname>.svg</code>
|-
| .png (map background) || <code>/materials/panorama/images/map_icons/screenshots/1080p/<mapname>.png</code>
|-
| .kv (player models) || <code>/maps/<mapname>.kv</code>
|}
{{back|Third Party Tools}}
'''AutoBSPpackingTool''' is a third party tool made for {{game name|src|name=Source}} developers and mappers. It automatically detects and packs almost every possible custom file that can be used in a map ([[BSP|.bsp file]]).


[[File:abspt_main.png|thumb|AutoBSPpackingTool interface.]]
Currently the program supports only {{game name|name=Counter-Strike: Global Offensive}}, but more games will be added in the future.
[[File:abspt_settings.png|thumb|AutoBSPpackingTool settings.]]


== Features ==
== Features ==
Line 8: Line 35:
* Detects materials and textures used in models (including skins) and also detects $includemodel parameter.
* Detects materials and textures used in models (including skins) and also detects $includemodel parameter.
* Recognizes patch materials.
* Recognizes patch materials.
* Detects .nav (navigation mesh), .ain (info_node), .txt (map description), .txt (soundscapes), .cache (soundcache), .txt (radar information), .dds (radar images), .svg (map icon), .png (map background), .kv (player models), .kv3 (bots behaviour).
* Detects [[NAV|.nav]] ([[Nav Mesh|navigation mesh]]), [[AIN|.ain]] ([[info_node]]), .txt ([[Mapname.txt|map description]]), .txt ([[soundscape]]s), .cache (soundcache), .txt (radar information), .dds (radar images), .svg (map icon), .png (map background), .kv ([[Choosing Player Models|player models]]), [[KeyValues3|.kv3]] ([[CS:GO Bot Behavior Trees|bots behaviour]]).
* Detects sounds referenced in sounscape file.
* Detects sounds referenced in soundscape file.
* Detects scripts (.nut and .cfg).
* Detects scripts ([[VScript|.nut]] and [[CFG|.cfg]]).
* Detects models, sounds and other scripts inside detected scripts.
* Detects models, sounds and other scripts inside detected scripts. {{example|In VScript files, the program will find the corresponding files from the expressions <code>IncludeScript("folder/scriptFile"), PrecacheScriptSound("folder/audioFile.wav")</code> and <code>SendToConsole("[[mp_bot_ai_bt]] \"scripts/ai/folder/file.kv3\"")</code>.}}
* Also finds .vmf files specified in func_instances and packs their data too.
* Also finds [[VMF|.vmf]] files specified in [[func_instance]]s 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.
* Can either pack all the found files into [[BSP|.bsp]] or save a file with a list of all detected custom files.
 
 
{{warning|
* Does not detect scripts with a space in the path (so does Hammer).
* Does not detect sounds referenced in scripts with a space in the path.
}}


== Information ==
== Information ==
Line 23: Line 56:
* The program requires an installed game you want to pack files for.
* The program requires an installed game you want to pack files for.
* The program uses HLLib.dll and CrowbarCommandLineDecomp.exe.
* The program uses HLLib.dll and CrowbarCommandLineDecomp.exe.
== Warnings ==
* Does not detect scripts with a space in the path (so does Hammer).
* Does not detect sounds referenced in scripts with a space in the path.
== Supported games ==
Currently supports only:
* {{game name|name=Counter-Strike: Global Offensive}}
(more games will be added in the future)


== Download ==
== Download ==

Revision as of 12:05, 10 March 2022

English (en)Русский (ru)中文 (zh)Translate (Translate)
AutoBSPpackingTool interface.
AutoBSPpackingTool settings.
Checkbox File(s)
.nav (navigation mesh) /maps/<mapname>.nav
.ain (info_node) /maps/graphs/<mapname>.ain
.txt (map description) /maps/<mapname>.txt
.txt (soundscapes) /scripts/soundscapes_<mapname>.txt
.cache (soundcache) /maps/soundcache/<mapname>.cache
.txt (radar information) /resource/overviews/<mapname>.txt
.dds (radar image) /resource/overviews/<mapname>_radar_spectate.dds
.svg (map icon) /materials/panorama/images/map_icons/<mapname>.svg
.png (map background) /materials/panorama/images/map_icons/screenshots/1080p/<mapname>.png
.kv (player models) /maps/<mapname>.kv
← Third Party Tools

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 Template:Game name, but 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 (soundscapes), .cache (soundcache), .txt (radar information), .dds (radar images), .svg (map icon), .png (map background), .kv (player models), .kv3 (bots behaviour).
  • Detects sounds referenced in soundscape file.
  • Detects scripts (.nut and .cfg).
  • Detects models, sounds and other scripts inside detected scripts.
    PlacementTip.pngExample:In VScript files, the program will find the corresponding files from the expressions IncludeScript("folder/scriptFile"), PrecacheScriptSound("folder/audioFile.wav") and SendToConsole("mp_bot_ai_bt \"scripts/ai/folder/file.kv3\"").
  • 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.pngWarning:
  • Does not detect scripts with a space in the path (so does Hammer).
  • 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.
  • 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 requires an installed game you want to pack files for.
  • The program uses HLLib.dll and CrowbarCommandLineDecomp.exe.

Download

See Also

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=AutoBSPpackingTool&oldid=253097"