Skip to content

Commit

Permalink
Merge pull request #541 from Farama-Foundation/elliottower-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
mwydmuch authored May 2, 2023
2 parents 08606aa + 437b907 commit 0f037c3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<img src="https://raw.githubusercontent.com/Farama-Foundation/ViZDoom/master/vizdoom-text.png" width="500px"/>
</p>

ViZDoom allows developing AI **bots that play Doom using only the visual information** (the screen buffer). It is primarily intended for research in machine visual learning, and deep reinforcement learning, in particular.
ViZDoom allows developing AI **bots that play Doom using only visual information** (the screen buffer). It is primarily intended for research in machine visual learning, and deep reinforcement learning, in particular.

ViZDoom is based on [ZDoom](https://github.com/rheit/zdoom) to provide the game mechanics.

Expand Down Expand Up @@ -128,20 +128,20 @@ Please note that the Windows version is not as well-tested as Linux and macOS ve
Gymnasium environments are installed along with ViZDoom
See [documentation](doc/Gymnasium.md) and [examples](examples/python/gymnasium_wrapper.py) on the use of Gymnasium API.

OpenAI-Gym wrappers that were previously used are also available, to install them run
OpenAI-Gym wrappers are also available, to install them run
```
pip install vizdoom[gym]
```
See [documentation](doc/Gym.md) and [examples](examples/python/gym_wrapper.py) on the use of Gym API.
**OpenAI-Gym are deprecated and will be removed in future versions in favour.**
**OpenAI-Gym wrappers are deprecated and will be removed in future versions in favour of Gymnasium.**


## Examples

- [Python](examples/python) (contain learning examples implemented in PyTorch, TensorFlow and Theano)
- [C++](examples/c%2B%2B)

Python examples are currently the richest, so we recommend to look at them, even if you plan to use other language. API is almost identical for all languages.
Python examples are currently the richest, so we recommend to look at them, even if you plan to use other language. The API is almost identical for all languages.

**See also the [tutorial](http://vizdoom.cs.put.edu.pl/tutorial).**

Expand Down Expand Up @@ -169,10 +169,10 @@ Additional documents:
- **[FAQ](doc/FAQ.md)**
- [Changelog](doc/Changelog.md) for 1.1.X version.

Also full documentation of engine and ACS scripting language can be found on
Full documentation of the Doom engine and ACS scripting language can be found on
[ZDoom Wiki](https://zdoom.org/wiki/).

Useful parts:
Useful articles:

- [ZDoom Wiki: ACS (scripting language)](https://zdoom.org/wiki/ACS)
- [ZDoom Wiki: CVARs (console variables)](https://zdoom.org/wiki/CVARs)
Expand Down
5 changes: 4 additions & 1 deletion gymnasium_wrapper/base_gymnasium_env.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@


class VizdoomEnv(gym.Env, EzPickle):
metadata = {"render_modes": ["human", "rgb_array"], "render_fps": vzd.DEFAULT_TICRATE}
metadata = {
"render_modes": ["human", "rgb_array"],
"render_fps": vzd.DEFAULT_TICRATE,
}

def __init__(
self,
Expand Down

0 comments on commit 0f037c3

Please sign in to comment.