mcserver-cli 3.0.0__py3-none-any.whl

mcserver/config.py

@@ -0,0 +1,37 @@
+# Modules
+# Standard
+import json
+from typing import Any
+
+# MCServer
+from .shared import mcserver_dir, merge_dict
+
+# Paths
+configs_dir = mcserver_dir / "configs"
+
+
+# Functions
+def generate_config(config_name: str, config_data: dict[str, Any]) -> None:
+    config_filename = f"{config_name}.json"
+    config_path = configs_dir / config_filename
+
+    with open(config_path, mode="xt") as config_file:
+        json.dump(config_data, config_file, indent=2)
+
+
+def load_config(config_name: str) -> dict[str, Any]:
+    config_filename = f"{config_name}.json"
+    config_path = configs_dir / config_filename
+
+    with open(config_path, mode="rt") as config_file:
+        return json.load(config_file)
+
+
+def update_config(config_name: str, new_data: dict[str, Any]) -> None:
+    config_filename = f"{config_name}.json"
+    config_path = configs_dir / config_filename
+
+    with open(config_path, mode="r+") as file:
+        config_data = json.load(file)
+        merge_dict(config_data, new_data)
+        json.dump(config_data, file, indent=2)

mcserver/constants.py

@@ -0,0 +1,14 @@
+__version__: str = "2.0.0"
+
+mojang_manifest_url: str = "https://launchermeta.mojang.com"
+
+minecraft_api_url: str = "https://api.minecraftservices.com"
+modrinth_api_url: str = "https://api.modrinth.com"
+papermc_api_url: str = "https://fill.papermc.io"
+purpurmc_api_url: str = "https://api.purpurmc.org"
+
+fabricmc_meta_url: str = "https://meta.fabricmc.net"
+quiltmc_meta_url: str = "https://meta.quiltmc.org"
+
+si_prefixes: list = ["", "K", "M", "B", "T"]
+iec_prefixes: list = ["B", "KiB", "MiB", "GiB", "TiB"]

mcserver/fabricmc/meta.py

@@ -0,0 +1,41 @@
+# Modules
+# Standard
+import json
+from typing import TypedDict
+
+# MCServer
+from .. import networking
+from ..constants import fabricmc_meta_url
+
+
+# TypedDict
+class LoaderVersion(TypedDict):
+    separator: str
+    build_id: int
+    maven_id: str
+    loader_version: str
+    is_stable: bool
+
+
+# Functions
+def get_loader_versions() -> list[LoaderVersion]:
+    response = networking.request(f"{fabricmc_meta_url}/v2/versions/loader")
+    response_json = json.loads(response["text"])
+
+    loader_versions: list[LoaderVersion] = []
+    for version in response_json:
+        loader_version: LoaderVersion = {
+            "separator": version["separator"],
+            "build_id": version["build"],
+            "maven_id": version["maven"],
+            "loader_version": version["version"],
+            "is_stable": version["stable"],
+        }
+
+        loader_versions.append(loader_version)
+
+    return loader_versions
+
+
+def download_url(game_version: str, loader_version: str, installer_version) -> str:
+    return f"{fabricmc_meta_url}/v2/versions/loader/{loader_version}/{game_version}/{installer_version}/server/jar"

mcserver/legacyfabric/meta.py

@@ -0,0 +1,37 @@
+# Modules
+# Standard
+import json
+from typing import TypedDict
+
+# MCServer
+from .. import networking
+from ..constants import fabricmc_meta_url
+
+
+# TypedDict
+class LoaderVersion(TypedDict):
+    separator: str
+    build_id: int
+    maven_id: str
+    loader_version: str
+    is_stable: bool
+
+
+# Functions
+def get_loader_versions() -> list[LoaderVersion]:
+    response = networking.request(f"{fabricmc_meta_url}/v2/versions/loader")
+    response_json = json.loads(response["text"])
+
+    loader_versions: list[LoaderVersion] = []
+    for version in response_json:
+        loader_version: LoaderVersion = {
+            "separator": version["separator"],
+            "build_id": version["build"],
+            "maven_id": version["maven"],
+            "loader_version": version["version"],
+            "is_stable": version["stable"],
+        }
+
+        loader_versions.append(loader_version)
+
+    return loader_versions

mcserver/metadata.py

@@ -0,0 +1,33 @@
+# Modules
+# Standard
+import json
+from typing import TypedDict
+
+# MCServer
+from .shared import mcserver_dir
+
+
+class MCServerMetadata(TypedDict):
+    version: tuple[int, int, int]
+
+
+class Metadata(TypedDict):
+    mcserver: MCServerMetadata
+
+
+# Paths
+metadata_file = mcserver_dir / "metadata.json"
+
+
+# Functions
+def set_metadata(mcserver_version: tuple[int, int, int]) -> None:
+    metadata: Metadata = {"mcserver": {"version": mcserver_version}}
+
+    metadata_data: str = json.dumps(metadata)
+    metadata_file.write_text(metadata_data)
+
+
+def get_metadata() -> Metadata:
+    metadata_data = metadata_file.read_text()
+    metadata: Metadata = json.loads(metadata_data)
+    return metadata

mcserver/minecraft/api.py

@@ -0,0 +1,94 @@
+# Modules
+# Standard
+import json
+from typing import NotRequired, TypedDict
+
+from .. import networking
+from ..constants import minecraft_api_url
+
+# MCSe.rver
+from .player_identity import PlayerUUID, normalize_player_uuid
+
+
+# TypedDict
+class PlayerIdentity(TypedDict):
+    player_uuid: PlayerUUID
+    player_name: str
+    is_legacy: NotRequired[bool]
+    is_demo: NotRequired[bool]
+
+
+# Functions
+def get_player_from_name(player_name: str) -> PlayerIdentity:
+    response = networking.request(
+        f"{minecraft_api_url}/minecraft/profile/lookup/name/{player_name}"
+    )
+    response_json = json.loads(response["text"])
+
+    player_identity: PlayerIdentity = {
+        "player_uuid": normalize_player_uuid(response_json["id"]),
+        "player_name": response_json["name"],
+    }
+
+    if "legacy" in response_json:
+        player_identity["is_legacy"] = response_json["legacy"]
+
+    if "demo" in response_json:
+        player_identity["is_demo"] = response_json["demo"]
+
+    return player_identity
+
+
+def get_players_from_names(player_names: list[str] | str) -> list[PlayerIdentity]:
+    if isinstance(player_names, str):
+        player_names = [player_names]
+
+    if len(player_names) > 10:
+        raise ValueError("Cannot query more than 10 player names at once")
+
+    data_payload = json.dumps(player_names).encode("utf-8")
+    response = networking.request(
+        f"{minecraft_api_url}/minecraft/profile/lookup/bulk/byname",
+        data=data_payload,
+        headers={"Content-Type": "application/json"},
+        method="POST",
+    )
+
+    response_json = json.loads(response["text"])
+
+    player_identities: list[PlayerIdentity] = []
+    for player in response_json:
+        player_identity: PlayerIdentity = {
+            "player_uuid": normalize_player_uuid(player["id"]),
+            "player_name": player["name"],
+        }
+
+        if "legacy" in player:
+            player_identity["is_legacy"] = player["legacy"]
+
+        if "demo" in player:
+            player_identity["is_demo"] = player["demo"]
+
+        player_identities.append(player_identity)
+
+    return player_identities
+
+
+def get_player_from_uuid(player_uuid: PlayerUUID) -> PlayerIdentity:
+    response = networking.request(
+        f"{minecraft_api_url}/minecraft/profile/lookup/{player_uuid}"
+    )
+    response_json = json.loads(response["text"])
+
+    player_identity: PlayerIdentity = {
+        "player_uuid": normalize_player_uuid(response_json["id"]),
+        "player_name": response_json["name"],
+    }
+
+    if "legacy" in response_json:
+        player_identity["is_legacy"] = response_json["legacy"]
+
+    if "demo" in response_json:
+        player_identity["is_demo"] = response_json["demo"]
+
+    return player_identity

mcserver/minecraft/player_identity.py

@@ -0,0 +1,21 @@
+# Modules
+from typing import NotRequired, TypedDict
+from uuid import UUID
+
+# Type Aliases
+type PlayerUUID = UUID | str
+
+
+# TypedDicts
+class PlayerID(TypedDict):
+    # Used for providing either player UUID and/or name
+    player_uuid: NotRequired[PlayerUUID]
+    player_name: NotRequired[str]
+
+
+# Functions
+def normalize_player_uuid(player_uuid: PlayerUUID) -> UUID:
+    if isinstance(player_uuid, str):
+        player_uuid = UUID(player_uuid)
+
+    return player_uuid