Minimap System

The minimap shows a subset of the world map at the top-right corner of the player’s screen. It also displays an indicator to show where you are, where the delivery vehicle is, and where your teammates are when playing in team mode. Lastly, it shows the current state of the storm and where the storm will be next so players know how to avoid it.

Players can toggle between the minimap and world map by pressing M on a keyboard, pressing up on a gamepad’s DPad, or by touching the minimap on touchscreens.

Structure

The minimap is simply an ImageLabel that displays a previously-generated image and uses CollectionService to show the position of objects with specific tags. All of the UI objects used for the minimap are inside of the minimap screen GUI located in ReplicatedStorage/Assets/GuiObjects.

Adding Indicators

To add new indicators that show up on the minimap, complete these steps:

Add a CollectionService tag to the workspace object that you want to show up on the minimap. One way to assign tag(s) is by calling CollectionService/AddTag|CollectionService:AddTag() from the Command Bar in Studio, where indicatorObject is the object and tag is the desired tag.

			
				Expected Output
			
				Expand
				
			game:GetService("CollectionService"):AddTag(indicatorObject, tag)
		
				Copy Code
			
				Light Theme

Add the ImageLabel you want to represent the object as a child of ReplicatedStorage/Assets/GuiObjects/minimap/mapframe and give it a unique name.
Inside of ReplicatedStorage/Libraries/Guis/MinimapGui, locate the MinimapGui.start() function. Inside it, register the tag as shown below, where tag is the tag you registered in step #1 and indicatorLabel is the name of the ImageLabel you added in step #2.

			
				Expected Output
			
				Expand
				
			function MinimapGui.start(teamDividingAngle)
	while not _setupFinished do
		wait()
	end

	MinimapGui.addMapTag("DeliveryVehicle", "Bus")
	MinimapGui.addMapTag(Util._clientFocusTag, "LocalPlayerLocation")
	MinimapGui.addMapTag("Player")
	MinimapGui.addMapTag("Vehicle", "VehicleLocation")
	MinimapGui.addMapTag(tag, indicatorLabel)
		
				Copy Code
			
				Light Theme

Customizing the Minimap

To customize the minimap or use the minimap system with your own map and minimap image, you can change these values in ReplicatedFirst/Configurations/MainConfiguration:

Variable	Description
`map_size`	The size of one edge of your map in studs. Note the minimap assumes your map is square and that the map center is located at this world point: `Vector3.new(map_size, 0, map_size)`.
`minimap_width`	Width in `datatype/UDim\|UDim` scale of the minimap on the player's screen.
`minimap_height`	Height in `datatype/UDim\|UDim` scale of the minimap on the player's screen.
`minimap_zoom`	Amount the minimap is zoomed in on the world map.
`worldmap_width`	Width in `datatype/UDim\|UDim` scale of the world map on the player's screen.
`worldmap_height`	Width in `datatype/UDim\|UDim` scale of the world map on the player's screen.
`worldmap_zoom`	Amount the world map is zoomed in on the worldmap.

Previous Building System Next The Storm