mcserver-cli 4.4.0__tar.gz → 4.5.0__tar.gz

{mcserver_cli-4.4.0 → mcserver_cli-4.5.0}/CHANGELOG.md

@@ -5,12 +5,23 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
 
-## [4.4.0] - 2026-11-04
+## [4.5.0] - 2026-11-04
 
 ### Added
 
-- `op remove` to remove players based on UUIDs or names
+- `whitelist add` and `op add` command (limited to 10 players at once for online mode for name)
+
+### Changed
+
+- `op remove` and `whitelist remove` to name is now case insensitive
+
+## [4.4.0] - 2026-11-03
+
+### Added
+
+- `op revoke` to revoke operator players permission  based on UUIDs or names
 - Player count to `whitelist list`
 
 ### Fixes
@@ -247,7 +258,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Better mod conflict error
 - Faster mod resolving
 
-[unreleased]: https://github.com/Othecat35/MCServer/compare/v4.4.0...HEAD
+[unreleased]: https://github.com/Othecat35/MCServer/compare/v4.5.0...HEAD
+[4.4.0]: https://github.com/Othecat35/MCServer/compare/v4.4.0...v4.5.0
 [4.4.0]: https://github.com/Othecat35/MCServer/compare/v4.3.0...v4.4.0
 [4.3.0]: https://github.com/Othecat35/MCServer/compare/v4.2.0...v4.3.0
 [4.2.0]: https://github.com/Othecat35/MCServer/compare/v4.1.0...v4.2.0

{mcserver_cli-4.4.0 → mcserver_cli-4.5.0}/NOTES.txt

@@ -391,4 +391,6 @@ and yea
 
 
 Ah yes... rcon, and also swrver management protocol.
-Don't forget to add a warning fof whitelist remove if the server is running to run whitelist remove
+Don't forget to add a warning fof whitelist remove if the server is running to run whitelist remover
+
+about whitelist add or op grant, remember to make the internal function does remove and add together, then call it upsert according to deepseek

{mcserver_cli-4.4.0 → mcserver_cli-4.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: mcserver-cli
-Version: 4.4.0
+Version: 4.5.0
 Summary: A CLI tool to manage Minecraft: Java Edition servers.
 Project-URL: Homepage, https://github.com/Othecat35/MCServer
 Project-URL: Repository, https://github.com/Othecat35/MCServer.git
@@ -25,7 +25,7 @@ Supported platforms:
 - JRE (depends on Minecraft version)
 
 ## How to install
-- Using pip: Run `pip install mcserver-cli`
+- Using pip: Just run `pip install mcserver-cli`
 
 - System-wide (Requires root): 
 1. Download the `mcserver` script file from GitHub releases
@@ -52,13 +52,13 @@ Supported platforms:
 - Remove whitelisted players: `mcserver whitelist remove <players>`
 
 ### Examples
-- Create and start a Fabric 1.20.1 server on current directory
+- Create and start a Fabric 1.20.1 server in the current directory
 ```bash
 mcserver init --game-version=1.20.1 --loader=fabric
 mcserver start
 ```
 
-- Search top 50 Fabric mods for Minecraft 1.20.1 in modrinth
+- Search top 50 Fabric mods for Minecraft 1.20.1 on modrinth
 ```bash
 mcserver search --loader=fabric --game-version=1.20.1 --limit=50
 ```
@@ -69,7 +69,22 @@ mcserver op list
 mcserver whitelist list
 ```
 
-- Stop a server on current directory with sigterm
+- Adding a player to the whitelist
+```bash
+mcserver whitelist add Notch
+```
+
+- Granting Notch operator level 4 and can bypass player limit
+```bash
+mcserver op grant Notch --permission-level=4 --bypasses-player-limit
+```
+
+- Remove me from the whitelist
+```bash
+mcserver whitelist remove Othecat35
+```
+
+- Stop a running server on current directory with sigterm
 ```bash
 mcserver stop
 ```

{mcserver_cli-4.4.0 → mcserver_cli-4.5.0}/README.md

@@ -12,7 +12,7 @@ Supported platforms:
 - JRE (depends on Minecraft version)
 
 ## How to install
-- Using pip: Run `pip install mcserver-cli`
+- Using pip: Just run `pip install mcserver-cli`
 
 - System-wide (Requires root): 
 1. Download the `mcserver` script file from GitHub releases
@@ -39,13 +39,13 @@ Supported platforms:
 - Remove whitelisted players: `mcserver whitelist remove <players>`
 
 ### Examples
-- Create and start a Fabric 1.20.1 server on current directory
+- Create and start a Fabric 1.20.1 server in the current directory
 ```bash
 mcserver init --game-version=1.20.1 --loader=fabric
 mcserver start
 ```
 
-- Search top 50 Fabric mods for Minecraft 1.20.1 in modrinth
+- Search top 50 Fabric mods for Minecraft 1.20.1 on modrinth
 ```bash
 mcserver search --loader=fabric --game-version=1.20.1 --limit=50
 ```
@@ -56,7 +56,22 @@ mcserver op list
 mcserver whitelist list
 ```
 
-- Stop a server on current directory with sigterm
+- Adding a player to the whitelist
+```bash
+mcserver whitelist add Notch
+```
+
+- Granting Notch operator level 4 and can bypass player limit
+```bash
+mcserver op grant Notch --permission-level=4 --bypasses-player-limit
+```
+
+- Remove me from the whitelist
+```bash
+mcserver whitelist remove Othecat35
+```
+
+- Stop a running server on current directory with sigterm
 ```bash
 mcserver stop
 ```

mcserver_cli-4.5.0/src/mcserver/__init__.py

@@ -0,0 +1 @@
+__version__ = "4.5.0"

{mcserver_cli-4.4.0 → mcserver_cli-4.5.0}/src/mcserver/cli.py

@@ -216,7 +216,40 @@ def main() -> int:
     op_command.set_defaults(parser=op_command)
     op_subcommands = op_command.add_subparsers(title="Subcommands")
 
-    # op_grant and op_revoke is not going to be implemented in this version
+    # 'op grant'
+    op_grant_command = op_subcommands.add_parser(
+        "grant",
+        help="Grant player operator permission",
+        description="Add players to the whitelist.",
+    )
+
+    op_grant_command.set_defaults(command_name="op_grant")
+    op_grant_command.add_argument(
+        "players", nargs="+", type=str, help="List of player names or UUIDs"
+    )
+
+    op_grant_command.add_argument(
+        "--bypasses-player-limit",
+        action="store_true",
+        help="Player can bypass player limit",
+    )
+
+    op_grant_command.add_argument(
+        "--online-mode",
+        type=str,
+        choices=["true","false"],
+        metavar="Boolean",
+        help="The server's online mode (true/false)",
+    )
+
+    op_grant_command.add_argument(
+        "--permission-level",
+        type=int,
+        choices=[1, 2, 3, 4],
+        metavar="Level",
+        help="The perator permission level",
+    )
+
     # 'op list'
     op_list_command = op_subcommands.add_parser(
         "list", help="List operator players", description="List all operator players."
@@ -334,7 +367,26 @@ def main() -> int:
     whitelist_command.set_defaults(parser=whitelist_command)
     whitelist_subcommands = whitelist_command.add_subparsers(title="Subcommands")
 
-    # whitelist_add and whitelist_remove is not going to be implemented in this version
+    # 'whitelist add'
+    whitelist_add_command = whitelist_subcommands.add_parser(
+        "add",
+        help="Add players to the whitelist",
+        description="Add players to the whitelist.",
+    )
+
+    whitelist_add_command.set_defaults(command_name="whitelist_add")
+    whitelist_add_command.add_argument(
+        "players", nargs="+", type=str, help="List of player names or UUIDs"
+    )
+
+    whitelist_add_command.add_argument(
+        "--online-mode",
+        type=str,
+        choices=["true","false"],
+        metavar="Boolean",
+        help="The server's online mode (true/false)",
+    )
+
     # 'whitelist list'
     whitelist_list_command = whitelist_subcommands.add_parser(
         "list",

mcserver_cli-4.5.0/src/mcserver/commands/op_grant.py

@@ -0,0 +1,103 @@
+import logging
+from argparse import Namespace
+from uuid import UUID
+
+from ..minecraft.player_identity import separate_uuids_and_names
+from ..server_files.ops import OperatorPlayer
+
+logger = logging.getLogger(__name__)
+
+
+def run(args: Namespace) -> int:
+    player_ids: list[str] = args.players
+    online_mode: str | None = args.online_mode
+    permission_level: int | None = args.permission_level
+    bypasses_player_limit: bool = args.bypasses_player_limit
+
+    # UUID vs name seperator
+    player_uuids, player_names = separate_uuids_and_names(player_ids)
+    uuids: set[UUID] = set(player_uuids)
+    names: set[str] = set(player_names)
+
+    player_uuids: list[UUID] = list(uuids)
+    player_names: list[str] = list(names)
+
+    is_online_mode: bool = True
+    if online_mode is None:
+        from ..server_files import server_properties
+        is_online_mode = server_properties.get_online_mode()
+    else:
+        is_online_mode = online_mode != "false"
+    
+    if permission_level is None:
+        from ..server_files import server_properties
+        permission_level = server_properties.get_operator_permission_level()
+
+    operator_players: list[OperatorPlayer] = []
+    if is_online_mode:
+        from ..minecraft import api as minecraft_api
+        for player_uuid in player_uuids:
+            player_profile = minecraft_api.get_player_from_uuid(player_uuid)
+            operator_player: OperatorPlayer = {
+                "player_uuid": player_profile["player_uuid"],
+                "player_name": player_profile["player_name"],
+                "permission_level": permission_level,
+                "bypasses_player_limit": bypasses_player_limit
+            }
+
+            operator_players.append(operator_player)
+        if len(player_names) > 10:
+            logger.error("Cannot add more than 10 players by name at once.")
+            return 1
+
+        player_profiles = minecraft_api.get_players_from_names(player_names)
+        for player_profile in player_profiles:
+            operator_player: OperatorPlayer = {
+                "player_uuid": player_profile["player_uuid"],
+                "player_name": player_profile["player_name"],
+                "permission_level": permission_level,
+                "bypasses_player_limit": bypasses_player_limit
+            }
+
+            operator_players.append(operator_player)
+    else:
+        for player_uuid in uuids:
+            logger.error(f"Cannot add by UUID in offline mode: {player_uuid}, use name instead.")
+            return 1
+
+        from ..minecraft.player_identity import get_offline_player_identities
+        player_profiles = get_offline_player_identities(player_names)
+        for player_profile in player_profiles:
+            operator_player: OperatorPlayer = {
+                "player_uuid": player_profile["player_uuid"],
+                "player_name": player_profile["player_name"],
+                "permission_level": permission_level,
+                "bypasses_player_limit": bypasses_player_limit
+            }
+
+            operator_players.append(operator_player)
+
+    from ..server_files import ops
+    ops.upsert_players(operator_players)
+    
+    from ..shared import pluralize
+    player_count: int = len(operator_players)
+    if player_count == 0:
+        logger.info("There are no player to be granted operator.")
+        return 0
+
+    player_list: list[str] = []
+    for player in operator_players:
+        player_list.append(f"{player['player_name']} ({player['player_uuid']})")
+
+    info_message = f"Granted {player_count} {pluralize('player', player_count)} operator with permission level {permission_level}"
+
+    if bypasses_player_limit:
+        info_message += " and can bypass player limit"
+
+    info_message += ":"
+    logger.info(info_message)
+
+    player_list.sort()
+    print("\n".join(player_list))
+    return 0

{mcserver_cli-4.4.0 → mcserver_cli-4.5.0}/src/mcserver/commands/op_revoke.py

@@ -1,7 +1,7 @@
 import logging
 from argparse import Namespace
-from uuid import UUID
 
+from ..minecraft.player_identity import separate_uuids_and_names
 from ..server_files import ops
 from ..shared import pluralize
 
@@ -9,18 +9,9 @@ logger = logging.getLogger(__name__)
 
 
 def run(args: Namespace) -> int:
-    player_identifiers: list[str] = args.players
-
-    player_uuids: list[UUID] = []
-    player_names: list[str] = []
-    for player in player_identifiers:
-        if len(player) > 16:
-            logger.debug(f"{player} is probably an UUID")
-            player_uuids.append(UUID(player))
-        else:
-            logger.debug(f"{player} is probably a name")
-            player_names.append(player)
+    player_ids: list[str] = args.players
 
+    player_uuids, player_names = separate_uuids_and_names(player_ids)
     removed_players = ops.remove_players(player_uuids, player_names)
 
     player_count: int = len(removed_players)

{mcserver_cli-4.4.0 → mcserver_cli-4.5.0}/src/mcserver/commands/search_projects.py

@@ -7,6 +7,7 @@ from mcserver import paths
 from .. import config
 from ..modrinth import apis as modrinth_apis
 from ..modrinth.shared import SearchSortIndex
+from ..modrinth.typings import Environment
 from ..shared import (
     default_configs,
     format_number,
@@ -98,7 +99,10 @@ def run(args: Namespace) -> int:
         logger.error("Vanilla does not support mods or plugin.")
         return 1
 
-    project_label, _ = get_loader_context(loader_name)
+    if loader_name is not None:
+        project_label, _ = get_loader_context(loader_name)
+    else:
+        project_label = "project"
 
     search_offset = search_limit * (page_number - 1)
     search_facets = [
@@ -158,13 +162,13 @@ def run(args: Namespace) -> int:
         project_author = f"by {hit['author_username']}"
 
         environments: list[Environment] = hit["environments"]
-        if len(environments) == 0:
-            environments.append("No environment")
-
         readable_environments: list[str] = []
         for environment in environments:
             readable_environments.append(project_environment_name(environment))
 
+        if len(readable_environments) == 0:
+            readable_environments.append("No environment")
+
         print(f"{hit['project_name']} ({slug_or_id}) {project_author}")
         print(
             f"> Downloads: {format_number(hit['download_count'])} | Follows: {format_number(hit['follower_count'])}"

mcserver_cli-4.5.0/src/mcserver/commands/whitelist_add.py

@@ -0,0 +1,81 @@
+import logging
+from argparse import Namespace
+from uuid import UUID
+
+from ..minecraft.player_identity import separate_uuids_and_names
+from ..server_files.whitelist import WhitelistedPlayer
+
+logger = logging.getLogger(__name__)
+
+
+def run(args: Namespace) -> int:
+    player_ids: list[str] = args.players
+    online_mode: str | None = args.online_mode
+
+    # UUID vs name seperator
+    player_uuids, player_names = separate_uuids_and_names(player_ids)
+    uuids: set[UUID] = set(player_uuids)
+    names: set[str] = set(player_names)
+
+    player_uuids: list[UUID] = list(uuids)
+    player_names: list[str] = list(names)
+
+    is_online_mode: bool = True
+    if online_mode is None:
+        from ..server_files import server_properties
+        is_online_mode = server_properties.get_online_mode()
+    else:
+        is_online_mode = online_mode != "false"
+
+    whitelisted_players: list[WhitelistedPlayer] = []
+    if is_online_mode:
+        from ..minecraft import api as minecraft_api
+        for player_uuid in player_uuids:
+            player_profile = minecraft_api.get_player_from_uuid(player_uuid)
+            whitelisted_player: WhitelistedPlayer = {
+                "player_uuid": player_profile["player_uuid"],
+                "player_name": player_profile["player_name"]
+            }
+
+            whitelisted_players.append(whitelisted_player)
+        if len(player_names) > 10:
+            logger.error("Cannot add more than 10 players by name at once.")
+            return 1
+
+        player_profiles = minecraft_api.get_players_from_names(player_names)
+        for player_profile in player_profiles:
+            whitelisted_player: WhitelistedPlayer = {
+                "player_uuid": player_profile["player_uuid"],
+                "player_name": player_profile["player_name"]
+            }
+
+            whitelisted_players.append(whitelisted_player)
+    else:
+        for player_uuid in uuids:
+            logger.error(f"Cannot add by UUID in offline mode: {player_uuid}, use name instead.")
+            return 1
+
+        from ..minecraft.player_identity import get_offline_player_identities
+        whitelisted_players = get_offline_player_identities(player_names)
+
+    from ..server_files import whitelist
+    whitelist.upsert_players(whitelisted_players)
+    
+    from ..shared import pluralize
+    player_count: int = len(whitelisted_players)
+    if player_count == 0:
+        logger.info("There are no whitelisted player.")
+        return 0
+
+    player_list: list[str] = []
+    for player in whitelisted_players:
+        player_list.append(f"{player['player_name']} ({player['player_uuid']})")
+
+    logger.info(
+        f"Added {player_count} {pluralize('player', player_count)} to the whitelist:"
+    )
+
+    player_list.sort()
+    print("\n".join(player_list))
+
+    return 0

{mcserver_cli-4.4.0 → mcserver_cli-4.5.0}/src/mcserver/commands/whitelist_remove.py

@@ -1,7 +1,7 @@
 import logging
 from argparse import Namespace
-from uuid import UUID
 
+from ..minecraft.player_identity import separate_uuids_and_names
 from ..server_files import whitelist
 from ..shared import pluralize
 
@@ -9,18 +9,9 @@ logger = logging.getLogger(__name__)
 
 
 def run(args: Namespace) -> int:
-    player_identifiers: list[str] = args.players
-
-    player_uuids: list[UUID] = []
-    player_names: list[str] = []
-    for player in player_identifiers:
-        if len(player) > 16:
-            logger.debug(f"{player} is probably an UUID")
-            player_uuids.append(UUID(player))
-        else:
-            logger.debug(f"{player} is probably a name")
-            player_names.append(player)
+    player_ids: list[str] = args.players
 
+    player_uuids, player_names = separate_uuids_and_names(player_ids)
     removed_players = whitelist.remove_players(player_uuids, player_names)
 
     player_count: int = len(removed_players)

mcserver_cli-4.5.0/src/mcserver/minecraft/api.py

@@ -0,0 +1,112 @@
+# Modules
+# Standard
+import json
+from typing import NotRequired
+from uuid import UUID
+
+from .. import networking
+from ..constants import minecraft_api_url
+from .player_identity import PlayerIdentity
+
+
+class GetPlayerError(Exception):
+    pass
+
+
+# TypedDict
+class PlayerProfile(PlayerIdentity):
+    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}"
+    )
+
+    if "json" not in response:
+        raise GetPlayerError("Response does not have JSON")
+
+    response_json = response["json"]
+    if not isinstance(response_json, dict):
+        raise TypeError("Response JSON is not a dictionary")
+
+    player_profile: PlayerProfile = {
+        "player_uuid": UUID(response_json["id"]),
+        "player_name": response_json["name"],
+    }
+
+    if "legacy" in response_json:
+        player_profile["is_legacy"] = response_json["legacy"]
+
+    if "demo" in response_json:
+        player_profile["is_demo"] = response_json["demo"]
+
+    return player_profile
+
+
+def get_players_from_names(player_names: list[str] | str) -> list[PlayerProfile]:
+    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",
+    )
+
+    if "json" not in response:
+        raise GetPlayerError("Response does not have JSON")
+
+    response_json = response["json"]
+    if not isinstance(response_json, list):
+        raise TypeError("Response JSON is not a list")
+
+    player_identities: list[PlayerProfile] = []
+    for player in response_json:
+        player_profile: PlayerProfile = {
+            "player_uuid": UUID(player["id"]),
+            "player_name": player["name"],
+        }
+
+        if "legacy" in player:
+            player_profile["is_legacy"] = player["legacy"]
+
+        if "demo" in player:
+            player_profile["is_demo"] = player["demo"]
+
+        player_identities.append(player_profile)
+
+    return player_identities
+
+
+def get_player_from_uuid(player_uuid: UUID) -> PlayerProfile:
+    response = networking.request(
+        f"{minecraft_api_url}/minecraft/profile/lookup/{player_uuid}"
+    )
+
+    if "json" not in response:
+        raise GetPlayerError("Response does not have JSON")
+
+    response_json = response["json"]
+    if not isinstance(response_json, dict):
+        raise TypeError("Response JSON is not a dictionary")
+
+    player_profile: PlayerProfile = {
+        "player_uuid": UUID(response_json["id"]),
+        "player_name": response_json["name"],
+    }
+
+    if "legacy" in response_json:
+        player_profile["is_legacy"] = response_json["legacy"]
+
+    if "demo" in response_json:
+        player_profile["is_demo"] = response_json["demo"]
+
+    return player_profile

mcserver_cli-4.5.0/src/mcserver/minecraft/player_identity.py

@@ -0,0 +1,41 @@
+# Modules
+import hashlib
+import logging
+from typing import TypedDict
+from uuid import UUID
+
+logger = logging.getLogger(__name__)
+
+# TypedDicts
+class PlayerIdentity(TypedDict):
+    player_uuid: UUID
+    player_name: str
+
+
+def separate_uuids_and_names(player_ids: list[str]) -> tuple[list[UUID], list[str]]:
+    player_uuids: list[UUID] = []
+    player_names: list[str] = []
+    for player_id in player_ids:
+        try:
+            player_uuids.append(UUID(player_id))
+        except ValueError:
+            player_names.append(player_id)
+
+    return (player_uuids, player_names)
+
+def get_offline_player_identities(
+    player_names: list[str] | str,
+) -> list[PlayerIdentity]:
+    player_identities: list[PlayerIdentity] = []
+    for player_name in player_names:
+        offline_player = f"OfflinePlayer:{player_name}".encode()
+        player_uuid: UUID = UUID(hashlib.md5(offline_player).hexdigest())
+        logger.debug(f"Offline UUID for '{player_name}' is '{player_uuid}'")
+        player_identity: PlayerIdentity = {
+            "player_uuid": player_uuid,
+            "player_name": player_name,
+        }
+
+        player_identities.append(player_identity)
+
+    return player_identities

{mcserver_cli-4.4.0 → mcserver_cli-4.5.0}/src/mcserver/modrinth/apis/get_project_informations.py

@@ -163,7 +163,7 @@ def get_project_informations(project_ids: list[str] | str) -> list[ProjectInform
                 and requested_project_status not in shared.REQUESTED_PROJECT_STATUS
             ):
                 logger.warning(
-                    f"Unknown requested_project_status status: {monetization_status}"
+                    f"Unknown requested_project_status: {requested_project_status}"
                 )
 
             project_information["requested_project_status"] = requested_project_status

{mcserver_cli-4.4.0 → mcserver_cli-4.5.0}/src/mcserver/modrinth/apis/search_projects.py

@@ -1,14 +1,13 @@
 import json
 import logging
 
-from mcserver.modrinth.typings.search_projects import DisclosureType
-
 from ... import networking
 from ...constants import modrinth_api_url
 from .. import shared
 from ..shared import SearchSortIndex
 from ..typings import (
     AllProjectType,
+    DisclosureType,
     Environment,
     EnvironmentSide,
     ProjectType,