OpenDiablo2/d2common/d2loader/doc.go

// Package d2loader provides a file loader which works in terms of `Source`s and `Asset`s.
// A `Source` is something that resembles a filesystem, and an `Asset` is something that
// implements `io.ReadSeeker`.
package d2loader
D2loader (#714) * adding logger implementation to d2common * Adding file loader implementation The file loader works in terms of `Sources` and `Assets`. A `Source` is something like a filesystem that has a cache. An `Asset` is something that implements `io.ReadSeeker` and has a few methods of its own. There are currently `Source` implementations for MPQ archives and for the host filesystem, meaning that one can specify a directory on the host fs to load files from. `Sources` are added to a loader with `loader.AddSource(path)`, where `path` resolves somewhere on disk. In the case that the path points to an MPQ, then an MPQ `Source` is created and added to the loader. If `path` resolves to a directory, then a filesystem source is added. Files are loaded with `loader.Load("data/global/excel/monstats.txt")`, and the sources are searched in the order that they were added. * adding tests for d2common/logger_test.go * adding tests and testdata for d2loader * logger lint fixes, fixed missing test case * minor edits, lint fixes, changes some comments, embedded Logger into Loader * moved d2loader into d2common (I dont think it belonged in d2core) * removed my simple cache implementation in favor of our existing cache in d2common 2020-09-08 15:45:26 -04:00			// Package d2loader provides a file loader which works in terms of `Source`s and `Asset`s.
			// A `Source` is something that resembles a filesystem, and an `Asset` is something that
			// implements `io.ReadSeeker`.
			`package d2loader`