bsp-tool 0.4.0

Python library for analysing .bsp files

bsp_tool

Python library for analysing .bsp files

bsp_tool provides a Command Line Interface for analysing .bsp files
Current development is focused on bringing new maps to Counter-Strike: Online 2 & the Titanfall Engine

Installation

To use the latest version, clone from git:

$ git clone [e-mail]:snake-biscuits/bsp_tool.git

Or to use the latest stable release (0.4.0), install via pip (Python 3.7-10):

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

Usage

To load a .bsp file in python:

>>> import bsp_tool
>>> bsp_tool.load_bsp("map_folder/filename.bsp")
<ValveBsp filename.bsp (VBSP version 20) at 0x00...>

Full documentation: snake-biscuits.github.io/bsp_tool/

Supported Games

The :x: emoji indicates tests are failing
The :o: emoji indicates a lack of .bsps to test

• Arkane Studios
  • Dark Messiah of Might & Magic Singleplayer
  • Dark Messiah of Might & Magic Multi-Player
• Gearbox Software
  • Half-Life: Blue Shift
  • Half-Life: Opposing Force
  • James Bond 007: Nightfire
• Id Software
  • Quake
  • Quake II
  • Quake III Arena
  • Quake III Arena (Dreamcast)
  • Quake III: Team Arena
  • Quake Champions :o:
  • Quake Live
• Infinity Ward
  • Call of Duty
  • Call of Duty 2
  • Call of Duty 4: Modern Warfare
  • Call of Duty: Modern Warfare 2 :o:
• Ion Storm
  • Anachronox
  • Daikatana
• Nexon
  • Counter-Strike: Online 2
  • Titanfall: Online
  • Vindictus :x:
• Raven Software
  • Heretic II
  • Hexen II
  • Soldier of Fortune
  • Soldier of Fortune II: Double Helix
  • Star Trek: Voyager - Elite Force
  • Star Wars: Jedi Knight - Jedi Academy
  • Star Wars: Jedi Knight II - Jedi Outcast
• Respawn Entertainment
  • Titanfall
  • Titanfall (Xbox360) :o:
  • Titanfall 2
  • Apex Legends
• Ritual Entertainment
  • American McGee's Alice
  • Heavy Metal F.A.K.K. 2
  • SiN
  • SiN: Gold
  • SiN Episodes: Emergence
  • Star Trek: Elite Force II
• Valve Software
  • Alien Swarm
  • Alien Swarm: Reactive Drop
  • Counter-Strike: Condition Zero
  • Counter-Strike: Condition Zero - Deleted Scenes
  • Counter-Strike: Global Offensive
  • Counter-Strike: Source
  • Counter-Strike
  • Day of Defeat
  • Day of Defeat: Source
  • Deathmatch Classic
  • Half-Life
  • Half-Life 2
  • Half-Life 2 (Xbox)
  • Half-Life 2: Deathmatch
  • Half-Life 2: Episode 1
  • Half-Life 2: Episode 2
  • Half-Life 2: Lost Coast
  • Half-Life Deathmatch: Source
  • Half-Life: Paranoia (Dreamcast)
  • Half-Life: Source
  • Left 4 Dead
  • Left 4 Dead (Xbox360) :x:
  • Left 4 Dead 2
  • Left 4 Dead 2 (Xbox360)
  • Portal
  • Portal 2
  • Portal 2 (Xbox360)
  • Richochet
  • Source Filmmaker
  • Source SDK 2013
  • Team Fortress 2
  • Team Fortress Classic
  • The Orange Box (Xbox360)
• Other
  • Alkaline
  • Black Mesa
  • Blade Symphony
  • Bloody Good Time
  • Call of Duty: Black Ops III :o:
  • Call of Duty: United Offensive :o:
  • Call of Duty: World at War :o:
  • Cocaine Diesel :o:
  • Contagion
  • Cry of Fear
  • DarkPlaces
  • D-Day Normandy
  • Dino D-Day
  • Double Action: Boogaloo
  • Entropy: Zero 2
  • E.Y.E: Divine Cybermancy
  • Fistful of Frags
  • Fortress Forever
  • G-String
  • Garry's Mod
  • Half-Life 2 VR Mod
  • Halfquake Trilogy
  • INFRA
  • Kingpin: Life of Crime :o:
  • Medal of Honor: Allied Assault Demo
  • Medal of Honor: Allied Assault
  • Medal of Honor: Allied Assault - Spearhead
  • Medal of Honor: Allied Assault - Breakthrough
  • Momentum Mod Playtest (Closed Beta)
  • Natural Selection
  • NEOTOKYO
  • Nexuiz Classic
  • No More Room in Hell
  • Nosferatu :o:
  • Quake: Dimension of the Past
  • Return to Castle Wolfenstein
  • The Ship
  • Sven Co-op
  • Synergy
  • Tactical Intervention
  • Team Fortress Quake
  • The Beginner's Guide :o:
  • The Stanley Parable :o:
  • Vampire: The Masquerade - Bloodlines
  • Warsow
  • Wolfenstein: Enemy Territory
  • WRATH: Aeon of Ruin
  • Xonotic

Thanks

• BobTheBob
  • Identified loads of Titanfall lumps (90% of static props + more)
• Call of Duty Promod Team
  • For distributing safe links to Call of Duty 4 Mod Tools
• 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
• F1F7Y
  • Lead developer on Spyglass Radiant NetRadiant-Custom fork for Titanfall Series
• GCFScape
  • Super handy .vpk (Valve format) browser; VTFLib / VTFEdit is also from Nem's Tools
• JJL772
  • Published public documentation for the otherwise closed-source VBSP v25
• Maxime Dupuis
  • Helping me identify multiple lumps in Source Engine .bsps
• MobyGames
  • Keeping records of the credits on so many games, helping to pin down engine origins
• pakextract
  • Super useful tool for .pak files
• PCGamingWiki
  • Archiving old patches to help install old modding tools
• REDxEYE
  • Being very open and actively collaborating on SourceIO & Titanfall .bsps
• Taskinoz
  • Helping me find people that can actively use my research & tools
• Valve Developer Wiki
  • For starting me on this path however many years ago
• Warmist
  • Identifying physics model related structs for Titanfall 2
• All of the Wiki Editors
  • Except for the uncited Id Tech 3 -> Treyarch NGL on CoDWiki [citation needed]