Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
milasudril committed Jul 5, 2023
1 parent 529c09d commit bfa33ba
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,22 @@ archive file format, with larger fields.
appear last. Also, the lump name must end with a null byte. That is why only 255 bytes are
allowed. The last byte must always be a null byte.

* WAD64 forbids overlapping lumps
* WAD64 forbids overlapping lumps. Note however, that a file of zero length, may have the same start
offset as any other file. This is similar to `[[no_unique_address]]` attribute in C++.

## Common archive features that are not supported nativly

* Hierarchical directory structures. However, since it is possible to have longer lump names, it
can be emulated by follwing some convtion. For example, it is possible to us `/` in lump names.
Another possiblity is to have WAD:s inside WAD:s. This works, because the file format allows
can be emulated by following some convention. For example, it is possible to us `/` in lump names.
Another possibility is to have WAD:s inside WAD:s. This works, because the file format allows
full random access. The utility application `wad64` uses the first approach because it is simpler
to implement.

* Compression/encryption. It is possible to add compressed/encrypted lumps (in fact, a lump can
contain anything), provided that the reader knows what compression/encryption scheme is used. The
directory cannot be compressed/encryption, because then it is not possible to find the data.

* File metadata
* File metadata. If desired, a special file such as a `medadata.json` file can be added to the
archive

* Checksum
* Any checksums. If desired, this can also be added by adding a special file to the archive

0 comments on commit bfa33ba

Please sign in to comment.