bsp-tool 0.3.0

Python library for analysing .bsp files

bsp_tool

Python library for analysing .bsp files

bsp_tool provides a Command Line Interface for exploring & editing .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, install via pip (Python 3.7+):

pip install bsp_tool

NOTE: The last PyPi release (v0.2.2) is close to a year old
v0.3.0 has made many changes and is the recommended version

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 :x:
• Gearbox Software
  • Half-Life: Blue Shift :x:
  • Half-Life: Opposing Force
• Id Software
  • Quake :x:
  • Quake II
  • Quake III Arena
  • Quake 4 :o:
  • Quake Champions :o:
  • Quake Live
• Infinity Ward
  • Call of Duty :x:
  • Call of Duty 2 :x:
  • Call of Duty 4: Modern Warfare :x:
• Nexon
  • Counter-Strike: Online 2 :x:
  • Vindictus :o:
• Respawn Entertainment
  • Apex Legends
  • Titanfall 2
  • Titanfall
  • Titanfall: Online
• Ritual Entertainment
  • American McGee's Alice :o:
  • Heavy Metal F.A.K.K. 2 :o:
  • Medal of Honor: Allied Assault :o:
  • SiN :o:
  • SiN: Gold :o:
  • SiN Episodes: Emergence :o:
  • Star Trek: Elite Force II :o:
• 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: Deathmatch
  • Half-Life 2: Episode 1
  • Half-Life 2: Episode 2
  • Half-Life 2: Lost Coast
  • Half-Life Deathmatch: Source
  • Half-Life: Source
  • Left 4 Dead
  • Left 4 Dead 2
  • Portal
  • Portal 2
  • Richochet
  • Source Filmmaker
  • Source SDK 2013
  • Team Fortress 2
  • Team Fortress Classic
• Other
  • Hexen 2 :x:
  • Black Mesa
  • Blade Symphony
  • Brink :o:
  • Daikatana :o:
  • Fortress Forever
  • G-String
  • Garry's Mod
  • Halfquake Trilogy
  • Medal of Honor: Allied Assault :o:
  • NEOTOKYO
  • Sven Co-op
  • Synergy
  • Tactical Intervention :x:
  • Team Fortress Quake :x:
  • Vampire: The Masquerade - Bloodlines :o: