automatic import of python-gym-super-mario-brosopeneuler20.03

1 files changed, 757 insertions, 0 deletions

diff --git a/python-gym-super-mario-bros.spec b/python-gym-super-mario-bros.spec
new file mode 100644
index 0000000..3326e0c
--- /dev/null
+++ b/python-gym-super-mario-bros.spec
@@ -0,0 +1,757 @@
+%global _empty_manifest_terminate_build 0
+Name:		python-gym-super-mario-bros
+Version:	7.4.0
+Release:	1
+Summary:	Super Mario Bros. for OpenAI Gym
+License:	Proprietary
+URL:		https://github.com/Kautenja/gym-super-mario-bros
+Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/0d/d0/af1263150596ff8cce3709c9883c1492de67b87b45322875cd6b03b8c967/gym_super_mario_bros-7.4.0.tar.gz
+BuildArch:	noarch
+
+Requires:	python3-nes-py
+
+%description
+# gym-super-mario-bros
+
+[![BuildStatus][build-status]][ci-server]
+[![PackageVersion][pypi-version]][pypi-home]
+[![PythonVersion][python-version]][python-home]
+[![Stable][pypi-status]][pypi-home]
+[![Format][pypi-format]][pypi-home]
+[![License][pypi-license]](LICENSE)
+
+[build-status]: https://app.travis-ci.com/Kautenja/gym-super-mario-bros.svg?branch=master
+[ci-server]: https://app.travis-ci.com/Kautenja/gym-super-mario-bros
+[pypi-version]: https://badge.fury.io/py/gym-super-mario-bros.svg
+[pypi-license]: https://img.shields.io/pypi/l/gym-super-mario-bros.svg
+[pypi-status]: https://img.shields.io/pypi/status/gym-super-mario-bros.svg
+[pypi-format]: https://img.shields.io/pypi/format/gym-super-mario-bros.svg
+[pypi-home]: https://badge.fury.io/py/gym-super-mario-bros
+[python-version]: https://img.shields.io/pypi/pyversions/gym-super-mario-bros.svg
+[python-home]: https://python.org
+
+![Mario](https://user-images.githubusercontent.com/2184469/40949613-7542733a-6834-11e8-895b-ce1cc3af9dbb.gif)
+
+An [OpenAI Gym](https://github.com/openai/gym) environment for
+Super Mario Bros. & Super Mario Bros. 2 (Lost Levels) on The Nintendo
+Entertainment System (NES) using
+[the nes-py emulator](https://github.com/Kautenja/nes-py).
+
+## Installation
+
+The preferred installation of `gym-super-mario-bros` is from `pip`:
+
+```shell
+pip install gym-super-mario-bros
+```
+
+## Usage
+
+### Python
+
+You must import `gym_super_mario_bros` before trying to make an environment.
+This is because gym environments are registered at runtime. By default,
+`gym_super_mario_bros` environments use the full NES action space of 256
+discrete actions. To contstrain this, `gym_super_mario_bros.actions` provides
+three actions lists (`RIGHT_ONLY`, `SIMPLE_MOVEMENT`, and `COMPLEX_MOVEMENT`)
+for the `nes_py.wrappers.JoypadSpace` wrapper. See
+[gym_super_mario_bros/actions.py](https://github.com/Kautenja/gym-super-mario-bros/blob/master/gym_super_mario_bros/actions.py) for a
+breakdown of the legal actions in each of these three lists.
+
+```python
+from nes_py.wrappers import JoypadSpace
+import gym_super_mario_bros
+from gym_super_mario_bros.actions import SIMPLE_MOVEMENT
+env = gym_super_mario_bros.make('SuperMarioBros-v0')
+env = JoypadSpace(env, SIMPLE_MOVEMENT)
+
+done = True
+for step in range(5000):
+    if done:
+        state = env.reset()
+    state, reward, done, info = env.step(env.action_space.sample())
+    env.render()
+
+env.close()
+```
+
+**NOTE:** `gym_super_mario_bros.make` is just an alias to `gym.make` for
+convenience.
+
+**NOTE:** remove calls to `render` in training code for a nontrivial
+speedup.
+
+### Command Line
+
+`gym_super_mario_bros` features a command line interface for playing
+environments using either the keyboard, or uniform random movement.
+
+```shell
+gym_super_mario_bros -e <the environment ID to play> -m <`human` or `random`>
+```
+
+**NOTE:** by default, `-e` is set to `SuperMarioBros-v0` and `-m` is set to
+`human`.
+
+**NOTE:** `SuperMarioBrosRandomStages-*` support the `--stages/-S` flag for
+supplying the set of stages to sample from like `-S 1-4 2-4 3-4 4-4`.
+
+## Environments
+
+These environments allow 3 attempts (lives) to make it through the 32 stages
+in the game. The environments only send reward-able game-play frames to
+agents; No cut-scenes, loading screens, etc. are sent from the NES emulator
+to an agent nor can an agent perform actions during these instances. If a
+cut-scene is not able to be skipped by hacking the NES's RAM, the environment
+will lock the Python process until the emulator is ready for the next action.
+
+| Environment                     | Game | ROM           | Screenshot |
+|:--------------------------------|:-----|:--------------|:-----------|
+| `SuperMarioBros-v0`             | SMB  | standard      | ![][v0]    |
+| `SuperMarioBros-v1`             | SMB  | downsample    | ![][v1]    |
+| `SuperMarioBros-v2`             | SMB  | pixel         | ![][v2]    |
+| `SuperMarioBros-v3`             | SMB  | rectangle     | ![][v3]    |
+| `SuperMarioBros2-v0`            | SMB2 | standard      | ![][2-v0]  |
+| `SuperMarioBros2-v1`            | SMB2 | downsample    | ![][2-v1]  |
+
+[v0]: https://user-images.githubusercontent.com/2184469/40948820-3d15e5c2-6830-11e8-81d4-ecfaffee0a14.png
+[v1]: https://user-images.githubusercontent.com/2184469/40948819-3cff6c48-6830-11e8-8373-8fad1665ac72.png
+[v2]: https://user-images.githubusercontent.com/2184469/40948818-3cea09d4-6830-11e8-8efa-8f34d8b05b11.png
+[v3]: https://user-images.githubusercontent.com/2184469/40948817-3cd6600a-6830-11e8-8abb-9cee6a31d377.png
+[2-v0]: https://user-images.githubusercontent.com/2184469/40948822-3d3b8412-6830-11e8-860b-af3802f5373f.png
+[2-v1]: https://user-images.githubusercontent.com/2184469/40948821-3d2d61a2-6830-11e8-8789-a92e750aa9a8.png
+
+### Individual Stages
+
+These environments allow a single attempt (life) to make it through a single
+stage of the game.
+
+Use the template
+
+    SuperMarioBros-<world>-<stage>-v<version>
+
+where:
+
+-   `<world>` is a number in {1, 2, 3, 4, 5, 6, 7, 8} indicating the world
+-   `<stage>` is a number in {1, 2, 3, 4} indicating the stage within a world
+-   `<version>` is a number in {0, 1, 2, 3} specifying the ROM mode to use
+    - 0: standard ROM
+    - 1: downsampled ROM
+    - 2: pixel ROM
+    - 3: rectangle ROM
+
+For example, to play 4-2 on the downsampled ROM, you would use the environment
+id `SuperMarioBros-4-2-v1`.
+
+### Random Stage Selection
+
+The random stage selection environment randomly selects a stage and allows a
+single attempt to clear it. Upon a death and subsequent call to `reset` the
+environment randomly selects a new stage. This is only available for the
+standard Super Mario Bros. game, _not_ Lost Levels (at the moment). To use
+these environments, append `RandomStages` to the `SuperMarioBros` id. For
+example, to use the standard ROM with random stage selection use
+`SuperMarioBrosRandomStages-v0`. To seed the random stage selection use the
+`seed` method of the env, i.e., `env.seed(222)`, before any calls to `reset`.
+Alternatively pass the `seed` keyword argument to the `reset` method directly
+like `reset(seed=222)`.
+
+In addition to randomly selecting any of the 32 original stages, a subset of
+user-defined stages can be specified to limit the random choice of stages to a
+specific subset. For example, the stage selector could be limited to only
+sample castle stages, water levels, underground, and more.
+
+To specify a subset of stages to randomly sample from, create a list of each
+stage to allow to be sampled and pass that list to the `gym.make()` function.
+For example:
+
+```python
+gym.make('SuperMarioBrosRandomStages-v0', stages=['1-4', '2-4', '3-4', '4-4'])
+```
+
+The example above will sample a random stage from 1-4, 2-4, 3-4, and 4-4 upon
+every call to `reset`.
+
+## Step
+
+Info about the rewards and info returned by the `step` method.
+
+### Reward Function
+
+The reward function assumes the objective of the game is to move as far right
+as possible (increase the agent's _x_ value), as fast as possible, without
+dying. To model this game, three separate variables compose the reward:
+
+1.  _v_: the difference in agent _x_ values between states
+    -   in this case this is instantaneous velocity for the given step
+    -   _v = x1 - x0_
+        -   _x0_ is the x position before the step
+        -   _x1_ is the x position after the step
+    -   moving right ⇔ _v > 0_
+    -   moving left ⇔ _v < 0_
+    -   not moving ⇔ _v = 0_
+2.  _c_: the difference in the game clock between frames
+    -   the penalty prevents the agent from standing still
+    -   _c = c0 - c1_
+        -   _c0_ is the clock reading before the step
+        -   _c1_ is the clock reading after the step
+    -   no clock tick ⇔ _c = 0_
+    -   clock tick ⇔ _c < 0_
+3.  _d_: a death penalty that penalizes the agent for dying in a state
+    -   this penalty encourages the agent to avoid death
+    -   alive ⇔ _d = 0_
+    -   dead ⇔ _d = -15_
+
+_r = v + c + d_
+
+The reward is clipped into the range _(-15, 15)_.
+
+### `info` dictionary
+
+The `info` dictionary returned by the `step` method contains the following
+keys:
+
+| Key        | Type   | Description
+|:-----------|:-------|:------------------------------------------------------|
+| `coins   ` | `int`  | The number of collected coins
+| `flag_get` | `bool` | True if Mario reached a flag or ax
+| `life`     | `int`  | The number of lives left, i.e., _{3, 2, 1}_
+| `score`    | `int`  | The cumulative in-game score
+| `stage`    | `int`  | The current stage, i.e., _{1, ..., 4}_
+| `status`   | `str`  | Mario's status, i.e., _{'small', 'tall', 'fireball'}_
+| `time`     | `int`  | The time left on the clock
+| `world`    | `int`  | The current world, i.e., _{1, ..., 8}_
+| `x_pos`    | `int`  | Mario's _x_ position in the stage (from the left)
+| `y_pos`    | `int`  | Mario's _y_ position in the stage (from the bottom)
+
+## Citation
+
+Please cite `gym-super-mario-bros` if you use it in your research.
+
+```tex
+@misc{gym-super-mario-bros,
+  author = {Christian Kauten},
+  howpublished = {GitHub},
+  title = {{S}uper {M}ario {B}ros for {O}pen{AI} {G}ym},
+  URL = {https://github.com/Kautenja/gym-super-mario-bros},
+  year = {2018},
+}
+```
+
+
+
+
+%package -n python3-gym-super-mario-bros
+Summary:	Super Mario Bros. for OpenAI Gym
+Provides:	python-gym-super-mario-bros
+BuildRequires:	python3-devel
+BuildRequires:	python3-setuptools
+BuildRequires:	python3-pip
+%description -n python3-gym-super-mario-bros
+# gym-super-mario-bros
+
+[![BuildStatus][build-status]][ci-server]
+[![PackageVersion][pypi-version]][pypi-home]
+[![PythonVersion][python-version]][python-home]
+[![Stable][pypi-status]][pypi-home]
+[![Format][pypi-format]][pypi-home]
+[![License][pypi-license]](LICENSE)
+
+[build-status]: https://app.travis-ci.com/Kautenja/gym-super-mario-bros.svg?branch=master
+[ci-server]: https://app.travis-ci.com/Kautenja/gym-super-mario-bros
+[pypi-version]: https://badge.fury.io/py/gym-super-mario-bros.svg
+[pypi-license]: https://img.shields.io/pypi/l/gym-super-mario-bros.svg
+[pypi-status]: https://img.shields.io/pypi/status/gym-super-mario-bros.svg
+[pypi-format]: https://img.shields.io/pypi/format/gym-super-mario-bros.svg
+[pypi-home]: https://badge.fury.io/py/gym-super-mario-bros
+[python-version]: https://img.shields.io/pypi/pyversions/gym-super-mario-bros.svg
+[python-home]: https://python.org
+
+![Mario](https://user-images.githubusercontent.com/2184469/40949613-7542733a-6834-11e8-895b-ce1cc3af9dbb.gif)
+
+An [OpenAI Gym](https://github.com/openai/gym) environment for
+Super Mario Bros. & Super Mario Bros. 2 (Lost Levels) on The Nintendo
+Entertainment System (NES) using
+[the nes-py emulator](https://github.com/Kautenja/nes-py).
+
+## Installation
+
+The preferred installation of `gym-super-mario-bros` is from `pip`:
+
+```shell
+pip install gym-super-mario-bros
+```
+
+## Usage
+
+### Python
+
+You must import `gym_super_mario_bros` before trying to make an environment.
+This is because gym environments are registered at runtime. By default,
+`gym_super_mario_bros` environments use the full NES action space of 256
+discrete actions. To contstrain this, `gym_super_mario_bros.actions` provides
+three actions lists (`RIGHT_ONLY`, `SIMPLE_MOVEMENT`, and `COMPLEX_MOVEMENT`)
+for the `nes_py.wrappers.JoypadSpace` wrapper. See
+[gym_super_mario_bros/actions.py](https://github.com/Kautenja/gym-super-mario-bros/blob/master/gym_super_mario_bros/actions.py) for a
+breakdown of the legal actions in each of these three lists.
+
+```python
+from nes_py.wrappers import JoypadSpace
+import gym_super_mario_bros
+from gym_super_mario_bros.actions import SIMPLE_MOVEMENT
+env = gym_super_mario_bros.make('SuperMarioBros-v0')
+env = JoypadSpace(env, SIMPLE_MOVEMENT)
+
+done = True
+for step in range(5000):
+    if done:
+        state = env.reset()
+    state, reward, done, info = env.step(env.action_space.sample())
+    env.render()
+
+env.close()
+```
+
+**NOTE:** `gym_super_mario_bros.make` is just an alias to `gym.make` for
+convenience.
+
+**NOTE:** remove calls to `render` in training code for a nontrivial
+speedup.
+
+### Command Line
+
+`gym_super_mario_bros` features a command line interface for playing
+environments using either the keyboard, or uniform random movement.
+
+```shell
+gym_super_mario_bros -e <the environment ID to play> -m <`human` or `random`>
+```
+
+**NOTE:** by default, `-e` is set to `SuperMarioBros-v0` and `-m` is set to
+`human`.
+
+**NOTE:** `SuperMarioBrosRandomStages-*` support the `--stages/-S` flag for
+supplying the set of stages to sample from like `-S 1-4 2-4 3-4 4-4`.
+
+## Environments
+
+These environments allow 3 attempts (lives) to make it through the 32 stages
+in the game. The environments only send reward-able game-play frames to
+agents; No cut-scenes, loading screens, etc. are sent from the NES emulator
+to an agent nor can an agent perform actions during these instances. If a
+cut-scene is not able to be skipped by hacking the NES's RAM, the environment
+will lock the Python process until the emulator is ready for the next action.
+
+| Environment                     | Game | ROM           | Screenshot |
+|:--------------------------------|:-----|:--------------|:-----------|
+| `SuperMarioBros-v0`             | SMB  | standard      | ![][v0]    |
+| `SuperMarioBros-v1`             | SMB  | downsample    | ![][v1]    |
+| `SuperMarioBros-v2`             | SMB  | pixel         | ![][v2]    |
+| `SuperMarioBros-v3`             | SMB  | rectangle     | ![][v3]    |
+| `SuperMarioBros2-v0`            | SMB2 | standard      | ![][2-v0]  |
+| `SuperMarioBros2-v1`            | SMB2 | downsample    | ![][2-v1]  |
+
+[v0]: https://user-images.githubusercontent.com/2184469/40948820-3d15e5c2-6830-11e8-81d4-ecfaffee0a14.png
+[v1]: https://user-images.githubusercontent.com/2184469/40948819-3cff6c48-6830-11e8-8373-8fad1665ac72.png
+[v2]: https://user-images.githubusercontent.com/2184469/40948818-3cea09d4-6830-11e8-8efa-8f34d8b05b11.png
+[v3]: https://user-images.githubusercontent.com/2184469/40948817-3cd6600a-6830-11e8-8abb-9cee6a31d377.png
+[2-v0]: https://user-images.githubusercontent.com/2184469/40948822-3d3b8412-6830-11e8-860b-af3802f5373f.png
+[2-v1]: https://user-images.githubusercontent.com/2184469/40948821-3d2d61a2-6830-11e8-8789-a92e750aa9a8.png
+
+### Individual Stages
+
+These environments allow a single attempt (life) to make it through a single
+stage of the game.
+
+Use the template
+
+    SuperMarioBros-<world>-<stage>-v<version>
+
+where:
+
+-   `<world>` is a number in {1, 2, 3, 4, 5, 6, 7, 8} indicating the world
+-   `<stage>` is a number in {1, 2, 3, 4} indicating the stage within a world
+-   `<version>` is a number in {0, 1, 2, 3} specifying the ROM mode to use
+    - 0: standard ROM
+    - 1: downsampled ROM
+    - 2: pixel ROM
+    - 3: rectangle ROM
+
+For example, to play 4-2 on the downsampled ROM, you would use the environment
+id `SuperMarioBros-4-2-v1`.
+
+### Random Stage Selection
+
+The random stage selection environment randomly selects a stage and allows a
+single attempt to clear it. Upon a death and subsequent call to `reset` the
+environment randomly selects a new stage. This is only available for the
+standard Super Mario Bros. game, _not_ Lost Levels (at the moment). To use
+these environments, append `RandomStages` to the `SuperMarioBros` id. For
+example, to use the standard ROM with random stage selection use
+`SuperMarioBrosRandomStages-v0`. To seed the random stage selection use the
+`seed` method of the env, i.e., `env.seed(222)`, before any calls to `reset`.
+Alternatively pass the `seed` keyword argument to the `reset` method directly
+like `reset(seed=222)`.
+
+In addition to randomly selecting any of the 32 original stages, a subset of
+user-defined stages can be specified to limit the random choice of stages to a
+specific subset. For example, the stage selector could be limited to only
+sample castle stages, water levels, underground, and more.
+
+To specify a subset of stages to randomly sample from, create a list of each
+stage to allow to be sampled and pass that list to the `gym.make()` function.
+For example:
+
+```python
+gym.make('SuperMarioBrosRandomStages-v0', stages=['1-4', '2-4', '3-4', '4-4'])
+```
+
+The example above will sample a random stage from 1-4, 2-4, 3-4, and 4-4 upon
+every call to `reset`.
+
+## Step
+
+Info about the rewards and info returned by the `step` method.
+
+### Reward Function
+
+The reward function assumes the objective of the game is to move as far right
+as possible (increase the agent's _x_ value), as fast as possible, without
+dying. To model this game, three separate variables compose the reward:
+
+1.  _v_: the difference in agent _x_ values between states
+    -   in this case this is instantaneous velocity for the given step
+    -   _v = x1 - x0_
+        -   _x0_ is the x position before the step
+        -   _x1_ is the x position after the step
+    -   moving right ⇔ _v > 0_
+    -   moving left ⇔ _v < 0_
+    -   not moving ⇔ _v = 0_
+2.  _c_: the difference in the game clock between frames
+    -   the penalty prevents the agent from standing still
+    -   _c = c0 - c1_
+        -   _c0_ is the clock reading before the step
+        -   _c1_ is the clock reading after the step
+    -   no clock tick ⇔ _c = 0_
+    -   clock tick ⇔ _c < 0_
+3.  _d_: a death penalty that penalizes the agent for dying in a state
+    -   this penalty encourages the agent to avoid death
+    -   alive ⇔ _d = 0_
+    -   dead ⇔ _d = -15_
+
+_r = v + c + d_
+
+The reward is clipped into the range _(-15, 15)_.
+
+### `info` dictionary
+
+The `info` dictionary returned by the `step` method contains the following
+keys:
+
+| Key        | Type   | Description
+|:-----------|:-------|:------------------------------------------------------|
+| `coins   ` | `int`  | The number of collected coins
+| `flag_get` | `bool` | True if Mario reached a flag or ax
+| `life`     | `int`  | The number of lives left, i.e., _{3, 2, 1}_
+| `score`    | `int`  | The cumulative in-game score
+| `stage`    | `int`  | The current stage, i.e., _{1, ..., 4}_
+| `status`   | `str`  | Mario's status, i.e., _{'small', 'tall', 'fireball'}_
+| `time`     | `int`  | The time left on the clock
+| `world`    | `int`  | The current world, i.e., _{1, ..., 8}_
+| `x_pos`    | `int`  | Mario's _x_ position in the stage (from the left)
+| `y_pos`    | `int`  | Mario's _y_ position in the stage (from the bottom)
+
+## Citation
+
+Please cite `gym-super-mario-bros` if you use it in your research.
+
+```tex
+@misc{gym-super-mario-bros,
+  author = {Christian Kauten},
+  howpublished = {GitHub},
+  title = {{S}uper {M}ario {B}ros for {O}pen{AI} {G}ym},
+  URL = {https://github.com/Kautenja/gym-super-mario-bros},
+  year = {2018},
+}
+```
+
+
+
+
+%package help
+Summary:	Development documents and examples for gym-super-mario-bros
+Provides:	python3-gym-super-mario-bros-doc
+%description help
+# gym-super-mario-bros
+
+[![BuildStatus][build-status]][ci-server]
+[![PackageVersion][pypi-version]][pypi-home]
+[![PythonVersion][python-version]][python-home]
+[![Stable][pypi-status]][pypi-home]
+[![Format][pypi-format]][pypi-home]
+[![License][pypi-license]](LICENSE)
+
+[build-status]: https://app.travis-ci.com/Kautenja/gym-super-mario-bros.svg?branch=master
+[ci-server]: https://app.travis-ci.com/Kautenja/gym-super-mario-bros
+[pypi-version]: https://badge.fury.io/py/gym-super-mario-bros.svg
+[pypi-license]: https://img.shields.io/pypi/l/gym-super-mario-bros.svg
+[pypi-status]: https://img.shields.io/pypi/status/gym-super-mario-bros.svg
+[pypi-format]: https://img.shields.io/pypi/format/gym-super-mario-bros.svg
+[pypi-home]: https://badge.fury.io/py/gym-super-mario-bros
+[python-version]: https://img.shields.io/pypi/pyversions/gym-super-mario-bros.svg
+[python-home]: https://python.org
+
+![Mario](https://user-images.githubusercontent.com/2184469/40949613-7542733a-6834-11e8-895b-ce1cc3af9dbb.gif)
+
+An [OpenAI Gym](https://github.com/openai/gym) environment for
+Super Mario Bros. & Super Mario Bros. 2 (Lost Levels) on The Nintendo
+Entertainment System (NES) using
+[the nes-py emulator](https://github.com/Kautenja/nes-py).
+
+## Installation
+
+The preferred installation of `gym-super-mario-bros` is from `pip`:
+
+```shell
+pip install gym-super-mario-bros
+```
+
+## Usage
+
+### Python
+
+You must import `gym_super_mario_bros` before trying to make an environment.
+This is because gym environments are registered at runtime. By default,
+`gym_super_mario_bros` environments use the full NES action space of 256
+discrete actions. To contstrain this, `gym_super_mario_bros.actions` provides
+three actions lists (`RIGHT_ONLY`, `SIMPLE_MOVEMENT`, and `COMPLEX_MOVEMENT`)
+for the `nes_py.wrappers.JoypadSpace` wrapper. See
+[gym_super_mario_bros/actions.py](https://github.com/Kautenja/gym-super-mario-bros/blob/master/gym_super_mario_bros/actions.py) for a
+breakdown of the legal actions in each of these three lists.
+
+```python
+from nes_py.wrappers import JoypadSpace
+import gym_super_mario_bros
+from gym_super_mario_bros.actions import SIMPLE_MOVEMENT
+env = gym_super_mario_bros.make('SuperMarioBros-v0')
+env = JoypadSpace(env, SIMPLE_MOVEMENT)
+
+done = True
+for step in range(5000):
+    if done:
+        state = env.reset()
+    state, reward, done, info = env.step(env.action_space.sample())
+    env.render()
+
+env.close()
+```
+
+**NOTE:** `gym_super_mario_bros.make` is just an alias to `gym.make` for
+convenience.
+
+**NOTE:** remove calls to `render` in training code for a nontrivial
+speedup.
+
+### Command Line
+
+`gym_super_mario_bros` features a command line interface for playing
+environments using either the keyboard, or uniform random movement.
+
+```shell
+gym_super_mario_bros -e <the environment ID to play> -m <`human` or `random`>
+```
+
+**NOTE:** by default, `-e` is set to `SuperMarioBros-v0` and `-m` is set to
+`human`.
+
+**NOTE:** `SuperMarioBrosRandomStages-*` support the `--stages/-S` flag for
+supplying the set of stages to sample from like `-S 1-4 2-4 3-4 4-4`.
+
+## Environments
+
+These environments allow 3 attempts (lives) to make it through the 32 stages
+in the game. The environments only send reward-able game-play frames to
+agents; No cut-scenes, loading screens, etc. are sent from the NES emulator
+to an agent nor can an agent perform actions during these instances. If a
+cut-scene is not able to be skipped by hacking the NES's RAM, the environment
+will lock the Python process until the emulator is ready for the next action.
+
+| Environment                     | Game | ROM           | Screenshot |
+|:--------------------------------|:-----|:--------------|:-----------|
+| `SuperMarioBros-v0`             | SMB  | standard      | ![][v0]    |
+| `SuperMarioBros-v1`             | SMB  | downsample    | ![][v1]    |
+| `SuperMarioBros-v2`             | SMB  | pixel         | ![][v2]    |
+| `SuperMarioBros-v3`             | SMB  | rectangle     | ![][v3]    |
+| `SuperMarioBros2-v0`            | SMB2 | standard      | ![][2-v0]  |
+| `SuperMarioBros2-v1`            | SMB2 | downsample    | ![][2-v1]  |
+
+[v0]: https://user-images.githubusercontent.com/2184469/40948820-3d15e5c2-6830-11e8-81d4-ecfaffee0a14.png
+[v1]: https://user-images.githubusercontent.com/2184469/40948819-3cff6c48-6830-11e8-8373-8fad1665ac72.png
+[v2]: https://user-images.githubusercontent.com/2184469/40948818-3cea09d4-6830-11e8-8efa-8f34d8b05b11.png
+[v3]: https://user-images.githubusercontent.com/2184469/40948817-3cd6600a-6830-11e8-8abb-9cee6a31d377.png
+[2-v0]: https://user-images.githubusercontent.com/2184469/40948822-3d3b8412-6830-11e8-860b-af3802f5373f.png
+[2-v1]: https://user-images.githubusercontent.com/2184469/40948821-3d2d61a2-6830-11e8-8789-a92e750aa9a8.png
+
+### Individual Stages
+
+These environments allow a single attempt (life) to make it through a single
+stage of the game.
+
+Use the template
+
+    SuperMarioBros-<world>-<stage>-v<version>
+
+where:
+
+-   `<world>` is a number in {1, 2, 3, 4, 5, 6, 7, 8} indicating the world
+-   `<stage>` is a number in {1, 2, 3, 4} indicating the stage within a world
+-   `<version>` is a number in {0, 1, 2, 3} specifying the ROM mode to use
+    - 0: standard ROM
+    - 1: downsampled ROM
+    - 2: pixel ROM
+    - 3: rectangle ROM
+
+For example, to play 4-2 on the downsampled ROM, you would use the environment
+id `SuperMarioBros-4-2-v1`.
+
+### Random Stage Selection
+
+The random stage selection environment randomly selects a stage and allows a
+single attempt to clear it. Upon a death and subsequent call to `reset` the
+environment randomly selects a new stage. This is only available for the
+standard Super Mario Bros. game, _not_ Lost Levels (at the moment). To use
+these environments, append `RandomStages` to the `SuperMarioBros` id. For
+example, to use the standard ROM with random stage selection use
+`SuperMarioBrosRandomStages-v0`. To seed the random stage selection use the
+`seed` method of the env, i.e., `env.seed(222)`, before any calls to `reset`.
+Alternatively pass the `seed` keyword argument to the `reset` method directly
+like `reset(seed=222)`.
+
+In addition to randomly selecting any of the 32 original stages, a subset of
+user-defined stages can be specified to limit the random choice of stages to a
+specific subset. For example, the stage selector could be limited to only
+sample castle stages, water levels, underground, and more.
+
+To specify a subset of stages to randomly sample from, create a list of each
+stage to allow to be sampled and pass that list to the `gym.make()` function.
+For example:
+
+```python
+gym.make('SuperMarioBrosRandomStages-v0', stages=['1-4', '2-4', '3-4', '4-4'])
+```
+
+The example above will sample a random stage from 1-4, 2-4, 3-4, and 4-4 upon
+every call to `reset`.
+
+## Step
+
+Info about the rewards and info returned by the `step` method.
+
+### Reward Function
+
+The reward function assumes the objective of the game is to move as far right
+as possible (increase the agent's _x_ value), as fast as possible, without
+dying. To model this game, three separate variables compose the reward:
+
+1.  _v_: the difference in agent _x_ values between states
+    -   in this case this is instantaneous velocity for the given step
+    -   _v = x1 - x0_
+        -   _x0_ is the x position before the step
+        -   _x1_ is the x position after the step
+    -   moving right ⇔ _v > 0_
+    -   moving left ⇔ _v < 0_
+    -   not moving ⇔ _v = 0_
+2.  _c_: the difference in the game clock between frames
+    -   the penalty prevents the agent from standing still
+    -   _c = c0 - c1_
+        -   _c0_ is the clock reading before the step
+        -   _c1_ is the clock reading after the step
+    -   no clock tick ⇔ _c = 0_
+    -   clock tick ⇔ _c < 0_
+3.  _d_: a death penalty that penalizes the agent for dying in a state
+    -   this penalty encourages the agent to avoid death
+    -   alive ⇔ _d = 0_
+    -   dead ⇔ _d = -15_
+
+_r = v + c + d_
+
+The reward is clipped into the range _(-15, 15)_.
+
+### `info` dictionary
+
+The `info` dictionary returned by the `step` method contains the following
+keys:
+
+| Key        | Type   | Description
+|:-----------|:-------|:------------------------------------------------------|
+| `coins   ` | `int`  | The number of collected coins
+| `flag_get` | `bool` | True if Mario reached a flag or ax
+| `life`     | `int`  | The number of lives left, i.e., _{3, 2, 1}_
+| `score`    | `int`  | The cumulative in-game score
+| `stage`    | `int`  | The current stage, i.e., _{1, ..., 4}_
+| `status`   | `str`  | Mario's status, i.e., _{'small', 'tall', 'fireball'}_
+| `time`     | `int`  | The time left on the clock
+| `world`    | `int`  | The current world, i.e., _{1, ..., 8}_
+| `x_pos`    | `int`  | Mario's _x_ position in the stage (from the left)
+| `y_pos`    | `int`  | Mario's _y_ position in the stage (from the bottom)
+
+## Citation
+
+Please cite `gym-super-mario-bros` if you use it in your research.
+
+```tex
+@misc{gym-super-mario-bros,
+  author = {Christian Kauten},
+  howpublished = {GitHub},
+  title = {{S}uper {M}ario {B}ros for {O}pen{AI} {G}ym},
+  URL = {https://github.com/Kautenja/gym-super-mario-bros},
+  year = {2018},
+}
+```
+
+
+
+
+%prep
+%autosetup -n gym-super-mario-bros-7.4.0
+
+%build
+%py3_build
+
+%install
+%py3_install
+install -d -m755 %{buildroot}/%{_pkgdocdir}
+if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
+if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
+if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
+if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
+pushd %{buildroot}
+if [ -d usr/lib ]; then
+	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/lib64 ]; then
+	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/bin ]; then
+	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/sbin ]; then
+	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+touch doclist.lst
+if [ -d usr/share/man ]; then
+	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
+fi
+popd
+mv %{buildroot}/filelist.lst .
+mv %{buildroot}/doclist.lst .
+
+%files -n python3-gym-super-mario-bros -f filelist.lst
+%dir %{python3_sitelib}/*
+
+%files help -f doclist.lst
+%{_docdir}/*
+
+%changelog
+* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 7.4.0-1
+- Package Spec generated