fs

Documentation

Overview

Package fs implements Warcraft 3 file system utilities.

Index

• Constants
• func FindInstallationDir() string
• func UserDir() string
• type Storage
  • func Open(installPath string, userPaths ...string) *Storage
  • func (stor *Storage) Close() error
  • func (stor *Storage) Open(subFileName string) (io.ReadCloser, error)

Constants

const LocalDir = "./war3"

LocalDir overrides any global directory

Functions

func FindInstallationDir

func FindInstallationDir() string

FindInstallationDir checks common Warcraft III installation directories and returns the first one that exists

func UserDir

func UserDir() string

UserDir returns the Warcraft III user directory

Types

type Storage

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

Storage provider for Warcraft III file system

func Open

func Open(installPath string, userPaths ...string) *Storage

Open Warcraft III storage from installPath and userPath

func (*Storage) Close

func (stor *Storage) Close() error

Close storage

func (*Storage) Open

func (stor *Storage) Open(subFileName string) (io.ReadCloser, error)

Open subFileName from storage