Coder Social home page Coder Social logo

zyf722 / flamethrower Goto Github PK

View Code? Open in Web Editor NEW
5.0 1.0 2.0 157 KB

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

License: GNU General Public License v3.0

Python 100.00%
battlefield battlefield-1 frostbite localization

flamethrower's Introduction

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/flammenwerferBF1CHS/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

flamethrower's People

Contributors

zyf722 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

flamethrower's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.