Metadata-Version: 2.3
Name: miniworld-maze
Version: 1.0.0
Summary: Multi-room maze environments from the DrStrategy paper for reinforcement learning research
Keywords: reinforcement-learning,environment,gymnasium,multi-room-maze,drstrategy,maze-navigation,partial-observability,3d-environments
Author: Tim Joseph
Author-email: Tim Joseph <tim@mctigger.com>
License: MIT License
         
         Copyright (c) 2025 DrStrategy Research Team
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Environment :: Console
Classifier: Typing :: Typed
Requires-Dist: gymnasium>=1.0.0,<2.0.0
Requires-Dist: numpy>=1.20.0,<3.0.0
Requires-Dist: opencv-python>=4.5.0,<5.0.0
Requires-Dist: pillow>=8.0.0,<11.0.0
Requires-Dist: pyopengl>=3.1.0,<4.0.0
Requires-Dist: pyglet>=1.5.0,<2.0.0
Requires-Dist: black>=22.0,<25.0 ; extra == 'dev'
Requires-Dist: isort>=5.10,<6.0 ; extra == 'dev'
Requires-Dist: flake8>=4.0,<7.0 ; extra == 'dev'
Requires-Dist: build>=0.8.0,<2.0.0 ; extra == 'dev'
Requires-Dist: twine>=4.0.0,<6.0.0 ; extra == 'dev'
Requires-Dist: mujoco>=2.3.0,<4.0.0 ; extra == 'mujoco'
Requires-Python: >=3.8
Project-URL: Bug Tracker, https://github.com/mctigger/miniworld-maze/issues
Project-URL: Documentation, https://github.com/mctigger/miniworld-maze#readme
Project-URL: Homepage, https://github.com/mctigger/miniworld-maze
Project-URL: Repository, https://github.com/mctigger/miniworld-maze
Provides-Extra: dev
Provides-Extra: mujoco
Description-Content-Type: text/markdown

# MiniWorld DrStrategy - Multi-Room Maze Environment

A refactored implementation of Dr. Strategy's MiniWorld-based maze environments with updated dependencies and modern Python packaging. Based on the now-deprecated [MiniWorld](https://github.com/Farama-Foundation/Miniworld) project and the original [DrStrategy implementation](https://github.com/ahn-ml/drstrategy).

## Environment Observations

### Environment Views
Full environment layout and render-on-position views:

| Full Environment | Partial Top-Down Observations | Partial First-Person Observations |
|---|---|---|
| ![Full View Clean](assets/images/full_view_clean.png) | ![Top Middle TD](assets/images/render_on_pos_1_top_middle_room_topdown.png) ![Center TD](assets/images/render_on_pos_3_environment_center_topdown.png) | ![Top Middle FP](assets/images/render_on_pos_1_top_middle_room_firstperson.png) ![Center FP](assets/images/render_on_pos_3_environment_center_firstperson.png) |

## Installation

```bash
pip install miniworld-maze
```

## Usage

```python
from miniworld_drstrategy import create_nine_rooms_env

# Create environment
env = create_nine_rooms_env(variant="NineRooms", size=64)
obs, info = env.reset()

# Take actions
action = env.action_space.sample()
obs, reward, terminated, truncated, info = env.step(action)

env.close()
```

## Environment Variants

- **NineRooms**: 3×3 grid layout
- **SpiralNineRooms**: Spiral connection pattern  
- **TwentyFiveRooms**: 5×5 grid layout


## License

MIT License - see LICENSE file for details.