Skip to content

Commit a16cd3f

Browse files
committed
docs: Update changelog and updating guide
1 parent 01797a8 commit a16cd3f

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

docs/content/docs/changelog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ weight: 6
2424
because too many projects use it.
2525
- Add warning to material `GL_SHININESS` because it isn't used for anything.
2626
- Align the Huffman temporary buffer to a word just in case it's needed.
27+
- Stop expecting a size field in the `GRF` chunk of GRF files.
28+
- Support `PIDX` chunks in GRF files.
2729

2830
- DSWiFi:
2931

@@ -39,6 +41,9 @@ weight: 6
3941

4042
- grit:
4143

44+
- Remove size field from `GRF` chunks in GRF files. This was added by BlocksDS
45+
and it makes it harder to be compatible with other GRF files. Removing it
46+
doesn't affect anything because the RIFF chunk already has the size.
4247
- When exporting tiled backgrounds grit didn't check if the size of the tile
4348
set was too big. There was a check but it was incorrect. Now, grit will fail
4449
if it's trying to export too many tiles for the specified format. For

docs/content/docs/guides/updating_guide.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,13 @@ including additions and enhancements to the SDK which are not listed here.
2222
games, but it's important to check all images that fail to be converted
2323
because they weren't being converted correctly before.
2424

25+
* The "size" field of `GRF` chunks in GRF files has been removed. This field was
26+
added in one of the initial versions of BlocksDS, and it makes it harder to
27+
support old and new files simultaneously. Programs using `grit`, `ptexconv`
28+
and the libnds helpers to load GRF files will need to rebuild all their
29+
graphics. Programs with custom parsers will need to modify their parsers to
30+
remove that field.
31+
2532
### Upgrading to BlocksDS 1.15.2
2633

2734
* The DSWiFi structs `Wifi_TxHeader` and `Wifi_RxHeader` are now private. They

0 commit comments

Comments
 (0)