minecraft-bedrock-server/src/index.d.ts

minecraft bedrock server wrapper

import { ChildProcess } from "child_process"

declare module "minecraft-bedrock-server" {
  type LatestVersion = {
    version4: string,
    version3: string,
    url: string
  }
  function getLatestVersions(): Promise<{
    linux: LatestVersion,
    windows: LatestVersion,
    macos?: LatestVersion,
    preview: {
      linux: LatestVersion,
      windows: LatestVersion,
      macos?: LatestVersion
    }
  }>

  type GameMode = "survival" | "creative" | "adventure";
  type Difficulty = "peaceful" | "easy" | "normal" | "hard";
  type PermissionLevel = "visitor" | "member" | "operator";

  type ServerOptions = {
    "server-name"?: string; // Used as the server name
    "gamemode"?: GameMode; // Sets the game mode for new players
    "force-gamemode"?: boolean; // Prevents the server from sending to the client gamemode values other than the gamemode value saved by the server during world creation
    "difficulty"?: Difficulty; // Sets the difficulty of the world
    "allow-cheats"?: boolean; // If true then cheats like commands can be used
    "max-players"?: number; // The maximum number of players that can play on the server
    "online-mode"?: boolean; // If true then all connected players must be authenticated to Xbox Live
    "white-list"?: boolean; // If true then all connected players must be listed in the separate whitelist.json file
    "server-port"?: number; // Which IPv4 port the server should listen to
    "server-portv6"?: number; // Which IPv6 port the server should listen to
    "view-distance"?: number; // The maximum allowed view distance in number of chunks
    "tick-distance"?: number; // The world will be ticked this many chunks away from any player
    "player-idle-timeout"?: number; // After a player has idled for this many minutes they will be kicked
    "max-threads"?: number; // Maximum number of threads the server will try to use
    "level-name"?: string; // Name of the level
    "level-seed"?: string; // Use to randomize the world
    "default-player-permission-level"?: PermissionLevel; // Permission level for new players joining for the first time
    "texturepack-required"?: boolean; // Force clients to use texture packs in the current world
    "content-log-file-enabled"?: boolean; // Enables logging content errors to a file
    "compression-threshold"?: number; // Determines the smallest size of raw network payload to compress
    "server-authoritative-movement"?: "client-auth" | "server-auth" | "server-auth-with-rewind"; // Enables server authoritative movement
    "player-movement-score-threshold"?: number; // The number of incongruent time intervals needed before abnormal behavior is reported
    "player-movement-distance-threshold"?: number; // The difference between server and client positions that needs to be exceeded before abnormal behavior is detected
    "player-movement-duration-threshold-in-ms"?: number; // The duration of time the server and client positions can be out of sync before the abnormal movement score is incremented
    "correct-player-movement"?: boolean; // If true, the client position will get corrected to the server position if the movement score exceeds the threshold
    "server-authoritative-block-breaking"?: boolean; // If true, the server will compute block mining operations in sync with the client
  };
  type ServerOptionsEx = ServerOptions & {
    path?: string, // where to save the folder
    root?: string // where the path is relative to (eg dirname)
  }

  // Downloads the server for a specific platform
  function downloadServer(version: string, options: ServerOptionsEx & { platform: 'win32' | 'linux' }): Promise<{ path: string, version: string }>

  // Starts the server
  // Options is an array of server.properties options.
  // `options.path` is the path to where the server will be started.
  function startServer(version: string, onStart: () => void, options: ServerOptionsEx): Promise<ChildProcess>

  // Starts the server and waits
  function startServerAndWait(version: string, withTimeout: number, options: ServerOptionsEx): Promise<ChildProcess>

  // Starts the server and waits. On failure, reset state and try again once more.
  function startServerAndWait2(version: string, withTimeout: number, options: ServerOptionsEx): Promise<ChildProcess>

  interface BedrockVanillaServer {
    path: string
    version: string
    startAndWaitReady(withTimeout: number): Promise<ChildProcess>
    // Stops the server after sending /stop to safely save everything
    stop(): Promise<void>

    // Helpers
    addResourcePack(packPath: string, packName?: string): Promise<void>
    addBehaviorPack(packPath: string, packName?: string): Promise<void>
    addQuickScript({ name, manifest, files }: { name?: string, manifest: any, files: Record<string, string> }, eraseExisting?: boolean, enable?: boolean): Promise<void>
    clearBehaviorPacks(eraseDevelopmentPacks?: boolean): Promise<void>
    disableBehaviorPack(uuid: string): Promise<void>
    enableBehaviorPack(uuid: string, version: string): Promise<void>
    // Enables or disables experiments. If worldName is provided, it will only affect that world, otherwise it will affect all worlds.
    toggleExperiments(experiments: Record<string, bool>, worldName?: string): Promise<void>
  }

  // Wrapper for downloadServer, that then returns a new BedrockVanillaServer instance with helpers
  function prepare(version: string, options: ServerOptionsEx): Promise<BedrockVanillaServer>
}