In the game

The Breeze mod adds a menu, 81 modules and a HUD editor to Minecraft. This page covers how to reach them and what each module does.

Opening the Breeze menu

Press Right Shift at any time, in a world or on the title screen. The title screen and the pause menu also have a Breeze button. To use a different key, change Open Breeze Menu in Minecraft's Options, Controls, Key Binds, under the Breeze heading.

Breeze also replaces Minecraft's title screen with its own menu, with the same Singleplayer, Multiplayer and Options buttons. If you prefer Minecraft's own title screen, turn off Breeze title screen in the Breeze menu's settings; Breeze stays one key away.

Two kinds of menu

On 20 Minecraft versions the Breeze menu is a web page drawn inside the game by an embedded Chromium browser: 1.20.1 to 1.20.4, 1.20.6 and 1.21 to 1.21.4 (with MCEF, which the launcher installs), and 1.21.5 to 1.21.8, 1.21.10, 1.21.11 and 26.1.1 to 26.3 (with Rinku, which comes inside the Breeze mod). It has a sidebar with Home, Mods, Wardrobe and Settings, search, and animations. On the other versions, the menu is made of Breeze's own in-game screens. Both have the same modules and the same settings, and your choices are saved in the same files. The versions page lists which is which.

The web menu's settings include a theme (the same ten themes as the launcher), an accent colour (blue, green, yellow, pink or red), interface size, animations, reduced transparency and how much the game behind the menu is dimmed.

Modules

A module is one feature you switch on or off. The menu lists them by category, with a search box; the in-game screens also have a Favorites tab for the ones you use most. Click a module's switch to turn it on; open the module to change its settings, such as colours, text, size and what it shows.

Every module can have a key. Seven come with one already, shown in the tables below. To give another module a key, find Toggle followed by the module's name in Options, Controls, Key Binds, under Breeze. When you press a module's key in a world, chat shows a short line such as [Breeze] Zoom: ON.

HUD: 36 modules

HUD modules draw information on screen. Each one is an element you can move and resize in the HUD editor, with a background panel you can turn off.

ModuleWhat it doesKey
Armor BarShows armor points.
Armor StatusShows each armour piece and what is in your hands, with durability as a percentage, a number or a bar. Look: Breeze, or Hotbar to show them in Minecraft's own hotbar slots, like a second hotbar.
Attack IndicatorShows attack cooldown charge.
Block IndicatorShows the block you are aiming at.
CPSShows clicks per second.
Combo CounterTracks consecutive hits.
CoordinatesShows player coordinates.
Day CounterShows the in-game day number.
Death InfoRecords your last death location.
DirectionShows facing direction.
FPSShows current framerate.
HeartsShows numeric health.
Held ItemShows the item in your hand.
Horse StatsShows your horse's speed, jump and health.
Inventory HUDMirrors your inventory onto the HUD.
Item CounterCounts held item across inventory.
Item Despawn TimerShows item despawn countdown.
Item InfoShows held item details.
KeystrokesShows WASD + jump keys.
Mouse StrokesShows mouse buttons.
Pack DisplayShows the active resource pack.
PingShows server latency.
PlaytimeShows session playtime.
Potion EffectsLists active effects.
Reach DisplayShows how far away your last hit landed.
Recording IndicatorShows a recording indicator.
SaturationShows food saturation.
Server AddressShows the current server address.
Speed MeterShows movement speed.
StopwatchA simple stopwatch.
System ResourcesShows RAM and CPU usage.
TNT TimerShows nearest TNT fuse.
TPSEstimated server ticks per second.
TimeShows the current time of day.
Totem CounterCounts totems of undying.
WaypointDrops a marker and shows distance back.

Visual: 22 modules

Visual modules change how the world and the screen look.

ModuleWhat it doesKey
Block OverlayOutlines the targeted block.
Boss BarHides the boss health bar.
Custom CapeAdds a wave to capes, and shows your own cape image from the breeze_capes folder when no Breeze cape is equipped.
Custom CrosshairReplaces the crosshair with a custom dot.
Damage IndicatorFloating damage numbers on entities.
Dark ModeDarkens GUI backgrounds.
FOV ChangesDisables FOV shift from sprint and speed.
Friend GlowGlows players marked as friends.
Hit IndicatorFlashes a marker when your attack lands.
HitboxesRenders entity hitboxes.
Item PhysicsLays dropped items flat on the ground.
Item ScaleResizes the held item model.
Light Level OverlayShows block light for mob-spawn checking.
Loot BeamsRenders a beam over dropped items.
Low FireLowers the fire overlay while you are burning so you can see. At 100% it is hidden.
Mob OverlayHighlights mobs with a glow outline.
Name TagsScales entity name tags.
No Hurt CamRemoves the camera tilt when hurt.
No View BobbingDisables view bobbing.
Player ModelEnables all skin layers.
Smooth CameraCinematic camera smoothing.
ZoomToggles a zoomed-in FOV.C

Utility: 22 modules

Utility modules change how the game behaves for you.

ModuleWhat it doesKey
Auto Hide HUDHides the vanilla HUD.
Auto PerspectiveThird-person while flying or riding.
Custom AdvancementsHides advancement toasts.
Drop PreventionBlocks accidental item drops.
FullbrightLights everything up fully, without changing your brightness setting.G
Keybind SearchOpens a searchable keybind list.K
Nickname HiderMasks your own name in the tab list.
PerspectiveCycles the camera perspective.P
ReconnectReconnects to the last server.
ScoreboardHides the sidebar scoreboard.
ScreenshotsTakes a screenshot on its keybind.F8
Shulker TooltipsPreviews shulker box contents on hover.
Sound FilterMutes sounds in the muted list.
Subtitles ToggleTurns sound subtitles on.
Time ChangerHolds the client-side world time of day.
Title TweakerHides on-screen title and subtitle text.
Toast ControlHides all toast notifications.
Toggle SneakKeeps you sneaking without holding the key.
Toggle SprintAlways sprint.V
TooltipsAdds the item id to tooltips.
UI ScalingForces a custom GUI scale.
World BackupsBacks up the current singleplayer world.

Chat: 1 module

ModuleWhat it doesKey
Auto TextSends a preset chat message on its keybind.N

Some servers do not allow every module. Fullbright, Light Level Overlay, Mob Overlay and Hitboxes in particular change what you can see, and a server may count them as an unfair advantage. Read a server's rules and switch off what it does not allow. See Can I use Breeze on servers?

The HUD editor

The HUD editor moves the real HUD: what you place there is exactly where it appears in game. Open the Breeze menu in a world and choose Edit HUD layout (on the web menu it is on the Mods page and the Home page). The editor needs a world because it shows the HUD over it.

ToDo this
Select an elementClick it, or press Tab to go through them in turn
Move itDrag it. It snaps to the screen edges, the centre and other elements, with guide lines. The snap button turns snapping off.
Nudge it by one pixelArrow keys
Resize itScroll the mouse wheel over it, press + or -, or use Bigger and Smaller
Put it back where it startedDelete, or Reset
Change its lookSettings, with the element selected
Show or hide an elementIts switch in the side list
Hide the side panelH, or Hide; H again brings it back
Lay everything out neatlyArrange
Start overReset all
Keep your changesDone, Enter or Escape
Throw your changes awayCancel, which puts every position and size back as it was when the editor opened

Positions are stored relative to the nearest screen edges, so a layout made in a small window still fits when you go full screen or change the GUI scale, and no element can end up off screen. Breeze also keeps elements clear of the hotbar and health bars when it first places them.

Where the mod keeps its settings

Each version folder has its own copy, so a layout on 1.21.4 does not change your layout on 1.20.1. The files are in the version folder's config folder:

FileWhat it holds
breeze.jsonWhich modules are on, and every module setting
breeze_hud.jsonThe position and size of each HUD element
breeze_theme.jsonThe menu's theme and colours

To copy your setup to another version, close Minecraft and copy these files into the other version's config folder. To reset Breeze completely for one version, close Minecraft and delete them; Breeze starts again with its defaults.