res

package module
v0.0.0-...-e78e2ff Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 28, 2018 License: BSD-3-Clause Imports: 0 Imported by: 17

README

Build Status Coverage Status

Resource File Access

Obsolescence Notice: Due to the release of InkyBlackness - HackEd, this project here has become obsolete: HackEd provides its own means to read/write resources. Furthermore, this project is based on pre-source-release information. Use it at your own risk.

This is a library as part of the InkyBlackness project, written in Go, to provide basic (binary) access to the resource files of System Shock.

It supports both reading and writing of the files, in a bit-transparent manner. Reading the extracted (and decompressed) data and then writing it again creates identical files.

Supported Files & Data Format

The library supports the following resource files:

  • chunk files (*.res / archive.dat)
  • objprop.dat (Object properties)
  • textprop.dat (Texture properties)

The data format (framing) of the supported files is documented in the ss-specs sub-project of InkyBlackness.

License

The project is available under the terms of the New BSD License (see LICENSE file).

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ObjectClass

type ObjectClass byte

ObjectClass is a first identification of an object

type ObjectID

type ObjectID struct {
	Class    ObjectClass
	Subclass ObjectSubclass
	Type     ObjectType
}

ObjectID completely identifies a specific object

func MakeObjectID

func MakeObjectID(class ObjectClass, subclass ObjectSubclass, objType ObjectType) ObjectID

MakeObjectID returns an object ID with the provided values

type ObjectSubclass

type ObjectSubclass byte

ObjectSubclass is the second identification of an object

type ObjectType

type ObjectType byte

ObjectType is the specific type of a class/subclass combination

type ResourceID

type ResourceID uint16

ResourceID uniquely identifies a resource

func (ResourceID) Value

func (id ResourceID) Value() uint16

Value returns the identifiers raw integer value.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL