Skip to content

Commit

Permalink
Updated setup.py and some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mwydmuch committed Jan 11, 2019
1 parent 447637a commit bc5ce0a
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 18 deletions.
11 changes: 7 additions & 4 deletions doc/DoomGame.md
Original file line number Diff line number Diff line change
Expand Up @@ -337,10 +337,13 @@ See also:
| Java | `void sendGameCommand(String cmd)` |
| Python | `void send_game_command(str cmd)` |

Sends the command to Doom console. Can be used for cheats, multiplayer etc.
Sends the command to Doom console. Can be used for controling game, changing settings, cheats etc.
Some commands will be blocked in some modes.

See also: [ZDoom Wiki](http://zdoom.org/wiki/Console)
See also:
- [ZDoom Wiki: Console](http://zdoom.org/wiki/Console)
- [ZDoom Wiki: CVARs (console variables)](https://zdoom.org/wiki/CVARs)
- [ZDoom Wiki: CCMD (console commands)](https://zdoom.org/wiki/CCMDs)


---
Expand Down Expand Up @@ -659,8 +662,8 @@ Useful for changing additional game settings.
Config key: `gameArgs/game_args`

See also:
- [ZDoom Wiki on command line parameters](http://zdoom.org/wiki/Command_line_parameters)
- [ZDoom Wiki on CVARS](http://zdoom.org/wiki/CVARS)
- [ZDoom Wiki: Command line parameters](http://zdoom.org/wiki/Command_line_parameters)
- [ZDoom Wiki: CVARs (Console Variables)](http://zdoom.org/wiki/CVARS)


---
Expand Down
6 changes: 2 additions & 4 deletions doc/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,8 @@ https://github.com/mwydmuch/ViZDoom/issues/190

We cannot provide original Doom's assets due to licensing issues.
ViZDoom uses [freedoom2.wad](https://freedoom.github.io) as default assets.
However, you can use original Doom's assets by placing doom.wad or doom2.wad.
You can just place it in you working directory,
specify path to it by using [`DoomGame: setDoomGamePath`](DoomGame.md#setDoomGamePath)
or place it in the same directory as vizdoom(.exe).
However, you can use original Doom's assets by placing doom.wad or doom2.wad in you working directory, specify path to it by using [`DoomGame: setDoomGamePath`](DoomGame.md#setDoomGamePath) or place it in the same directory as vizdoom(.exe).
On Unix you can also set `DOOMWADDIR` environment variable to directory with your wads files.


### How to create/modify scenarios?
Expand Down
18 changes: 9 additions & 9 deletions doc/Types.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@

**value** - value that represents this particular object in **labelsBuffer**.

**x**, **y**, **width**, **height** - describes bounding box of this particular object in **labelsBuffer**.
**x**, **y**, **width**, **height** - describes bounding box of this particular object in **labelsBuffer**. Added in 1.1.5.


---
Expand Down Expand Up @@ -228,10 +228,10 @@ Enum type that defines all variables that can be obtained from the game.
- **SECRETCOUNT** - Counts the number of secret location/objects discovered during the current episode.
- **FRAGCOUNT** - Counts the number of players/bots killed, minus the number of committed suicides. Useful only in multiplayer mode.
- **DEATHCOUNT** - Counts the number of players deaths during the current episode. Useful only in multiplayer mode.
- **HITCOUNT** - Counts number of hit monsters/players/bots during the current episode.
- **HITS_TAKEN** - Counts number of hits taken by the player during the current episode.
- **DAMAGECOUNT** - Counts number of damage dealt to monsters/players/bots during the current episode.
- **DAMAGE_TAKEN** - Counts number of damage taken by the player during the current episode.
- **HITCOUNT** - Counts number of hit monsters/players/bots during the current episode. Added in 1.1.5.
- **HITS_TAKEN** - Counts number of hits taken by the player during the current episode. Added in 1.1.5.
- **DAMAGECOUNT** - Counts number of damage dealt to monsters/players/bots during the current episode. Added in 1.1.5.
- **DAMAGE_TAKEN** - Counts number of damage taken by the player during the current episode. Added in 1.1.5.
- **HEALTH** - Can be higher then 100!
- **ARMOR** - Can be higher then 100!
- **DEAD** - True if the player is dead.
Expand All @@ -248,17 +248,17 @@ Enum type that defines all variables that can be obtained from the game.
- **ANGLE** - Orientation of the player, not available if `viz_nocheat` is enabled.
- **PITCH**
- **ROLL**
- **VIEW_HEIGHT** - View high of the player, not available if `viz_nocheat` is enabled. Position of the camera in Z axis is equal to **POSITION_Z** + **VIEW_HEIGHT**.
- **VIEW_HEIGHT** - View high of the player, not available if `viz_nocheat` is enabled. Position of the camera in Z axis is equal to **POSITION_Z** + **VIEW_HEIGHT**. Added in 1.1.7.
- **VELOCITY_X** - Velocity of the player, not available if `viz_nocheat` is enabled.
- **VELOCITY_Y**
- **VELOCITY_Z**
- **CAMERA_POSITION_X** - Position of the camera, not available if `viz_nocheat` is enabled.
- **CAMERA_POSITION_X** - Position of the camera, not available if `viz_nocheat` is enabled. Added in 1.1.7.
- **CAMERA_POSITION_Y**
- **CAMERA_POSITION_Z**
- **CAMERA_ANGLE** - Orientation of the camera, not available if `viz_nocheat` is enabled.
- **CAMERA_ANGLE** - Orientation of the camera, not available if `viz_nocheat` is enabled. Added in 1.1.7.
- **CAMERA_PITCH**
- **CAMERA_ROLL**
- **CAMERA_FOV** - Field of view in degrees, not available if `viz_nocheat` is enabled.
- **CAMERA_FOV** - Field of view in degrees, not available if `viz_nocheat` is enabled. Added in 1.1.7.
- **PLAYER_NUMBER** - Player's number in multiplayer game.
- **PLAYER_COUNT** - Number of players in multiplayer game.
- **PLAYER1_FRAGCOUNT** - **PLAYER16_FRAGCOUNT** - Number of N player's frags
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ def run(self):
setup_requires=['numpy'],
packages=['vizdoom'],
package_dir={'vizdoom': package_path},
package_data={'vizdoom': ['freedoom2.wad', 'vizdoom', 'vizdoom.pk3', 'vizdoom.so', 'bots.cfg', 'scenarios/*']},
package_data={'vizdoom': ['__init__.py', 'bots.cfg', 'freedoom2.wad', 'vizdoom', 'vizdoom.pk3', 'vizdoom.so', 'scenarios/*']},
include_package_data=True,
cmdclass={'build': BuildCommand},
platforms=supported_platforms,
Expand Down

0 comments on commit bc5ce0a

Please sign in to comment.