Skip to main content

OpenAI Gym Environment for 2048 extended functionality

Project description

https://badge.fury.io/py/gym-2048-extended.svg

This package implements the classic grid game 2048 for OpenAI gym environment.

Summarizing my changes to the repo Activated Geek Gym 2048:

  • changed the requirements.txt to be more flexible

  • added the method is_action_possible

  • added different reward schemes

  • added the render mode dict

  • added game.py a PyGame that uses the GymEnvironment from this repo

Install

Pip

pip install gym-2048-extended

From cloned repository

python setup.py install

Environment(s)

The package currently contains two environments

  • Tiny2048-v0: A 2 x 2 grid game.

  • 2048-v0: The standard 4 x 4 grid game.

I only checked the 4 x 4 grid game, the other one might not work.

Attributes

  • Observation: All observations are n x n numpy arrays representing the grid. The array is 0 for empty locations and numbered 2, 4, 8, ... wherever the tiles are placed.

  • Actions: There are four actions defined by integers.
    • LEFT = 0

    • UP = 1

    • RIGHT = 2

    • DOWN = 3

  • Reward: Reward is the total score obtained by merging any potential tiles for a given action. Score obtained by merging two tiles is simply the sum of values of those two tiles.

Rendering

Currently 2 rendering modes are implemented

  • basic print rendering (mode='human')

  • dict rendering (mode='dict') returns a dictionary with the board state

Usage

PyGame Interactive Demo

game.py provides a PyGame implementation of the game. Use the arrow keys to play, q and n can be used to quit the game or restart it.

The game serves as a demo, the different reward schemes and step function can be explored.

python gym_2048/game.py
pygame.png

Basic Demo

Here is a sample rollout of the game which follows the same API as OpenAI gym.Env.

import gym_2048
import gym


if __name__ == '__main__':
  env = gym.make('2048-extended-v1')
  env.seed(42)

  env.reset()
  env.render()

  done = False
  moves = 0
  while not done:
    action = env.np_random.choice(range(4), 1).item()
    next_state, reward, done, info = env.step(action)
    moves += 1

    print('Next Action: "{}"\n\nReward: {}'.format(
      gym_2048.Base2048Env.ACTION_STRING[action], reward))
    env.render()

  print('\nTotal Moves: {}'.format(moves))

NOTE: Top level import gym_2048 is needed to ensure registration with Gym.

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

gym-2048-extended-1.7.tar.gz (81.9 kB view details)

Uploaded Source

Built Distribution

gym_2048_extended-1.7-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file gym-2048-extended-1.7.tar.gz.

File metadata

  • Download URL: gym-2048-extended-1.7.tar.gz
  • Upload date:
  • Size: 81.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for gym-2048-extended-1.7.tar.gz
Algorithm Hash digest
SHA256 341ab75007a904dc7d97834320ebf1c2dce2453d15c7cf2a8f7109ed644c2c2c
MD5 a2a07cae0dc467b92b12ff22ba8b8450
BLAKE2b-256 850dc85eef03e880bb18844ffad4a0eb54391c33f5fb8250c4830bdea864fbb8

See more details on using hashes here.

File details

Details for the file gym_2048_extended-1.7-py3-none-any.whl.

File metadata

File hashes

Hashes for gym_2048_extended-1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 e7942a8fc9b2518ef706815a150dd8212ac9b2e1712a51f582bbcc178731284a
MD5 07b2c513df81bfd06e04e3ca1dd448d5
BLAKE2b-256 3a5383b05d2e811c3add6e4bd2d3091b375cee7f75e289f1963aa7ba6ce54346

See more details on using hashes here.

Supported by

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