itzg-docker-minecraft-server

Namespace

itzg-docker-minecraft-server

Description:

  • Experience seamless Minecraft server management with our Docker solution! Easily deploy, customize, and scale your servers with robust support for different versions, mods, and plugins. Perfect for dedicated gamers and server admins alike!

Author:
Copyright:
  • 2025 Eyevinn Technology AB

Methods

(async, static) createItzgDockerMinecraftServerInstance(context, body) → {ItzgDockerMinecraftServer}

Description:

  • Create a new Minecraft Server instance

Example
import { Context } from '@osaas/client-core';
import { createItzgDockerMinecraftServerInstance } from '@osaas/client-services';

const ctx = new Context();
const body: ItzgDockerMinecraftServerConfig = { name: 'myinstance', ... };
const instance = await createItzgDockerMinecraftServerInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
body ItzgDockerMinecraftServerConfig

Service instance configuration
Returns:
  • Service instance
Type
ItzgDockerMinecraftServer

(async, static) getItzgDockerMinecraftServerInstance(context, name) → {ItzgDockerMinecraftServer}

Description:

  • Get a Minecraft Server instance

Example
import { Context } from '@osaas/client-core';
import { getItzgDockerMinecraftServerInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getItzgDockerMinecraftServerInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the minecraft-server to be retrieved
Returns:
  • Service instance
Type
ItzgDockerMinecraftServer

(async, static) removeItzgDockerMinecraftServerInstance(context, name)

Description:

  • Remove a Minecraft Server instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the minecraft-server to be removed