Add Waypoint Compass to your Roblox project in one command. Requires Node 18+ and a Roblox project — run robloxui init first if you don't have one yet. See the docs.
bashnpx robloxui add waypoint-compassFirst time? Start with the documentation.
import { Waypoint Compass } from "./src/client/ui/components/waypoint-compass";local WaypointService = require(script.Parent.WaypointService)
WaypointService:Add({ id = "quest", worldPos = Vector3.new(100, 0, 200), label = "Quest Giver", color = Color3.fromHex("#FBBF24") })3D-projected objective markers on a top strip. WaypointService tracks {id, worldPos, label, color}; CompassStrip projects each worldPos to screen space every frame, pins off-screen markers to the strip edge, and shows live distance from the player's HumanoidRootPart. Off-screen markers clamp to the strip edges with their label.
by RobloxUI Team
| Author | RobloxUI Team |
| Framework | Roblox-TS + React-Luau |
| Category | Settings |
| Dependencies | @rbxts/react |
| Theme Tokens |
| colors.primary, colors.primaryLight, colors.primaryDark, colors.secondary, colors.secondaryLight, colors.secondaryDark, colors.accent, colors.accentLight, colors.accentDark, colors.bg, colors.bgSecondary, colors.bgTertiary, colors.surface, colors.border, colors.borderLight, colors.glow, colors.text, colors.textPrimary, colors.textSecondary, colors.textMuted, colors.success, colors.successLight, colors.error, colors.errorLight, colors.warning, colors.info, colors.gold, colors.goldLight, gradients.primary, gradients.gold, gradients.health, gradients.mana, gradients.purple, gradients.card, gradients.surface, gradients.surfaceLight, spacing.3xs, spacing.2xs, spacing.xs, spacing.sm, spacing.md, spacing.lg, spacing.xl, radius.sm, radius.md, radius.lg, radius.xl |
| Last Updated | July 31, 2026 |