mpq

Documentation

Overview

Package mpq reads data from Blizzard MPQ files.

Index

• Constants
• func Hash(in string, hashType HashType) uint32
• type HashType
• type Reader
  • func NewReader(f *os.File) *Reader
  • func (r *Reader) GetFileList() []string
  • func (r *Reader) OpenFile(name string) io.Reader

Constants

const (
	HashTableOffset = HashType(0)
	HashNameA       = HashType(1)
	HashNameB       = HashType(2)
	HashFileKey     = HashType(3)
)

const (
	BlockFlagFile           uint32 = 1 << 31
	BlockFlagCheckSums      uint32 = 1 << 26
	BlockFlagDeletionMarker uint32 = 1 << 25
	BlockFlagSingleUnit     uint32 = 1 << 24
	BlockFlagCompressed     uint32 = 1 << 9
	BlockFlagImploded       uint32 = 1 << 8
)

Functions

func Hash

func Hash(in string, hashType HashType) uint32

Hash is the hash function used within MPQ files.

Types

type HashType

type HashType int

HashType identifies which variant of the hash function to use.

type Reader

type Reader struct {
	*os.File
	// contains filtered or unexported fields
}

Reader reads an MPQ file.

func NewReader

func NewReader(f *os.File) *Reader

NewReader reads the header of a file, returning an opened Reader.

func (*Reader) GetFileList

func (r *Reader) GetFileList() []string

GetFileList returns a list of the files contained in the MPQ according to its "(listfile") metafile, if present.

func (*Reader) OpenFile

func (r *Reader) OpenFile(name string) io.Reader

ReadFile reads a file from within the MPQ file.