Metadata-Version: 2.4
Name: mcio-ctrl
Version: 1.5.0
Summary: Python interface to connect to the MCio Minecraft mod
Author: TwoTurtles
Author-email: TwoTurtles <97465192+twoturtles@users.noreply.github.com>
License-Expression: MIT
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Dist: pyzmq>=26.2.0
Requires-Dist: cbor2>=5.6.5
Requires-Dist: glfw>=2.7.0
Requires-Dist: pyopengl>=3.1.7
Requires-Dist: gymnasium>=1.0.0
Requires-Dist: pillow>=11.0.0
Requires-Dist: imageio>=2.37.0
Requires-Dist: imageio-ffmpeg>=0.6.0
Requires-Dist: minecraft-launcher-lib>=7.1
Requires-Dist: tqdm>=4.67.1
Requires-Dist: requests>=2.32.3
Requires-Dist: ruamel-yaml>=0.18.6
Requires-Dist: dacite>=1.8.1
Requires-Dist: nbt>=1.5.1
Requires-Python: >=3.12
Project-URL: Changelog, https://github.com/twoturtles/mcio_ctrl/blob/main/CHANGELOG.md
Project-URL: Issues, https://github.com/twoturtles/mcio_ctrl/issues
Project-URL: Source, https://github.com/twoturtles/mcio_ctrl
Description-Content-Type: text/markdown

# mcio_ctrl

### [MCio mod](https://github.com/twoturtles/MCio) | [mcio_ctrl](https://github.com/twoturtles/mcio_ctrl) | [Documentation](https://github.com/twoturtles/mcio_ctrl/wiki) | [Discord](https://discord.gg/PBfdc27h4q)

`mcio_ctrl` is a comprehensive Python library designed to interface seamlessly with [MCio](https://github.com/twoturtles/MCio), a Minecraft Fabric mod tailored for AI agent development. It includes a versatile [Gymnasium](https://gymnasium.farama.org/) environment, making it ideal for reinforcement learning research and development.

## Key Features

* **Simplified Installation and Launching:** API and commands to easily install Minecraft with the MCio mod, create custom worlds, and launch the game directly from Python.
* **Pre-built Gymnasium Environments:** Offers example environments, including compatibility with MineRL 1.0 actions and observations, all leveraging the robust low-level API.
* **Customizable Base Environment:** A convenient base class for quickly creating tailored Gymnasium environments suited to specific research needs.
* **Interactive GUI Support:** Enables human control of Minecraft through the standard Minecraft controls using the MCio backend. (Seamless Human-in-the-loop is planned for future updates.)
* **Type-Hinting and Development Convenience:** Fully type-hinted for easier integration, improved code clarity, and streamlined development workflows.
* **BONUS:** Easily [set up VPT and STEVE-1](https://github.com/jxiong21029/mcio-vpt-example) on modern Minecraft with support for [Sodium](https://modrinth.com/mod/sodium)!


## Quick Links

* **Documentation:** Find comprehensive documentation and tutorials on our [Wiki](https://github.com/twoturtles/mcio_ctrl/wiki).

* **MCio Mod:**
  * [GitHub Repository](https://github.com/twoturtles/MCio)
  * [Modrinth Project Page](https://modrinth.com/mod/mcio)

* **Python Interface (`mcio_ctrl`):**
  * [GitHub Repository](https://github.com/twoturtles/mcio_ctrl)
  * [PyPI Package](https://pypi.org/project/mcio_ctrl/)
