AutoBSPpackingTool: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(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.)
(update 0.1.0.4)
Line 13: Line 13:
|-
|-
| .txt (soundscapes) || <code>/scripts/soundscapes_<mapname>.txt</code>
| .txt (soundscapes) || <code>/scripts/soundscapes_<mapname>.txt</code>
|-
| .txt (soundscript) || <code>/maps/<mapname>__level_sounds.txt</code>
|-
|-
| .cache (soundcache) || <code>/maps/soundcache/<mapname>.cache</code>
| .cache (soundcache) || <code>/maps/soundcache/<mapname>.cache</code>
|-
| .txt (retake bombplants) || <code>/maps/<mapname>_retake.txt</code>
|-
| .txt (cameras positions) || <code>maps/<mapname>_cameras.txt</code>
|-
| .txt (map story) || <code>maps/<mapname>_story.txt</code>
|-
|-
| .txt (radar information) || <code>/resource/overviews/<mapname>.txt</code>
| .txt (radar information) || <code>/resource/overviews/<mapname>.txt</code>
|-
|-
| .dds (radar image) || <code>/resource/overviews/<mapname>_radar_spectate.dds</code>
| .dds (radar image) || <code>/resource/overviews/<mapname>_radar_spectate.dds</code> and vertical sections
|-
|-
| .svg (map icon) || <code>/materials/panorama/images/map_icons/<mapname>.svg</code>
| .svg (map icon) || <code>/materials/panorama/images/map_icons/<mapname>.svg</code>
Line 25: Line 33:
|-
|-
| .kv (player models) || <code>/maps/<mapname>.kv</code>
| .kv (player models) || <code>/maps/<mapname>.kv</code>
|-
| .kv3 (bots behaviour) || <code>/scripts/<any mentioned in scripts or .vmf>.kv3</code>
|}
|}
{{back|Third Party Tools}}
{{back|Third Party Tools}}
Line 35: Line 45:
* 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|.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 [[NAV|.nav]] ([[Nav Mesh|navigation mesh]]), [[AIN|.ain]] ([[info_node]]), .txt ([[Mapname.txt|map description]]), .txt ([[soundscape]]s), .txt ([[soundscripts|soundscript]]), .cache ([[soundcache]]), .txt ([[CS:GO_Game_Modes/Retakes#Adding_Retakes_Support_to_a_Bomb_Scenario_Map|retake bombplants]]), .txt (cameras positions), .txt (map story), .txt ([[Creating_a_working_mini-map#Intro_and_Basics|radar information]]), .dds ([[Creating_a_working_mini-map#Intro_and_Basics|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 soundscape file.
* Detects sounds referenced in soundscape and soundscript files.
* Detects scripts ([[VScript|.nut]] and [[CFG|.cfg]]).
* Detects scripts ([[VScript|.nut]] and [[CFG|.cfg]]).
* 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>.}}
* Detects models, sounds and other scripts inside detected scripts.
* Also finds [[VMF|.vmf]] files specified in [[func_instance]]s 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|.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.
Line 44: Line 54:


{{warning|
{{warning|
* Does not detect scripts with a space in the path (so does Hammer).
* The program 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.
* The program does not detect sounds referenced in scripts with a space in the path.
}}
}}



Revision as of 14:27, 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
.txt (soundscript) /maps/<mapname>__level_sounds.txt
.cache (soundcache) /maps/soundcache/<mapname>.cache
.txt (retake bombplants) /maps/<mapname>_retake.txt
.txt (cameras 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/<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
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


Warning.pngWarning:
  • 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.
  • 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