Farama-Foundation / Miniworld

Simple and easily configurable 3D FPS-game-like environments for reinforcement learning

http://miniworld.farama.org/

Apache License 2.0

700 stars 131 forks source link

Added Docstrings and Updated `manual_control.py` #73

Closed BolunDai0216 closed 1 year ago

BolunDai0216 commented 2 years ago

Description

Added docstrings to all of the environments.
Updated manual_control.py to work with the new render(), step() and reset()

Type of change

Please delete options that are not relevant.

[x] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)

Checklist:

[x] I have run the pre-commit checks with pre-commit run --all-files (see CONTRIBUTING.md instructions to set it up)
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[x] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes

pseudo-rnd-thoughts commented 2 years ago

Looks good to me, @BolunDai0216 Do you want me to merge?

BolunDai0216 commented 2 years ago

Looks good to me, @BolunDai0216 Do you want me to merge?

Yes, you can merge it.