/pixel-art-map

Shows a map for a pixel art of any image.

Primary LanguagemcfunctionMIT LicenseMIT

pixel-art-map

This repo is now archived. Please refer to https://github.com/Eric-Mendes/unexpected-isaves in case you still want to map an image to a Minecraft pixel art.

Maps an image to a minecraft pixel art.

2022-01-11_19 52 33

Setting up the environment

Assuming you have python >= 3.9 and pipenv installed:

# Cloning the repo 
git clone https://github.com/Eric-Mendes/pixel-art-map.git
cd pixel-art-map/

# Opening the environment and installing the dependencies
pipenv shell
pipenv install

Running the project

Essentially all you need is to get your image ready and tweak the parameters on the pixel_art_map/config.ini file. No manipulation of the main.py file is necessary.

  1. Get any image you want and put it inside the images/ folder OR copy the url of an image on the internet;

    • IMPORTANT: passing an url will download the image into the images/ folder. If you think that some url looks sketchy, do not use it.

  2. Correctly pass the path or the url to the image string:

    • image=naruto.png or
    • image=https://media.geeksforgeeks.org/wp-content/uploads/20210318103632/gfg-300x300.png (just an example of an url)

  3. Lower the dimensions a little by a factor (a big pixel art takes a long time to build when building block by block.):

    • factor=15

      • What's the best factor for your image? You have to find that out by trying different numbers when you resize it.

  4. player_x, player_y and player_z: the player's position.

  5. From source, run the code (keep in mind that you need to be inside the pipenv shell):

python3 pixel_art_map/main.py

The output will be inside the output/ folder and it'll be another folder with the same name of your image. This folder should contain a map.csv file where each cell corresponds to a block. Place the blocks by going cell by cell and in the end you'll have your pixel art.

The folder will also have a metadata.txt file with metadata about the pixel art, such as a total of all the blocks you'll use and a total by column of the blocks you'll use in them, so that you know how to organize your inventory. Besides that, a datapack/ folder will also be generated and it will contain a datapack for you to use in world. If you go to your world, open chat and type /reload you should see the image appearing.

Adding a datapack to your world

Copy the folder inside the your images datapack/ folder to your:

  • On Windows: %appdata%/.minecraft/saves/map_name/datapacks
  • On Linux: ~/.minecraft/saves/map_name/datapacks

Where map_name is your map's name.

Special thanks to everyone that contributed to the commands file feature @ https://stackoverflow.com/questions/70512775/how-to-group-elements-in-dataframe-by-row/70546452#70546452