Skip to main content

Pickomino (Heckmeck) Gymnasium environment

Project description

Pickomino-Env

PyPI version Python 3.8-3.12 Ruff pre-commit Type hints: Pyright License: MIT Gymnasium Code style: black pydocstyle Code complexity: radon Complexity: xenon Pylint Type hints: mypy pytest: 95%+ coverage

Description

An environment conforming to the Gymnasium API for the dice game Pickomino (Heckmeck am Bratwurmeck) Goal: train a Reinforcement Learning agent for optimal play. Meaning, decide which face of the dice to collect, when to roll and when to stop.

Action Space

The Action space is a tuple with two integers. Tuple (int, int)

Action = [dice_face (0-5), action_type (0=roll, 1=stop)].

  • 0-5: Face of the dice, which you want to take, where:

    • 0 -> face 1
    • 1 -> face 2
    • 2 -> face 3
    • 3 -> face 4
    • 4 -> face 5
    • 5 -> face worm
  • 0-1: Roll (0) or stop (1).

Observation Space

The observation is a dict with shape (4,) with the values corresponding to the following: dice, table and player.

Observation Min Max Shape
dice_collected 0 8 (6,)
dice_rolled 0 8 (6,)
tiles_table 0 1 (16,)
tile_players 0 36 number_of_players

Note: There are eight dice to roll and collect. A die has six sides with the number of eyes one through five, but a worm instead of a six. The values correspond to the number of eyes, with the worm also having the value five (and not six!). The 16 tiles are numbered 21 to 36 and have worm values from one to four in spread in four groups. The game is for two to seven players. Here your Reinforcement Learning Agent is the first player. The other players are computer bots. The bots play, according to a heuristic. When you create the environment, you have to define the number of bots.

For a more detailed description of the rules, see the file pickomino-rulebook.pdf. You can play the game online here: https://www.maartenpoirot.com/pickomino/. The heuristic used by the bots is described here: https://frozenfractal.com/blog/2015/5/3/how-to-win-at-pickomino/.

Rewards

The goal is to collect tiles in a stack. The winner is the player, which at the end of the game has the most worms on her tiles. For the Reinforcement Learning Agent a reward equal to the value (worms) of a tile is given when the tile is picked. For a failed attempt (see rulebook), a corresponding negative reward is given. When a bot steals your tile, no negative reward is given. Hence, the total reward at the end of the game can be greater than the score.

Starting State

  • dice_collected = [0, 0, 0, 0, 0, 0].
  • dice_rolled = [3, 0, 1, 2, 0, 2] Random dice, sum = 8.
  • tiles_table = [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1].
  • tile_players = [0, 0, 0] (with number_of_bots = 2).

Episode End

The episode ends if one of the following occurs:

  1. Termination: If there are no more tiles to take on the table = Game Over.
  2. Termination: Action out of allowed range [0–5, 0-1].

Truncation

Truncation: Attempt to break the rules, the game continues, and you have to give a new valid action.

Failed Attempt

Note that a Failed Attempt means: If a tile is present, put it back on the table and get a negative reward. However, the game continues, so the Episode does not end.

Arguments

These must be specified.

Parameter Type Default Description
number_of_bots int -- Number of bot opponents (1-6) you want to play against
render_mode str or None None Visualization mode:
None (training),
"human" (display), or "rgb_array" (recording)

Setup

pip install pickomino-env

Usage example

import gymnasium as gym

# Create environment
env = gym.make("Pickomino-v0", render_mode="human", number_of_bots=2)

# Reset and get initial observation
obs, info = env.reset(seed=42)

# Run one episode
terminated = False
truncated = False
total_reward = 0

while not terminated and not truncated:
    # Agent selects action: (dice_face, roll_choice)
    action = env.action_space.sample()  # Random action for demo

    # Step environment
    obs, reward, terminated, truncated, info = env.step(action)
    total_reward += reward

    if truncated:
        print(f"Invalid action: {info['explanation']}")
        break

print(f"Episode finished. Total reward: {total_reward}")
env.close()

Resources

License

MIT License. See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pickomino_env-1.1.1.tar.gz (23.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pickomino_env-1.1.1-py3-none-any.whl (24.1 kB view details)

Uploaded Python 3

File details

Details for the file pickomino_env-1.1.1.tar.gz.

File metadata

  • Download URL: pickomino_env-1.1.1.tar.gz
  • Upload date:
  • Size: 23.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pickomino_env-1.1.1.tar.gz
Algorithm Hash digest
SHA256 8890e82b720ed243f8acc56dd5b6814e27034d9b3e61a23950b871693544621f
MD5 0ad5fcfed3ab094c7d27d4dbc80ac4fc
BLAKE2b-256 abb1c516d7bcb34b107e4653a4b52bd3c36ff0c5ea4334a0434bf346998f8927

See more details on using hashes here.

Provenance

The following attestation bundles were made for pickomino_env-1.1.1.tar.gz:

Publisher: python-publish.yml on smallgig/Pickomino

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pickomino_env-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: pickomino_env-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 24.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pickomino_env-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 de50c7cf300cb7da1e6a2d5b11b8fe85726ae7bed92da58413b312d880399b28
MD5 0e46b7724f06da2ce85827a26c516f09
BLAKE2b-256 8ad253d0bec95c8a4c874563a019dae0bc2ab8c6851c4fdc8e3f4105cfebe61a

See more details on using hashes here.

Provenance

The following attestation bundles were made for pickomino_env-1.1.1-py3-none-any.whl:

Publisher: python-publish.yml on smallgig/Pickomino

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page