Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

vpk

package module

Go to main page

Versions in this module

v1

v1.0.0

Jul 9, 2026

Changes in this version

+ var ErrClosed = errors.New("vpk: closed")

+ var ErrExist = errors.New("vpk: file already exists")

+ var ErrNoSavePath = errors.New("vpk: no save path")

+ var ErrNotExist = errors.New("vpk: file does not exist")

+ func Create(path string, v *VPK, opts ...CreateOption) error

+ type ArchiveResolver interface

+ OpenArchive func(index uint16) (io.ReaderAt, io.Closer, int64, error)

+ type ChecksumError struct

+ Actual uint32

+ Expected uint32

+ Name string

+ func (e ChecksumError) Error() string

+ type CreateOption func(*createOptions)

+ func WithVersion(version Version) CreateOption

+ type Entry struct

+ ArchiveIndex uint16

+ CRC32 uint32

+ Name string

+ Offset uint32

+ PreloadBytes []byte

+ Size uint32

+ type EntryOption func(*entryOptions)

+ type File struct

+ Body io.Reader

+ Name string

+ type Header struct

+ ArchiveMD5SectionSize uint32

+ FileDataSectionSize uint32

+ OtherMD5SectionSize uint32

+ Signature uint32

+ SignatureSectionSize uint32

+ TreeSize uint32

+ Version uint32

+ type Option func(*options)

+ func WithArchiveResolver(resolver ArchiveResolver) Option

type Reader

+ func (r *Reader) Read() (*VPK, error)

+ type ReaderOption func(*readerOptions)

+ func WithReaderArchiveResolver(resolver ArchiveResolver) ReaderOption

+ type VPK struct

+ func New() *VPK

+ func Open(path string, opts ...Option) (*VPK, error)

+ func OpenFS(fsys fs.FS, name string, opts ...Option) (*VPK, error)

+ func (v *VPK) Add(name string, r io.Reader, opts ...EntryOption) error

+ func (v *VPK) AddFS(fsys fs.FS, root string, opts ...EntryOption) error

+ func (v *VPK) Clear() error

+ func (v *VPK) Close() error

+ func (v *VPK) Delete(name string) error

+ func (v *VPK) Entries() []Entry

+ func (v *VPK) Open(name string) (fs.File, error)

+ func (v *VPK) Put(name string, r io.Reader, opts ...EntryOption) error

+ func (v *VPK) ReadDir(name string) ([]fs.DirEntry, error)

+ func (v *VPK) ReadFile(name string) ([]byte, error)

+ func (v *VPK) Rename(oldName, newName string) error

+ func (v *VPK) Save() error

+ func (v *VPK) SetVerifyCRC(enabled bool)

+ func (v *VPK) Stat(name string) (fs.FileInfo, error)

+ func (v *VPK) VerifyCRC() bool

+ type Version uint32

+ const Version1

+ const Version2

+ type Writer struct

+ func NewWriter(w io.Writer, opts ...CreateOption) *Writer

+ func (w *Writer) Close() error

+ func (w *Writer) Write(v *VPK) error

v0

v0.1.0

Nov 22, 2025

Changes in this version

+ type ReadCloser struct

+ func OpenReader(name string) (*ReadCloser, error)

+ func (r *ReadCloser) Close() error

+ type Reader struct

+ func NewReader(r io.ReaderAt, size int64) (*Reader, error)

+ func (r *Reader) Open(name string) (fs.File, error)

+ func (reader *Reader) AddSubArchive(index int, r io.ReaderAt, size int64)