@kodamc/protocol/src/options.js

Minecraft Bedrock Edition protocol library

const mcData = require("minecraft-data");

// Minimum supported version (< will be kicked)
const MIN_VERSION = "1.16.201";
// Currently supported verson. Note, clients with newer versions can still connect as long as data is in minecraft-data
const CURRENT_VERSION = "1.19.70";

const Versions = Object.fromEntries(
  mcData.versions.bedrock
    .filter((e) => e.releaseType === "release")
    .map((e) => [e.minecraftVersion, e.version])
);

// Skip some low priority versions (middle major) on Github Actions to allow faster CI
const skippedVersionsOnGithubCI = [
  "1.16.210",
  "1.17.10",
  "1.17.30",
  "1.18.11",
  "1.19.10",
  "1.19.20",
  "1.19.30",
  "1.19.40",
  "1.19.50",
];
const testedVersions = process.env.CI
  ? Object.keys(Versions).filter((v) => !skippedVersionsOnGithubCI.includes(v))
  : Object.keys(Versions);

const defaultOptions = {
  // https://minecraft.gamepedia.com/Protocol_version#Bedrock_Edition_2
  version: CURRENT_VERSION,
  // client: If we should send SetPlayerInitialized to the server after getting play_status spawn.
  // if this is disabled, no 'spawn' event will be emitted, you should manually set
  // client.status to ClientStatus.Initialized after sending the init packet.
  autoInitPlayer: true,
  // If true, do not authenticate with Xbox Live
  offline: false,
  // Milliseconds to wait before aborting connection attempt
  connectTimeout: 9000,
  // Specifies the raknet implementation to use
  raknetBackend: "raknet-native",
  // If using JS implementation of RakNet, should we use workers? (This only affects the client)
  useRaknetWorkers: true,

  // server: What compression algorithm to use by default, either `none`, `deflate` or `snappy`
  compressionAlgorithm: "deflate",
  // server and client: On Deflate, what compression level to use, between 1 and 9
  compressionLevel: 7,
  // server: If true, only compress if a payload is larger than compressionThreshold
  compressionThreshold: 512,
};

function validateOptions(options) {
  if (!Versions[options.version] && !Versions[options.maxVersion]) {
    console.warn("Supported versions", Versions);
    throw Error(`Unsupported version ${options.version}`);
  }

  options.protocolVersion = Versions[options.version];
  options.maxProtocolVersion = Versions[options.maxVersion];

  console.warn(options.protocolVersion, options.maxProtocolVersion);

  if (options.protocolVersion < MIN_VERSION) {
    throw new Error(
      `Protocol version < ${MIN_VERSION} : ${options.protocolVersion}, too old`
    );
  }
  if (options.maxProtocolVersion > CURRENT_VERSION) {
    throw new Error(
      `Protocol version < ${CURRENT_VERSION} : ${options.protocolVersion}, too old`
    );
  }
  if (options.useNativeRaknet === true) options.raknetBackend = "raknet-native";
  if (options.useNativeRaknet === false) options.raknetBackend = "jsp-raknet";
}

module.exports = {
  defaultOptions,
  MIN_VERSION,
  CURRENT_VERSION,
  Versions,
  validateOptions,
  testedVersions,
};