Crate pmd_farc

This library permit to have a read-only access to Farc file format used in the 3ds game of pokemon mystery dungeon.

The pmd_farc::Farc file format is a packed file format, like tar. It doesn’t have a notion of subdirectory. There is two type of pmd_farc::Farc file:

• A version with file index by their name.
• A version with file index by the crc32 hash of their name. This library automatically identify the pmd_farc::Farc type. For type without full file name, you can test if a String correspond to a file name.

Modules

message_dehash

contain useful function to get the original name of message* farc files.

Structs

Farc

A parser for a file in the farc format (see the crate root documentation for more information)

FarcFile

Represent a file stored in a farc file

FarcWriter

Represent the content to be written to a FARC file. IT can only create hash-indexed file.

FileNameIndex

Represent an index of a FARC file. Each subfile have a known position and lenght related to it’s parent file, as well as the hash of the name. The full name may or may not be known for a file.

Enums

FarcError

An error that Farc can return

FarcWriterError

An error that could happen with any function of a FarcWriter

FileHashType

This enum store the way we can find the name of the files of the compressed file

FileNameError

Any error that may happend due to name conflict

Functions

hash_name

Hash a name, first transforming it into utf16, then applying the ieee crc32 checksum