Note: This project has been upgraded to Minecrftify 2.0. Therefore, it is no longer maintained and is not suitable for the latest version of Minecraft.

Minecraftify

A tool for converting 3D models to Minecraft blocks. 中文

Project Introduction

This project is a tool for voxelizing 3D models and converting them into blocks in the Minecraft world. It supports multiple 3D model formats, such as OBJ, STL, PLY, etc., and can perform conversions based on the materials (wool, concrete, terracotta, glass) selected by the user.

Installation

For Users

1. Download the latest release from the releases page
2. Extract the downloaded compressed package
3. Run Minecraftify.exe to start the application

For Developers

1. Clone this repository
2. Install the required dependencies:

   pip install -r requirements.txt

3. Rungui.py to start the application, or use the command line tool python mcify.py to perform conversions:

   # simple usage
   python mcify.py model.obj world_path
   # use more parameters
   python mcify.py model.obj world_path --start-pos 0,-60,0 --rotate 90,0,0 --pitch 0.5 --version 1.20.1 --no-wool --no-glass
   # view detailed parameter descriptions
   python mcify.py --help 

Usage Instructions for GUI

1. Prepare the 3D model file you want to convert. Supported formats include OBJ, STL, PLY, GLB, etc.
2. Create a new world in Minecraft, save and exit. It is recommended to choose a flat world.
3. Run Minecraftify.exe or gui.py to start the tool interface.
4. In the interface, select the 3D model file you want to convert and the path of an existing Minecraft world (usually Game Directory\saves\World Name\).
5. Check the materials to be used for the conversion. Currently, wool, concrete, terracotta, and glass are supported.
6. You can expand the advanced options to set the starting position, rotation angle, voxel size, game version, etc.
7. Click the "Convert" button to start the conversion.
8. After the conversion is completed, open the selected world in Minecraft, and you can see the converted model.

Notes

• Please ensure that the selected Minecraft world path is correct to avoid data loss.
• The Rotation Angle is in degrees. Three angles are used to represent the rotation of the model in the x, y, and z axes.
• Setting a smaller voxel size can improve the conversion accuracy, but it will also increase the conversion time.
• The conversion process may take some time, depending on the complexity of the model.
• The color of the block will be selected automatically from the materials checked.
• The conversion effect has only been tested in Java Edition 1.20.1. Other versions need to be verified.

File Description

• gui.py: The graphical user interface of the tool.
• tran.py: The core code for implementing the 3D model conversion logic.
• mcify.py: The command line tool for model conversion.