ue-asset-cli


Nameue-asset-cli JSON
Version 0.1.1 PyPI version JSON
download
home_page
SummaryA linux-compatible command-line interface to download Assets from the Epic Game Store Marketplace.
upload_time2024-03-15 22:58:19
maintainer
docs_urlNone
author
requires_python>=3.9
license
keywords egs eos epic games marketplace ue ue4 ue5 unreal engine
VCS
bugtrack_url
requirements requests keyring tqdm
Travis-CI No Travis.
coveralls test coverage No coveralls.
             # Unreal Engine Asset CLI
A linux-compatible command-line interface to download Assets from the Epic Game Store Marketplace. This is a re-implementation from [Allar's ue-mp-downloader](https://github.com/Allar/ue4-mp-downloader) or rather [its Fork](https://github.com/IncantaGames/ue-mp-downloader). A big shoutout to them, epsecially Allar, for figuring all this out!

## Features
- Download an Asset from the Marketplace
- List Assets from your EGS Library
- Get details about a specific Asset, like it's Version and what Engine Version is supported by each, or the description or author

## Legal
For this tool to work, you must have already accepted Epic's Terms (on account registration) and relevant EULAs (prompted when you open the Launcher for the first time or buy a marketplace item).
This tool can only download assets you own.

As with both original Repos: I, jwindgassen, mean no foul or infringement, and I will take this repo down immediately at the request of Epic Games if they do so.

## Usage
To use this tool, you can use the CLI it provides: `ue-assets`. To get help: `ue-assets --help`
The CLI provides a list of actions, that you can use:

 | Actions | Description |
 |---------|-------------|
 | login   | Login to the Epic Services. This will require an authentication code, which you must get by logging into your account [in your browser](https://www.epicgames.com/id/api/redirect?clientId=34a02cf8f4414e29b15921876da36f9a&responseType=code). The login will be stored in your keyring, so you don't need to enter in every time. |
 | list    | List the assets and their available Versions. |
 | details | Get the full details, including which Versions work with which Engine Version, for a specific detail. |
 | download | Download a given Asset + Version into a desired Directory on your system. |
 | logout | Logout from the Epic Services, i.e., removing the access token from the keyring. |

## Installation
The CLI can be installed from PyPI with `pip install ue-asset-cli`.
For developing, clone the repo and install the Package as editable with `pip intall -e .`.

## ToDo:
- More Login Method, primarily Username + Password.
- Interfacing with [ue4cli](https://github.com/adamrehn/ue4cli).
- More Caching, maybe usage of file instead of keyring??
- Better Output formatting

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "ue-asset-cli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "EGS,EOS,Epic Games,Marketplace,UE,UE4,UE5,Unreal Engine",
    "author": "",
    "author_email": "Jonathan Windgassen <j.windgassen@fz-juelich.de>",
    "download_url": "https://files.pythonhosted.org/packages/80/5d/b39565449762e221691ce9c100e367d40c830af5a14cf66461215ec4dbf1/ue_asset_cli-0.1.1.tar.gz",
    "platform": null,
    "description": " # Unreal Engine Asset CLI\nA linux-compatible command-line interface to download Assets from the Epic Game Store Marketplace. This is a re-implementation from [Allar's ue-mp-downloader](https://github.com/Allar/ue4-mp-downloader) or rather [its Fork](https://github.com/IncantaGames/ue-mp-downloader). A big shoutout to them, epsecially Allar, for figuring all this out!\n\n## Features\n- Download an Asset from the Marketplace\n- List Assets from your EGS Library\n- Get details about a specific Asset, like it's Version and what Engine Version is supported by each, or the description or author\n\n## Legal\nFor this tool to work, you must have already accepted Epic's Terms (on account registration) and relevant EULAs (prompted when you open the Launcher for the first time or buy a marketplace item).\nThis tool can only download assets you own.\n\nAs with both original Repos: I, jwindgassen, mean no foul or infringement, and I will take this repo down immediately at the request of Epic Games if they do so.\n\n## Usage\nTo use this tool, you can use the CLI it provides: `ue-assets`. To get help: `ue-assets --help`\nThe CLI provides a list of actions, that you can use:\n\n | Actions | Description |\n |---------|-------------|\n | login   | Login to the Epic Services. This will require an authentication code, which you must get by logging into your account [in your browser](https://www.epicgames.com/id/api/redirect?clientId=34a02cf8f4414e29b15921876da36f9a&responseType=code). The login will be stored in your keyring, so you don't need to enter in every time. |\n | list    | List the assets and their available Versions. |\n | details | Get the full details, including which Versions work with which Engine Version, for a specific detail. |\n | download | Download a given Asset + Version into a desired Directory on your system. |\n | logout | Logout from the Epic Services, i.e., removing the access token from the keyring. |\n\n## Installation\nThe CLI can be installed from PyPI with `pip install ue-asset-cli`.\nFor developing, clone the repo and install the Package as editable with `pip intall -e .`.\n\n## ToDo:\n- More Login Method, primarily Username + Password.\n- Interfacing with [ue4cli](https://github.com/adamrehn/ue4cli).\n- More Caching, maybe usage of file instead of keyring??\n- Better Output formatting\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A linux-compatible command-line interface to download Assets from the Epic Game Store Marketplace.",
    "version": "0.1.1",
    "project_urls": {
        "Issues": "https://github.com/jwindgassen/ue-asset-cli/issues",
        "Repository": "https://github.com/jwindgassen/ue-asset-cli"
    },
    "split_keywords": [
        "egs",
        "eos",
        "epic games",
        "marketplace",
        "ue",
        "ue4",
        "ue5",
        "unreal engine"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a44045d785fa20071dd4fa72aa2919a39146a49e766d8f8a08e5cd87e6ad619a",
                "md5": "8951217409e0681bb00e6a6532a26880",
                "sha256": "391240c11f33378cfe5d9454db41cd12375f05de073b51f70dba386135dd1792"
            },
            "downloads": -1,
            "filename": "ue_asset_cli-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8951217409e0681bb00e6a6532a26880",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 11593,
            "upload_time": "2024-03-15T22:58:18",
            "upload_time_iso_8601": "2024-03-15T22:58:18.383684Z",
            "url": "https://files.pythonhosted.org/packages/a4/40/45d785fa20071dd4fa72aa2919a39146a49e766d8f8a08e5cd87e6ad619a/ue_asset_cli-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "805db39565449762e221691ce9c100e367d40c830af5a14cf66461215ec4dbf1",
                "md5": "fd388888474f43645d61f2328a712b81",
                "sha256": "a46d735836a52d4eb9c28bb11897e0646a395be17ec42ef246a782283f6d1a91"
            },
            "downloads": -1,
            "filename": "ue_asset_cli-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "fd388888474f43645d61f2328a712b81",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 10730,
            "upload_time": "2024-03-15T22:58:19",
            "upload_time_iso_8601": "2024-03-15T22:58:19.930102Z",
            "url": "https://files.pythonhosted.org/packages/80/5d/b39565449762e221691ce9c100e367d40c830af5a14cf66461215ec4dbf1/ue_asset_cli-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-15 22:58:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jwindgassen",
    "github_project": "ue-asset-cli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "requests",
            "specs": []
        },
        {
            "name": "keyring",
            "specs": []
        },
        {
            "name": "tqdm",
            "specs": []
        }
    ],
    "lcname": "ue-asset-cli"
}
        
Elapsed time: 0.22225s