sbrl-github
/
Minetest-WorldEditAdditions
mirror of https://github.com/sbrl/Minetest-WorldEditAdditions.git
1
0
Fork 0
Code Issues Releases Wiki Activity

specs/weaschem: be specific about the first line

This commit is contained in:
Starbeamrainbowlabs 2023-08-12 01:43:48 +01:00
parent c734a46579
commit c05228a37a
Signed by: sbrl
GPG Key ID: 1BE5172E637709C2
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.docs/specs/WorldEditAdditionsSchematic_v1.md
View File

@ -72,7 +72,7 @@ Stands for the ASCII character new line U+0A. Wherever this symbol appears, subs
## Overview
The format can be divided into 4 sequential parts:
1. **Magic bytes:** The string `WEASCHEM 1\n` is always the beginning of the file.
1. **Magic bytes:** The string `WEASCHEM` is always the beginning of the file, followed by exactly 1 space (` ` U+20) and an integer version number
2. **Header:** Contains metadata about the schematic.
3. **ID map:** The map of node ids to their respective node names.
4. **Data tables:** The actual data itself.
@ -118,6 +118,8 @@ WEASCHEM 1
## Magic bytes
The string `WEASCHEM` is always present at the beginning of a WorldEditAdditions schematic file, followed a a single space ` ` U+20, then an integer version number.
If the string `WEASCHEM` is *not* present at the very beginning of a file, then it MUST be considered invalid and a clear error message returned.
This specification, as noted above, described WorldEditAdditions schematic files version `1`. It is RECOMMENDED that implementers reject schematic files with a version number that they do not support parsing with a useful error message.
For example, `WEASCHEM 1` defines a schematic file of version 1.