PhysInOne / Utils /3D_ASSETS_DOWNLOAD.md
vLAR's picture
Complete public 3D asset release documentation
bd6f3a1 verified
|
Raw History Blame Contribute Delete
7.34 kB

PhysInOne 3D Assets

This guide explains how to download, extract, and open the currently released PhysInOne Unreal Engine project assets. The release contains shared project files, Train and Val resource libraries, and Scene/Trajectory resources for 14,847 validation scenes and 120,660 training scenes. The 273 validation origins reserved for the Motion Transfer test set are intentionally excluded.

Repository location:

Assets/PhysicBenchmark

Requirements

  • Unreal Engine 5.5.4
  • Python 3.9 or newer for the automated downloader
  • Approximately 140 GiB for the compressed public release alone
  • Substantially more free disk space when keeping both ZIP files and extracted assets

Windows is recommended for the simplest Unreal Engine setup. Linux is also supported, but platform plugins, permissions, and case-sensitive paths may require additional configuration.

Automated setup

The public downloader uses only the Python standard library and anonymous HTTPS. Clone the GitHub repository, which contains the script and exact release manifest:

git clone https://github.com/vLAR-group/PhysInOne.git
cd PhysInOne
python scripts/download_data.py --task 3d-assets --output-dir ./PhysInOne_data

The default command:

  1. Downloads the exact current public release list.
  2. Maps the project to the space-free local path assets/PhysicBenchmark/.
  3. Validates ZIP paths and rejects unsafe archive members.
  4. Extracts all 285 released ZIP files into their current parent directories.
  5. Merges Train and Val resources without overwriting different files.
  6. Writes resumable extraction markers and detailed success/failure logs.
  7. Shows live file count, estimated size, download speed, and ETA.

After completion, launch:

PhysInOne_data/assets/PhysicBenchmark/PhysInOne.uproject

Download without extraction

python scripts/download_data.py --task 3d-assets \
  --output-dir ./PhysInOne_data \
  --no-extract

Run the default command later with the same output directory to extract the archives.

Save disk space

python scripts/download_data.py --task 3d-assets \
  --output-dir ./PhysInOne_data \
  --delete-zip-after-extract

A ZIP is deleted only after successful validation and extraction. Completion markers prevent it from being downloaded again when the same command resumes.

Current release contents

  • 4,585 downloadable files
  • 285 ZIP archives
  • Approximately 139.67 GiB before extraction
  • Scene and Trajectory resources for 14,847 validation scenes
  • Scene and Trajectory resources for 120,660 training scenes
  • Six validation resource archives and seven training resource archives
  • Shared Unreal Engine project files and dependencies
  • Ten Movie Render Queue configurations under Content/PhysInOne/Scripts/

Maintained lists:

Archives and extraction destinations

Every ZIP must be extracted in place, into its current parent directory. Scene and Trajectory files are deliberately packaged separately.

Archive pattern, relative to PhysicBenchmark/ Member paths Extract in
Content/PhysInOne/Scenes/val_scenes_batch_*.zip Val/<Physics>/<Scene>.umap Content/PhysInOne/Scenes/
Content/PhysInOne/Scenes/train_scenes_batch_*.zip Train/<Physics>/<Scene>.umap Content/PhysInOne/Scenes/
Content/PhysInOne/Trajectories/val_trajectory_batch_*.zip Val/<Physics>/<Scene>_trajectory.uasset Content/PhysInOne/Trajectories/
Content/PhysInOne/Trajectories/train_trajectory_batch_*.zip Train/<Physics>/<Scene>_trajectory.uasset Content/PhysInOne/Trajectories/
Content/PhysInOne/<Resource>/Val.zip Val/... its current <Resource>/ parent
Content/PhysInOne/<Resource>/Train.zip Train/... its current <Resource>/ parent

Because members begin with their split directory, Train and Val ZIPs can share one remote parent directory without colliding after extraction.

The Train Scene and Trajectory series each span batches 0000–0120; the Val series each span batches 0000–0014. The final Train batch contains 660 scenes, and the final Val batch contains 847 scenes.

Expected project structure

PhysicBenchmark/
β”œβ”€β”€ PhysInOne.uproject
β”œβ”€β”€ Config/
β”œβ”€β”€ DerivedDataCache/
└── Content/
    β”œβ”€β”€ Collections/
    β”œβ”€β”€ Ice/
    β”œβ”€β”€ StarterContent/
    β”œβ”€β”€ __ExternalActors__/
    β”œβ”€β”€ __ExternalObjects__/
    └── PhysInOne/
        β”œβ”€β”€ Backgrounds/
        β”‚   └── Train/
        β”œβ”€β”€ BackGrounds_raw/
        β”‚   β”œβ”€β”€ Train/
        β”‚   └── Val/
        β”œβ”€β”€ BreakableObjects/
        β”‚   β”œβ”€β”€ Train/
        β”‚   └── Val/
        β”œβ”€β”€ InteractableObjects/
        β”‚   β”œβ”€β”€ Train/
        β”‚   └── Val/
        β”œβ”€β”€ MaterialsAppearance/
        β”‚   β”œβ”€β”€ Train/
        β”‚   └── Val/
        β”œβ”€β”€ MaterialsPhysics/
        β”‚   β”œβ”€β”€ Train/
        β”‚   └── Val/
        β”œβ”€β”€ Scripts/
        β”‚   └── MoviePipelinePrimaryConfig*.uasset
        β”œβ”€β”€ SolidObjects/
        β”‚   β”œβ”€β”€ Train/
        β”‚   └── Val/
        β”œβ”€β”€ Scenes/
        β”‚   β”œβ”€β”€ Train/
        β”‚   └── Val/
        └── Trajectories/
            β”œβ”€β”€ Train/
            └── Val/

The Movie Render Queue assets must remain in Content/PhysInOne/Scripts/, which Unreal Engine exposes as /Game/PhysInOne/Scripts/. The public rendering tools refer to that package path directly.

Do not rename or flatten BackGrounds_raw, __ExternalActors__, or __ExternalObjects__. Unreal Engine resolves assets by project-relative package paths.

Resume and logs

Re-run the same command with the same output directory. Completed downloads are reused, .part files resume, and archives with valid completion markers are skipped.

Logs are written to:

<output-dir>/_download_logs/YYYYMMDD_HHMMSS/
β”œβ”€β”€ downloads.tsv
β”œβ”€β”€ extractions.tsv
β”œβ”€β”€ failures.tsv
└── summary.json

For slower or rate-limited networks:

python scripts/download_data.py --task 3d-assets \
  --output-dir ./PhysInOne_data \
  --workers 2

Public downloads are anonymous. The downloader has no token parameter or credential-handling path.

Contact

For setup questions, contact Siyuan Zhou at siyuan.zhou@connect.polyu.hk. WeChat: aify20001009.