mcserver-cli 3.0.0__py3-none-any.whl

mcserver/shared.py

@@ -0,0 +1,198 @@
+# Modules
+# Standard
+import sys
+from pathlib import Path
+
+# MCServer
+from .constants import iec_prefixes, si_prefixes
+
+# Variables
+mods_loader = ["fabric", "quilt"]
+plugins_loader = ["paper", "purpur"]
+loader_list = ["vanilla"] + mods_loader + plugins_loader
+
+loader_context = {"project_directory": None, "project_label": "project"}
+
+special_plural = {"is": "are", "this": "these"}
+
+color_output_mode = "auto"  # 'never', 'auto', 'always'
+ansi_codes = {
+    "gray": "\033[90m",
+    "green": "\033[92m",
+    "red": "\033[91m",
+    "yellow": "\033[93m",
+    "bold": "\033[1m",
+    "reset": "\033[0m",
+    "clear_line": "\033[K",
+    "cursor_up": "\033[A",
+    "start_line": "\033[G",
+}
+
+isatty = sys.stdout.isatty() and sys.stderr.isatty()
+last_status_message = ""
+
+default_configs = {
+    "launcher": {
+        "ram": {"_comment": "Memory size in MebiByte (MiB)", "min": 512, "max": 2_048},
+        "jarfile": "Server.jar",
+        "is_nogui": True,
+        "force_stop": 5,
+    },
+    "modrinth": {"search_limit": 20, "sort_by": "relevance"},
+    "server": {
+        "game_version": "",  # Auto-fetched the latest version when init without --mc-version
+        "loader": {"name": "vanilla", "version": None},
+    },
+}
+
+# Paths
+current_dir: Path = Path.cwd()
+mcserver_dir: Path = Path(".mcserver")
+tempfiles_dir: Path = mcserver_dir / "tempfiles"
+
+mods_dir: Path = Path("mods")
+plugins_dir: Path = Path("plugins")
+
+
+# Functions
+def pluralize(singular: str, count: int = 0, plural: str = ""):
+    if count != 1:
+        if plural:
+            return plural
+
+        if singular in special_plural:
+            return special_plural[singular]
+
+        if singular.endswith(("ch", "sh", "x", "s", "o")):
+            return f"{singular}es"
+        elif singular.endswith("y") and singular[-2] not in "aeiou":
+            return f"{singular[:-1]}ies"
+        else:
+            return f"{singular}s"
+
+    return singular
+
+
+def format_number(number: str | float, unit_type: str = "si"):
+    number = float(number)
+    unit_multiples = 0
+    prefixes = []
+
+    if unit_type == "si":
+        unit_multiples = 1_000
+        prefixes = si_prefixes
+    elif unit_type == "iec":
+        unit_multiples = 1_024
+        prefixes = iec_prefixes
+    else:
+        raise ValueError(f"'{unit_type}' is not a valid number unit type")
+
+    iteration = 0
+    while number >= unit_multiples:
+        if iteration >= len(prefixes) - 1:
+            break
+
+        number /= unit_multiples
+        iteration += 1
+
+    return f"{round(number, 2):g}{prefixes[iteration]}"
+
+
+def remap_keys(source: dict, mapping: dict[str, str]) -> dict:
+    remapped_source = {}
+    for target_key, source_key in mapping.items():
+        if source_key in source:
+            remapped_source[target_key] = source[source_key]
+
+    return remapped_source
+
+
+def merge_dict(base: dict, update: dict) -> dict:
+    for key, value in update.items():
+        if key in base and isinstance(base[key], dict) and isinstance(value, dict):
+            merge_dict(base[key], value)
+        else:
+            base[key] = value
+
+    return base
+
+
+def confirmation_prompt(prompt: str, default_option: bool = False) -> bool:
+    accepted_value = "y/n"
+    if default_option:
+        accepted_value = "Y/n"
+    else:
+        accepted_value = "y/N"
+
+    try:
+        answer = input(f"{prompt} [{accepted_value}]: ")
+    except KeyboardInterrupt:
+        print()  # To avoid weird no newline when Ctrl+C
+        return False
+
+    match answer.lower():
+        case "y" | "yes":
+            return True
+        case "n" | "no":
+            return False
+        case "":
+            return default_option
+        case _:
+            return False
+
+
+def set_loader_context(loader_name: str) -> None:
+    global loader_context
+
+    if loader_name in mods_loader:
+        loader_context = {"project_directory": mods_dir, "project_label": "mod"}
+    elif loader_name in plugins_loader:
+        loader_context = {"project_directory": plugins_dir, "project_label": "plugin"}
+
+
+# ANSI
+def ansi(name: str):
+    match color_output_mode:
+        case "always":
+            return ansi_codes.get(name, "")
+        case "never":
+            return ""
+        case "auto":
+            if isatty:
+                return ansi_codes.get(name, "")
+
+            return ""
+        case _:
+            raise ValueError(
+                f"Invalid string '{color_output_mode}' of variable color_output_mode"
+            )
+
+
+def wrap_ansi(string: str, ansi_name: str):
+    return f"{ansi(ansi_name)}{string}{ansi('reset')}"
+
+
+def mod_environment_color(environment: str, padding: int = 0):
+    if environment == "required":
+        return wrap_ansi(f"{'Required': <{padding}}", "green")
+    elif environment == "optional":
+        return wrap_ansi(f"{'Optional': <{padding}}", "yellow")
+    elif environment == "unsupported":
+        return wrap_ansi(f"{'Unsupported': <{padding}}", "red")
+    elif environment == "unknown":
+        return wrap_ansi(f"{'Unknown': <{padding}}", "gray")
+    return f"{environment: <{padding}}"
+
+
+def print_status(message: str, dynamic: str | None = None):
+    if dynamic is None:
+        dynamic = ""
+    global last_status_message
+
+    if dynamic and isatty:
+        print(f"{ansi('clear_line')} {dynamic}", end=ansi("start_line"), flush=True)
+    else:
+        if message != last_status_message:
+            print(message, flush=True)
+
+    last_status_message = message

mcserver/state.py

@@ -0,0 +1,77 @@
+# Modules
+# Standard
+import json
+import logging as log
+import os
+from pathlib import Path
+from typing import TypedDict
+
+# MCServer
+from .shared import mcserver_dir
+
+
+# TypedDict
+class State(TypedDict):
+    process_id: int
+    start_time: int
+    action: str
+
+
+class CurrentState(TypedDict):
+    is_active: bool
+    process_id: int
+    start_time: int
+    action: str
+
+
+# Paths
+proc_dir = Path("/proc")
+state_file = mcserver_dir / "state.json"
+
+
+# Functions
+def get_start_time(process_id: int | str) -> int:
+    process_id = str(process_id)
+
+    proc_pid = proc_dir / process_id
+    if not proc_pid.exists():
+        log.debug(f"Process ID ({process_id}) does not exist")
+        return 0
+
+    pid_stat = proc_pid / "stat"
+    pid_stat_data = pid_stat.read_text()
+
+    start_time: int = int(pid_stat_data.split()[21])
+    return start_time
+
+
+def set_state(action: str) -> None:
+    current_state: State = {
+        "process_id": os.getpid(),
+        "start_time": get_start_time("self"),
+        "action": action,
+    }
+
+    state_data: str = json.dumps(current_state, indent=2)
+    state_file.write_text(state_data)
+
+
+def get_state() -> CurrentState:
+    state_data: str = state_file.read_text()
+    file_state: State = json.loads(state_data)  # I ran out of naming
+
+    current_state: CurrentState = {
+        "is_active": False,
+        "process_id": file_state["process_id"],
+        "start_time": file_state["start_time"],
+        "action": file_state["action"],
+    }
+
+    if file_state["start_time"] == get_start_time(file_state["process_id"]):
+        current_state["is_active"] = True
+
+    return current_state
+
+
+def clear_state() -> None:
+    state_file.write_text(json.dumps({}))

mcserver_cli-3.0.0.dist-info/METADATA

@@ -0,0 +1,63 @@
+Metadata-Version: 2.5
+Name: mcserver-cli
+Version: 3.0.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
+Project-URL: Changelog, https://github.com/Othecat35/MCServer/blob/main/CHANGELOG.md
+Author-email: Othecat35 <othecat35@gmail.com>
+Maintainer-email: Othecat35 <othecat35@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+# MCServer
+## About
+A CLI tool to manage Minecraft: Java Edition servers.
+
+## Platform
+Supported platforms:
+- Linux
+- and Termux.
+
+## Requirements
+- Python 3.14 or newer
+- JRE (depends on Minecraft version)
+
+## How to install
+- System-wide (Requires root): 
+1. Download the `mcserver` script file from GitHub releases
+2. Move the file to `/usr/local/bin`
+3. Run `chmod +x mcserver`
+
+- Per-user:
+1. Create a directory "bin"
+2. Download the script from GitHub releases onto that directory
+3. Give it "executable" permission with `chmod +x mcserver`
+4. Add the directory in the PATH environment:
+   - Run `export PATH=$HOME/bin:$PATH` if you're using shell that is POSIX-compliant like Bash, Zsh, or ash
+   - Run `fish_add_path ~/bin` if you're using FISH
+
+## Usage
+- Add mods (and its dependencies): `mcserver add <mods>`
+- Import a modpack: `mcserver import [file]`
+- Initialize the server: `mcserver init [options]`
+- Manage operator status: `mcserver op`
+- Search mods from Modrinth: `mcserver search [<query>] [options]`
+- Show mod information from Modrinth: `mcserver show <mods>`
+- Start the server: `mcserver start`
+- Stop the server: `mcserver stop`
+- Manage the whitelist: `mcserver whitelist`
+
+### Example
+```bash
+mcserver init --mc-version=1.20.1 --loader=fabric --loader-version=0.19.3
+mcserver search --no-filter thdilos
+mcserver show thdilos-fox-origin thdilos-fox-origin-expanded
+mcserver add thdilos-fox-origin-expanded lithium tick-stasis ferrite-core krypton
+mcserver start
+```
+
+## Note
+This is a **Personal Project**, things may be unstable.

mcserver_cli-3.0.0.dist-info/RECORD

@@ -0,0 +1,61 @@
+mcserver/__init__.py,sha256=EPmgXOdWKks5S__ZMH7Nu6xpAeVrZpfxaFy4pykuyeI,22
+mcserver/__main__.py,sha256=3-WYJCtLQ8TbzmLMYBiAsm9PC89DwjXc6s_J-izMEz8,30
+mcserver/app.py,sha256=khFj3Op1Lnwa5mcgCGEr2nlnsrHDqAAqJDRqWrO9w44,691
+mcserver/caching.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mcserver/cli.py,sha256=_p2xWVdZLJofrDAkHywFECNy3ER86Oa286w-xYET8bc,9622
+mcserver/commandsa.py,sha256=7a2glWGLax2SSN4jRGrE7nOGDbdETDSDE5WHIc2ymLc,45042
+mcserver/config.py,sha256=UdthS6YI4SLWdNYkizR48pfEybVEbgFn2BcLMlNeBzI,1032
+mcserver/constants.py,sha256=pGKNo_wiJ250iWbB_tpnYwibN4e3DLu4iexAKX7SYjA,508
+mcserver/metadata.py,sha256=Uji_Q4gQutQkP8SyvSXrxvTW_d-FCgZuKijo939zTSk,686
+mcserver/mysterious.py,sha256=95ktZ0XGNtbjpCTvZOxRvxrOZXMpg-Xw9A3nV6cENic,104
+mcserver/networking.py,sha256=y0YmX1fb40ojCXgUPtjBIEBmNRn0B6LsiaxVpDjwqSQ,4419
+mcserver/resolver.py,sha256=RHIIaFiWhGzUpt46St9QKizJtf-zd6dmJz6kcrcp3xo,5414
+mcserver/shared.py,sha256=_Z8zDPJ8skBH3MagwgraDKAnfHxN-Px_zulbTCDCdQU,5408
+mcserver/state.py,sha256=IzeXXej4Wh9kC7lQnBoTjRwOUuaPg-myn7AoXIPTiaM,1690
+mcserver/commands/__init__.py,sha256=O8gWbBLk87zZMxF9py_codbRe9Gob8JbTWEAfsFJQCU,1248
+mcserver/commands/add_projects.py,sha256=pxQ7iNKsIjtT524fz8q57zFpAjcV3r_D1TpEmRv1Ljo,130
+mcserver/commands/import_setup.py,sha256=_Vs8tNb3YBKs5x8IlJTDVlPy1rbF6G2vnmxS7UWVECs,90
+mcserver/commands/initialize_server.py,sha256=WZ7KrPGWGY5LQGDGmJpl3pePHfBA8D9HCOQs3_mktLE,4371
+mcserver/commands/list_projects.py,sha256=_Vs8tNb3YBKs5x8IlJTDVlPy1rbF6G2vnmxS7UWVECs,90
+mcserver/commands/op_grant.py,sha256=NyPL8eHQ7A4LYkS7vhuRW_r8yRQNpxVR_txeJT0d3XY,128
+mcserver/commands/op_list.py,sha256=MdYui8q98IjyYLSyLwBaWk8EryaDQAFIXhY-1tDiUBQ,823
+mcserver/commands/op_revoke.py,sha256=NyPL8eHQ7A4LYkS7vhuRW_r8yRQNpxVR_txeJT0d3XY,128
+mcserver/commands/print_help.py,sha256=30nMXGL2epEGSOaavJWfspsc28iru-IGH43_NQiI8r8,148
+mcserver/commands/remove_projects.py,sha256=_Vs8tNb3YBKs5x8IlJTDVlPy1rbF6G2vnmxS7UWVECs,90
+mcserver/commands/search_projects.py,sha256=rYDSGDxyIpaGZB4UMi3rtO8lVf9xpwrvomi8kpW4RaA,124
+mcserver/commands/server_status.py,sha256=_Vs8tNb3YBKs5x8IlJTDVlPy1rbF6G2vnmxS7UWVECs,90
+mcserver/commands/show_projects.py,sha256=QikjJmU5psBMIOFFz42oAX4YaOriqgkTEvPGMqds7ko,876
+mcserver/commands/start_server.py,sha256=3w3R3X65hpmwp9-QSWpHP7FseUM2lW0p1nRvGxrQTfs,4843
+mcserver/commands/stop_server.py,sha256=UtQeq5xRrBwLWgKiqLRTnYwDVMpGs3v6nVNiqr5iBjA,1134
+mcserver/commands/update_projects.py,sha256=_Vs8tNb3YBKs5x8IlJTDVlPy1rbF6G2vnmxS7UWVECs,90
+mcserver/commands/whitelist_add.py,sha256=NyPL8eHQ7A4LYkS7vhuRW_r8yRQNpxVR_txeJT0d3XY,128
+mcserver/commands/whitelist_list.py,sha256=oRZp4d3R5qoGTONB3FRYikfYhbtMkE8V7WZBmRSWxRc,850
+mcserver/commands/whitelist_remove.py,sha256=bsKyTmAz4AaRfljvV9pVnk9VFyvu-M6bVVnhm973Eeo,818
+mcserver/fabricmc/meta.py,sha256=k0AYn2oQVK6mC4V3HnNi1pbw_oHeKUNnks3w-5ZbF2w,1113
+mcserver/legacyfabric/meta.py,sha256=FRrPm4QZq3uuH7zscjyHPs-zoFW7uREIz3iWaX_Tqxs,911
+mcserver/minecraft/api.py,sha256=7twGWNv6UytlzJJ5kSCpVZzkXjBVDxTMY-t3VoKNAzA,2704
+mcserver/minecraft/player_identity.py,sha256=LDvL5vFs5i-67nezUB4G12FrmQoZCT0ID94pQLnorzU,467
+mcserver/modrinth/api.py,sha256=hFV5Gzv7oXuC6E0IwGCU97pelYp5xEGvhm72yAuoIWc,22188
+mcserver/modrinth/modpack.py,sha256=uBx51G8sxQZEK127EMyXEZbyFMayps9pPGzTa49Vk6w,2957
+mcserver/modrinth/projects.py,sha256=86EksO7F1sQZvIqMWVH9g4FmU2xIFUGcmvqgT6ZQP-E,2342
+mcserver/modrinth/shared.py,sha256=eQZ1P8g7TUM2bYzBOsSQ9NZc76vD5fTDmyRL6egWBXk,294
+mcserver/modrinth/slug_index.py,sha256=Twcm5769Sjn4GVaGKVE2nUFHjjgyBDA9hwCXXi_IzSk,727
+mcserver/modrinth/project_records/metadata.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mcserver/modrinth/project_records/relationships.py,sha256=URDu4-9KV_ozrpdaSNAd9rmfH4vRiBpvKfnLgtm1OQM,6912
+mcserver/modrinth/project_records/shared.py,sha256=yzJqO-2I4pU2Asi-qIIUJ7dERU0522Iiq214Q4RNRO0,191
+mcserver/mojang/eula.py,sha256=LHVet4Kq-m7O6yiyiFwBk6McUxZUvZHTM58vuIbd3z8,626
+mcserver/mojang/manifest.py,sha256=P32hyNCg0s4YKjFLNsWYRojpnEU5PSvB-uOqF2Iuh8E,1976
+mcserver/papermc/api.py,sha256=BVENtFgRkRNFix5RWzW1biu7QjMBKDjXcpAEJ4SfENk,2372
+mcserver/purpurmc/api.py,sha256=aG3roAXMtCG2PMQMHGAM4zlV18Myd-LOW5EHVi8iUvU,2556
+mcserver/quiltmc/meta.py,sha256=BVbvGCfQ1_ft9i1KJFSFDnuvFoSoDz2lcWF-nr4nMdI,1385
+mcserver/server_files/banned_ips.py,sha256=3kfG9fck8JLvSnrfWl9eVj-ztClsld3Z9G4RxCyPtUw,3581
+mcserver/server_files/banned_players.py,sha256=qMSuwRdn_PzMCUD9CEOyy3plbfCmf_StauwbrgU5RXI,5050
+mcserver/server_files/ops.py,sha256=PFhR95aNTJ_sHorZct8hNQLV1OaSL9vOdxf6PqYaxKw,4032
+mcserver/server_files/properties.py,sha256=Cv5DZzjrzJXUcAIazw6Y4LkwdpyknreLFaMsApduduw,1003
+mcserver/server_files/usercaches.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mcserver/server_files/whitelist.py,sha256=ACEuuRxkSokIdmbv9VXSViYUzAL5JJH6nCIhh_3y06g,4633
+mcserver_cli-3.0.0.dist-info/METADATA,sha256=ylgHqc4cxmsWCYVj20eE0MUEIbjnkinCUZ2Ejdyq8E4,2098
+mcserver_cli-3.0.0.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+mcserver_cli-3.0.0.dist-info/entry_points.txt,sha256=wi3Sd39CDMohnpL0nNTaVQ8tLj0pk2AFrYbQhNUizSo,47
+mcserver_cli-3.0.0.dist-info/licenses/LICENSE,sha256=PXsLSnDlIrxje6E34tEo0s0rnxNvaiXRziyOXFDeuQU,1083
+mcserver_cli-3.0.0.dist-info/RECORD,,

mcserver_cli-3.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.0
+Root-Is-Purelib: true
+Tag: py3-none-any

mcserver_cli-3.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+mcserver = mcserver:__main__

mcserver_cli-3.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright © 2026 Othecat35
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.