# Install Burgerovka for Codex

This package contains a Codex pet.

## What is inside this archive

After unpacking, you should see this folder:

```text
burgerovka/
  pet.json
  spritesheet.webp
  INSTALL.md
```

`pet.json` tells Codex what this pet is.
`spritesheet.webp` is the animated image file used by Codex.
`INSTALL.md` is this installation guide.

## Where this pet should be installed

Codex pets should live in this folder on your computer:

```text
~/.codex/pets/
```

For this pet, the final folder should be:

```text
~/.codex/pets/burgerovka/
```

And inside it you should have:

```text
~/.codex/pets/burgerovka/pet.json
~/.codex/pets/burgerovka/spritesheet.webp
```

## Install with Terminal

1. Download `codex-pet-burgerovka.zip`.
2. Open Terminal.
3. Create the Codex pets folder if it does not exist yet:

```sh
mkdir -p ~/.codex/pets
```

4. Unzip the package into the Codex pets folder:

```sh
unzip ~/Downloads/codex-pet-burgerovka.zip -d ~/.codex/pets/
```

If your browser saved the file somewhere else, replace `~/Downloads/codex-pet-burgerovka.zip`
with the actual file location.

5. Check that the files are in the right place:

```sh
ls ~/.codex/pets/burgerovka/
```

You should see:

```text
INSTALL.md
pet.json
spritesheet.webp
```

## Install manually with Finder

1. Download `codex-pet-burgerovka.zip`.
2. Double-click the zip file to unpack it.
3. Find the folder named `burgerovka`.
4. Open this folder on your Mac:

```text
~/.codex/pets/
```

If you do not see `.codex`, it may be hidden. In Finder, press:

```text
Command + Shift + .
```

5. Move the `burgerovka` folder into:

```text
~/.codex/pets/
```

The final result should be:

```text
~/.codex/pets/burgerovka/pet.json
~/.codex/pets/burgerovka/spritesheet.webp
```

## Important

Do not place the zip file itself into `~/.codex/pets/`.

The zip must be unpacked first.

Do not rename:

```text
pet.json
spritesheet.webp
```

Do not rename the pet folder unless you also know how to update `pet.json`.

## If it does not work

Check these things:

1. The pet folder is inside `~/.codex/pets/`.
2. The folder name is `burgerovka`.
3. The folder contains both `pet.json` and `spritesheet.webp`.
4. The files are not inside an extra nested folder.

Correct:

```text
~/.codex/pets/burgerovka/pet.json
~/.codex/pets/burgerovka/spritesheet.webp
```

Wrong:

```text
~/.codex/pets/codex-pet-burgerovka/burgerovka/pet.json
```
