bfstool is a library to interact with BZF and BFS archives

BZF and BFS archives are present in all games and tech demos developed by Bugbear Entertainment except Glimmerati (Nokia N-Gage).

This library guarantees support for official pre-Wreckfest Bugbear files and provides support for other files on a best-effort basis. Sometimes specific behaviour is required to support unofficial files, in which case all the required changes are documented.

3 example apps using bfstool will be provided:

• bfstool-cli - Command-line application to interact with BFS archives providing advanced functionality, perfect for various automations as well as power users
• bfstool-tui - Command-line application with a terminal user interface providing most options a regular user requires
• bfstool-gui - egui-based application providing the same functionality as bfstool-tui

• BZF
  • bbzf v2001.06.06 (Rally Trophy)
    • Decryption
    • Reading
    • Writing
    • Encryption
  • bzf2 v2002.01.11 (Bugbear Retro Demo 2002, Tough Trucks: Modified Monsters)
    • Decryption
    • Reading
    • Writing
    • Encryption
• BFS
  • bfs1 v2004.05.05a (FlatOut)
    • Reading
    • Writing
  • bfs1 v2004.05.05b (FlatOut 2, FlatOut: Head On)
    • Reading
    • Writing
  • bfs1 v2007.03.10 (FlatOut: Ultimate Carnage, Sega Rally Revo)
    • Reading
    • Writing
  • bfs1 v2011.12.20 (Ridge Racer Unbounded)
    • Decryption
    • Reading
    • Writing
    • Encryption
  • bbfs v2013.03.14 (Ridge Racer Driftopia, Next Car Game Free Technology Demo, Next Car Game Technology Sneak Peek 2.0)

• FOV3 Mod has some files with file names of length 0. Additional code is required to handle those files. The files will be listed without a name, but will be extracted with a filename matching the file offset.

• Sewer56's FlatOut 2 Mod Loader adds support for files compressed with Zstandard (zstd). The files get handled automatically and no code tweaks are required.

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

bfstool is not affiliated with nor endorsed by Bugbear Entertainment Oy, ZOOM Platform Media, or other rightsholders. All trademarks are property of their respective owners.