zucaro 0.5.1__tar.gz

zucaro-0.5.1/.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# change project strucutre
+16da1dc0d39f3390f2abeb6213a50ebb4124b77d

zucaro-0.5.1/.github/workflows/pypi.yml

@@ -0,0 +1,57 @@
+name: Try to upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Python Setup Rye
+        uses: eifinger/setup-rye@v4.2.9
+        # optionally specify version:
+        # with:
+        #   version: "0.44.0"
+
+      - name: Build release distributions with Rye
+        run: rye build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs: release-build
+    permissions:
+      id-token: write
+
+    environment:
+      name: pypi
+      url: https://pypi.org/project/zucaro/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

zucaro-0.5.1/.gitignore

@@ -0,0 +1,10 @@
+# python generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# venv
+.venv

zucaro-0.5.1/LICENSE

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2024 Samuel Čavoj
+
+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.

zucaro-0.5.1/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.4
+Name: zucaro
+Version: 0.5.1
+Summary: A very small CLI Minecraft launcher.
+Author-email: Samuel Čavoj <samuel@cavoj.net>
+License-File: LICENSE
+Requires-Python: >=3.8
+Requires-Dist: aiohttp==3.11.12
+Requires-Dist: click~=8.1
+Requires-Dist: colorama~=0.4
+Requires-Dist: coloredlogs~=15.0
+Requires-Dist: requests~=2.31
+Requires-Dist: tqdm~=4.66
+Description-Content-Type: text/markdown
+
+# hey
+
+This is a fork thats made to work as the backend of the picodulce launcher, this is a work in progress and a lot of things will change
+
+this is a fork of the amazing work of [sammko](https://github.com/sammko/picomc)
+
+zucaro
+====
+
+`zucaro` is a cross-platform command-line Minecraft launcher. It supports
+all(?) officialy available Minecraft versions, account switching and
+multiple separate instances of the game. The on-disk launcher file
+structure mimics the vanilla launcher and as such most mod installers
+(such as forge, fabric or optifine) should work with zucaro just fine,
+though you will have to change the installation path.
+Don't hesitate to report any problems you run into.
+
+Usage
+---
+
+The quickest way to get started is to run
+
+```
+zucaro play
+```
+
+which, on the first launch, will ask you for your account details,
+create an instance named `default` using the latest version of Minecraft
+and launch it.
+
+Of course, more advanced features are available. Try running
+
+```
+zucaro --help
+```
+
+and you should be able to figure it out. More detailed documentation
+may appear someday in the future.
+
+Development
+---
+
+For project management and dependency tracking `zucaro` uses
+[Rye](https://rye-up.com/).

zucaro-0.5.1/README.md

@@ -0,0 +1,44 @@
+# hey
+
+This is a fork thats made to work as the backend of the picodulce launcher, this is a work in progress and a lot of things will change
+
+this is a fork of the amazing work of [sammko](https://github.com/sammko/picomc)
+
+zucaro
+====
+
+`zucaro` is a cross-platform command-line Minecraft launcher. It supports
+all(?) officialy available Minecraft versions, account switching and
+multiple separate instances of the game. The on-disk launcher file
+structure mimics the vanilla launcher and as such most mod installers
+(such as forge, fabric or optifine) should work with zucaro just fine,
+though you will have to change the installation path.
+Don't hesitate to report any problems you run into.
+
+Usage
+---
+
+The quickest way to get started is to run
+
+```
+zucaro play
+```
+
+which, on the first launch, will ask you for your account details,
+create an instance named `default` using the latest version of Minecraft
+and launch it.
+
+Of course, more advanced features are available. Try running
+
+```
+zucaro --help
+```
+
+and you should be able to figure it out. More detailed documentation
+may appear someday in the future.
+
+Development
+---
+
+For project management and dependency tracking `zucaro` uses
+[Rye](https://rye-up.com/).

zucaro-0.5.1/pyproject.toml

@@ -0,0 +1,37 @@
+[project]
+name = "zucaro"
+version = "0.5.1"
+description = "A very small CLI Minecraft launcher."
+authors = [
+    { name = "Samuel Čavoj", email = "samuel@cavoj.net" }
+]
+dependencies = [
+    "click~=8.1",
+    "coloredlogs~=15.0",
+    "colorama~=0.4",
+    "requests~=2.31",
+    "tqdm~=4.66",
+    "aiohttp==3.11.12",
+]
+readme = "README.md"
+requires-python = ">= 3.8"
+
+[project.scripts]
+zucaro = "zucaro:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.rye]
+managed = true
+dev-dependencies = []
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/zucaro"]
+
+[tool.ruff.lint]
+extend-select = ["I", "W"]

zucaro-0.5.1/requirements-dev.lock

@@ -0,0 +1,30 @@
+# generated by rye
+# use `rye lock` or `rye sync` to update this lockfile
+#
+# last locked with the following flags:
+#   pre: false
+#   features: []
+#   all-features: false
+#   with-sources: false
+
+-e file:.
+certifi==2024.2.2
+    # via requests
+charset-normalizer==3.3.2
+    # via requests
+click==8.1.7
+    # via zucaro
+colorama==0.4.6
+    # via zucaro
+coloredlogs==15.0.1
+    # via zucaro
+humanfriendly==10.0
+    # via coloredlogs
+idna==3.7
+    # via requests
+requests==2.31.0
+    # via zucaro
+tqdm==4.66.2
+    # via zucaro
+urllib3==2.2.1
+    # via requests

zucaro-0.5.1/requirements.lock

@@ -0,0 +1,30 @@
+# generated by rye
+# use `rye lock` or `rye sync` to update this lockfile
+#
+# last locked with the following flags:
+#   pre: false
+#   features: []
+#   all-features: false
+#   with-sources: false
+
+-e file:.
+certifi==2024.2.2
+    # via requests
+charset-normalizer==3.3.2
+    # via requests
+click==8.1.7
+    # via zucaro
+colorama==0.4.6
+    # via zucaro
+coloredlogs==15.0.1
+    # via zucaro
+humanfriendly==10.0
+    # via coloredlogs
+idna==3.7
+    # via requests
+requests==2.31.0
+    # via zucaro
+tqdm==4.66.2
+    # via zucaro
+urllib3==2.2.1
+    # via requests

zucaro-0.5.1/src/zucaro/__init__.py

@@ -0,0 +1,16 @@
+import sys
+
+from zucaro.cli import zucaro_cli
+
+MINPYVERSION = (3, 7, 0)
+
+if sys.version_info < MINPYVERSION:
+    print(
+        "zucaro requires at least Python version "
+        "{}.{}.{}. You are using {}.{}.{}.".format(*MINPYVERSION, *sys.version_info)
+    )
+    sys.exit(1)
+
+
+def main():
+    zucaro_cli()

zucaro-0.5.1/src/zucaro/__main__.py

@@ -0,0 +1,6 @@
+#!/bin/python
+
+if __name__ == "__main__":
+    from zucaro import main
+
+    main()

zucaro-0.5.1/src/zucaro/account.py

@@ -0,0 +1,232 @@
+import uuid
+import aiohttp
+import asyncio
+from zucaro.errors import RefreshError, ValidationError
+from zucaro.logging import logger
+from zucaro.msapi import MicrosoftAuthApi
+from zucaro.yggdrasil import MojangYggdrasil
+
+
+class NAMESPACE_NULL:
+    bytes = b""
+
+
+def generate_client_token():
+    # Any random string, this matches the behavior of the official launcher.
+    return str(uuid.uuid4().hex)
+
+
+class Account:
+    def __init__(self, **kwargs):
+        self.__dict__.update(self.DEFAULTS)
+        self.__dict__.update(kwargs)
+
+    def __repr__(self):
+        return self.name
+
+    def to_dict(self):
+        return {k: getattr(self, k) for k in self.DEFAULTS.keys()}
+
+    def save(self):
+        self._am.save(self)
+
+    @classmethod
+    def from_config(cls, am, name, config):
+        if config.get("microsoft", False):
+            c = MicrosoftAccount
+        elif config.get("online", False):
+            c = OnlineAccount
+        else:
+            c = OfflineAccount
+        return c(name=name, _am=am, **config)
+
+
+class OfflineAccount(Account):
+    DEFAULTS = {"uuid": "-", "online": False}
+    access_token = "-"
+
+    @classmethod
+    def new(cls, am, name):
+        u = uuid.uuid3(NAMESPACE_NULL, "OfflinePlayer:{}".format(name)).hex
+        return cls(name=name, uuid=u, _am=am)
+
+    @property
+    def gname(self):
+        return self.name
+
+    async def refresh(self):
+        return False
+
+    def can_launch_game(self):
+        return True
+
+
+class OnlineAccount(Account):
+    DEFAULTS = {
+        "uuid": "-",
+        "online": True,
+        "gname": "-",
+        "access_token": "-",
+        "is_authenticated": False,
+        "username": "-",
+    }
+
+    fresh = False
+
+    @classmethod
+    def new(cls, am, name, username):
+        return cls(name=name, username=username, _am=am)
+
+    async def validate(self):
+        r = await self._am.yggdrasil.validate(self.access_token)
+        if r:
+            self.fresh = True
+        return r
+
+    async def refresh(self, force=False):
+        if self.fresh and not force:
+            return False
+        if self.is_authenticated:
+            if await self.validate():
+                return
+            else:
+                try:
+                    refresh = await self._am.yggdrasil.refresh(self.access_token)
+                    self.access_token, self.uuid, self.gname = refresh
+                    self.fresh = True
+                    return True
+                except RefreshError as e:
+                    logger.error(
+                        "Failed to refresh access_token," " please authenticate again."
+                    )
+                    self.is_authenticated = False
+                    raise e
+                finally:
+                    self.save()
+        else:
+            raise AccountError("Not authenticated.")
+
+    async def authenticate(self, password):
+        self.access_token, self.uuid, self.gname = await self._am.yggdrasil.authenticate(
+            self.username, password
+        )
+        self.is_authenticated = True
+        self.fresh = True
+        self.save()
+
+    def can_launch_game(self):
+        return self.is_authenticated
+
+
+class MicrosoftAccount(Account):
+    DEFAULTS = {
+        "uuid": "-",
+        "online": True,
+        "microsoft": True,
+        "gname": "-",
+        "access_token": "-",
+        "refresh_token": "-",
+        "is_authenticated": False,
+    }
+
+    @classmethod
+    def new(cls, am, name):
+        return cls(name=name, _am=am)
+
+    async def refresh(self, force=False):
+        if not self.is_authenticated:
+            raise RefreshError("Account is not authenticated, cannot refresh")
+        try:
+            valid = await self._am.msapi.validate(self.access_token)
+        except ValidationError as e:
+            raise RefreshError(e)
+        if valid:
+            logger.debug("msa: token still valid")
+            return False
+        else:
+            logger.debug("msa: token not valid anymore, refreshing")
+            self.access_token, self.refresh_token = await self._am.msapi.refresh(
+                self.refresh_token
+            )
+            self.save()
+            return True
+
+    async def authenticate(self):
+        self.access_token, self.refresh_token = await self._am.msapi.authenticate()
+        profile = await self._am.msapi.get_profile(self.access_token)
+        self.gname = profile["name"]
+        self.uuid = profile["id"]
+        self.is_authenticated = True
+        self.save()
+
+    def can_launch_game(self):
+        return self.is_authenticated
+
+
+class AccountError(ValueError):
+    def __str__(self):
+        return " ".join(self.args)
+
+
+DEFAULT_CONFIG = {
+    "default": None,
+    "accounts": {},
+    "client_token": generate_client_token(),
+}
+
+
+class AccountManager:
+    CONFIG_FILE = "accounts.json"
+
+    def __init__(self, launcher):
+        self.config = launcher.config_manager.get(self.CONFIG_FILE, init=DEFAULT_CONFIG)
+        self.yggdrasil = MojangYggdrasil(self.config["client_token"])
+        self.msapi = MicrosoftAuthApi()
+
+    def list(self):
+        return self.config["accounts"].keys()
+
+    def get(self, name):
+        try:
+            acc = Account.from_config(self, name, self.config["accounts"][name])
+            acc.is_default = self.config["default"] == name
+            return acc
+        except KeyError as ke:
+            raise AccountError("Account does not exist:", name) from ke
+
+    def exists(self, name):
+        return name in self.config["accounts"]
+
+    def get_default(self):
+        default = self.config["default"]
+        if not default:
+            raise AccountError("Default account not configured.")
+        return self.get(default)
+
+    def is_default(self, name):
+        return name == self.config["default"]
+
+    def set_default(self, account):
+        self.config["default"] = account.name
+
+    def add(self, account):
+        if self.exists(account.name):
+            raise AccountError("An account already exists with that name.")
+        if not self.config["default"] and not self.config["accounts"]:
+            self.config["default"] = account.name
+        self.save(account)
+
+    def save(self, account):
+        self.config["accounts"][account.name] = account.to_dict()
+        # HACK This doesn't trip the crappy dirty flag on config, set manually
+        self.config.dirty = True
+
+    def remove(self, name):
+        try:
+            if self.config["default"] == name:
+                self.config["default"] = None
+            del self.config["accounts"][name]
+            # HACK This doesn't trip the crappy dirty flag on config, set manually
+            self.config.dirty = True
+        except KeyError:
+            raise AccountError("Account does not exist:", name)

zucaro-0.5.1/src/zucaro/cli/__init__.py

@@ -0,0 +1,14 @@
+from .account import register_account_cli
+from .config import register_config_cli
+from .instance import register_instance_cli
+from .main import zucaro_cli
+from .mod import register_mod_cli
+from .play import register_play_cli
+from .version import register_version_cli
+
+register_account_cli(zucaro_cli)
+register_version_cli(zucaro_cli)
+register_instance_cli(zucaro_cli)
+register_config_cli(zucaro_cli)
+register_mod_cli(zucaro_cli)
+register_play_cli(zucaro_cli)

zucaro-0.5.1/src/zucaro/cli/account.py

@@ -0,0 +1,127 @@
+import click
+
+from zucaro.account import (
+    AccountError,
+    MicrosoftAccount,
+    OfflineAccount,
+    OnlineAccount,
+    RefreshError,
+)
+from zucaro.cli.utils import pass_account_manager, coro
+from zucaro.logging import logger
+from zucaro.yggdrasil import AuthenticationError
+
+
+def account_cmd(fn):
+    return click.argument("account")(fn)
+
+
+@click.group()
+def account_cli():
+    """Manage your accounts."""
+    pass
+
+
+@account_cli.command("list")
+@click.option("--ms", is_flag=True, help="List the online accounts")
+@pass_account_manager
+def _list(am, ms):
+    """List available accounts."""
+    alist = am.list()
+    if ms:
+        alist = [acc for acc in alist if isinstance(am.get(acc), MicrosoftAccount)]
+    if alist:
+        lines = ("{}{}".format("* " if am.is_default(u) else "  ", u) for u in alist)
+        print("\n".join(lines))
+    else:
+        logger.info("No accounts.")
+
+
+@account_cli.command()
+@account_cmd
+@click.argument("mojang_username", required=False)
+@click.option("--ms", "--microsoft", "microsoft", is_flag=True, default=False)
+@pass_account_manager
+def create(am, account, mojang_username, microsoft):
+    """Create an account."""
+    try:
+        if mojang_username:
+            if microsoft:
+                logger.error("Do not use --microsoft with mojang_username argument")
+                return
+            acc = OnlineAccount.new(am, account, mojang_username)
+        elif microsoft:
+            acc = MicrosoftAccount.new(am, account)
+        else:
+            acc = OfflineAccount.new(am, account)
+        am.add(acc)
+    except AccountError as e:
+        logger.error("Could not create account: %s", e)
+
+
+@account_cli.command()
+@account_cmd
+@pass_account_manager
+@coro
+async def authenticate(am, account):
+    """Retrieve access token from Mojang servers using password."""
+
+    try:
+        a = am.get(account)
+    except AccountError:
+        logger.error("AccountError", exc_info=True)
+        return
+
+    try:
+        if isinstance(a, OfflineAccount):
+            logger.error("Offline accounts cannot be authenticated")
+        elif isinstance(a, OnlineAccount):
+            import getpass
+
+            p = getpass.getpass("Password: ")
+            await a.authenticate(p)  # Await the coroutine
+        elif isinstance(a, MicrosoftAccount):
+            await a.authenticate()
+        else:
+            logger.error("Unknown account type")
+    except AuthenticationError as e:
+        logger.error("Authentication failed: %s", e)
+
+
+@account_cli.command()
+@account_cmd
+@pass_account_manager
+def refresh(am, account):
+    """Refresh access token with Mojang servers."""
+    try:
+        a = am.get(account)
+        a.refresh()
+    except (AccountError, RefreshError) as e:
+        logger.error("Could not refresh account: %s", e)
+
+
+@account_cli.command()
+@account_cmd
+@pass_account_manager
+def remove(am, account):
+    """Remove the account."""
+    try:
+        am.remove(account)
+    except AccountError as e:
+        logger.error("Could not remove account: %s", e)
+
+
+@account_cli.command()
+@account_cmd
+@pass_account_manager
+def setdefault(am, account):
+    """Set the account as default."""
+    try:
+        default = am.get(account)
+        am.set_default(default)
+    except AccountError as e:
+        logger.error("Could not set default account: %s", e)
+
+
+def register_account_cli(zucaro_cli):
+    zucaro_cli.add_command(account_cli, name="account")