Overview
The EncodingType class represents a specific world format that can be read from or written to. Chunker includes built-in support for Java Edition, Bedrock Edition, and internal formats for preview generation and settings extraction.
Class Definition
package com.hivemc.chunker.conversion.encoding;
public class EncodingType
cli/src/main/java/com/hivemc/chunker/conversion/encoding/EncodingType.java:22
Built-in Encoding Types
JAVA
Reader and writer for Minecraft Java Edition worlds.
public static final EncodingType JAVA
EncodingType.java:31
BEDROCK
Reader and writer for Minecraft Bedrock Edition worlds.
public static final EncodingType BEDROCK
EncodingType.java:42
PREVIEW
Writer for rendering world map previews (internal use).
public static final EncodingType PREVIEW
EncodingType.java:53
SETTINGS
Writer for extracting world settings and in-game maps (internal use).
public static final EncodingType SETTINGS
EncodingType.java:64
Constructor
public EncodingType(
String name,
boolean internal,
EncoderLevelReaderConstructor<?> readerConstructor,
EncoderLevelWriterConstructor<?> writerConstructor,
Collection<Version> supportedVersions
)
The display name of the encoding type in English (e.g., “Java”, “Bedrock”)
Whether the encoding type should be hidden from users (true for PREVIEW and SETTINGS)
readerConstructor
EncoderLevelReaderConstructor<?>
Constructor for creating level readers, or null if reading is not supported
writerConstructor
EncoderLevelWriterConstructor<?>
Constructor for creating level writers, or null if writing is not supported
supportedVersions
Collection<Version>
required
List of Minecraft versions this encoding type supports
EncodingType.java:89
Core Methods
createReader()
Create a level reader for this encoding type from an input directory.
public Optional<? extends LevelReader> createReader(
File directory,
Converter converter
)
The input directory containing the world data
The converter instance to use with the reader
Optional<LevelReader>
Optional<? extends LevelReader>
A newly created level reader, or empty if the format cannot be read or version is not detected
EncodingType.java:197
createWriter()
Create a level writer for this encoding type targeting a specific version.
public Optional<? extends LevelWriter> createWriter(
File directory,
Version version,
Converter converter
)
The output directory where the world will be written
The target Minecraft version for the output world
The converter instance to use with the writer
Optional<LevelWriter>
Optional<? extends LevelWriter>
A newly created level writer, or empty if the version is not supported
EncodingType.java:210
getName()
Get the display name of this encoding type.
Returns: The name in English (e.g., “Java”, “Bedrock”)
Location: EncodingType.java:186
getSupportedVersions()
Get all versions supported by this encoding type.
public Collection<Version> getSupportedVersions()
EncodingType.java:220
isInternal()
Check if this encoding type is internal (not shown to users).
public boolean isInternal()
true if this is an internal format like PREVIEW or SETTINGS
Location: EncodingType.java:229
Static Methods
register()
Create and register a new encoding type.
public static EncodingType register(
String name,
boolean internal,
EncoderLevelReaderConstructor<?> reader,
EncoderLevelWriterConstructor<?> writer,
Collection<Version> supportedVersions
)
The display name of the encoding type
Whether this should be hidden from users
reader
EncoderLevelReaderConstructor<?>
Reader constructor, or null if not readable
writer
EncoderLevelWriterConstructor<?>
Writer constructor, or null if not writable
supportedVersions
Collection<Version>
required
List of supported versions
EncodingType.java:106
findReader()
Automatically detect the format of a world directory and create an appropriate reader.
public static Optional<? extends LevelReader> findReader(
File directory,
Converter converter
)
The input directory to analyze
The converter instance to use
Optional<LevelReader>
Optional<? extends LevelReader>
A reader for the detected format, or empty if no format matches
EncodingType.java:136
getTypes()
Get all registered encoding types (including internal ones).
public static Set<EncodingType> getTypes()
EncodingType.java:157
getReadableTypes()
Get all encoding types that support reading.
public static Set<EncodingType> getReadableTypes()
EncodingType.java:167
getWriteableTypes()
Get all encoding types that support writing.
public static Set<EncodingType> getWriteableTypes()
EncodingType.java:177
Usage Examples
Auto-detect and Convert
import com.hivemc.chunker.conversion.encoding.EncodingType;
import com.hivemc.chunker.conversion.encoding.base.Version;
import java.io.File;
// Auto-detect the input format
File inputDir = new File("path/to/world");
LevelReader reader = EncodingType.findReader(inputDir, converter)
.orElseThrow(() -> new IllegalArgumentException("Unknown world format"));
System.out.println("Detected format: " + reader.getEncodingType().getName());
import com.hivemc.chunker.conversion.encoding.EncodingType;
import com.hivemc.chunker.conversion.encoding.base.Version;
// Create a Bedrock 1.20.0 writer
File outputDir = new File("path/to/output");
Version targetVersion = new Version(1, 20, 0);
LevelWriter writer = EncodingType.BEDROCK
.createWriter(outputDir, targetVersion, converter)
.orElseThrow(() -> new IllegalArgumentException("Version not supported"));
List Supported Versions
import com.hivemc.chunker.conversion.encoding.EncodingType;
// List all supported Java versions
System.out.println("Java Edition versions:");
for (Version version : EncodingType.JAVA.getSupportedVersions()) {
System.out.println(" " + version);
}
// List all supported Bedrock versions
System.out.println("\nBedrock Edition versions:");
for (Version version : EncodingType.BEDROCK.getSupportedVersions()) {
System.out.println(" " + version);
}
import com.hivemc.chunker.conversion.encoding.EncodingType;
// List all non-internal formats
System.out.println("Available formats:");
for (EncodingType type : EncodingType.getTypes()) {
if (!type.isInternal()) {
System.out.println(" " + type.getName() +
" (Read: " + EncodingType.getReadableTypes().contains(type) +
", Write: " + EncodingType.getWriteableTypes().contains(type) + ")");
}
}
Version
Represents a Minecraft version in major.minor.patch format.
public class Version {
public Version(int major, int minor, int patch)
public static Version fromString(String input)
public int getMajor()
public int getMinor()
public int getPatch()
public boolean isGreaterThan(Version version)
public boolean isGreaterThanOrEqual(Version version)
}
cli/src/main/java/com/hivemc/chunker/conversion/encoding/base/Version.java:11
See Also