diff --git a/README.md b/README.md index d7723404d..7a849529d 100644 --- a/README.md +++ b/README.md @@ -125,21 +125,21 @@ Please note that the Windows version is not as well-tested as Linux and macOS ve ### Gymnasium/Gym wrappers -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. +Gymnasium environments are installed along with ViZDoom. +See [documentation](https://github.com/Farama-Foundation/ViZDoom/blob/master/doc/Gymnasium.md) and [examples](https://github.com/Farama-Foundation/ViZDoom/blob/master/examples/python/gymnasium_wrapper.py) on the use of Gymnasium API. -OpenAI-Gym wrappers 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. +See [documentation](https://github.com/Farama-Foundation/ViZDoom/blob/master/doc/Gym.md) and [examples](https://github.com/Farama-Foundation/ViZDoom/blob/master/examples/python/gym_wrapper.py) on the use of Gym API. **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](https://github.com/Farama-Foundation/ViZDoom/blob/master/examples/python) (contain learning examples implemented in PyTorch, TensorFlow and Theano) +- [C++](https://github.com/Farama-Foundation/ViZDoom/blob/master/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. The API is almost identical for all languages. @@ -151,23 +151,23 @@ Python examples are currently the richest, so we recommend to look at them, even Unfortunately, we cannot distribute ViZDoom with original Doom graphics. If you own original Doom or Doom 2 games, you can replace [Freedoom](https://freedoom.github.io/) graphics by placing `doom.wad` or `doom2.wad` into your working directory or `vizdoom` package directory. -Alternatively, any base game WAD (including other Doom engine-based games and custom/community games) can be used by pointing to it with the [`set_doom_game_path/setDoomGamePath`](https://github.com/mwydmuch/ViZDoom/blob/master/doc/DoomGame.md#-setdoomscenariopath) method. +Alternatively, any base game WAD (including other Doom engine-based games and custom/community games) can be used by pointing to it with the [`set_doom_game_path/setDoomGamePath`](https://github.com/Farama-Foundation/ViZDoom/blob/master/doc/DoomGame.md#-setdoomscenariopath) method. ## Documentation Detailed description of all types and methods: -- **[DoomGame](doc/DoomGame.md)** -- **[Types](doc/Types.md)** -- [Configuration files](doc/ConfigFile.md) -- [Exceptions](doc/Exceptions.md) -- [Utilities](doc/Utilities.md) +- **[DoomGame](https://github.com/Farama-Foundation/ViZDoom/blob/master/doc/DoomGame.md)** +- **[Types](https://github.com/Farama-Foundation/ViZDoom/blob/master/doc/Types.md)** +- [Configuration files](https://github.com/Farama-Foundation/ViZDoom/blob/master/doc/ConfigFile.md) +- [Exceptions](https://github.com/Farama-Foundation/ViZDoom/blob/master/doc/Exceptions.md) +- [Utilities](https://github.com/Farama-Foundation/ViZDoom/blob/master/doc/Utilities.md) Additional documents: -- **[FAQ](doc/FAQ.md)** -- [Changelog](doc/Changelog.md) for 1.1.X version. +- **[FAQ](https://github.com/Farama-Foundation/ViZDoom/blob/master/doc/FAQ.md)** +- [Changelog](https://github.com/Farama-Foundation/ViZDoom/blob/master/doc/Changelog.md) for 1.1.X version. Full documentation of the Doom engine and ACS scripting language can be found on [ZDoom Wiki](https://zdoom.org/wiki/). diff --git a/vizdoom-text.png b/vizdoom-text.png index 0cc79b573..b4500010b 100644 Binary files a/vizdoom-text.png and b/vizdoom-text.png differ