Metadata-Version: 2.4
Name: envpool-assets
Version: 0.1.0
Summary: Runtime data assets for EnvPool.
Home-page: https://github.com/Trinkle23897/envpool-assets
Author: EnvPool Contributors
Author-email: sail@sea.com
License: Apache-2.0
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-python
Dynamic: summary

# envpool-assets

Runtime data assets for EnvPool.

This package intentionally contains only platform-independent data files. The
resulting wheel should be a single `py3-none-any` artifact, so it does not need
a Python-version or platform build matrix. Platform-specific executables and
native libraries stay in the main `envpool` wheels.

`envpool-assets` has its own compatibility version. It is not derived from the
main `envpool` package version; for example, an `envpool` release can depend on
an asset compatibility range such as `envpool-assets>=0.1.0,<0.2.0`.

## Build locally

From a checked-out EnvPool repository:

```bash
python scripts/collect_envpool_assets.py \
  --envpool-root /path/to/envpool \
  --output-root .asset-root

python scripts/build_wheel.py \
  --asset-root .asset-root \
  --version 0.1.0 \
  --dist-dir dist

python scripts/optimize_wheel.py dist/envpool_assets-*.whl
```

If you already have an asset root with the EnvPool asset subtree layout, skip
collection and run only `scripts/build_wheel.py`.

## Expected asset root layout

The asset root must contain these paths:

```text
atari/roms
gfootball/assets
mujoco/assets_dmc
mujoco/assets_gym
mujoco/metaworld/assets
mujoco/robotics/assets
procgen/assets
vizdoom/bin/freedoom2.wad
vizdoom/maps
```

`vizdoom/bin/vizdoom` and `vizdoom/bin/vizdoom.pk3` are deliberately excluded
because they are platform-specific runtime files shipped by the main EnvPool
wheel.
