Note

This project has been migrated to BF1CHS/flammenwerfer and is no longer maintained here.

Please visit the new repository for the latest updates.

本仓库及 BF1CHS 工具箱源码已分别迁移至 BF1CHS/flammenwerfer 及 BF1CHS/bf1chs，此处不再维护。

flamethrower

🔥 Flamethrower, where ❄️ Frostbite meets the dance of inferno.

flamethrower is a Python package designed to provide a simple interface for modders to interact with the original Frostbite engine binaries.

Installation

This package is managed by Poetry.

Currently, the package is in its early stages of development and is not yet ready for public use. However, if you are interested, you can install the package by cloning the repository and running the following command:

poetry install

Then you can use the package in the virtual environment created by Poetry.

Usage

The package only supports the following features now:

• flamethrower.hash: Hash functions used by the Frostbite engine. Currently, only FNV series hash functions are supported.
• flamethrower.localization: Interface for Histogram and LocalizationBinary files.

Examples of how to use the package are available in the examples directory. There is only one example now, which is an interactive toolbox for Chinese localization of Battlefield 1 (with UI in Chinese). More examples are welcomed.

Contributing

Though the package is still in its early stages of development, Pull Requests are welcome.

You can setup your own copy of the source code with Git and Poetry:

# Git
git clone https://github.com/zyf722/flamethrower.git
cd flamethrower/

# Poetry
poetry lock
poetry install
poetry shell

It is strongly recommended to follow the Conventional Commits specification when writing commit messages and creating pull requests.

License

GPL-3.0