Incrementing version to 0.3.1 & updating documentation

CHANGELOG.md

@@ -1,49 +1,79 @@
 # Changelog
 
-# v0.3.0 (29th September 2021)
+## v0.3.1 (4th October 2021)
 
-## New
+### New
+ * Identified & thwarted Half-Life: Blue Shift obfuscation
+
+### Changed
+ * Fixed `.as_bytes()` method for `shared.PhysicsCollide`
+   - byte perfect recreation of input
+ * Re-implemented `PhysicsCollide` for Source & Titanfall Engines
+
+### Newly Supported
+  * Half-Life: Blue Shift
+
+### Updated Support
+ * Source Engine
+ * Titanfall Engine
+
+
+## v0.3.0 (29th September 2021)
+
+### New
  * Added `load_bsp` function to identify bsp type  
  * Added `D3DBsp`, `IdTechBsp`, `RespawnBsp` & `ValveBsp` classes
  * Added general support for the PakFile lump
  * Added general support for the GameLump lump
  * Extension scripts
-   * `archive.py` extractor for CoD `.iwd` / Quake `.pk3`
-   * `diff.py` compare bsps for changelogs / study
-   * `lightmaps.py` bsp lightmap -> `.png`
+   - `archive.py` extractor for CoD `.iwd` / Quake `.pk3`
+   - `diff.py` compare bsps for changelogs / study
+   - `lightmaps.py` bsp lightmap -> `.png`
  * Made a basic C++ 17 implementation in `src/`
 
-## Changed
+### Changed
  * `Bsp` lumps are loaded dynamically, reducing memory usage
-   * New wrapper classes can be found in `bsp_tool/lumps.py`
+   - New wrapper classes can be found in `bsp_tool/lumps.py`
  * `mods/` changed to `branches/`
-   * Added subfolders for developers
-   * Helpful lists for auto-detecting a .bsp's origin
-   * Renamed `team_fortress2` to `valve/orange_box`
+   - Added subfolders for developers
+   - Helpful lists for auto-detecting a .bsp's origin
+   - Renamed `team_fortress2` to `valve/orange_box`
  * `LumpClasses` now end up in 3 dictionaries per branch script
-   * `BASIC_LUMP_CLASSES` for types like `short int`
-   * `LUMP_CLASSES` for standard `LumpClasses`
-   * `SPECIAL_LUMP_CLASSES` for irregular types (e.g. PakFile)
-   * `GAME_LUMP_CLASSES` for GameLump SpecialLumpClasses
+   - `BASIC_LUMP_CLASSES` for types like `short int`
+   - `LUMP_CLASSES` for standard `LumpClasses`
+   - `SPECIAL_LUMP_CLASSES` for irregular types (e.g. PakFile)
+   - `GAME_LUMP_CLASSES` for GameLump SpecialLumpClasses
  * `Bsp`s no longer print to console once loaded
  * `Base.Bsp` & subclasses have reserved ALL CAPS member names for lumps only
-   * BSP_VERSION, FILE_MAGIC, HEADERS, REVISION -> bsp_version, file_magic, headers, revision
- * TODO: load external lumps and internal lumps at the same time
+   - BSP_VERSION, FILE_MAGIC, HEADERS, REVISION -> bsp_version, file_magic, headers, revision
 
-## New Supported Games
-  * GoldSrc Engine (excluding Half-Life: Blue Shift)
-  * Quake II
-  * Quake 3 Arena
+### Newly Supported
+  * IdTech Engine
+    - Quake II
+    - Quake 3 Arena
+  * GoldSrc Engine
   * Source Engine
+    - 2013 SDK
+    - Alien Swarm branch
+    - Counter-Strike: Global Offensive
+    - Half-Life 2
+    - Left 4 Dead branch
 
-## Broken Support
-  * Call of Duty
-  * Dark Messiah of Might and Magic
-  * Half-Life: Blue Shift
-  * Quake
+### Broken Support
+  * GoldSrc Engine
+    - Half-Life: Blue Shift
+  * IdTech Engine
+    - Quake
+  * IW Engine
+    - Call of Duty
+  * Source Engine
+    - Dark Messiah of Might and Magic
+    - Vindictus (cannot extract files)
 
-## Updated Game Support
- * Apex Legends
- * Orange Box
- * Titanfall
- * Titanfall 2
+### Updated Support
+ * Source Engine
+   - Orange Box
+ * Titanfall Engine
+   - Titanfall
+   - Titanfall 2
+   - Apex Legends

README.md

@@ -1,7 +1,7 @@
 # bsp_tool
 Python library for analysing .bsp files  
 
-`bsp_tool` provides a Command Line Interface for exploring & editing .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
 
 

docs/index.md

@@ -1,8 +1,8 @@
 # bsp_tool
  A library for .bsp file analysis & modification
 
-`bsp_tool` provides a Command Line Interface for exploring & editing .bsp files  
-Current development is focused on bringing new maps to Titanfall 1 & 2 and Counter-Strike: Online 2  
+ `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 / contribute to the latest version, clone this package
@@ -15,9 +15,6 @@ Or to use the latest stable release, install via [pip](https://pypi.org/project/
 pip install bsp_tool
 ```
 
-> The last PyPi release (v0.2.2) is close to a year old  
-> v0.3.0 has made many [changes](./CHANGELOG.md) and is the recommended version
-
 ## Fair Use & Commercial Works
 **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  
@@ -44,7 +41,7 @@ The primary goal of `bsp_tool` is to extend community mapping tools
 ## Guides
 [Basic Usage](./usage.html) <!-- Split up / include links to the wiki -->
 <!-- [BSP format crash course](...) # include branch specific pages -->
-<!-- Links & credits to other community tools -->
+[Extensions](./extensions.md)
 
 ## Supported Games
   * [Id Software](./id_software/SUPPORTED.html)
@@ -60,6 +57,7 @@ The primary goal of `bsp_tool` is to extend community mapping tools
 ## [Changelog](./CHANGELOG.html)
 You can see a list of all changes in the [changelog](./CHANGELOG.html)
 
+## Other tools
 
 ## 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  

setup.py

@@ -15,7 +15,7 @@
     long_description=readme_text,
     long_description_content_type="text/markdown",
     url="https://github.com/snake-biscuits/bsp_tool",
-    download_url="https://github.com/snake-biscuits/bsp_tool/archive/v0.4.0.tar.gz",
+    download_url="https://github.com/snake-biscuits/bsp_tool/archive/v0.3.1.tar.gz",
     keywords=["source", "bsp", "valve"],
     classifiers=[
         "Development Status :: 4 - Beta",