(installation)=
# Installation

## Requirements
Run Regolith with **Python 3.11 or 3.12** (3.13 has no `numpy` 1.x wheel). The
filter depends on `amulet-core`, pinned to `<1.9.36`: version 1.9.36+ adds a
hard dependency on `amulet-rocksdb`, a large C++ package with no Linux wheel for
Python 3.12, so `regolith install` would spend 10-20 minutes compiling RocksDB
from source. 1.9.35 drops that dependency and reads Bedrock worlds through the
same `amulet-leveldb` backend. On Windows the install is fully prebuilt; on
Linux the smaller `amulet-leveldb`/`amulet-nbt` extensions still compile from
source (Amulet ships no Linux wheels for them). See
`shapescape_cgg_containers/requirements.txt` for details.

## Steps

### 1. Install the filter
Use the following command
```
regolith install shapescape_cgg_containers
```

You can alternatively use this command:
```
regolith install github.com/ShapescapeMC/Shapescape-Content-Guide-Generator-Containers/shapescape_cgg_containers
```

### 2. Add filter to a profile
Add the filter to the `filters` list in the `config.json` file of the Regolith project and add the settings:

```json
{
  "filter": "shapescape_cgg_containers"
}
```