> [!NOTE]
> This project is migrated from [zyf722/flamethrower](https://github.com/zyf722/flamethrower).
>
> For versions `v0.1.6` and earlier, please visit [Releases of that repository](https://github.com/zyf722/flamethrower/releases).
>
> **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](https://python-poetry.org/).
**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:
```bash
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](https://github.com/BF1CHS/flammenwerfer/pulls) are welcome.
You can setup your own copy of the source code with Git and Poetry:
```shell
# 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](https://www.conventionalcommits.org/en/v1.0.0/) specification when writing commit messages and creating pull requests.
## License
[GPL-3.0](/LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/BF1CHS/flammenwerfer",
"name": "flammenwerfer",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "Frostbite, entertainment, reverse engineering, game development",
"author": "MaxMixAlex",
"author_email": "MaxMixAlex@protonmail.com",
"download_url": "https://files.pythonhosted.org/packages/2b/01/20b8f8bafdcd7d21c2afe768763dd80d31d62be13971a608f123d4b7dd8d/flammenwerfer-0.1.9.tar.gz",
"platform": null,
"description": "> [!NOTE]\n> This project is migrated from [zyf722/flamethrower](https://github.com/zyf722/flamethrower).\n> \n> For versions `v0.1.6` and earlier, please visit [Releases of that repository](https://github.com/zyf722/flamethrower/releases).\n>\n> **Starting from version `v0.1.7`, this project is renamed `flammenwerfer` to avoid naming conflicts with other projects.**\n\n# flammenwerfer\n> \ud83d\udd25 ***Flammenwerfer*** (*flamethrower* in German), where \u2744\ufe0f ***Frostbite*** meets the dance of inferno.\n\n`flammenwerfer` is a Python package designed to provide a simple interface for modders to interact with the original Frostbite engine binaries. \n\n## Installation\nThis package is managed by [Poetry](https://python-poetry.org/).\n\n**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:\n\n```bash\npoetry install\n```\n\nThen you can use the package in the virtual environment created by Poetry.\n\n## Usage\nThe package only supports the following features now:\n\n- `flammenwerfer.hash`: Hash functions used by the Frostbite engine. Currently, only FNV series hash functions (`flammenwerfer.hash.fnv`) are supported.\n- `flammenwerfer.localization`: Interface for `Histogram` and `LocalizationBinary` files.\n\nExamples 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.\n\n## Contributing\nThough the package is still in its early stages of development, [Pull Requests](https://github.com/BF1CHS/flammenwerfer/pulls) are welcome.\n\nYou can setup your own copy of the source code with Git and Poetry:\n\n```shell\n# Git\ngit clone https://github.com/BF1CHS/flammenwerfer.git\ncd flammenwerfer/\n\n# Poetry\npoetry lock\npoetry install\npoetry shell\n```\n\nIt is strongly recommended to follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification when writing commit messages and creating pull requests.\n\n## License\n[GPL-3.0](/LICENSE)",
"bugtrack_url": null,
"license": null,
"summary": "Python utility for processing Frostbite engine game files and interacting with the Frosty Editor.",
"version": "0.1.9",
"project_urls": {
"Homepage": "https://github.com/BF1CHS/flammenwerfer",
"Repository": "https://github.com/BF1CHS/flammenwerfer"
},
"split_keywords": [
"frostbite",
" entertainment",
" reverse engineering",
" game development"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "59ef5ccabc443f365fe681aed6253c07e1c40646df099fe947f4b69f3360e803",
"md5": "b4aa847276b9e9ff555b4a22c719b615",
"sha256": "4d24cf6a1d9f4a4a1b9bf7f50b95bdf2577fbdde1fab6c6be00ff1debd7542f0"
},
"downloads": -1,
"filename": "flammenwerfer-0.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b4aa847276b9e9ff555b4a22c719b615",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 19148,
"upload_time": "2024-06-04T08:11:51",
"upload_time_iso_8601": "2024-06-04T08:11:51.916104Z",
"url": "https://files.pythonhosted.org/packages/59/ef/5ccabc443f365fe681aed6253c07e1c40646df099fe947f4b69f3360e803/flammenwerfer-0.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2b0120b8f8bafdcd7d21c2afe768763dd80d31d62be13971a608f123d4b7dd8d",
"md5": "f7c982d8916734f135b2cc7342872f10",
"sha256": "faecb9106bb40207d7060e26175b36541e748c77e9bd8f6ebdf53d9cfd19a0f6"
},
"downloads": -1,
"filename": "flammenwerfer-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "f7c982d8916734f135b2cc7342872f10",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 18183,
"upload_time": "2024-06-04T08:11:53",
"upload_time_iso_8601": "2024-06-04T08:11:53.423473Z",
"url": "https://files.pythonhosted.org/packages/2b/01/20b8f8bafdcd7d21c2afe768763dd80d31d62be13971a608f123d4b7dd8d/flammenwerfer-0.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-04 08:11:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BF1CHS",
"github_project": "flammenwerfer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "flammenwerfer"
}
JSON
