Skip to content

Commit

Permalink
Update README.md, Changelog.md and FAQ.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mwydmuch committed Jan 7, 2023
1 parent 8d3e11c commit a754dc3
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 11 deletions.
15 changes: 5 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ or
### Ubuntu
To install ViZDoom on Ubuntu run (may take few minutes):
```
sudo apt install cmake libboost-all-dev libsdl2-dev libfreetype6-dev libgl1-mesa-dev libglu1-mesa-dev libpng-dev libjpeg-dev libbz2-dev libfluidsynth-dev libgme-dev libopenal-dev zlib1g-dev timidity tar nasm
sudo apt install cmake libboost-all-dev libsdl2-dev libfreetype6-dev libgl1-mesa-dev libglu1-mesa-dev libpng-dev libjpeg-dev libbz2-dev libfluidsynth-dev libgme-dev libopenal-dev zlib1g-dev timidity tar
pip install vizdoom
```
We recommend using at least Ubuntu 18.04+ with Python 3.7+.
Expand All @@ -85,27 +85,22 @@ python setup.py build && python setup.py install
Note that `pip install vizdoom` won't work with conda install and you have to follow these steps.

### macOS
To install ViZDoom on macOS (Intel) run (may take few minutes):
To install ViZDoom on macOS (for Intel and Apple Silicon) run (may take few minutes):
```
brew install cmake boost openal-soft sdl2
pip install vizdoom
```
We recommend using at least macOS High Sierra 10.13+ with Python 3.7+.

To install ViZDoom on macOS with Apple Silicon (M1 or M2) run:
```
brew install cmake boost openal-soft sdl2
pip install git+https://github.com/mwydmuch/ViZDoom.git
```
On Apple Silicon (M1 and M2), make sure you are using Python for Apple Silicon.

### Windows
To install pre-build release for Windows 10 or 11 64-bit and Python 3.6+ just run (should take few seconds):
To install pre-build release for Windows 10 or 11 64-bit and Python 3.7+ just run (should take few seconds):
```
pip install vizdoom
```

### Gym wrappers
If you wish to use OpenAI Gym environments, install ViZDoom with
If you wish to also install OpenAI Gym environments, install ViZDoom with
```
pip install vizdoom[gym]
```
Expand Down
10 changes: 10 additions & 0 deletions doc/Changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Changelog

## Changes in 1.1.14

#### Support for Apple Silicon
- Fixed building on Apple Silicon Macbooks.

#### Gym
- OpenAI Gym environment wrappers were updated to the Gym v0.26 API version.

---

## Changes in 1.1.13

#### Releases
Expand Down
9 changes: 8 additions & 1 deletion doc/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,9 @@ with ViZDoom. You have several options you can try (one of these steps has worke

## How to display ViZDoom's window when running it on WSL (Windows Subsystem for Linux)

GUI apps do not work out-of-the-box on WSL on Windows 10. To make it work you need:
Please note that as running ViZDoom on WSL seems to be working fine, it is not officially supported.

GUI apps do not work out-of-the-box on WSL on Windows 10/11. To make it work, you need:

* Download and install X-Server (VcXsrv) on Windows: https://sourceforge.net/projects/vcxsrv/.
* Start it using Command Prompt (cmd.exe) on Windows: `"C:\Program Files\VcXsrv\vcxsrv.exe" :0 -ac -terminate -lesspointer -multiwindow -clipboard -wgl -dpi auto` (`"C:\Program Files\VcXsrv\vcxsrv.exe"` is default install location).
Expand All @@ -168,3 +170,8 @@ GUI apps do not work out-of-the-box on WSL on Windows 10. To make it work you ne

**Original issue:**
* https://github.com/mwydmuch/ViZDoom/issues/491


## What is a difference between ViZDoom, ZDoom and GZDoom

ViZDoom is based on the last version of ZDoom (2.8.1). ZDoom was discontinued in 2016, and the development switched to GZDoom, which provides a new 3D renderer implemented in OpenGL. ViZDoom, however, sticks to the original 2D software renderer, which is much faster for small resolutions than OpenGL. Because of that, ViZDoom modernized the ZDoom engine by adding support for Apple Silicon and removing old unused parts of the code base (e.g., by removing Assembler parts).

0 comments on commit a754dc3

Please sign in to comment.