mpq

Documentation

Overview

Package mpq provides golang bindings to the StormLib library to read MPQ archives.

Example

package main

import (
	"fmt"
	"io/ioutil"

	"github.com/nielsAD/gowarcraft3/file/mpq"
)

func main() {
	archive, err := mpq.OpenArchive("./test.mpq")
	if err != nil {
		fmt.Println(err)
		return
	}
	defer archive.Close()

	hello, err := archive.Open("hello.txt")
	if err != nil {
		fmt.Println(err)
		return
	}

	raw, err := ioutil.ReadAll(hello)
	if err != nil {
		fmt.Println(err)
		return
	}

	fmt.Print(string(raw))

}

Output:

Hello

Index

• Variables
• type Archive
  • func OpenArchive(fileName string) (*Archive, error)
  • func (a *Archive) Close() error
  • func (a *Archive) Open(subFileName string) (*File, error)
  • func (a *Archive) StrongSigned() bool
  • func (a *Archive) WeakSigned() bool
• type File
  • func (f *File) Close() error
  • func (f *File) Read(b []byte) (int, error)
  • func (f *File) Size() int64

Examples

• Package

Variables

var (
	ErrBadFormat    = errors.New("mpq: Bad format")
	ErrArchiveOpen  = errors.New("mpq: Could not open archive")
	ErrArchiveClose = errors.New("mpq: Could not close archive")
	ErrFileOpen     = errors.New("mpq: Could not open subfile")
	ErrFileClose    = errors.New("mpq: Could not close subfile")
	ErrFileRead     = errors.New("mpq: Could not read subfile")
)

Errors

Types

type Archive

type Archive struct {
	// contains filtered or unexported fields
}

Archive stores a handle to an opened MPQ archive

func OpenArchive

func OpenArchive(fileName string) (*Archive, error)

OpenArchive opens fileName as MPQ archive

func (*Archive) Close

func (a *Archive) Close() error

Close an MPQ archive

func (*Archive) Open

func (a *Archive) Open(subFileName string) (*File, error)

Open a subfile inside an opened MPQ archive

func (*Archive) StrongSigned

func (a *Archive) StrongSigned() bool

StrongSigned checks and verifies the archive against its strong signature if present

func (*Archive) WeakSigned

func (a *Archive) WeakSigned() bool

WeakSigned checks and verifies the archive against its weak signature if present

type File

type File struct {
	// contains filtered or unexported fields
}

File stores a handle to an opened subfile in an MPQ archive

func (*File) Close

func (f *File) Close() error

Close an MPQ subfile

func (*File) Read

func (f *File) Read(b []byte) (int, error)

Read implements the io.Reader interface

func (*File) Size

func (f *File) Size() int64

Size reports the total file size in bytes