Skip to content

Commit

Permalink
misc(readme): Add Godot version support notice.
Browse files Browse the repository at this point in the history
  • Loading branch information
elenakrittik committed Sep 22, 2023
1 parent f047868 commit ac25cae
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
29 changes: 29 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# v1.0.0 -> v2.0.0

## Breaking Changes

- `XMLNodeType` was removed due to not being used anywhere.
- `beautify` parameter in all `XML.dump_*()` functions was renamed to `pretty`.
- Move `XMLDocument.to_dict()` to `XMLNode.to_dict()`.
- Make `XMLNode.to_dict()` opinionated by removing all controllability functions.
- Change structure of `XMLNode.to_dict()`'s output.

## Features

- `XML` can now handle semantically invalid XML.
- Added `indent_level` and `indent_length` to control initial indentation level and level width respectively.
- Allow accessing `XMLNode` children by their name if their name is unqiue amongst that `XMLNode`'s children. Works in the editor too.
- Document structure of `XMLNode.to_dict()`'s output.

## Bug Fixes

- Fix empty standalone nodes geting two spaces before `>` when prettified.
- Fix node content being on the same line as it's node when prettified.

## Internal Changes

- Remove pointless checks in parsing logic.
- Properly document code to make contributing easier.
- Reformat code to use 4-space indent instead of the previous tabs.
- Remove commented out code in some places.
- Refactor prettifier and dictionary converter to be recursive-descent, significantly simplifying logic.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This addon adds support for manipulating XML data in Godot 4 with ease.

> Supports Godot 4.0, 4.1 and the likely the upcoming 4.2.
> HINT: Migrating from v1? See [changelog](./CHANGELOG.md) for a complete list of breaking (and not) changes.
## Features
Expand Down

0 comments on commit ac25cae

Please sign in to comment.