app

Documentation

Index

• Variables
• func DetectGameDir() (string, error)
• func ExtractorConfigHelpMessage(template ConfigTemplate) string
• func ParseExtractorConfig(template ConfigTemplate, cfgStr string) (map[string]map[string]string, error)
• func ParseHashes(str string) []string
• func VerifyGameDir(path string) error
• type App
  • func OpenGameDir(ctx context.Context, gameDir string, hashes []string, thinhashes []string, ...) (*App, error)
  • func (a *App) ExtractFile(ctx context.Context, id stingray.FileID, triadId stingray.Hash, outDir string, ...) ([]string, error)
  • func (a *App) MatchingFiles(includeGlob, excludeGlob string, triadName string, cfgTemplate ConfigTemplate, ...) (map[stingray.FileID]*stingray.File, error)
• type ConfigTemplate
• type ConfigTemplateExtractor
• type ConfigTemplateOption
• type ConfigValueType
• type Printer
  • func NewPrinter(colorOutput bool, stdout io.Writer, stderr io.Writer) *Printer
  • func (p *Printer) Errorf(f string, a ...any)
  • func (p *Printer) Fatalf(f string, a ...any)
  • func (p *Printer) Infof(f string, a ...any)
  • func (p *Printer) NoStatus()
  • func (p *Printer) Statusf(f string, a ...any)
  • func (p *Printer) Warnf(f string, a ...any)

Variables

var ConfigFormat = ConfigTemplate{
	Extractors: map[string]ConfigTemplateExtractor{
		"wwise_stream": {
			Category: "audio",
			Options: map[string]ConfigTemplateOption{
				"format": {
					Type: ConfigValueEnum,
					Enum: []string{"ogg", "wav", "aac", "mp3", "wem", "source"},
				},
			},
		},
		"wwise_bank": {
			Category: "audio",
			Options: map[string]ConfigTemplateOption{
				"format": {
					Type: ConfigValueEnum,
					Enum: []string{"ogg", "wav", "aac", "mp3", "bnk", "source"},
				},
			},
		},
		"bik": {
			Category: "video",
			Options: map[string]ConfigTemplateOption{
				"format": {
					Type: ConfigValueEnum,
					Enum: []string{"mp4", "bik", "source"},
				},
			},
		},
		"material": {
			Category: "shader",
			Options: map[string]ConfigTemplateOption{
				"format": {
					Type: ConfigValueEnum,
					Enum: []string{"glb", "source", "blend"},
				},
				"single_glb": {
					Type: ConfigValueEnum,
					Enum: []string{"false", "true"},
				},
				"image_jpeg": {
					Type: ConfigValueEnum,
					Enum: []string{"false", "true"},
				},
				"jpeg_quality": {
					Type:        ConfigValueIntRange,
					IntRangeMin: 1,
					IntRangeMax: 100,
				},
				"png_compression": {
					Type: ConfigValueEnum,
					Enum: []string{"default", "none", "fast", "best"},
				},
				"all_textures": {
					Type: ConfigValueEnum,
					Enum: []string{"false", "true"},
				},
				"accurate_only": {
					Type: ConfigValueEnum,
					Enum: []string{"false", "true"},
				},
			},
		},
		"texture": {
			Category: "image",
			Options: map[string]ConfigTemplateOption{
				"format": {
					Type: ConfigValueEnum,
					Enum: []string{"png", "dds", "source"},
				},
			},
		},
		"unit": {
			Category: "model",
			Options: map[string]ConfigTemplateOption{
				"format": {
					Type: ConfigValueEnum,
					Enum: []string{"glb", "source", "blend"},
				},
				"include_lods": {
					Type: ConfigValueEnum,
					Enum: []string{"false", "true"},
				},
				"join_components": {
					Type: ConfigValueEnum,
					Enum: []string{"true", "false"},
				},
				"bounding_boxes": {
					Type: ConfigValueEnum,
					Enum: []string{"false", "true"},
				},
				"single_glb": {
					Type: ConfigValueEnum,
					Enum: []string{"false", "true"},
				},
				"no_bones": {
					Type: ConfigValueEnum,
					Enum: []string{"false", "true"},
				},
				"image_jpeg": {
					Type: ConfigValueEnum,
					Enum: []string{"false", "true"},
				},
				"jpeg_quality": {
					Type:        ConfigValueIntRange,
					IntRangeMin: 1,
					IntRangeMax: 100,
				},
				"png_compression": {
					Type: ConfigValueEnum,
					Enum: []string{"default", "none", "fast", "best"},
				},
				"all_textures": {
					Type: ConfigValueEnum,
					Enum: []string{"false", "true"},
				},
			},
		},
		"raw": {
			Category: "",
			Options: map[string]ConfigTemplateOption{
				"format": {
					Type: ConfigValueEnum,
					Enum: []string{"source"},
				},
			},
			DefaultDisabled: true,
		},
	},
	Fallback: "raw",
}

Functions

func DetectGameDir

func DetectGameDir() (string, error)

Returns error if steam path couldn't be found.

func ExtractorConfigHelpMessage

func ExtractorConfigHelpMessage(template ConfigTemplate) string

func ParseExtractorConfig

func ParseExtractorConfig(template ConfigTemplate, cfgStr string) (map[string]map[string]string, error)

func ParseHashes

func ParseHashes(str string) []string

func VerifyGameDir

func VerifyGameDir(path string) error

Types

type App

type App struct {
	Hashes     map[stingray.Hash]string
	ThinHashes map[stingray.ThinHash]string
	ArmorSets  map[stingray.Hash]dlbin.ArmorSet
	DataDir    *stingray.DataDir
}

func OpenGameDir

func OpenGameDir(ctx context.Context, gameDir string, hashes []string, thinhashes []string, onProgress func(curr, total int)) (*App, error)

Open game dir and read metadata.

func (*App) ExtractFile

func (a *App) ExtractFile(ctx context.Context, id stingray.FileID, triadId stingray.Hash, outDir string, extrCfg map[string]map[string]string, runner *exec.Runner, gltfDoc *gltf.Document) ([]string, error)

Returns path to extracted file/directory.

func (*App) MatchingFiles

func (a *App) MatchingFiles(includeGlob, excludeGlob string, triadName string, cfgTemplate ConfigTemplate, cfg map[string]map[string]string) (map[stingray.FileID]*stingray.File, error)

type ConfigTemplate

type ConfigTemplate struct {
	Extractors map[string]ConfigTemplateExtractor
	Fallback   string
}

type ConfigTemplateExtractor

type ConfigTemplateExtractor struct {
	Category        string
	Options         map[string]ConfigTemplateOption
	DefaultDisabled bool
}

type ConfigTemplateOption

type ConfigTemplateOption struct {
	Type        ConfigValueType
	Enum        []string
	IntRangeMin int
	IntRangeMax int
}

type ConfigValueType

type ConfigValueType int

const (
	ConfigValueEnum ConfigValueType = iota
	ConfigValueIntRange
)

type Printer

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

func NewPrinter

func NewPrinter(colorOutput bool, stdout io.Writer, stderr io.Writer) *Printer

func (*Printer) Errorf

func (p *Printer) Errorf(f string, a ...any)

func (*Printer) Fatalf

func (p *Printer) Fatalf(f string, a ...any)

func (*Printer) Infof

func (p *Printer) Infof(f string, a ...any)

func (*Printer) NoStatus

func (p *Printer) NoStatus()

func (*Printer) Statusf

func (p *Printer) Statusf(f string, a ...any)

func (*Printer) Warnf

func (p *Printer) Warnf(f string, a ...any)