Tutorial - 28Pollux28/ImageWorldGenerator GitHub Wiki

Tutorial

How to use Image World Generator ?

  • Go to curseforge.com and download the latest version of the mod for your game version.
  • Install fabric mod-loader for your game version (client or server), the fabric-api for your game version then place the mod file in the /mods folder.
  • Run the game.
  • In your game folder, a folder named config should have been created. Open imggen.json inside the config folder to start configurate the mod.

How to create my world ?

Biomes

  • The mod uses an image you have to draw using the color codes provided here to place the biomes in the world. Therefore open your favorite image editor and draw your world. Please do not use gradients on biome borders. Use sharp delimitations to avoid issues
  • Once the image is drawn, save it (PNG format is mandatory !) and place it in the /imggen/image/ folder.
  • Go to the config file, and set the biomesImageScale field to your image file name. Don't forget the extension.
  • You can find examples in the Showcase.

HeightMap

  • You can use a greyscale image to set the height of your world. To do so, draw a greyscale image, y=0 being 0x000000 (black) and y=255 0xFFFFFF (white). Save it and place it in the /imggen/image/ folder.
  • Go to the config file, and set the customHeightmap field to true. Then, change the heightMapName field to match with the HeightMap image file name.
  • The water level (sea level) can be changed using the seaLevel field. Do note that if the height on the HeightMap is under the sea level, it will fill with water until it reaches the sea level.
  • You can find examples in the Showcase

Structures

  • By default, the mod will generate structures using vanilla placement. To add custom structures placement, go to the config file, then modify the "customStructures" field to true. You can let the placeVanillaStructuresfield to true if you want the vanilla structure placement too. Note that you can enable them independently.
  • Unlike the biome generation, the image for the structures has specific requirements :
    1. Each pixel corresponds to a block, the center of the image representing the 0 0 of your world.
    2. The Background of the Image MUST be Black (0x000000 color code). Don't use transparent.
    3. To place a structure, use the corresponding color code and change the 1 pixel where you want your structure to be placed.
  • Place the image in the /imggen/image/ folder, then head toward the config file and change the customStructuresImage field to your image file name. Don't forget the extension ! Not meeting those requirements could lead to numerous structures spawning at the same point, resulting in this mess :

Creating the world :

On client versions :

  • On the create world screen, cycle down the different world type options, until you find the Image Generator type. Set up your options and hit the Create New World button. Generation might be slower than normal generation.

On server versions :

  • Go to your server.properties file and change the level-type field to imggen. As for client versions, generation can take more time than vanilla one.

Advanced Settings

Troubleshooting

My World is an normal one

Check if you've correctly set the World Type to Image Generator (client) or the level-type in your server.properties to imggen (server)

My World is only one biome

Check you've correctly place your image in the ../imggen/image folder and correctly set its name in the config file.

Max Image Size :

The width*height of your images MUST be lower than 2147483647. Super Large image support might come in a later version.

I get a java.lang.OutOfMemoryError when using the mod

Image handling is memory intensive and this error means that minecraft doesn't have enough RAM allocated. Try to allocate more or reduce the size of your image.