Skip to main content

Python utility for processing Frostbite engine game files and interacting with the Frosty Editor.

Project description

[!NOTE] This project is migrated from zyf722/flamethrower.

For versions v0.1.6 and earlier, please visit Releases of that repository.

Starting from version v0.1.7, this project is renamed flammenwerfer to avoid naming conflicts with other projects.

flammenwerfer

🔥 Flammenwerfer (flamethrower in German), where ❄️ Frostbite meets the dance of inferno.

flammenwerfer 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:

  • flammenwerfer.hash: Hash functions used by the Frostbite engine. Currently, only FNV series hash functions (flammenwerfer.hash.fnv) are supported.
  • flammenwerfer.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/BF1CHS/flammenwerfer.git
cd flammenwerfer/

# 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flammenwerfer-0.1.9.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

flammenwerfer-0.1.9-py3-none-any.whl (19.1 kB view details)

Uploaded Python 3

File details

Details for the file flammenwerfer-0.1.9.tar.gz.

File metadata

  • Download URL: flammenwerfer-0.1.9.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.0 Linux/6.5.0-1021-azure

File hashes

Hashes for flammenwerfer-0.1.9.tar.gz
Algorithm Hash digest
SHA256 faecb9106bb40207d7060e26175b36541e748c77e9bd8f6ebdf53d9cfd19a0f6
MD5 f7c982d8916734f135b2cc7342872f10
BLAKE2b-256 2b0120b8f8bafdcd7d21c2afe768763dd80d31d62be13971a608f123d4b7dd8d

See more details on using hashes here.

File details

Details for the file flammenwerfer-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: flammenwerfer-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 19.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.0 Linux/6.5.0-1021-azure

File hashes

Hashes for flammenwerfer-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 4d24cf6a1d9f4a4a1b9bf7f50b95bdf2577fbdde1fab6c6be00ff1debd7542f0
MD5 b4aa847276b9e9ff555b4a22c719b615
BLAKE2b-256 59ef5ccabc443f365fe681aed6253c07e1c40646df099fe947f4b69f3360e803

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page