eric/Crosspoint
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: sync book.bin/section.bin version refs to source (#2169)

Browse Source
This commit is contained in:
Angad Kandhari
2026-05-29 03:07:57 -04:00
committed by GitHub
parent 75a35f0578
commit cc2079a578
2 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.skills/SKILL.md
+2 -2
View File
@@ -898,7 +898,7 @@ rm -rf /path/to/sd/.crosspoint/epub_<hash>/sections/
**Current Versions** (as of docs/file-formats.md): **Current Versions** (as of docs/file-formats.md):
- `book.bin`: **Version 5** (metadata structure) - `book.bin`: **Version 5** (metadata structure)
- `section.bin`: **Version 12** (layout structure) - `section.bin`: **Version 24** (layout structure)
**Version Increment Rules**: **Version Increment Rules**:
1. **ALWAYS increment version** BEFORE changing binary structure 1. **ALWAYS increment version** BEFORE changing binary structure
@@ -908,7 +908,7 @@ rm -rf /path/to/sd/.crosspoint/epub_<hash>/sections/
**Example** (incrementing section format version): **Example** (incrementing section format version):
```cpp ```cpp
// lib/Epub/Epub/Section.cpp // lib/Epub/Epub/Section.cpp
static constexpr uint8_t SECTION_FILE_VERSION = 13; // Was 12, now 13 static constexpr uint8_t SECTION_FILE_VERSION = 25; // Was 24, now 25
// Add new field to structure // Add new field to structure
struct PageLine { struct PageLine {
docs/file-formats.md
+3 -2
View File
@@ -2,7 +2,7 @@
## `book.bin` ## `book.bin`
### Version 3 ### Version 5
ImHex Pattern: ImHex Pattern:
@@ -12,7 +12,7 @@ import std.string;
import std.core; import std.core;
// === Configuration === // === Configuration ===
#define EXPECTED_VERSION 3 #define EXPECTED_VERSION 5
#define MAX_STRING_LENGTH 65535 #define MAX_STRING_LENGTH 65535
// === String Structure === // === String Structure ===
@@ -34,6 +34,7 @@ fn format_string(String s) {
struct Metadata { struct Metadata {
String title [[comment("Book title")]]; String title [[comment("Book title")]];
String author [[comment("Book author")]]; String author [[comment("Book author")]];
String language [[comment("Book language code")]];
String coverItemHref [[comment("Path to cover image")]]; String coverItemHref [[comment("Path to cover image")]];
String textReferenceHref [[comment("Path to guided first text reference")]]; String textReferenceHref [[comment("Path to guided first text reference")]];
} [[comment("Book metadata information")]]; } [[comment("Book metadata information")]];