NAP Map Generator

NAP Map Generator addon useful for fast and easy (mini)map generation. The addon scans your game's 3D world and generates a top-down image of it, so you can use it in your game's map view or minimap radar.

Prerequisites

1. Godot 4.4.1 (Although lower versions might work, too)
2. 3D world consisting of at least one VisualInstance3D (e.g. MeshInstance3D).
3. A bit of patience.

Instructions

1. First, download the addon and put it inside your addons folder. The final path should be res://addons/nap_map_generator.
2. Switch to the 3D world/level you want to generate a map for, and add a new node called NapMapGenerator.
3. Select the NapMapGenerator node in your Scene tree. Now, set all the settings in the Inspector dock.
   • Level parent - you should select the parent node containing all your world's meshes.
   • Image directory - Point to a directory you want the image to be saved to.
   • Map scale - The generated image's scale factor. If your world is 100x100 meters and scale is 1.0 the image's size will be 100x100px. For scale value 2.0, the same image will be 200x200px big. You get the idea.
   • Simultaneous rows - The number of rows which will be scanned at the same time. Basically the bigger the number, the faster the scan is, but beware- too high value might result in unexpected behavior (e.g. crashing Godot)
4. Stay on 3D view in Godot. In the Inspector dock click Generate map button.
5. You will se now a bunch of cameras rolling through your world. Wait till you see a completion confirmation log in the Output console.
6. Navigate to the directory specified in Image directory field, you will find your map in there.
7. Enjoy!

If you encounter any issues, feel free to write about it in the Issues tab in the repository!