(installation)=
# Installation

## Requirements
Run Regolith with **Python 3.12** (3.11 also works). The filter depends on
`amulet-core`, which pulls in `amulet-rocksdb`. The latest `amulet-rocksdb`
(1.0.5) only publishes wheels for Python 3.11, so on 3.12 pip would compile
RocksDB from source (a build of several minutes). To avoid that, `amulet-rocksdb`
is pinned below 1.0.5, which keeps the prebuilt 3.12 wheel while `amulet-core`
stays on its latest release. Python 3.13 is not supported yet (no `numpy` 1.x
wheel). 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"
}
```