2022-09-13 20:27:34 +01:00
---
title: Kangaroo
---
2022-12-04 22:24:02 +08:00
2022-09-13 20:27:34 +01:00
# Kangaroo
2022-12-04 22:24:02 +08:00
```{figure} ../../_static/videos/atari/kangaroo.gif
2022-09-13 20:27:34 +01:00
:width: 120px
:name: Kangaroo
```
This environment is part of the < a href = '..' > Atari environments< / a > . Please read that page first for general information.
2023-03-08 12:31:43 +00:00
| | |
|---|---|
| Action Space | Discrete(18) |
2023-03-30 15:49:37 +01:00
| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
2023-03-08 12:31:43 +00:00
| Import | `gymnasium.make("ALE/Kangaroo-v5")` |
For more Kangaroo variants with different observation and action spaces, see the variants section.
2022-10-12 15:58:01 +01:00
## Description
2022-12-04 22:24:02 +08:00
2024-01-26 10:56:01 -05:00
The object of the game is to score as many points as you can while controlling Mother Kangaroo to rescue her precious baby. You start the game with three lives. During this rescue mission, Mother Kangaroo encounters many obstacles. You need to help her climb ladders, pick bonus fruit, and throw punches at monkeys.
2023-02-15 01:30:47 +00:00
2023-03-17 23:25:58 +00:00
For a more detailed documentation, see [the AtariAge page ](https://atariage.com/manual_html_page.php?SoftwareLabelID=923 )
2022-09-13 20:27:34 +01:00
2022-10-12 15:58:01 +01:00
## Actions
2022-12-04 22:24:02 +08:00
2023-03-30 15:49:37 +01:00
Kangaroo has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings.
2023-02-15 01:30:47 +00:00
As Kangaroo uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make` .
2023-03-17 23:25:58 +00:00
| Value | Meaning | Value | Meaning | Value | Meaning |
|---------|--------------|---------|-----------------|---------|----------------|
| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` |
| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` |
| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` |
| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` |
| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` |
| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` |
2022-09-13 20:27:34 +01:00
2022-10-12 15:58:01 +01:00
## Observations
2022-12-04 22:24:02 +08:00
2023-03-30 15:49:37 +01:00
Atari environments have three possible observation types: `"rgb"` , `"grayscale"` and `"ram"` .
2022-12-04 22:24:02 +08:00
2023-02-15 01:30:47 +00:00
- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)`
- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)`
2023-03-30 15:49:37 +01:00
- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)` , a grayscale version of the "rgb" type
See variants section for the type of observation used by each environment id by default.
2022-09-13 20:27:34 +01:00
2024-02-05 15:26:56 +00:00
## Rewards
Your score will be shown at the top right corner of the game. Your end game score with be dependent on how much time you have remaining and who you encounter along the way. For a more detailed documentation, consult the [AtariAge page ](https://atariage.com/manual_html_page.php?SoftwareLabelID=923 ).
2022-12-04 22:24:02 +08:00
2023-02-15 01:30:47 +00:00
## Variants
Kangaroo has the following variants of the environment id which have the following differences in observation,
the number of frame-skips and the repeat action probability.
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
|------------------------------|-------------|--------------|------------------------------|
| Kangaroo-v0 | `"rgb"` | `(2, 5)` | `0.25` |
| Kangaroo-ram-v0 | `"ram"` | `(2, 5)` | `0.25` |
| Kangaroo-ramDeterministic-v0 | `"ram"` | `4` | `0.25` |
| Kangaroo-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` |
| KangarooDeterministic-v0 | `"rgb"` | `4` | `0.25` |
| KangarooNoFrameskip-v0 | `"rgb"` | `1` | `0.25` |
| Kangaroo-v4 | `"rgb"` | `(2, 5)` | `0.0` |
| Kangaroo-ram-v4 | `"ram"` | `(2, 5)` | `0.0` |
| Kangaroo-ramDeterministic-v4 | `"ram"` | `4` | `0.0` |
| Kangaroo-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` |
| KangarooDeterministic-v4 | `"rgb"` | `4` | `0.0` |
| KangarooNoFrameskip-v4 | `"rgb"` | `1` | `0.0` |
| ALE/Kangaroo-v5 | `"rgb"` | `4` | `0.25` |
| ALE/Kangaroo-ram-v5 | `"ram"` | `4` | `0.25` |
## Difficulty and modes
2022-09-13 20:27:34 +01:00
2022-12-04 22:24:02 +08:00
It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode` .
2023-02-15 01:30:47 +00:00
A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values
along with the default values.
2022-09-13 20:27:34 +01:00
2023-02-15 01:30:47 +00:00
| Available Modes | Default Mode | Available Difficulties | Default Difficulty |
|-------------------|----------------|--------------------------|----------------------|
| `[0, 1]` | `0` | `[0]` | `0` |
2022-09-13 20:27:34 +01:00
2022-10-12 15:58:01 +01:00
## Version History
2022-12-04 22:24:02 +08:00
2023-02-15 01:30:47 +00:00
A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments.
2022-09-13 20:27:34 +01:00
2024-06-29 10:57:22 +01:00
* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace.
2022-09-13 20:27:34 +01:00
* v4: Stickiness of actions was removed
2023-02-15 01:30:47 +00:00
* v0: Initial versions release
