Skip to content

A code library to marshal, unmarshal, visual and reverse visualization of BDX files

License

Notifications You must be signed in to change notification settings

TriM-Organization/BDXConverter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BDX Converter

一个免费开源的 BDX 文件解析器







目录

BDX Converter

BDX Converter 是一个轻量化的纯 Python 实现,它提供了基本的 BDX 解析、反解析、JSON 可视化和反可视化功能。

注意事项

兼容性

  • 版本 1.1.14 不兼容之前的所有版本
  • 版本 1.1.11 在签名功能上不兼容之前的版本
  • 版本 1.1.0 不兼容之前的所有版本
  • 版本 1.0.16 在可视化和反可视化字典方面不兼容之前的版本

签名

  • BDX 文件格式是由 PhoenixBuilder 所定义,签名 BDX 文件则必须具备 PhoenixBuilder 账户

  • 签名 时需要用到 ProvePrivateSigningKey ,它们由 PhoenixBuilder Auth Server 提供。本库不计划支持自动获取这些字段,因此请通过以下展示的方法手动获取。有关本项目实现的签名功能,请见 BDXConverter/Converter/Signature.py

    import ecdsa
    import requests
    import json
    
    
    api_url = 'https://api.fastbuilder.pro/api/phoenix/login'
    # Address of PhoenixBuilder Auth Server(Login API URL)
    
    
    peer = ecdsa.SigningKey.generate(ecdsa.NIST384p)
    verifyingKey = peer.get_verifying_key()
    client_public_key = verifyingKey.to_string().hex()  # type: ignore
    # Generate a new client public key.
    # This key is used to send a reuqest to PhoenixBuilder Auth Server,
    # which is related to create connection with Netease Rental Server.
    # But for us, it is not very necessary.
    # However, we need do that or our request will be refused.
    
    
    login_request = {
        'server_code': ...,  # data type is string
        'server_passcode': ...,  # data type is string
        'client_public_key': client_public_key,
        'login_token': ...  # data type is string
    }
    # This dictionary contained your server code,
    # your server password, and the key you recently generated,
    # and your FB Token.
    # We use this dictionary to send a request to PhoenixBuilder Auth Server,
    # which allowed us to login to the Netease Rental Server.
    # But for us, it is not very necessary.
    # However, this maybe is the only way we could get the thing which signing used.
    
    
    header = {
        "Content-Type": "application/json",
        "Authorization": f'Bearer {requests.get("https://api.fastbuilder.pro/api/new").text}'
    }
    result = requests.post(
        url=api_url, headers=header, data=json.dumps(login_request),
    )
    # Send login reuqest to PhoenixBuilder Auth Server and receive the response.
    
    
    result_dict = json.loads(result.text)
    # The response from PhoenixBuilder Auth Server is a JSON string,
    # which including the following data.
    # {
    #     'chainInfo': ...,
    #     'ip_address': ...,
    #     'message': 'well done',
    #     'privateSigningKey': ...,
    #     'prove': ...,
    #     'respond_to': ...,
    #     'success': True,
    #     'uid': ...,
    #     'username': ...
    # }
    
    
    print('privateSigningKey is:')
    print(json.dumps(result_dict['privateSigningKey']))
    print('\nprove is:')
    print(json.dumps(result_dict['prove']))
    # "privateSigningKey" and "prove" are used for signature related purposes.
    # All we did was to get these two data points.

快速上手

您可以利用 BDXConverter/Converter/FileOperation.py 中已提供的 4 个函数来完成 BDX 文件和 JSON 文件的相关操作。

🐍 Pypi Packages

我们已将此存储库以 BDXConverter 的名字上载到 Pypi ,您可以通过 pip install BDXConverter 快速安装。

访问 📦 BDXConverter on Pypi 以了解有关此库的更多信息。

我们配置了自动化 CD/CI 工作流 ,因此如果您是本项目的 协作者 ,您可以通过更改 version 文件或通过手动触发的方式启动工作流,它会自动编译本项目并将将其上载到 Pypi 中。

[注:我们建议您在 Python 3.10 及以上的版本使用本项目,3.7 及以下的版本已不再受到 Python 的维护和更新,3.8 版本将在 2024 年的 10 月份停止维护]

第三方依赖

本项目使用了 brotli, nbtlibpycryptodome 总计 3 个第三方库,您可以通过在 终端 逐一地执行以下命令以安装它们。

pip install brotli
pip install nbtlib
pip install pycryptodome

特性

您可以从 BDXConverter/General/Pool.py 查看本项目已支持的全部 BDX 操作符。

实际上,我们将每一个操作符都转换为了 Python 下已被实例化的类,并且每个类都有以下属性。

class GeneralClass:
    """
    Any operation of the BDX file will inherit this class
    """

    def __init__(self) -> None:
        self.operationNumber: int
        self.operationName: str

    def Marshal(self, writer: BytesIO) -> None:
        """
        Marshal Self@GeneralClass into the writer(io object)
        """
        ...

    def UnMarshal(self, buffer: BytesIO) -> None:
        """
        Unmarshal the buffer(io object) into Self@GeneralClass
        """
        ...

    def Loads(self, jsonDict: dict) -> None:
        """
        Load data from jsonDict:dict
        """
        ...

    def Dumps(self) -> dict:
        """
        Convert Self@GeneralClass into the basic dictionary
        """
        ...

因此,通过 MarshalUnMarshal 函数,BDX Converter 可以自由的将 二进制数据 转换为 Python Class ,亦或转换回去。
LoadsDumps 分别支持了把只带有基本数据类型的字典转换为 Python Class 亦或转换回去的功能。

目前 BDX Converter 支持了所有的操作符,包括但不限于 Operation 5, Operation 13, Operation 40Operation 41 ,当前也包含 签名 相关的功能。

什么是 BDX 文件

PhoenixBuilder 是一个用于 网易我的世界中国版 · 基岩版租赁服 的商业化快速建造器,而 BDX 文件则是此建造器用于存储 Minecraft 建筑结构的 私有文件格式

如果您希望解析 BDX 文件,敬请参阅 bdump-cn.md

关于 PhoenixBuilder

待办列表

  • API 文档
  • 支持与 签名 有关的功能
  • 可以将得到的 Python Class 进一步解析为建筑结构
  • 可以自由地转换 BDX 和其他建筑文件格式

其他

本项目依照 MIT LICENSE 许可证进行许可和授权。

About

A code library to marshal, unmarshal, visual and reverse visualization of BDX files

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages