Saucexages v0.2.0 API Reference

Modules

Saucexages is a library that provides functionality for reading, writing, interrogating, and fixing SAUCE – Standard Architecture for Universal Comment Extensions

ANSiFlags allow an author of ANSi and similar files to provide a clue to a viewer / editor how to render the image

Functions for decoding SAUCE records and SAUCE comment blocks

Functions for encoding SAUCE blocks as binary

Functions for decoding commonly used SAUCE field data types

Functions for working with SAUCE Data Types. Each data type in combination with a file type determines how SAUCE type dependent fields should be interpreted. The data type and file type together form named file types such as ANSI, ASCII, RIP Script, HTML, and S3M among many others

Module used for working with font data embedded into certain SAUCE types

Reads SAUCE data from binaries according to the SAUCE specification

Functions for writing and maintaining SAUCE binaries

Reads SAUCE data from files according to the SAUCE specification

Functions for writing and maintaining SAUCE files

Functions for working with SAUCE containing and related binaries

Functions for handling SAUCE files in the file system

This module is used to provide facilities for working with type information described in the SAUCE spec. Typically, this consists at a minimum of a data type, possibly combined with a file type. The combination of the two together comprise the actual information type the SAUCE data is representing

Functions for working with SAUCE

Represents a full SAUCE block, including both a SAUCE record and comments

Represents a bare SAUCE record