# Unreal Engine Assets Dump
Command-line Interface (CLI) responsible for returning the list of the assets of an Unreal Engine project into a JSON structure.
## Development
### Poetry
_Unreal Engine Assets Dump_ project used Poetry to declare all its dependencies. [Poetry](https://python-poetry.org/) is a python dependency management tool to manage dependencies, packages, and libraries in your python project.
We need to create the Python virtual environment using Poetry:
```shell
poetry env use /Users/Shared/Epic\ Games/UE_5.2/Engine/Binaries/ThirdParty/Python3/Mac/bin/python3
```
We can enter this virtual environment and install all the required dependencies:
```shell
poetry shell
poetry update
```
## Publication
To publish a new version of the _Unreal Engine Assets Dump_ library to [Pypi](https://pypi.org/), we need to execute the following command:
```shell
poetry publish --build --username $PYPI_USERNAME --password $PYPI_PASSWORD
```
Where the environment variables:
- `$PYPI_USERNAME`: The value `__token__`
- `$PYPI_PASSWORD`: The [API token](https://pypi.org/manage/account/token/) used to authenticate when uploading packages to PyPI (e.g., `pypi-...`)
We generally defined a `.env` file and add these environment variables:
```text
# Copyright (C) 2023 Bootloader. All rights reserved.
#
# This software is the confidential and proprietary information of
# Bootloader or one of its subsidiaries. You shall not disclose this
# confidential information and shall use it only in accordance with the
# terms of the license agreement or other applicable agreement you
# entered into with Bootloader.
#
# BOOTLOADER MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE
# SUITABILITY OF THE SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT
# NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR
# A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. BOOTLOADER SHALL NOT BE
# LIABLE FOR ANY LOSSES OR DAMAGES SUFFERED BY LICENSEE AS A RESULT OF
# USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES.
# The Python Package Index (PyPI) API token to authenticate when
# uploading this package to PyPI.
PYPI_USERNAME=__token__
PYPI_PASSWORD=pypi-(...)
```
## Installation
To install _Unreal Engine Assets Dump_ library to Unreal Engine, execute the following command.
```shell
/Users/Shared/Epic\ Games/UE_5.1/Engine/Binaries/ThirdParty/Python3/Mac/bin/python3 -m pip install --upgrade uasset-dump
/Users/Shared/Epic\ Games/UE_5.2/Engine/Binaries/ThirdParty/Python3/Mac/bin/python3 -m pip install --upgrade uasset-dump
```
/Users/admin/Library/JenkinsAgent/workspace/client-app/scooby-app-build/main/Scooby/Content
## Execution
Then we can load our Unreal Engine project in Unreal Engine Editor and execute the following Python instructions in the Output Log drawer:
```shell
from bootloader.ue.utils import uasset_dump
uasset_dump.dump_assets('/Users/dcaune/Devel/Bootloader/bootloader-human-trainer-ar5/Content')
```
This prints long JSON data. For instance:
```json
[
{
"asset_name": "A_d2_ChangeOutfit_01",
"asset_class_path": "/Script/Engine/AnimSequence",
"package_name": "/Game/ArtAssets/Pets/QuadrupedDog/Animations/A_d2_ChangeOutfit_01",
"dependencies": [
"/Game/ArtAssets/Pets/QuadrupedDog/Mesh/S_d2"
]
},
{
"asset_name": "A_d2_ChangeOutfit_02",
"asset_class_path": "/Script/Engine/AnimSequence",
"package_name": "/Game/ArtAssets/Pets/QuadrupedDog/Animations/A_d2_ChangeOutfit_02",
"dependencies": [
"/Game/ArtAssets/Pets/QuadrupedDog/Mesh/S_d2"
]
},
(...)
]
```
```shell
export UNREAL_ENGINE_PROJECT_PATH=/Users/admin/Library/JenkinsAgent/workspace/client-app/scooby-app-build/main/Scooby/Scooby.uproject
export UNREAL_ENGINE_ASSET_DUMP_FILE_PATH=/Users/admin/bootloader-scooby-uassets.dump.json
"`find "/Users/Shared/Epic Games/UE_5.2" -name UnrealEditor-Cmd`" \
"$UNREAL_ENGINE_PROJECT_PATH" \
-run=pythonscript \
-stdout \
-Unattended \
-script="/Users/admin/Downloads/run.py"
echo $?;
```
# Command Line Execution
```shell
```
Raw data
{
"_id": null,
"home_page": "https://github.com/bootloader-studio/cli-uasset-dump",
"name": "uasset-dump",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "cli,tool,utility,unreal,engine,asset,inventory,dump,json",
"author": "Daniel CAUNE",
"author_email": "daniel@bootloader.studio",
"download_url": "https://files.pythonhosted.org/packages/ad/a0/da0cf391105bffdede381ce2070ba86083f202cd8fd5c77e02a8a316cabf/uasset_dump-0.0.17.tar.gz",
"platform": null,
"description": "# Unreal Engine Assets Dump\n\nCommand-line Interface (CLI) responsible for returning the list of the assets of an Unreal Engine project into a JSON structure.\n\n## Development\n\n### Poetry\n\n_Unreal Engine Assets Dump_ project used Poetry to declare all its dependencies. [Poetry](https://python-poetry.org/) is a python dependency management tool to manage dependencies, packages, and libraries in your python project.\n\nWe need to create the Python virtual environment using Poetry:\n\n```shell\npoetry env use /Users/Shared/Epic\\ Games/UE_5.2/Engine/Binaries/ThirdParty/Python3/Mac/bin/python3\n```\n\nWe can enter this virtual environment and install all the required dependencies:\n\n```shell\npoetry shell\npoetry update\n```\n\n\n## Publication\n\nTo publish a new version of the _Unreal Engine Assets Dump_ library to [Pypi](https://pypi.org/), we need to execute the following command:\n\n```shell\npoetry publish --build --username $PYPI_USERNAME --password $PYPI_PASSWORD\n```\n\nWhere the environment variables:\n\n- `$PYPI_USERNAME`: The value `__token__`\n- `$PYPI_PASSWORD`: The [API token](https://pypi.org/manage/account/token/) used to authenticate when uploading packages to PyPI (e.g., `pypi-...`)\n\nWe generally defined a `.env` file and add these environment variables:\n\n```text\n# Copyright (C) 2023 Bootloader. All rights reserved.\n#\n# This software is the confidential and proprietary information of\n# Bootloader or one of its subsidiaries. You shall not disclose this\n# confidential information and shall use it only in accordance with the\n# terms of the license agreement or other applicable agreement you\n# entered into with Bootloader.\n#\n# BOOTLOADER MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE\n# SUITABILITY OF THE SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT\n# NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR\n# A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. BOOTLOADER SHALL NOT BE\n# LIABLE FOR ANY LOSSES OR DAMAGES SUFFERED BY LICENSEE AS A RESULT OF\n# USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES.\n\n# The Python Package Index (PyPI) API token to authenticate when\n# uploading this package to PyPI.\nPYPI_USERNAME=__token__\nPYPI_PASSWORD=pypi-(...)\n```\n\n\n## Installation\n\nTo install _Unreal Engine Assets Dump_ library to Unreal Engine, execute the following command.\n\n```shell\n/Users/Shared/Epic\\ Games/UE_5.1/Engine/Binaries/ThirdParty/Python3/Mac/bin/python3 -m pip install --upgrade uasset-dump\n/Users/Shared/Epic\\ Games/UE_5.2/Engine/Binaries/ThirdParty/Python3/Mac/bin/python3 -m pip install --upgrade uasset-dump\n```\n\n/Users/admin/Library/JenkinsAgent/workspace/client-app/scooby-app-build/main/Scooby/Content\n\n## Execution\n\nThen we can load our Unreal Engine project in Unreal Engine Editor and execute the following Python instructions in the Output Log drawer:\n\n```shell\nfrom bootloader.ue.utils import uasset_dump\nuasset_dump.dump_assets('/Users/dcaune/Devel/Bootloader/bootloader-human-trainer-ar5/Content')\n```\n\nThis prints long JSON data. For instance:\n\n```json\n[\n {\n \"asset_name\": \"A_d2_ChangeOutfit_01\",\n \"asset_class_path\": \"/Script/Engine/AnimSequence\",\n \"package_name\": \"/Game/ArtAssets/Pets/QuadrupedDog/Animations/A_d2_ChangeOutfit_01\",\n \"dependencies\": [\n \"/Game/ArtAssets/Pets/QuadrupedDog/Mesh/S_d2\"\n ]\n },\n {\n \"asset_name\": \"A_d2_ChangeOutfit_02\",\n \"asset_class_path\": \"/Script/Engine/AnimSequence\",\n \"package_name\": \"/Game/ArtAssets/Pets/QuadrupedDog/Animations/A_d2_ChangeOutfit_02\",\n \"dependencies\": [\n \"/Game/ArtAssets/Pets/QuadrupedDog/Mesh/S_d2\"\n ]\n },\n (...)\n]\n```\n\n```shell\nexport UNREAL_ENGINE_PROJECT_PATH=/Users/admin/Library/JenkinsAgent/workspace/client-app/scooby-app-build/main/Scooby/Scooby.uproject\n\nexport UNREAL_ENGINE_ASSET_DUMP_FILE_PATH=/Users/admin/bootloader-scooby-uassets.dump.json\n\n\"`find \"/Users/Shared/Epic Games/UE_5.2\" -name UnrealEditor-Cmd`\" \\\n \"$UNREAL_ENGINE_PROJECT_PATH\" \\\n -run=pythonscript \\\n -stdout \\\n -Unattended \\\n -script=\"/Users/admin/Downloads/run.py\"\n\necho $?;\n```\n\n# Command Line Execution\n\n```shell\n\n\n```",
"bugtrack_url": null,
"license": "SEE LICENSE IN <LICENSE.md>",
"summary": "Command-line Interface (CLI) responsible for returning the list of the assets of an Unreal Engine project into a JSON structure",
"version": "0.0.17",
"project_urls": {
"Homepage": "https://github.com/bootloader-studio/cli-uasset-dump",
"Repository": "https://github.com/bootloader-studio/cli-uasset-dump"
},
"split_keywords": [
"cli",
"tool",
"utility",
"unreal",
"engine",
"asset",
"inventory",
"dump",
"json"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1f37b0772033e99b8e3b22a12298ecbf8ec5a8f56068745183058fdabb9d318a",
"md5": "7af9711de6129a325341903bc6885064",
"sha256": "2a4190f6e688227faf65717b63b9bfc51643e30085b3eff1f95d5e29ddeaf799"
},
"downloads": -1,
"filename": "uasset_dump-0.0.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7af9711de6129a325341903bc6885064",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 14983,
"upload_time": "2023-07-04T13:37:06",
"upload_time_iso_8601": "2023-07-04T13:37:06.798688Z",
"url": "https://files.pythonhosted.org/packages/1f/37/b0772033e99b8e3b22a12298ecbf8ec5a8f56068745183058fdabb9d318a/uasset_dump-0.0.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ada0da0cf391105bffdede381ce2070ba86083f202cd8fd5c77e02a8a316cabf",
"md5": "aed8f0ece618357c3b7e4cb74082f141",
"sha256": "025d0a68ca66ee29af507d6d6af097eaec81ecfe27a090ab4a804493aee5cfa5"
},
"downloads": -1,
"filename": "uasset_dump-0.0.17.tar.gz",
"has_sig": false,
"md5_digest": "aed8f0ece618357c3b7e4cb74082f141",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 9263,
"upload_time": "2023-07-04T13:37:08",
"upload_time_iso_8601": "2023-07-04T13:37:08.087621Z",
"url": "https://files.pythonhosted.org/packages/ad/a0/da0cf391105bffdede381ce2070ba86083f202cd8fd5c77e02a8a316cabf/uasset_dump-0.0.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-04 13:37:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bootloader-studio",
"github_project": "cli-uasset-dump",
"github_not_found": true,
"lcname": "uasset-dump"
}
JSON
