Skip to content

v13.0.0

Latest

Choose a tag to compare

@ItsDrike ItsDrike released this 05 Mar 09:25
· 1 commit to master since this release
a72278c

Breaking Changes

  • Restructure the project & public API clarification from code by @ItsDrike in #1103
    • This changes a lot of file paths and class names within mcstatus, you might see deprecation warnings if importing certain objects from the old paths.
    • We also better clarify what is and what is not a part of the public API, no deprecations will be provided for things that we do not consider as public API, so you might face full import errors if you were using these, they will now live under _ prefixed symbols.
    • Specifically:
      • mcstatus.status_response -> mcstatus.responses (which is also further divided into submodules, but you can import from mcstatus.responses directly too through re-exports)
      • mcstatus.forge_data -> mcstatus.responses.forge (or the re-exports in mcstatus.responses)
      • mcstatus.bedrock_status, mcstatus.pinger, mcstatus.legacy_status, mcstatus.querier -> considered private API
      • mcstatus.protocol, mcstatus.address, mcstatus.dns -> considered private API
      • mcstatus.motd.transformers, mcstatus.motd.simplifies -> considered private API
      • The typed dict definitions in mcstatus.status_response and mcstatus.forge_data -> considered private API
  • CLI: use StatusResponse.as_dict() in JSON command by @PerchunPak in #1102
    • This changes the JSON output of mcstatus CLI in an incompatible way, people relying on certain field names / value types might face breakages. The breaking changes only affect query responses.
    • The following has changed specifically in the query response JSON:
      • The map key was renamed to map_name
      • The port value is now a JSON number type, not a string
      • New fields: motd, game_id, game_type, players, and software were added

Features / Improvements

Other changes

New Contributors

Full Changelog: v12.2.1...v13.0.0