Breeze documentation

How to install Breeze, what each part of it does, and what to do when something goes wrong.

What Breeze is

Breeze Client is a free launcher for Minecraft: Java Edition on Windows, macOS and Linux, together with a mod that runs inside the game. The launcher signs you in with Microsoft, keeps a separate game folder for every Minecraft version you play, and makes sure each one has the Java runtime, the Fabric mod loader and the Breeze mod it needs. Inside the game, the Breeze mod adds a menu with 81 modules: HUD elements such as an FPS counter and keystrokes, visual changes such as zoom and a lower fire overlay, and utilities such as toggle sprint and shulker box previews.

Breeze is not a separate edition of Minecraft and does not replace the game. It starts the same Minecraft you would get from the official launcher, signed in with the same account, with Fabric and the Breeze mod added. Your account, your purchases from Mojang and your skin stay exactly as they are.

How the pieces fit together

When you press Play, several programs work together. Knowing which one does what makes problems much easier to place.

The Breeze launcher

The app you install. It handles sign-in, downloads, your version folders, mods from Modrinth, themes and settings. It runs on your computer, outside the game.

Fabric Loader and Fabric API

Fabric is the open-source mod loader Breeze is built on. The launcher installs the newest stable Fabric Loader and the matching Fabric API for the version you play. Any other Fabric mod you add runs on the same loader.

The Breeze mod

The part inside Minecraft: the menu, the modules, the HUD editor and the drawing of cosmetics. The launcher fetches the build made for your exact Minecraft version each time you play, so it is always up to date.

MCEF and Rinku

Open-source mods that embed a small Chromium browser in Minecraft. On 20 Minecraft versions the Breeze menu is a web page drawn by one of them: MCEF, which the launcher installs, on 1.20.1 to 1.21.4, and Rinku, which comes inside the Breeze mod, on 1.21.5 and newer. On the other versions the menu is made of Breeze's own in-game screens and no browser is needed.

The Breeze servers

Breeze's own online service, at api.breezeclient.net. It serves launcher updates and the Breeze mod files, and keeps track of cosmetics: who owns what and what each player is wearing, so other Breeze players can see it.

What is in this guide

Getting started

Install the launcher, sign in, pick a version and open the Breeze menu for the first time. Start here if you are new.

The launcher

Every page of the launcher, from Play to Config, and every setting with what it changes.

In the game

Opening the menu, the full list of 81 modules with their default keys, the HUD editor and where the mod keeps its settings.

Cosmetics

Capes, 3D cosmetics and tags: who sees them, how to get them, and how to equip them in the launcher or the in-game Wardrobe.

Supported versions

All 34 supported Minecraft versions, the Java each one uses, which ones have the web menu, and how each release is tested.

Troubleshooting

Sign-in errors, Xbox account problems, launch failures, crashes, a menu that will not open, and update problems, with the exact messages Breeze shows.

Questions and answers

Short answers about cost, safety, servers, other mods, Bedrock, your worlds and your data.

Words used in this guide

Version folder

The folder the launcher keeps for one Minecraft version, such as instances/1.21.4. It has its own mods, worlds, resource packs and settings, so a mod for one version never ends up in another.

Module

One feature of the Breeze mod that you switch on or off, such as FPS or Zoom. Each module has its own settings.

HUD

Heads-up display: the text and graphics drawn over the game, like the hotbar. Breeze's HUD modules add their own elements, which you place with the HUD editor.

Modrinth

A public website for Minecraft mods, resource packs and shaders. The launcher's Mods and Packs pages search it and install from it.

Wardrobe

The part of the in-game Breeze menu where you see and equip the cosmetics you own.

Wind Charges

The balance you spend in the launcher's Store. 64 Wind Charges cost 1 US dollar.