bsp_tool

Python library for analysing .bsp files

bsp_tool provides a Command Line Interface for analysing .bsp files

Installation

To use the latest unstable version, clone with git:

$ git clone git@github.com:snake-biscuits/bsp_tool.git

You can also clone with pip:

$ pip install git+https://github.com/snake-biscuits/bsp_tool.git

Or, use the latest stable release (August 2024 | 0.5.0 | Python 3.8-11):

$ pip install bsp_tool

Fair Use

Please do not use bsp_tool to copy or steal another creator's work
The primary goal of bsp_tool is to extend community mapping tools

Always

• Ask the creator's permission before touching their work
• Understand that by default creator's works are under copyright
  • US Law Copyright FAQ
  • US Copyright Duration
    • Circular 15a
• Contact the original creator to get their permission
  • This can get complicated
  • Some creators don't hold the copyright on their works
    • often because of Company / Publisher contracts
• Credit the original creator; once you have permission to share a derivative work
• Support the official release

DO NOT use this tool to steal another creator's work
DO use this tool to understand the .bsp format(s) and create more specific tools

Be aware that this gets even more complicated with commercial projects

Guides

Basic Usage

Extensions

Supported Games

• Arkane Studios
  • Dark Messiah of Might & Magic Singleplayer
  • Dark Messiah of Might & Magic Multiplayer
• Id Software
  • Quake
  • Quake II
  • Quake III
• Infinity Ward
  • Call of Duty
  • Call of Duty 2
  • Call of Duty 4: Modern Warfare
• Nexon
• Respawn Entertainment
  • Titanfall
  • Titanfall 2
  • Apex Legends
• Valve Software
  • GoldSrc
  • Source Engine
  • Left 4 Dead
  • Alien Swarm

.bsp Format Reference

Timeline of "relevant" games
Game engine bloodline

Changelog

You can see a list of all changes in the changelog

Thanks

• Chris Strahl
  • Preserving extensive documentation, mods & source code for Quake 3 & Ubertools games
• Ficool2
  • Providing lots of current and detailed info on Source & helping track down some rarer titles
• Maxime Dupuis
  • Helping me identify multiple lumps in Source Engine .bsps
• REDxEYE
  • Being very open and actively collaborating on SourceIO & Titanfall .bsps
• Taskinoz
  • Helping me find people that can actively use my research & tools
• All of the Wiki Editors
  • Except the uncited Id Tech 3 -> Treyarch NGL on CoDWiki, that was a massive pain to verify

Other tools

Blender

• io_import_rbsp
  • Titanfall / Apex .bsp importer
• SourceIO
  • GoldSrc & Source Engine importer (.bsp, .vmt, .vtf, .mdl)
• SourceOps
  • Source Engine .mdl exporter
• PyD3DBSP (Archived)
  • Call of Duty 2 .bsp importer
• blender_io_mesh_bsp
  • Quake 1 .bsp importer
• Blender_BSP_Importer
  • Quake 3 .bsp importer

Contributing

At present the easiest way to contribute to the project is to add or extend a "branch script" for a game bsp_tool doesn't yet fully support
Learn More