Godot Jumpstart: Mini-Map HUD - [Gold Edition] by poplava (original) (raw)

Jumpstart your godot project with a customizable 3D mini-map HUD for survival and exploration games built in Godot 4.5.

Add to your collection! Check out other tools and 'Jump Start' projects by clicking on "View all by poplava" (at top right).

Features

Controls

Input Action
W/A/S/D Move
Mouse Look around
Shift Sprint
Escape Toggle mouse capture
V Change camera perspective
M Configure Minimap
Mouse Wheel Zoom Minimap In/Out

Quick Start

  1. Open project in Godot 4.5+
  2. Run the main scene
  3. Move around and watch yourself on the mini-map!
    1. Try V
    2. Try M
    3. Try mouse-wheel

Integration Guide

Using the Mini-Map in Your Project

  1. Copy these files to your project:
    1. scenes/minimap/minimap.tscn
    2. scenes/minimap/minimap.gd
    3. scenes/minimap/player_arrow.gd
    4. scenes/minimap/cardinal_indicator.gd
  2. Instance the mini-map in your UI:

var minimap = preload("res://scenes/minimap/minimap.tscn").instantiate() $CanvasLayer.add_child(minimap)

3. Connect your player:

In your main scene func _ready(): minimap.set_player($Player)

Customization

Configure via Inspector or edit minimap.gd exports:

@export var map_size: Vector2i = Vector2i(200, 200) # Dimensions in pixels @export var screen_corner: ScreenCorner = ScreenCorner.TOP_RIGHT @export var margin: Vector2 = Vector2(16, 16) # Offset from edge @export var map_view: MapView = MapView.TOP_DOWN # Camera angle @export var camera_height: float = 50.0 @export var camera_ortho_size: float = 30.0 @export var show_cardinal_directions: bool = true @export var show_all_cardinals: bool = true # N only vs N/S/E/W

License

Support