Skip to main content

A gym-esque environment for Super Smash Bros. Melee.

Project description

melee-env

melee-env wraps the fantastic libmelee as a more gym-esque environment with less boilerplate and setup. Additionally, melee-env provides a convenient and highly flexible framework for creating your own agents. For more information on these topics and melee-env, see the README in the agents folder.

Code example:

from melee import enums
from melee_env.env import MeleeEnv
from melee_env.agents.basic import *
import argparse

players = [Rest(), NOOP(enums.Character.FOX)]

env = MeleeEnv('path/to/iso', players, fast_forward=True)

episodes = 10; reward = 0
env.start()

for episode in range(episodes):
    gamestate, done = env.setup(enums.Stage.BATTLEFIELD)
    while not done:
        for i in range(len(players)):
            players[i].act(gamestate)
        gamestate, done = env.step()

Video Demonstration

IClick me!

This library has been designed with flexibility in mind. The action space, observation space, and the agents are completely modular, and there are only a few requirements to build your own.

Note

This library requires Slippi, which in turn requires an SSBM 1.02 NTSC/PAL ISO. This library does not and will not distribute this. You must acquire this on your own!

Installation

Install from pip: pip install melee-env. Test by running agents_example.py --iso=/path/to/your/iso

Platform support

  • Linux
  • Windows

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

melee-env-0.30.0.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

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

melee_env-0.30.0-py3-none-any.whl (15.3 kB view details)

Uploaded Python 3

File details

Details for the file melee-env-0.30.0.tar.gz.

File metadata

  • Download URL: melee-env-0.30.0.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for melee-env-0.30.0.tar.gz
Algorithm Hash digest
SHA256 ebbfc0901985de0f1cb77703a5e237e512de032aedaeac7581412b9965c74192
MD5 c179217734e7b9b173b6dbcc2e263d9d
BLAKE2b-256 f24e0a5c1aec923c50fbe59074fb3adafc7755cb0e514eaa8216b46e1ecb8daa

See more details on using hashes here.

File details

Details for the file melee_env-0.30.0-py3-none-any.whl.

File metadata

  • Download URL: melee_env-0.30.0-py3-none-any.whl
  • Upload date:
  • Size: 15.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for melee_env-0.30.0-py3-none-any.whl
Algorithm Hash digest
SHA256 22165417e5e90cf8a32a26514aee69b9fb9dc4770b9bee0a9cb7e7b8db0dab5b
MD5 83569ce9d506cb7868cc40a52ed900c1
BLAKE2b-256 76cf951073766c680d0697dab645d872d1803876e390128eae856eea1fde04be

See more details on using hashes here.

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