diff --git a/.buildinfo b/.buildinfo index d6b37c4ce..18faef3ad 100644 --- a/.buildinfo +++ b/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 0db2548a5db6e4d02e0446f6b454798b +config: e3d576cf4db1f735de1c66feb9612cb6 tags: d77d1c0d9ca2f4c8421862c7c5a0d620 diff --git a/404.html b/404.html index 56c04f69d..b4cbe16ef 100644 --- a/404.html +++ b/404.html @@ -220,8 +220,8 @@

Development

@@ -278,7 +278,7 @@
-
+

404 - Page Not Found#

The requested page could not be found.#

diff --git a/README/index.html b/README/index.html index 65a5313b4..980ca6588 100644 --- a/README/index.html +++ b/README/index.html @@ -220,8 +220,8 @@

Development

@@ -278,7 +278,7 @@
-
+

Stable-retro docs#

This folder contains the documentation for StableRetro.

If you are modifying an atari environment page, please follow the instructions below. For more information about how to contribute to the documentation go to our CONTRIBUTING.md

diff --git a/_images/stable-retro-text.png b/_images/stable-retro-text.png index 5f718258a..6657f2270 100644 Binary files a/_images/stable-retro-text.png and b/_images/stable-retro-text.png differ diff --git a/_modules/index.html b/_modules/index.html index 857b58f8b..e5dd683f2 100644 --- a/_modules/index.html +++ b/_modules/index.html @@ -219,8 +219,8 @@

Development

diff --git a/_modules/retro/enums/index.html b/_modules/retro/enums/index.html index 841cd6514..1ec9a1d06 100644 --- a/_modules/retro/enums/index.html +++ b/_modules/retro/enums/index.html @@ -219,8 +219,8 @@

Development

diff --git a/_modules/retro/index.html b/_modules/retro/index.html index 06024eaf3..9236d6a3d 100644 --- a/_modules/retro/index.html +++ b/_modules/retro/index.html @@ -219,8 +219,8 @@

Development

@@ -270,6 +270,7 @@

Source code for retro

 import os
+import sys
 
 import retro.data
 from retro._retro import Movie, RetroEmulator, core_path
@@ -335,6 +336,16 @@ 
Source code for retro
             )
     return RetroEnv(game, state, inttype=inttype, **kwargs)

 
+
+
+try:
+    from farama_notifications import notifications
+
+    if "stable-retro" in notifications and __version__ in notifications["stable-retro"]:
+        print(notifications["stable-retro"][__version__], file=sys.stderr)
+
+except Exception:  # nosec
+    pass
diff --git a/_modules/retro/retro_env/index.html b/_modules/retro/retro_env/index.html index 6d92b75e4..7f0f0ba6c 100644 --- a/_modules/retro/retro_env/index.html +++ b/_modules/retro/retro_env/index.html @@ -219,8 +219,8 @@

Development

@@ -543,6 +543,9 @@

Source code for retro.retro_env

             return actions[0]
         return actions
 
+    def set_value(self, name, val):
+        self.data.set_value(name, val)
+
     def get_ram(self):
         blocks = []
         for offset in sorted(self.data.memory.blocks):
diff --git a/_static/img/stable-retro-text.png b/_static/img/stable-retro-text.png
index 5f718258a..6657f2270 100644
Binary files a/_static/img/stable-retro-text.png and b/_static/img/stable-retro-text.png differ
diff --git a/_static/img/stable_retro_black.svg b/_static/img/stable_retro_black.svg
new file mode 100644
index 000000000..0371352e9
--- /dev/null
+++ b/_static/img/stable_retro_black.svg
@@ -0,0 +1,12 @@
+
+
+
+CopyRight:SVG Design Editor;
+configurationStart;Unit=smInches;Dpi=96;Division=4;Grid=True;Zoom=1;CanvasW=975.4118;CanvasH=887.1533;configurationEnd;
+
+
+
+
+SR
+
+
diff --git a/_static/img/stable_retro_white.svg b/_static/img/stable_retro_white.svg
new file mode 100644
index 000000000..1d8091b90
--- /dev/null
+++ b/_static/img/stable_retro_white.svg
@@ -0,0 +1,12 @@
+
+
+
+CopyRight:SVG Design Editor;
+configurationStart;Unit=smInches;Dpi=96;Division=4;Grid=True;Zoom=1;CanvasW=975.4118;CanvasH=887.1533;configurationEnd;
+
+
+
+
+SR
+
+
diff --git a/developing/index.html b/developing/index.html
index 5907341f3..dea7dd66e 100644
--- a/developing/index.html
+++ b/developing/index.html
@@ -220,8 +220,8 @@
 
Development
@@ -278,7 +278,7 @@
-
+

Development#

Adding new games can be done without recompiling Stable Retro, but if you need to work on the C++ code or make changes to the UI, you will want to compile Stable Retro from source.

diff --git a/genindex/index.html b/genindex/index.html index b3b280c52..454a081b2 100644 --- a/genindex/index.html +++ b/genindex/index.html @@ -218,8 +218,8 @@

Development

diff --git a/getting_started/index.html b/getting_started/index.html index df1f6a0c0..8df87ed9b 100644 --- a/getting_started/index.html +++ b/getting_started/index.html @@ -220,8 +220,8 @@

Development

@@ -278,7 +278,7 @@
-
+

Getting Started#

Stable Retro requires one of the supported versions of Python (3,6 to 3.10). Please make sure to install the appropriate distribution for your OS beforehand. Please note that due to compatibility issues with some of the cores, 32-bit operating systems are not supported.

pip3 install stable-retro
@@ -317,9 +317,10 @@ 
Random Agentenv = retro.make(game="Airstriker-Genesis")
     env.reset()
     while True:
-        obs, rew, done, info = env.step(env.action_space.sample())
+        action = env.action_space.sample()
+        observation, reward, terminated, truncated, info = env.step(action)
         env.render()
-        if done:
+        if terminated or truncated:
             env.reset()
     env.close()
 
@@ -345,7 +346,7 @@ 
Brute#<
 

 
PPO#

 
Using “Proximal Policy Optimization” by Schulman et al., you can train an agent to play many of the games, though it takes awhile and is much faster with a GPU.

-
This example requires installing OpenAI Baselines.  Once installed, you can run it:

+
This example requires installing Stable Baselines.  Once installed, you can run it:

 
python3 -m retro.examples.ppo --game Airstriker-Genesis
 

 

diff --git a/index.html b/index.html
index 9a91cfc67..e85b9e7be 100644
--- a/index.html
+++ b/index.html
@@ -220,8 +220,8 @@
 
Development
diff --git a/integration/index.html b/integration/index.html index ef925d657..f0f633f03 100644 --- a/integration/index.html +++ b/integration/index.html @@ -220,8 +220,8 @@

Development

@@ -278,7 +278,7 @@
-
+

Game Integration#

Integrating a game means taking a video game ROM file and setting it up as a reinforcement learning environment by defining 3 things:

    diff --git a/python/index.html b/python/index.html index ecd9d47e0..f3eb6f7da 100644 --- a/python/index.html +++ b/python/index.html @@ -220,8 +220,8 @@

    Development

    @@ -278,7 +278,7 @@
    -
    +

    Python API#

    RetroEnv#

    diff --git a/release_notes/index.html b/release_notes/index.html index 65d79ce4d..edd1be513 100644 --- a/release_notes/index.html +++ b/release_notes/index.html @@ -220,8 +220,8 @@

    Development

    @@ -278,8 +278,12 @@
    -
    +

    Release Notes#

    +
    +

    stable-retro v0.9.3#

    +

    Released on 2024-01-12 - GitHub

    +

    stable-retro v0.9.2#

    Released on 2023-10-16 - GitHub

    @@ -458,6 +462,7 @@

    New Contributors

    diff --git a/searchindex.js b/searchindex.js index 80ac0f238..49adbb783 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["404", "README", "developing", "getting_started", "index", "integration", "python", "release_notes"], "filenames": ["404.md", "README.md", "developing.md", "getting_started.md", "index.md", "integration.md", "python.md", "release_notes.md"], "titles": ["404 - Page Not Found", "Stable-retro docs", "Development", "Getting Started", "<no title>", "Game Integration", "Python API", "Release Notes"], "terms": {"thi": [1, 2, 3, 5, 6], "folder": [1, 5], "contain": [1, 2, 5, 6], "stableretro": 1, "If": [1, 2, 3, 5, 6], "you": [1, 2, 3, 4, 5, 6], "ar": [1, 3, 5, 6], "an": [1, 3, 4, 5, 6], "atari": [1, 4, 5], "pleas": [1, 3, 5], "follow": [1, 2, 5, 6], "below": [1, 5], "For": [1, 3, 5, 6], "more": [1, 3, 4, 5, 6], "inform": [1, 3, 5], "about": [1, 3, 5, 6], "how": [1, 5, 6], "contribut": [1, 7], "go": [1, 5], "our": 1, "md": [1, 7], "todo": 1, "add": [1, 2, 3, 5, 7], "detail": [1, 5], "instal": [1, 3, 6, 7], "requir": [1, 2, 3, 5, 6], "packag": [1, 2, 5], "your": [1, 2, 3, 5, 6], "fork": [1, 4], "pip": [1, 2, 7], "r": [1, 5], "txt": [1, 7], "To": [1, 2, 3, 5, 6], "onc": [1, 2, 3, 5], "cd": [1, 2, 7], "make": [1, 2, 3, 4, 5, 6], "dirhtml": 1, "rebuild": 1, "automat": 1, "everi": [1, 5], "time": [1, 5, 6], "chang": [1, 2, 3, 5, 7], "i": [1, 2, 3, 4, 5, 6], "made": [1, 6, 7], "sphinx": 1, "autobuild": 1, "b": 1, "_build": 1, "ad": [2, 5, 7], "new": [2, 3, 4, 7], "game": [2, 3, 4, 6], "can": [2, 3, 5, 6], "done": [2, 3, 6], "without": [2, 5], "recompil": 2, "stabl": [2, 3, 4, 5, 6], "need": [2, 5], "work": [2, 3, 5], "c": [2, 3, 7], "code": [2, 3, 5, 7], "want": [2, 3, 5, 6], "compil": [2, 5, 7], "least": 2, "either": [2, 5, 6], "gcc": 2, "5": [2, 5, 7], "clang": 2, "3": [2, 3, 4, 5, 6, 7], "4": [2, 4, 5], "must": [2, 3], "first": [2, 4, 5, 7], "cmake": 2, "do": [2, 3, 5], "through": [2, 5], "manag": 2, "download": [2, 5], "offici": 2, "site": 2, "pip3": [2, 3], "re": [2, 5], "us": [2, 3, 4, 6, 7], "sure": [2, 3, 5], "tell": [2, 5], "itself": [2, 5], "system": [2, 3, 5], "path": [2, 3, 5], "sinc": [2, 5], "luajit": 2, "doe": [2, 5], "properli": [2, 3, 5], "lua": [2, 5], "1": [2, 3, 4, 5, 6], "homebrew": 2, "brew": 2, "pkg": 2, "config": [2, 4], "docker": [2, 7], "sudo": 2, "apt": 2, "get": [2, 5], "zlib1g": 2, "dev": 2, "git": [2, 7], "clone": 2, "http": 2, "github": [2, 3, 5, 7], "com": 2, "farama": [2, 7], "foundat": 2, "e": [2, 5], "run": [2, 3, 5], "build_window": 2, "bat": 2, "complet": [2, 5], "cp": 2, "copi": [2, 3, 5, 7], "whl": 2, "file": [2, 3, 7], "out": [2, 3, 5], "Then": [2, 5], "mai": [2, 5, 6], "after": [2, 3, 4, 5, 6], "instruct": 2, "platform": [2, 5], "note": [2, 3, 5], "mojav": 2, "10": [2, 3, 5, 7], "14": [2, 7], "librari": [2, 4], "commandlinetool": 2, "macos_sdk_headers_for_macos_10": 2, "capnp": 2, "qt5": 2, "dcmake_prefix_path": 2, "usr": 2, "local": [2, 5], "opt": 2, "qt": 2, "dbuild_ui": 2, "ON": 2, "upylib_directori": 2, "j": 2, "sysctl": 2, "hw": 2, "ncpu": 2, "cut": 2, "d": [2, 5], "f2": 2, "open": [2, 5], "gym": [2, 4, 6], "integr": [2, 6, 7], "app": 2, "capnproto": 2, "libcapnp": 2, "libqt5opengl5": 2, "qtbase5": 2, "grep": 2, "processor": 2, "proc": 2, "cpuinfo": 2, "The": [2, 3, 6], "current": [2, 3, 5], "support": [2, 3, 4, 6, 7], "nativ": [2, 5], "easili": [2, 5], "via": [2, 7], "wsl2": 2, "subsystem": 2, "abov": [2, 5], "within": [2, 5], "just": 2, "launch": 2, "binari": [2, 5], "like": [2, 3, 5], "would": [2, 5], "one": [3, 5], "version": [3, 5, 7], "python": 3, "6": [3, 5, 7], "appropri": [3, 5], "distribut": 3, "o": [3, 5], "beforehand": 3, "due": 3, "compat": 3, "issu": [3, 5], "some": [3, 5, 7], "core": [3, 7], "32": [3, 4, 5, 7], "bit": [3, 5], "oper": 3, "see": [3, 5, 6], "section": [3, 5, 6], "develop": 3, "build": [3, 7], "yourself": 3, "onli": [3, 5, 6], "now": [3, 6], "gymnasium": [3, 4, 5, 7], "env": [3, 4, 5, 6], "airstrik": [3, 4, 5, 6], "genesi": [3, 4, 5, 6], "ha": [3, 5], "non": [3, 5], "commerci": 3, "includ": [3, 4, 5, 6], "default": [3, 4, 5, 6, 7], "other": [3, 5], "obtain": 3, "them": [3, 5], "most": [3, 5, 6], "hash": [3, 5], "sourc": [3, 5, 6], "from": [3, 4, 6, 7], "respect": 3, "No": 3, "intro": 3, "sha": 3, "sum": [3, 5], "primarili": [3, 6], "mean": [3, 5], "train": [3, 4, 6], "rl": 3, "classic": [3, 4, 6], "video": [3, 4, 5], "though": [3, 5], "also": [3, 5, 6], "control": [3, 5, 6], "those": [3, 5], "here": [3, 4, 5, 6], "wai": [3, 5], "There": [3, 5, 6], "let": [3, 4, 5], "interfac": [3, 6], "python3": [3, 6], "m": [3, 6], "arrow": 3, "kei": [3, 5, 6], "x": 3, "ship": 3, "fire": [3, 5], "try": [3, 5], "api": [3, 5], "quit": 3, "basic": [3, 5], "advanc": [3, 5], "tool": [3, 7], "check": [3, 5, 7], "ui": [3, 6], "A": [3, 5, 6], "choos": 3, "action": [3, 4, 5], "each": [3, 5, 6], "timestep": 3, "look": [3, 5], "much": [3, 5, 6], "def": [3, 4, 5, 6], "main": [3, 4, 5, 6], "reset": [3, 4, 6], "while": [3, 5, 6], "true": [3, 6], "ob": [3, 4, 6], "rew": [3, 4, 6], "info": [3, 4, 5, 6], "step": [3, 4, 5, 6], "action_spac": [3, 6], "sampl": [3, 6], "render": 3, "close": [3, 6], "__name__": [3, 4, 5, 6], "__main__": [3, 4, 5, 6], "full": [3, 4, 5, 6, 7], "featur": [3, 6], "avail": [3, 5, 6], "dir": 3, "random_ag": 3, "It": [3, 5], "print": [3, 5], "reward": [3, 7], "exit": 3, "when": [3, 5, 7], "scenario": [3, 4, 6], "throw": 3, "except": [3, 5], "data": [3, 6, 7], "defin": [3, 5, 6], "set": [3, 5, 6], "up": [3, 5], "function": [3, 6], "isn": 3, "t": [3, 5], "too": [3, 5], "gener": 3, "simpl": [3, 5], "effect": [3, 5], "reinforc": [3, 4, 5], "learn": [3, 4, 5], "algorithm": [3, 5], "call": [3, 5], "revisit": 3, "arcad": 3, "machado": 3, "et": 3, "al": 3, "which": [3, 5, 6], "determinist": [3, 6], "easi": [3, 5], "implement": 3, "sequenc": 3, "button": [3, 5, 6], "press": [3, 6], "well": [3, 5, 6], "doesn": [3, 5], "screen": [3, 5, 6], "all": [3, 5, 6], "best": [3, 5], "seen": 3, "so": [3, 5, 6], "far": 3, "proxim": [3, 4], "polici": [3, 4], "optim": [3, 4], "schulman": 3, "plai": [3, 5, 6], "mani": [3, 5], "take": [3, 5], "awhil": [3, 5], "faster": 3, "gpu": 3, "openai": [3, 4, 7], "baselin": [3, 4], "progress": [3, 5], "goe": [3, 5], "found": [3, 5], "spin": 3, "what": [3, 5, 7], "have": [3, 5, 6], "alreadi": 3, "been": [3, 5], "displai": [3, 5], "even": 3, "ones": 3, "miss": 3, "list_gam": [3, 5], "actual": [3, 5], "repo": 3, "correct": [3, 5], "comput": [3, 5], "identifi": 3, "directori": [3, 5, 6], "match": [3, 5, 7], "correspond": [3, 5], "type": 3, "list": [3, 4, 5, 6], "should": [3, 5], "collect": 3, "archiv": 3, "org": 3, "search": [3, 5], "insid": [3, 5], "zip": 3, "retro": [4, 5, 6], "maintain": 4, "": [4, 5, 6, 7], "turn": 4, "environ": [4, 5], "plateform": 4, "sega": [4, 5, 7], "32x": [4, 7], "super": [4, 5], "nintendo": [4, 5], "2600": [4, 5], "agent": [4, 5, 6], "import": [4, 5, 6], "argpars": 4, "numpi": 4, "np": 4, "wrapper": [4, 6], "time_limit": 4, "timelimit": 4, "stable_baselines3": 4, "ppo": 4, "common": 4, "atari_wrapp": 4, "cliprewardenv": 4, "warpfram": 4, "vec_env": 4, "subprocvecenv": 4, "vecframestack": 4, "vectransposeimag": 4, "class": [4, 6], "stochasticframeskip": 4, "__init__": 4, "self": 4, "n": [4, 5, 6], "stickprob": 4, "curac": 4, "none": [4, 6], "rng": 4, "random": [4, 6], "randomst": 4, "supports_want_rend": 4, "hasattr": 4, "kwarg": [4, 6], "return": [4, 5], "ac": 4, "termin": [4, 6], "fals": [4, 6], "truncat": [4, 6], "totrew": 4, "0": [4, 5, 6, 7], "rang": [4, 6], "substep": 4, "delai": 4, "probabl": [4, 5], "elif": 4, "rand": 4, "second": 4, "definit": 4, "kick": 4, "want_rend": 4, "els": 4, "break": [4, 6], "make_retro": 4, "state": [4, 6], "max_episode_step": 4, "4500": 4, "25": [4, 7], "wrap_deepmind_retro": 4, "configur": 4, "similar": [4, 5], "deepmind": 4, "style": [4, 7], "wrap_deepmind": 4, "parser": 4, "argumentpars": 4, "add_argu": 4, "arg": 4, "parse_arg": 4, "make_env": 4, "venv": 4, "8": [4, 5, 6], "n_stack": 4, "model": 4, "cnnpolici": 4, "learning_r": 4, "lambda": 4, "f": 4, "2": [4, 5, 6], "5e": 4, "n_step": 4, "128": [4, 5], "batch_siz": 4, "n_epoch": 4, "gamma": 4, "99": 4, "gae_lambda": 4, "95": 4, "clip_rang": 4, "ent_coef": 4, "01": 4, "verbos": 4, "total_timestep": 4, "100_000_000": 4, "log_interv": 4, "thing": 5, "start": [5, 6], "abl": 5, "ll": 5, "savest": [5, 6], "begin": 5, "restart": [5, 6], "put": 5, "point": 5, "relat": 5, "base": 5, "memori": [5, 6], "address": 5, "gameov": 5, "16712294": 5, "u2": 5, "live": 5, "16712282": 5, "score": 5, "16712270": 5, "u4": 5, "op": 5, "equal": 5, "refer": 5, "zero": 5, "specifi": [5, 6], "user": [5, 6], "miscellan": 5, "debug": [5, 7], "default_st": 5, "whitelist": 5, "suspici": 5, "few": [5, 6], "sha1": 5, "c67af162391fff4a63432be5a156eb9ca7b4da5a": 5, "These": 5, "next": 5, "describ": 5, "emul": [5, 6, 7], "allow": [5, 6], "entir": 5, "store": [5, 6], "disk": 5, "restor": 5, "specif": 5, "alwai": 5, "end": 5, "ident": 5, "standalon": 5, "gzip": 5, "inner": 5, "alongsid": 5, "name": [5, 6], "document": 5, "ground": 5, "truth": 5, "format": 5, "manifest": 5, "separ": 5, "although": 5, "entri": 5, "consist": [5, 6], "valu": [5, 6], "ram": [5, 6], "arrai": 5, "byte": 5, "descriptor": 5, "addendum": 5, "show": [5, 6], "wide": 5, "unsign": 5, "big": 5, "endian": 5, "possibl": [5, 6], "pertain": 5, "manual": 5, "overrid": 5, "retroenv": 5, "write": [5, 6], "multipli": 5, "posit": [5, 7], "penalti": 5, "neg": 5, "creat": [5, 6], "similarli": 5, "over": 5, "By": 5, "load": [5, 6], "altern": 5, "constructor": 5, "again": [5, 7], "calcul": 5, "split": 5, "subsect": 5, "coeffici": 5, "extract": 5, "measur": 5, "delta": 5, "pass": [5, 6], "raw": 5, "impli": 5, "addit": [5, 6], "instead": [5, 6], "subtract": 5, "off": 5, "taken": 5, "two": [5, 7], "reach": 5, "At": 5, "top": [5, 6], "level": [5, 6], "properti": 5, "combin": 5, "ani": [5, 6], "fulfil": 5, "per": 5, "absolut": 5, "ignor": 5, "help": 5, "normal": 5, "window": [5, 7], "mac": 5, "howev": 5, "url": 5, "longer": 5, "releas": 5, "command": 5, "shift": 5, "select": 5, "menu": 5, "option": 5, "mode": 5, "charact": 5, "etc": 5, "final": 5, "playabl": 5, "moment": 5, "paus": 5, "p": [5, 6], "save": 5, "hard": 5, "might": 5, "back": [5, 6], "exact": 5, "chose": 5, "previou": 5, "g": 5, "sailormoon": 5, "queenberylscastl": 5, "we": 5, "prefer": 5, "usa": 5, "denot": 5, "europ": 5, "japan": 5, "bin": 5, "extens": [5, 7], "renam": [5, 7], "applic": 5, "uniqu": 5, "given": [5, 6], "known": 5, "mega": 5, "drive": 5, "sfc": 5, "entertain": 5, "famicom": 5, "ne": 5, "a26": 5, "gb": 5, "boi": 5, "gba": 5, "gbc": 5, "color": 5, "gg": 5, "gear": 5, "pce": 5, "nec": 5, "turbografx": 5, "16": [5, 6, 7], "pc": 5, "engin": 5, "sm": 5, "master": 5, "sometim": 5, "differ": [5, 6], "gen": 5, "aforement": 5, "case": [5, 7], "know": 5, "session": 5, "provid": [5, 6], "numer": 5, "goal": 5, "machin": 5, "maxim": 5, "player": [5, 6], "remain": [5, 6], "hit": 5, "instanc": 5, "dy": 5, "modifi": 5, "disallow": 5, "kidchameleon": 5, "usual": 5, "easier": 5, "continu": 5, "left": 5, "pretti": 5, "better": 5, "reliabl": 5, "slightli": 5, "incorrect": 5, "still": 5, "life": 5, "becaus": [5, 6], "detect": 5, "than": [5, 6], "unreli": 5, "present": 5, "incorrectli": 5, "switch": 5, "test": [5, 7], "replai": 5, "multipl": 5, "row": 5, "accident": 5, "ideal": 5, "beat": 5, "besid": 5, "That": 5, "impract": 5, "exist": 5, "unabl": 5, "result": 5, "often": [5, 6], "good": 5, "choic": 5, "In": [5, 6], "stand": 5, "place": 5, "attack": 5, "same": [5, 6], "enemi": 5, "respawn": 5, "veri": 5, "Be": 5, "care": 5, "thei": [5, 6], "tricki": 5, "right": 5, "sens": 5, "receiv": 5, "factor": 5, "100": 5, "compar": 5, "cumul": 5, "pane": 5, "keep": 5, "pattern": 5, "tip": 5, "group": 5, "themselv": 5, "togeth": 5, "narrow": 5, "down": 5, "particular": 5, "nearbi": 5, "suspect": 5, "high": 5, "occasion": 5, "individu": 5, "123400": 5, "updat": [5, 7], "broken": [5, 7], "digit": 5, "bob": 5, "sne": 5, "number": [5, 6], "across": 5, "frame": 5, "script": [5, 6], "1942": 5, "uncommon": 5, "length": 5, "don": 5, "nice": 5, "neat": 5, "short": 5, "certain": 5, "track": 5, "long": 5, "suddenli": 5, "jump": 5, "between": 5, "decid": 5, "shorter": 5, "safer": 5, "bet": 5, "sai": 5, "2400": 5, "24": 5, "transpos": 5, "123456": 5, "012345": 5, "rather": 5, "fix": [5, 7], "health": 5, "symbol": 5, "bar": 5, "could": 5, "repres": 5, "9999999": 5, "becom": 5, "99999": 5, "lose": 5, "unit": 5, "And": 5, "consecut": 5, "ve": 5, "avoid": 5, "later": [5, 6], "One": 5, "correctli": 5, "d2": 5, "d4": 5, "maximum": 5, "9999": 5, "increas": 5, "viewer": 5, "10000": 5, "wrong": 5, "d3": 5, "999999": 5, "watch": 5, "increment": 5, "decrement": 5, "255": 5, "sign": 5, "u": 5, "appear": [5, 6], "16769105": 5, "i2": 5, "littl": 5, "notic": 5, "uneven": 5, "unusu": 5, "eg": 5, "u1": 5, "7e094d": 5, "144": 5, "137": 5, "d1": 5, "90": 5, "89": 5, "higher": 5, "reveal": 5, "didn": 5, "origin": 5, "until": 5, "someth": 5, "give": 5, "larg": 5, "die": 5, "upon": 5, "unless": 5, "befor": 5, "happen": 5, "forgot": 5, "upper": 5, "lower": 5, "kill": 5, "bug": [5, 7], "diverg": 5, "guardianlegend": 5, "custom_integr": 5, "structur": 5, "depend": 5, "addamsfamili": 5, "atari2600": [5, 6, 7], "adventur": 5, "gameboi": 5, "aerostar": 5, "gbadvanc": 5, "mariokart": 5, "gbcolor": 5, "pokemonpinbal": 5, "gamegear": 5, "mortalkombat": 5, "pcengin": 5, "soldierblad": 5, "add_custom_path": 5, "script_dir": 5, "dirnam": 5, "abspath": 5, "__file__": 5, "join": 5, "fakegam": 5, "inttyp": [5, 6], "directli": [5, 6], "three": 5, "part": 5, "order": 5, "hex": 5, "string": [5, 6], "0x01020304": 5, "0x01": 5, "0x02": 5, "0x03": 5, "0x04": 5, "middl": 5, "outsid": 5, "sigil": 5, "singl": 5, "nb": 5, "rare": 5, "plu": 5, "gx": 5, "thu": 5, "aka": 5, "As": 5, "groom": 5, "0x81": 5, "decim": 5, "129": 5, "127": 5, "81": 5, "low": 5, "nybbl": 5, "0xa": 5, "0xf": 5, "cannot": 5, "occur": 5, "last": 5, "piec": 5, "occupi": 5, "power": [5, 6], "mario": 5, "bro": 5, "size": 5, "less": 5, "0x0102": 5, "four": 5, "1234": 5, "0x12": 5, "0x34": 5, "u3": 5, "0x010203": 5, "0x1": 5, "n2": 5, "12": [5, 7], "intel": 5, "arm": 5, "cpu": 5, "powerpc": 5, "valid": 5, "recommend": 5, "undefin": 5, "invalid": 5, "q2": 5, "i0": 5, "variou": 5, "vari": 5, "form": 5, "premis": 5, "transform": 5, "furthermor": 5, "method": 5, "context": 5, "appli": 5, "nonzero": 5, "otherwis": 5, "greater": 5, "enum": 6, "use_restricted_act": 6, "filter": 6, "obs_typ": 6, "imag": 6, "render_mod": 6, "human": 6, "metadata": 6, "json": [6, 7], "initi": 6, "consol": 6, "special": 6, "space": 6, "multibinari": 6, "discret": 6, "multi_discret": 6, "multidiscet": 6, "own": 6, "deriv": 6, "exampl": [6, 7], "py": [6, 7], "custom": 6, "reduc": 6, "126": 6, "7": [6, 7], "rgb": 6, "view": 6, "smaller": 6, "variabl": 6, "dict": 6, "where": 6, "small": 6, "both": 6, "paddl": 6, "pong": [6, 7], "bottom": 6, "half": 6, "player_1_rew": 6, "player_2_rew": 6, "bk2": 6, "seri": 6, "output": 6, "1000": 6, "wish": 6, "sonic": 6, "hedgehog": 6, "were": 6, "contest": 6, "movi": 6, "gameplai": 6, "process": 6, "_": 6, "level1": 6, "000000": 6, "get_gam": 6, "everyth": 6, "initial_st": 6, "get_stat": 6, "num_button": 6, "append": 6, "get_kei": 6, "ffmpeg": 6, "input": 6, "locat": 6, "playback_movi": [6, 7], "2023": 7, "ci": 7, "zbeucler2018": 7, "pseudo": 7, "rnd": 7, "thought": 7, "onaclov2000": 7, "remov": 7, "travi": 7, "setup": 7, "11": 7, "capabl": 7, "15": 7, "readm": 7, "matpoliquin": 7, "17": 7, "gcp": 7, "20": 7, "link": 7, "websit": 7, "23": 7, "doc": 7, "mgoulao": 7, "27": 7, "28": 7, "extra": 7, "18": 7, "duplic": 7, "30": 7, "publish": 7, "linux": 7, "31": 7, "appl": 7, "silicon": 7, "34": 7, "cmakelist": 7, "libzip": 7, "35": 7, "moonpatrol": 7, "36": 7, "pre": 7, "commit": 7, "hook": 7, "victorsevero": 7, "38": 7, "37": 7, "badg": 7, "elliottow": 7, "43": 7, "45": 7, "placehold": 7, "logo": 7, "screenshot": 7, "47": 7, "260": 7, "joohei": 7, "46": 7, "handl": 7, "log": 7, "48": 7, "saturn": 7, "virtua": 7, "fighter": 7, "49": 7, "whitespac": 7, "50": 7, "bump": 7, "setuptool": 7, "40": 7, "65": 7, "build_script": 7, "dependabot": 7, "39": 7, "21": 7, "41": 7, "certifi": 7, "2018": 7, "2022": 7, "42": 7, "wheel": 7, "adapt": 7, "yml": 7, "pettingzoo": 7, "workflow": 7, "51": 7, "52": 7, "54": 7, "53": 7, "mortal": 7, "kombat": 7, "55": 7, "58": 7, "cmd": 7, "line": 7, "59": 7, "disabl": 7, "multi": 7, "retro_env": 7, "61": 7, "misc": 7, "62": 7, "checker": 7, "63": 7, "nhl941on1": 7, "star": 7, "66": 7, "temp": 7, "segment": 7, "fault": 7, "67": 7, "typo": 7, "68": 7, "69": 7, "package_data": 7, "71": 7, "buld": 7, "manylinux": 7, "cibuildwheel": 7, "mwydmuch": 7, "73": 7, "contributor": 7, "changelog": 7, "08": 7}, "objects": {"retro": [[6, 0, 1, "", "Actions"], [6, 0, 1, "", "Observations"], [6, 0, 1, "", "RetroEnv"], [6, 0, 1, "", "State"], [6, 2, 1, "", "make"]], "retro.Actions": [[6, 1, 1, "", "ALL"], [6, 1, 1, "", "DISCRETE"], [6, 1, 1, "", "MULTI_DISCRETE"]], "retro.Observations": [[6, 1, 1, "", "IMAGE"], [6, 1, 1, "", "RAM"]], "retro.State": [[6, 1, 1, "", "DEFAULT"], [6, 1, 1, "", "NONE"]]}, "objtypes": {"0": "py:class", "1": "py:attribute", "2": "py:function"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "attribute", "Python attribute"], "2": ["py", "function", "Python function"]}, "titleterms": {"404": 0, "page": [0, 1], "Not": 0, "found": 0, "The": [0, 5], "request": 0, "could": 0, "stabl": [1, 7], "retro": [1, 2, 3, 7], "doc": 1, "instruct": 1, "modifi": 1, "environ": [1, 3, 6], "build": [1, 2], "document": 1, "develop": 2, "instal": 2, "from": [2, 5], "sourc": 2, "prerequisit": 2, "mac": 2, "window": 2, "linux": 2, "ui": [2, 5], "maco": 2, "get": 3, "start": 3, "creat": 3, "exampl": [3, 5], "usag": 3, "interact": 3, "script": 3, "random": 3, "agent": 3, "brute": 3, "ppo": 3, "integr": [3, 5], "import": 3, "rom": [3, 5], "game": 5, "level1": 5, "state": 5, "data": 5, "json": 5, "scenario": 5, "metadata": 5, "md": 5, "sha": 5, "file": [5, 6], "variabl": 5, "locat": 5, "new": 5, "support": 5, "type": 5, "done": 5, "condit": 5, "reward": 5, "function": 5, "find": 5, "common": 5, "error": 5, "us": 5, "custom": 5, "python": [5, 6], "appendix": 5, "oper": 5, "api": 6, "retroenv": 6, "action": 6, "observ": 6, "multiplay": 6, "replai": 6, "record": 6, "playback": 6, "render": 6, "video": 6, "releas": 7, "note": 7, "v0": 7, "9": 7, "2": 7, "1": 7}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"404 - Page Not Found": [[0, "page-not-found"]], "The requested page could not be found.": [[0, "the-requested-page-could-not-be-found"]], "Stable-retro docs": [[1, "stable-retro-docs"]], "Instructions for modifying environment pages": [[1, "instructions-for-modifying-environment-pages"]], "Build the Documentation": [[1, "build-the-documentation"]], "Development": [[2, "development"]], "Install Retro from source": [[2, "install-retro-from-source"]], "Prerequisites": [[2, "prerequisites"]], "Mac prerequisites": [[2, "mac-prerequisites"]], "Windows prerequisites": [[2, "windows-prerequisites"]], "Linux prerequisites": [[2, "linux-prerequisites"]], "Building Linux and Mac": [[2, "building-linux-and-mac"]], "Building Windows": [[2, "building-windows"]], "Install Retro UI from source": [[2, "install-retro-ui-from-source"]], "macOS": [[2, "macos"]], "Linux": [[2, "linux"]], "Windows": [[2, "windows"]], "Getting Started": [[3, "getting-started"]], "Create a Retro Environment": [[3, "create-a-retro-environment"]], "Example Usage": [[3, "example-usage"]], "Interactive Script": [[3, "interactive-script"]], "Random Agent": [[3, "random-agent"]], "Brute": [[3, "brute"]], "PPO": [[3, "ppo"]], "Integrations": [[3, "integrations"]], "Importing ROMs": [[3, "importing-roms"]], "Game Integration": [[5, "game-integration"]], "Example Integration": [[5, "example-integration"]], "Level1.state": [[5, "level1-state"]], "data.json": [[5, "data-json"]], "scenario.json": [[5, "scenario-json"]], "metadata.json": [[5, "metadata-json"]], "rom.md": [[5, "rom-md"]], "rom.sha": [[5, "rom-sha"]], "Integration Files": [[5, "integration-files"]], "States": [[5, "states"]], "Variable Locations data.json": [[5, "variable-locations-data-json"]], "Scenario scenario.json": [[5, "scenario-scenario-json"]], "The Integration UI": [[5, "the-integration-ui"]], "Integrating a new ROM": [[5, "integrating-a-new-rom"]], "Supported ROM Types": [[5, "supported-rom-types"]], "Integrating a Game": [[5, "integrating-a-game"]], "Done Condition": [[5, "done-condition"]], "Reward Function": [[5, "reward-function"]], "Finding Variables": [[5, "finding-variables"]], "Common Errors": [[5, "common-errors"]], "Using a Custom Integration from Python": [[5, "using-a-custom-integration-from-python"]], "Appendix: Types": [[5, "appendix-types"]], "Appendix: Operations": [[5, "appendix-operations"]], "Python API": [[6, "python-api"]], "RetroEnv": [[6, "retroenv"]], "Actions": [[6, "actions"]], "Observations": [[6, "observations"]], "Multiplayer Environments": [[6, "multiplayer-environments"]], "Replay files": [[6, "replay-files"]], "Record": [[6, "record"]], "Playback": [[6, "playback"]], "Render to Video": [[6, "render-to-video"]], "Release Notes": [[7, "release-notes"]], "stable-retro v0.9.2": [[7, "release-v0-9-2"]], "stable-retro v0.9.1": [[7, "release-v0-9-1"]]}, "indexentries": {"all (retro.actions attribute)": [[6, "retro.Actions.ALL"]], "actions (class in retro)": [[6, "retro.Actions"]], "default (retro.state attribute)": [[6, "retro.State.DEFAULT"]], "discrete (retro.actions attribute)": [[6, "retro.Actions.DISCRETE"]], "image (retro.observations attribute)": [[6, "retro.Observations.IMAGE"]], "multi_discrete (retro.actions attribute)": [[6, "retro.Actions.MULTI_DISCRETE"]], "none (retro.state attribute)": [[6, "retro.State.NONE"]], "observations (class in retro)": [[6, "retro.Observations"]], "ram (retro.observations attribute)": [[6, "retro.Observations.RAM"]], "retroenv (class in retro)": [[6, "retro.RetroEnv"]], "state (class in retro)": [[6, "retro.State"]], "make() (in module retro)": [[6, "retro.make"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["404", "README", "developing", "getting_started", "index", "integration", "python", "release_notes"], "filenames": ["404.md", "README.md", "developing.md", "getting_started.md", "index.md", "integration.md", "python.md", "release_notes.md"], "titles": ["404 - Page Not Found", "Stable-retro docs", "Development", "Getting Started", "<no title>", "Game Integration", "Python API", "Release Notes"], "terms": {"thi": [1, 2, 3, 5, 6], "folder": [1, 5], "contain": [1, 2, 5, 6], "stableretro": 1, "If": [1, 2, 3, 5, 6], "you": [1, 2, 3, 4, 5, 6], "ar": [1, 3, 5, 6], "an": [1, 3, 4, 5, 6], "atari": [1, 4, 5], "pleas": [1, 3, 5], "follow": [1, 2, 5, 6], "below": [1, 5], "For": [1, 3, 5, 6], "more": [1, 3, 4, 5, 6], "inform": [1, 3, 5], "about": [1, 3, 5, 6], "how": [1, 5, 6], "contribut": [1, 7], "go": [1, 5], "our": 1, "md": [1, 7], "todo": 1, "add": [1, 2, 3, 5, 7], "detail": [1, 5], "instal": [1, 3, 6, 7], "requir": [1, 2, 3, 5, 6], "packag": [1, 2, 5], "your": [1, 2, 3, 5, 6], "fork": [1, 4], "pip": [1, 2, 7], "r": [1, 5], "txt": [1, 7], "To": [1, 2, 3, 5, 6], "onc": [1, 2, 3, 5], "cd": [1, 2, 7], "make": [1, 2, 3, 4, 5, 6], "dirhtml": 1, "rebuild": 1, "automat": 1, "everi": [1, 5], "time": [1, 5, 6], "chang": [1, 2, 3, 5, 7], "i": [1, 2, 3, 4, 5, 6], "made": [1, 6, 7], "sphinx": 1, "autobuild": 1, "b": 1, "_build": 1, "ad": [2, 5, 7], "new": [2, 3, 4, 7], "game": [2, 3, 4, 6], "can": [2, 3, 5, 6], "done": [2, 3, 6], "without": [2, 5], "recompil": 2, "stabl": [2, 3, 4, 5, 6], "need": [2, 5], "work": [2, 3, 5], "c": [2, 3, 7], "code": [2, 3, 5, 7], "want": [2, 3, 5, 6], "compil": [2, 5, 7], "least": 2, "either": [2, 5, 6], "gcc": 2, "5": [2, 5, 7], "clang": 2, "3": [2, 3, 4, 5, 6], "4": [2, 4, 5], "must": [2, 3], "first": [2, 4, 5, 7], "cmake": 2, "do": [2, 3, 5], "through": [2, 5], "manag": 2, "download": [2, 5], "offici": 2, "site": 2, "pip3": [2, 3], "re": [2, 5], "us": [2, 3, 4, 6, 7], "sure": [2, 3, 5], "tell": [2, 5], "itself": [2, 5], "system": [2, 3, 5], "path": [2, 3, 5], "sinc": [2, 5], "luajit": 2, "doe": [2, 5], "properli": [2, 3, 5], "lua": [2, 5], "1": [2, 3, 4, 5, 6], "homebrew": 2, "brew": 2, "pkg": 2, "config": [2, 4], "docker": [2, 7], "sudo": 2, "apt": 2, "get": [2, 5], "zlib1g": 2, "dev": 2, "git": [2, 7], "clone": 2, "http": 2, "github": [2, 3, 5, 7], "com": 2, "farama": [2, 7], "foundat": 2, "e": [2, 5], "run": [2, 3, 5], "build_window": 2, "bat": 2, "complet": [2, 5], "cp": 2, "copi": [2, 3, 5, 7], "whl": 2, "file": [2, 3, 7], "out": [2, 3, 5], "Then": [2, 5], "mai": [2, 5, 6], "after": [2, 3, 4, 5, 6], "instruct": 2, "platform": [2, 5], "note": [2, 3, 5], "mojav": 2, "10": [2, 3, 5, 7], "14": [2, 7], "librari": [2, 4], "commandlinetool": 2, "macos_sdk_headers_for_macos_10": 2, "capnp": 2, "qt5": 2, "dcmake_prefix_path": 2, "usr": 2, "local": [2, 5], "opt": 2, "qt": 2, "dbuild_ui": 2, "ON": 2, "upylib_directori": 2, "j": 2, "sysctl": 2, "hw": 2, "ncpu": 2, "cut": 2, "d": [2, 5], "f2": 2, "open": [2, 5], "gym": [2, 4, 6], "integr": [2, 6, 7], "app": 2, "capnproto": 2, "libcapnp": 2, "libqt5opengl5": 2, "qtbase5": 2, "grep": 2, "processor": 2, "proc": 2, "cpuinfo": 2, "The": [2, 3, 6], "current": [2, 3, 5], "support": [2, 3, 4, 6, 7], "nativ": [2, 5], "easili": [2, 5], "via": [2, 7], "wsl2": 2, "subsystem": 2, "abov": [2, 5], "within": [2, 5], "just": 2, "launch": 2, "binari": [2, 5], "like": [2, 3, 5], "would": [2, 5], "one": [3, 5], "version": [3, 5, 7], "python": 3, "6": [3, 5, 7], "appropri": [3, 5], "distribut": 3, "o": [3, 5], "beforehand": 3, "due": 3, "compat": 3, "issu": [3, 5], "some": [3, 5, 7], "core": [3, 7], "32": [3, 4, 5, 7], "bit": [3, 5], "oper": 3, "see": [3, 5, 6], "section": [3, 5, 6], "develop": 3, "build": [3, 7], "yourself": 3, "onli": [3, 5, 6], "now": [3, 6], "gymnasium": [3, 4, 5, 7], "env": [3, 4, 5, 6], "airstrik": [3, 4, 5, 6], "genesi": [3, 4, 5, 6], "ha": [3, 5], "non": [3, 5], "commerci": 3, "includ": [3, 4, 5, 6], "default": [3, 4, 5, 6, 7], "other": [3, 5], "obtain": 3, "them": [3, 5], "most": [3, 5, 6], "hash": [3, 5], "sourc": [3, 5, 6], "from": [3, 4, 6, 7], "respect": 3, "No": 3, "intro": 3, "sha": 3, "sum": [3, 5], "primarili": [3, 6], "mean": [3, 5], "train": [3, 4, 6], "rl": 3, "classic": [3, 4, 6], "video": [3, 4, 5], "though": [3, 5], "also": [3, 5, 6], "control": [3, 5, 6], "those": [3, 5], "here": [3, 4, 5, 6], "wai": [3, 5], "There": [3, 5, 6], "let": [3, 4, 5], "interfac": [3, 6], "python3": [3, 6], "m": [3, 6], "arrow": 3, "kei": [3, 5, 6], "x": 3, "ship": 3, "fire": [3, 5], "try": [3, 5], "api": [3, 5], "quit": 3, "basic": [3, 5], "advanc": [3, 5], "tool": [3, 7], "check": [3, 5, 7], "ui": [3, 6], "A": [3, 5, 6], "choos": 3, "action": [3, 4, 5], "each": [3, 5, 6], "timestep": 3, "look": [3, 5], "much": [3, 5, 6], "def": [3, 4, 5, 6], "main": [3, 4, 5, 6], "reset": [3, 4, 6], "while": [3, 5, 6], "true": [3, 6], "action_spac": [3, 6], "sampl": [3, 6], "observ": 3, "reward": [3, 7], "termin": [3, 4, 6], "truncat": [3, 4, 6], "info": [3, 4, 5, 6], "step": [3, 4, 5, 6], "render": 3, "close": [3, 6], "__name__": [3, 4, 5, 6], "__main__": [3, 4, 5, 6], "full": [3, 4, 5, 6, 7], "featur": [3, 6], "avail": [3, 5, 6], "dir": 3, "random_ag": 3, "It": [3, 5], "print": [3, 5], "exit": 3, "when": [3, 5, 7], "scenario": [3, 4, 6], "throw": 3, "except": [3, 5], "data": [3, 6, 7], "defin": [3, 5, 6], "set": [3, 5, 6], "up": [3, 5], "function": [3, 6], "isn": 3, "t": [3, 5], "too": [3, 5], "gener": 3, "simpl": [3, 5], "effect": [3, 5], "reinforc": [3, 4, 5], "learn": [3, 4, 5], "algorithm": [3, 5], "call": [3, 5], "revisit": 3, "arcad": 3, "machado": 3, "et": 3, "al": 3, "which": [3, 5, 6], "determinist": [3, 6], "easi": [3, 5], "implement": 3, "sequenc": 3, "button": [3, 5, 6], "press": [3, 6], "well": [3, 5, 6], "doesn": [3, 5], "screen": [3, 5, 6], "all": [3, 5, 6], "best": [3, 5], "seen": 3, "so": [3, 5, 6], "far": 3, "proxim": [3, 4], "polici": [3, 4], "optim": [3, 4], "schulman": 3, "plai": [3, 5, 6], "mani": [3, 5], "take": [3, 5], "awhil": [3, 5], "faster": 3, "gpu": 3, "baselin": [3, 4], "progress": [3, 5], "goe": [3, 5], "found": [3, 5], "spin": 3, "what": [3, 5, 7], "have": [3, 5, 6], "alreadi": 3, "been": [3, 5], "displai": [3, 5], "even": 3, "ones": 3, "miss": 3, "list_gam": [3, 5], "actual": [3, 5], "repo": 3, "correct": [3, 5], "comput": [3, 5], "identifi": 3, "directori": [3, 5, 6], "match": [3, 5, 7], "correspond": [3, 5], "type": 3, "list": [3, 4, 5, 6], "should": [3, 5], "collect": 3, "archiv": 3, "org": 3, "search": [3, 5], "insid": [3, 5], "zip": 3, "retro": [4, 5, 6], "maintain": 4, "openai": [4, 7], "": [4, 5, 6, 7], "turn": 4, "environ": [4, 5], "plateform": 4, "sega": [4, 5, 7], "32x": [4, 7], "super": [4, 5], "nintendo": [4, 5], "2600": [4, 5], "agent": [4, 5, 6], "import": [4, 5, 6], "argpars": 4, "numpi": 4, "np": 4, "wrapper": [4, 6], "time_limit": 4, "timelimit": 4, "stable_baselines3": 4, "ppo": 4, "common": 4, "atari_wrapp": 4, "cliprewardenv": 4, "warpfram": 4, "vec_env": 4, "subprocvecenv": 4, "vecframestack": 4, "vectransposeimag": 4, "class": [4, 6], "stochasticframeskip": 4, "__init__": 4, "self": 4, "n": [4, 5, 6], "stickprob": 4, "curac": 4, "none": [4, 6], "rng": 4, "random": [4, 6], "randomst": 4, "supports_want_rend": 4, "hasattr": 4, "kwarg": [4, 6], "return": [4, 5], "ac": 4, "fals": [4, 6], "totrew": 4, "0": [4, 5, 6, 7], "rang": [4, 6], "substep": 4, "delai": 4, "probabl": [4, 5], "elif": 4, "rand": 4, "second": 4, "definit": 4, "kick": 4, "ob": [4, 6], "rew": [4, 6], "want_rend": 4, "els": 4, "break": [4, 6], "make_retro": 4, "state": [4, 6], "max_episode_step": 4, "4500": 4, "25": [4, 7], "wrap_deepmind_retro": 4, "configur": 4, "similar": [4, 5], "deepmind": 4, "style": [4, 7], "wrap_deepmind": 4, "parser": 4, "argumentpars": 4, "add_argu": 4, "arg": 4, "parse_arg": 4, "make_env": 4, "venv": 4, "8": [4, 5, 6], "n_stack": 4, "model": 4, "cnnpolici": 4, "learning_r": 4, "lambda": 4, "f": 4, "2": [4, 5, 6], "5e": 4, "n_step": 4, "128": [4, 5], "batch_siz": 4, "n_epoch": 4, "gamma": 4, "99": 4, "gae_lambda": 4, "95": 4, "clip_rang": 4, "ent_coef": 4, "01": [4, 7], "verbos": 4, "total_timestep": 4, "100_000_000": 4, "log_interv": 4, "thing": 5, "start": [5, 6], "abl": 5, "ll": 5, "savest": [5, 6], "begin": 5, "restart": [5, 6], "put": 5, "point": 5, "relat": 5, "base": 5, "memori": [5, 6], "address": 5, "gameov": 5, "16712294": 5, "u2": 5, "live": 5, "16712282": 5, "score": 5, "16712270": 5, "u4": 5, "op": 5, "equal": 5, "refer": 5, "zero": 5, "specifi": [5, 6], "user": [5, 6], "miscellan": 5, "debug": [5, 7], "default_st": 5, "whitelist": 5, "suspici": 5, "few": [5, 6], "sha1": 5, "c67af162391fff4a63432be5a156eb9ca7b4da5a": 5, "These": 5, "next": 5, "describ": 5, "emul": [5, 6, 7], "allow": [5, 6], "entir": 5, "store": [5, 6], "disk": 5, "restor": 5, "specif": 5, "alwai": 5, "end": 5, "ident": 5, "standalon": 5, "gzip": 5, "inner": 5, "alongsid": 5, "name": [5, 6], "document": 5, "ground": 5, "truth": 5, "format": 5, "manifest": 5, "separ": 5, "although": 5, "entri": 5, "consist": [5, 6], "valu": [5, 6], "ram": [5, 6], "arrai": 5, "byte": 5, "descriptor": 5, "addendum": 5, "show": [5, 6], "wide": 5, "unsign": 5, "big": 5, "endian": 5, "possibl": [5, 6], "pertain": 5, "manual": 5, "overrid": 5, "retroenv": 5, "write": [5, 6], "multipli": 5, "posit": [5, 7], "penalti": 5, "neg": 5, "creat": [5, 6], "similarli": 5, "over": 5, "By": 5, "load": [5, 6], "altern": 5, "constructor": 5, "again": [5, 7], "calcul": 5, "split": 5, "subsect": 5, "coeffici": 5, "extract": 5, "measur": 5, "delta": 5, "pass": [5, 6], "raw": 5, "impli": 5, "addit": [5, 6], "instead": [5, 6], "subtract": 5, "off": 5, "taken": 5, "two": [5, 7], "reach": 5, "At": 5, "top": [5, 6], "level": [5, 6], "properti": 5, "combin": 5, "ani": [5, 6], "fulfil": 5, "per": 5, "absolut": 5, "ignor": 5, "help": 5, "normal": 5, "window": [5, 7], "mac": 5, "howev": 5, "url": 5, "longer": 5, "releas": 5, "command": 5, "shift": 5, "select": 5, "menu": 5, "option": 5, "mode": 5, "charact": 5, "etc": 5, "final": 5, "playabl": 5, "moment": 5, "paus": 5, "p": [5, 6], "save": 5, "hard": 5, "might": 5, "back": [5, 6], "exact": 5, "chose": 5, "previou": 5, "g": 5, "sailormoon": 5, "queenberylscastl": 5, "we": 5, "prefer": 5, "usa": 5, "denot": 5, "europ": 5, "japan": 5, "bin": 5, "extens": [5, 7], "renam": [5, 7], "applic": 5, "uniqu": 5, "given": [5, 6], "known": 5, "mega": 5, "drive": 5, "sfc": 5, "entertain": 5, "famicom": 5, "ne": 5, "a26": 5, "gb": 5, "boi": 5, "gba": 5, "gbc": 5, "color": 5, "gg": 5, "gear": 5, "pce": 5, "nec": 5, "turbografx": 5, "16": [5, 6, 7], "pc": 5, "engin": 5, "sm": 5, "master": 5, "sometim": 5, "differ": [5, 6], "gen": 5, "aforement": 5, "case": [5, 7], "know": 5, "session": 5, "provid": [5, 6], "numer": 5, "goal": 5, "machin": 5, "maxim": 5, "player": [5, 6], "remain": [5, 6], "hit": 5, "instanc": 5, "dy": 5, "modifi": 5, "disallow": 5, "kidchameleon": 5, "usual": 5, "easier": 5, "continu": 5, "left": 5, "pretti": 5, "better": 5, "reliabl": 5, "slightli": 5, "incorrect": 5, "still": 5, "life": 5, "becaus": [5, 6], "detect": 5, "than": [5, 6], "unreli": 5, "present": 5, "incorrectli": 5, "switch": 5, "test": [5, 7], "replai": 5, "multipl": 5, "row": 5, "accident": 5, "ideal": 5, "beat": 5, "besid": 5, "That": 5, "impract": 5, "exist": 5, "unabl": 5, "result": 5, "often": [5, 6], "good": 5, "choic": 5, "In": [5, 6], "stand": 5, "place": 5, "attack": 5, "same": [5, 6], "enemi": 5, "respawn": 5, "veri": 5, "Be": 5, "care": 5, "thei": [5, 6], "tricki": 5, "right": 5, "sens": 5, "receiv": 5, "factor": 5, "100": 5, "compar": 5, "cumul": 5, "pane": 5, "keep": 5, "pattern": 5, "tip": 5, "group": 5, "themselv": 5, "togeth": 5, "narrow": 5, "down": 5, "particular": 5, "nearbi": 5, "suspect": 5, "high": 5, "occasion": 5, "individu": 5, "123400": 5, "updat": [5, 7], "broken": [5, 7], "digit": 5, "bob": 5, "sne": 5, "number": [5, 6], "across": 5, "frame": 5, "script": [5, 6], "1942": 5, "uncommon": 5, "length": 5, "don": 5, "nice": 5, "neat": 5, "short": 5, "certain": 5, "track": 5, "long": 5, "suddenli": 5, "jump": 5, "between": 5, "decid": 5, "shorter": 5, "safer": 5, "bet": 5, "sai": 5, "2400": 5, "24": 5, "transpos": 5, "123456": 5, "012345": 5, "rather": 5, "fix": [5, 7], "health": 5, "symbol": 5, "bar": 5, "could": 5, "repres": 5, "9999999": 5, "becom": 5, "99999": 5, "lose": 5, "unit": 5, "And": 5, "consecut": 5, "ve": 5, "avoid": 5, "later": [5, 6], "One": 5, "correctli": 5, "d2": 5, "d4": 5, "maximum": 5, "9999": 5, "increas": 5, "viewer": 5, "10000": 5, "wrong": 5, "d3": 5, "999999": 5, "watch": 5, "increment": 5, "decrement": 5, "255": 5, "sign": 5, "u": 5, "appear": [5, 6], "16769105": 5, "i2": 5, "littl": 5, "notic": 5, "uneven": 5, "unusu": 5, "eg": 5, "u1": 5, "7e094d": 5, "144": 5, "137": 5, "d1": 5, "90": 5, "89": 5, "higher": 5, "reveal": 5, "didn": 5, "origin": 5, "until": 5, "someth": 5, "give": 5, "larg": 5, "die": 5, "upon": 5, "unless": 5, "befor": 5, "happen": 5, "forgot": 5, "upper": 5, "lower": 5, "kill": 5, "bug": [5, 7], "diverg": 5, "guardianlegend": 5, "custom_integr": 5, "structur": 5, "depend": 5, "addamsfamili": 5, "atari2600": [5, 6, 7], "adventur": 5, "gameboi": 5, "aerostar": 5, "gbadvanc": 5, "mariokart": 5, "gbcolor": 5, "pokemonpinbal": 5, "gamegear": 5, "mortalkombat": 5, "pcengin": 5, "soldierblad": 5, "add_custom_path": 5, "script_dir": 5, "dirnam": 5, "abspath": 5, "__file__": 5, "join": 5, "fakegam": 5, "inttyp": [5, 6], "directli": [5, 6], "three": 5, "part": 5, "order": 5, "hex": 5, "string": [5, 6], "0x01020304": 5, "0x01": 5, "0x02": 5, "0x03": 5, "0x04": 5, "middl": 5, "outsid": 5, "sigil": 5, "singl": 5, "nb": 5, "rare": 5, "plu": 5, "gx": 5, "thu": 5, "aka": 5, "As": 5, "groom": 5, "0x81": 5, "decim": 5, "129": 5, "127": 5, "81": 5, "low": 5, "nybbl": 5, "0xa": 5, "0xf": 5, "cannot": 5, "occur": 5, "last": 5, "piec": 5, "occupi": 5, "power": [5, 6], "mario": 5, "bro": 5, "size": 5, "less": 5, "0x0102": 5, "four": 5, "1234": 5, "0x12": 5, "0x34": 5, "u3": 5, "0x010203": 5, "0x1": 5, "n2": 5, "12": [5, 7], "intel": 5, "arm": 5, "cpu": 5, "powerpc": 5, "valid": 5, "recommend": 5, "undefin": 5, "invalid": 5, "q2": 5, "i0": 5, "variou": 5, "vari": 5, "form": 5, "premis": 5, "transform": 5, "furthermor": 5, "method": 5, "context": 5, "appli": 5, "nonzero": 5, "otherwis": 5, "greater": 5, "enum": 6, "use_restricted_act": 6, "filter": 6, "obs_typ": 6, "imag": 6, "render_mod": 6, "human": 6, "metadata": 6, "json": [6, 7], "initi": 6, "consol": 6, "special": 6, "space": 6, "multibinari": 6, "discret": 6, "multi_discret": 6, "multidiscet": 6, "own": 6, "deriv": 6, "exampl": [6, 7], "py": [6, 7], "custom": 6, "reduc": 6, "126": 6, "7": [6, 7], "rgb": 6, "view": 6, "smaller": 6, "variabl": 6, "dict": 6, "where": 6, "small": 6, "both": 6, "paddl": 6, "pong": [6, 7], "bottom": 6, "half": 6, "player_1_rew": 6, "player_2_rew": 6, "bk2": 6, "seri": 6, "output": 6, "1000": 6, "wish": 6, "sonic": 6, "hedgehog": 6, "were": 6, "contest": 6, "movi": 6, "gameplai": 6, "process": 6, "_": 6, "level1": 6, "000000": 6, "get_gam": 6, "everyth": 6, "initial_st": 6, "get_stat": 6, "num_button": 6, "append": 6, "get_kei": 6, "ffmpeg": 6, "input": 6, "locat": 6, "playback_movi": [6, 7], "2024": 7, "2023": 7, "ci": 7, "zbeucler2018": 7, "pseudo": 7, "rnd": 7, "thought": 7, "onaclov2000": 7, "remov": 7, "travi": 7, "setup": 7, "11": 7, "capabl": 7, "15": 7, "readm": 7, "matpoliquin": 7, "17": 7, "gcp": 7, "20": 7, "link": 7, "websit": 7, "23": 7, "doc": 7, "mgoulao": 7, "27": 7, "28": 7, "extra": 7, "18": 7, "duplic": 7, "30": 7, "publish": 7, "linux": 7, "31": 7, "appl": 7, "silicon": 7, "34": 7, "cmakelist": 7, "libzip": 7, "35": 7, "moonpatrol": 7, "36": 7, "pre": 7, "commit": 7, "hook": 7, "victorsevero": 7, "38": 7, "37": 7, "badg": 7, "elliottow": 7, "43": 7, "45": 7, "placehold": 7, "logo": 7, "screenshot": 7, "47": 7, "260": 7, "joohei": 7, "46": 7, "handl": 7, "log": 7, "48": 7, "saturn": 7, "virtua": 7, "fighter": 7, "49": 7, "whitespac": 7, "50": 7, "bump": 7, "setuptool": 7, "40": 7, "65": 7, "build_script": 7, "dependabot": 7, "39": 7, "21": 7, "41": 7, "certifi": 7, "2018": 7, "2022": 7, "42": 7, "wheel": 7, "adapt": 7, "yml": 7, "pettingzoo": 7, "workflow": 7, "51": 7, "52": 7, "54": 7, "53": 7, "mortal": 7, "kombat": 7, "55": 7, "58": 7, "cmd": 7, "line": 7, "59": 7, "disabl": 7, "multi": 7, "retro_env": 7, "61": 7, "misc": 7, "62": 7, "checker": 7, "63": 7, "nhl941on1": 7, "star": 7, "66": 7, "temp": 7, "segment": 7, "fault": 7, "67": 7, "typo": 7, "68": 7, "69": 7, "package_data": 7, "71": 7, "buld": 7, "manylinux": 7, "cibuildwheel": 7, "mwydmuch": 7, "73": 7, "contributor": 7, "changelog": 7, "08": 7}, "objects": {"retro": [[6, 0, 1, "", "Actions"], [6, 0, 1, "", "Observations"], [6, 0, 1, "", "RetroEnv"], [6, 0, 1, "", "State"], [6, 2, 1, "", "make"]], "retro.Actions": [[6, 1, 1, "", "ALL"], [6, 1, 1, "", "DISCRETE"], [6, 1, 1, "", "MULTI_DISCRETE"]], "retro.Observations": [[6, 1, 1, "", "IMAGE"], [6, 1, 1, "", "RAM"]], "retro.State": [[6, 1, 1, "", "DEFAULT"], [6, 1, 1, "", "NONE"]]}, "objtypes": {"0": "py:class", "1": "py:attribute", "2": "py:function"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "attribute", "Python attribute"], "2": ["py", "function", "Python function"]}, "titleterms": {"404": 0, "page": [0, 1], "Not": 0, "found": 0, "The": [0, 5], "request": 0, "could": 0, "stabl": [1, 7], "retro": [1, 2, 3, 7], "doc": 1, "instruct": 1, "modifi": 1, "environ": [1, 3, 6], "build": [1, 2], "document": 1, "develop": 2, "instal": 2, "from": [2, 5], "sourc": 2, "prerequisit": 2, "mac": 2, "window": 2, "linux": 2, "ui": [2, 5], "maco": 2, "get": 3, "start": 3, "creat": 3, "exampl": [3, 5], "usag": 3, "interact": 3, "script": 3, "random": 3, "agent": 3, "brute": 3, "ppo": 3, "integr": [3, 5], "import": 3, "rom": [3, 5], "game": 5, "level1": 5, "state": 5, "data": 5, "json": 5, "scenario": 5, "metadata": 5, "md": 5, "sha": 5, "file": [5, 6], "variabl": 5, "locat": 5, "new": 5, "support": 5, "type": 5, "done": 5, "condit": 5, "reward": 5, "function": 5, "find": 5, "common": 5, "error": 5, "us": 5, "custom": 5, "python": [5, 6], "appendix": 5, "oper": 5, "api": 6, "retroenv": 6, "action": 6, "observ": 6, "multiplay": 6, "replai": 6, "record": 6, "playback": 6, "render": 6, "video": 6, "releas": 7, "note": 7, "v0": 7, "9": 7, "3": 7, "2": 7, "1": 7}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"404 - Page Not Found": [[0, "page-not-found"]], "The requested page could not be found.": [[0, "the-requested-page-could-not-be-found"]], "Stable-retro docs": [[1, "stable-retro-docs"]], "Instructions for modifying environment pages": [[1, "instructions-for-modifying-environment-pages"]], "Build the Documentation": [[1, "build-the-documentation"]], "Development": [[2, "development"]], "Install Retro from source": [[2, "install-retro-from-source"]], "Prerequisites": [[2, "prerequisites"]], "Mac prerequisites": [[2, "mac-prerequisites"]], "Windows prerequisites": [[2, "windows-prerequisites"]], "Linux prerequisites": [[2, "linux-prerequisites"]], "Building Linux and Mac": [[2, "building-linux-and-mac"]], "Building Windows": [[2, "building-windows"]], "Install Retro UI from source": [[2, "install-retro-ui-from-source"]], "macOS": [[2, "macos"]], "Linux": [[2, "linux"]], "Windows": [[2, "windows"]], "Getting Started": [[3, "getting-started"]], "Create a Retro Environment": [[3, "create-a-retro-environment"]], "Example Usage": [[3, "example-usage"]], "Interactive Script": [[3, "interactive-script"]], "Random Agent": [[3, "random-agent"]], "Brute": [[3, "brute"]], "PPO": [[3, "ppo"]], "Integrations": [[3, "integrations"]], "Importing ROMs": [[3, "importing-roms"]], "Game Integration": [[5, "game-integration"]], "Example Integration": [[5, "example-integration"]], "Level1.state": [[5, "level1-state"]], "data.json": [[5, "data-json"]], "scenario.json": [[5, "scenario-json"]], "metadata.json": [[5, "metadata-json"]], "rom.md": [[5, "rom-md"]], "rom.sha": [[5, "rom-sha"]], "Integration Files": [[5, "integration-files"]], "States": [[5, "states"]], "Variable Locations data.json": [[5, "variable-locations-data-json"]], "Scenario scenario.json": [[5, "scenario-scenario-json"]], "The Integration UI": [[5, "the-integration-ui"]], "Integrating a new ROM": [[5, "integrating-a-new-rom"]], "Supported ROM Types": [[5, "supported-rom-types"]], "Integrating a Game": [[5, "integrating-a-game"]], "Done Condition": [[5, "done-condition"]], "Reward Function": [[5, "reward-function"]], "Finding Variables": [[5, "finding-variables"]], "Common Errors": [[5, "common-errors"]], "Using a Custom Integration from Python": [[5, "using-a-custom-integration-from-python"]], "Appendix: Types": [[5, "appendix-types"]], "Appendix: Operations": [[5, "appendix-operations"]], "Python API": [[6, "python-api"]], "RetroEnv": [[6, "retroenv"]], "Actions": [[6, "actions"]], "Observations": [[6, "observations"]], "Multiplayer Environments": [[6, "multiplayer-environments"]], "Replay files": [[6, "replay-files"]], "Record": [[6, "record"]], "Playback": [[6, "playback"]], "Render to Video": [[6, "render-to-video"]], "Release Notes": [[7, "release-notes"]], "stable-retro v0.9.3": [[7, "release-v0-9-3"]], "stable-retro v0.9.2": [[7, "release-v0-9-2"]], "stable-retro v0.9.1": [[7, "release-v0-9-1"]]}, "indexentries": {"all (retro.actions attribute)": [[6, "retro.Actions.ALL"]], "actions (class in retro)": [[6, "retro.Actions"]], "default (retro.state attribute)": [[6, "retro.State.DEFAULT"]], "discrete (retro.actions attribute)": [[6, "retro.Actions.DISCRETE"]], "image (retro.observations attribute)": [[6, "retro.Observations.IMAGE"]], "multi_discrete (retro.actions attribute)": [[6, "retro.Actions.MULTI_DISCRETE"]], "none (retro.state attribute)": [[6, "retro.State.NONE"]], "observations (class in retro)": [[6, "retro.Observations"]], "ram (retro.observations attribute)": [[6, "retro.Observations.RAM"]], "retroenv (class in retro)": [[6, "retro.RetroEnv"]], "state (class in retro)": [[6, "retro.State"]], "make() (in module retro)": [[6, "retro.make"]]}}) \ No newline at end of file