pile

package module

Go to main page

Versions in this module

v0

v0.2.3

Aug 17, 2026

v0.2.2

Aug 10, 2026

v0.2.1

Aug 9, 2026

Changes in this version

+ func MCDBBlockStates(dir string) ([]format.BlockState, error)

+ func RegisterBlockState(reg world.BlockRegistry, s format.BlockState) (bool, error)

+ func RegisterMCDBStates(dir string, reg world.BlockRegistry) (int, error)

+ func WorldBlockStates(dir string, opts ...format.ReadOption) ([]format.BlockState, error)

v0.2.0

Aug 8, 2026

Changes in this version

+ const CompressionBest

+ const CompressionDefault

+ const CompressionFast

+ const CompressionNone

+ var ErrCorrupt = format.ErrCorrupt

+ var ErrDecodeBudget = format.ErrDecodeBudget

+ var ErrNotFound = leveldb.ErrNotFound

+ var ErrReadOnly = errors.New("pile: provider is read-only")

+ var ErrUnmovableUserData = errors.New("pile: world carries user data, which pile cannot translate")

+ var ErrWouldClip = errors.New("pile: move would clip content outside the world's vertical range")

+ func DimPath(dir string, dim world.Dimension) string

+ func ExportMCDB(src, dst string, opts ...Option) (int, error)

+ func FileMode(path string) (uint8, error)

+ func ImportMCDB(src, dst string, opts ...Option) (int, error)

+ func IsMCDB(dir string) bool

+ func IsPile(dir string) bool

+ func WorldBounds(p *Provider, dim world.Dimension) (lo, hi cube.Pos, ok bool)

+ type Builder struct

+ func NewBuilder(reg world.BlockRegistry, rng cube.Range) *Builder

+ func (b *Builder) AddBlockEntity(pos cube.Pos, data map[string]any)

+ func (b *Builder) AddEntity(data map[string]any)

+ func (b *Builder) Fill(lo, hi cube.Pos, bl world.Block)

+ func (b *Builder) FillBiome(lo, hi cube.Pos, bio world.Biome)

+ func (b *Builder) Provider(opts ...Option) *Provider

+ func (b *Builder) Save(dir string, opts ...Option) error

+ func (b *Builder) SetBlock(pos cube.Pos, bl world.Block)

+ func (b *Builder) SetUserData(data []byte)

+ func (b *Builder) Settings(s *world.Settings)

+ type DimFile struct

+ Columns []format.Column

+ Dim world.Dimension

+ Indexed bool

+ StoreLight bool

+ type MoveOptions struct

+ Backup bool

+ Clip bool

+ DryRun bool

+ KeepUserData bool

+ MaxDecoded int64

+ Offset cube.Pos

+ Registry world.BlockRegistry

+ type MoveReport struct

+ Chunks int

+ ClippedBlockEntities int

+ ClippedBlocks int

+ ClippedEntities int

+ ClippedTicks int

+ FastPath bool

+ Offset cube.Pos

+ func MoveWorld(dir string, opt MoveOptions) (*MoveReport, error)

+ func (r *MoveReport) ClippedTotal() int

+ type Option func(*config)

+ func AppendMode() Option

+ func CacheColumns(n int) Option

+ func Compression(level format.CompressionLevel) Option

+ func FastSaves() Option

+ func FilterBlockEntity(f func(chunk.BlockEntity) bool) Option

+ func FilterColumn(f func(world.ChunkPos, world.Dimension) bool) Option

+ func FilterEntity(f func(chunk.Entity) bool) Option

+ func LoadSkip(m SkipMask) Option

+ func MaxDecodedBytes(n int64) Option

+ func ReadOnly() Option

+ func Registry(reg world.BlockRegistry) Option

+ func Skip(m SkipMask) Option

+ func StoreLight() Option

+ func WithSpawnStore(s SpawnStore) Option

type Provider

+ func NewMemory(opts ...Option) *Provider

+ func Open(dir string, opts ...Option) (*Provider, error)

+ func (p *Provider) AutoSave(interval time.Duration) (stop func())

+ func (p *Provider) ChunkUserData(pos world.ChunkPos, dim world.Dimension) []byte

+ func (p *Provider) Columns(dim world.Dimension) iter.Seq2[world.ChunkPos, *chunk.Column]

+ func (p *Provider) DeleteSnapshot(name string) error

+ func (p *Provider) Dir() string

+ func (p *Provider) IterError() error

+ func (p *Provider) Rollback(name string) error

+ func (p *Provider) SaveAs(dir string) error

+ func (p *Provider) SetChunkUserData(pos world.ChunkPos, dim world.Dimension, b []byte) error

+ func (p *Provider) Snapshot(name string) error

+ func (p *Provider) Snapshots() ([]string, error)

+ func (p *Provider) UserData() []byte

+ type SkipMask uint32

+ const SkipBiomes

+ const SkipBlockEntities

+ const SkipChunkUserData

+ const SkipEntities

+ const SkipScheduledTicks

+ type SpawnStore interface

+ LoadPlayerSpawn func(id uuid.UUID) (pos cube.Pos, exists bool, err error)

+ SavePlayerSpawn func(id uuid.UUID, pos cube.Pos) error

+ type Structure struct

+ func ExtractStructure(p *Provider, dim world.Dimension, lo, hi cube.Pos, opts ...StructureOption) (*Structure, error)

+ func LoadStructure(path string, opts ...StructureOption) (*Structure, error)

+ func (s *Structure) At(x, y, z int, _ func(x, y, z int) world.Block) (world.Block, world.Liquid)

+ func (s *Structure) Data() *format.StructureData

+ func (s *Structure) Dimensions() [3]int

+ func (s *Structure) PasteInto(p *Provider, dim world.Dimension, at cube.Pos) error

+ func (s *Structure) Rotate(quarters int) *Structure

+ func (s *Structure) Save(path string) error

+ type StructureLibrary struct

+ func LoadStructureLibrary(dir string, opts ...StructureOption) (*StructureLibrary, error)

+ func (l *StructureLibrary) Get(name string) (*Structure, bool)

+ func (l *StructureLibrary) Len() int

+ func (l *StructureLibrary) Names() []string

+ type StructureOption func(*Structure)

+ func SkipAir() StructureOption

+ func StructureMaxDecodedBytes(n int64) StructureOption

+ func StructureRegistry(reg world.BlockRegistry) StructureOption

+ type Template struct

+ func OpenTemplate(dir string, opts ...Option) (*Template, error)

+ func (t *Template) Close() error

+ func (t *Template) Instance(opts ...Option) *Provider

+ func (t *Template) Provider() *Provider

+ type WorldFiles struct

+ Dims []DimFile

+ Settings []byte

+ UserData []byte

+ func LoadWorldFiles(dir string, reg world.BlockRegistry, opts ...Option) (*WorldFiles, error)

+ func (wf *WorldFiles) Backup(dir, name string) error

+ func (wf *WorldFiles) Dim(dim world.Dimension) *DimFile

+ func (wf *WorldFiles) Write(dir string, reg world.BlockRegistry) error

v0.1.7

Aug 2, 2026

v0.1.6

Nov 27, 2025

Changes in this version

type Provider

+ func (p *Provider) GetUserData() []byte

+ func (p *Provider) SetUserData(d world.Dimension, data []byte)

v0.1.5

Nov 27, 2025

v0.1.4

Nov 27, 2025

v0.1.3

Nov 27, 2025

v0.1.2

Nov 27, 2025

v0.1.1

Nov 27, 2025

v0.1.0

Nov 12, 2025

Changes in this version

+ const CompressionLevelBest

+ const CompressionLevelDefault

+ const CompressionLevelFast

+ const CompressionLevelNone

+ type CompressionLevel = format.CompressionLevel

+ type Provider struct

+ func New(dir string) (*Provider, error)

+ func NewReadOnly(dir string) (*Provider, error)

+ func NewReadOnlyWithCompression(dir string, compressionLevel CompressionLevel) (*Provider, error)

+ func NewWithCompression(dir string, compressionLevel CompressionLevel) (*Provider, error)

+ func (p *Provider) ChunkCount() int

+ func (p *Provider) Close() error

+ func (p *Provider) DimensionChunkCount(dim world.Dimension) int

+ func (p *Provider) DisableBackgroundSaves()

+ func (p *Provider) EnableBackgroundSaves()

+ func (p *Provider) IsDirty() bool

+ func (p *Provider) IsReadOnly() bool

+ func (p *Provider) LoadColumn(pos world.ChunkPos, dim world.Dimension) (*chunk.Column, error)

+ func (p *Provider) LoadPlayerSpawnPosition(id uuid.UUID) (cube.Pos, bool, error)

+ func (p *Provider) Save() error

+ func (p *Provider) SaveAsync()

+ func (p *Provider) SavePlayerSpawnPosition(id uuid.UUID, pos cube.Pos) error

+ func (p *Provider) SaveSettings(s *world.Settings)

+ func (p *Provider) SetCompressionLevel(level CompressionLevel)

+ func (p *Provider) SetStreamingSaves(enabled bool)

+ func (p *Provider) Settings() *world.Settings

+ func (p *Provider) StoreColumn(pos world.ChunkPos, dim world.Dimension, col *chunk.Column) error

+ type Settings struct

+ CurrentTick int64

+ DefaultGameMode int32

+ Difficulty int32

+ Name string

+ RainTime int64

+ Raining bool

+ Spawn cube.Pos

+ ThunderTime int64

+ Thundering bool

+ Time int64

+ TimeCycle bool

+ WeatherCycle bool

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