Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/VazkiiMods/Quark/llms.txt

Use this file to discover all available pages before exploring further.

Quark’s client modules run entirely on the local machine and do not require the server to have Quark installed (unless otherwise noted). They improve the Minecraft UI, add visual polish, and introduce quality-of-life keybinds — all without touching gameplay mechanics or giving any advantage in multiplayer.
All client features can be disabled independently. Features marked as purely client-side produce no change in server behavior when toggled.

Improved Tooltips

Richer tooltips for food, shulker boxes, maps, enchanted books, fuel, and attributes.

Chest Searching

A live search bar on any container screen that dims non-matching slots.

Usage Ticker

A HUD indicator showing total inventory counts for your held item and armor.

Camera Mode

A screenshot helper with composition guides, filters, borders, and overlays.

Greener Grass

A configurable color matrix that makes grass, leaves, and optionally water more vivid.

Variant Animal Textures

Cows, pigs, chickens, and allays spawn with alternate skins. Some animals can be shiny.

Buckets Show Inhabitants

Axolotl, tropical fish, crab, and slime buckets display the variant of their occupant.

Elytra Indicator

An icon in the armor HUD row indicates when you’re wearing a flyable Elytra.

Long Range Pick Block

Middle-click pick-block works up to 200 blocks away in Creative mode.

Microcraft Helper

Right-click a ghost recipe ingredient in the crafting grid to drill into sub-recipes.

Soul Candles

Candles placed on Soul Sand or Soul Soil burn with a blue soul-fire flame.

Auto Walk Keybind

Toggle auto-walking with a keybind, with an optional HUD indicator.

Back Button Keybind

Bind mouse button 4 (or any key) to act as a “Back/Done” button in any menu.

Uses for Curses

Curse of Vanishing on a carved pumpkin hides the overlay. Curse of Binding on a player head makes armor stands look like players.

Wool Shuts Up Minecarts

Minecarts traveling over wool (or any vibration dampener) make no sound.

Improved Tooltips

Replaces Minecraft’s sparse item tooltips with richer, more informative versions. Each sub-feature is independently toggleable:
Sub-featureDescription
Attribute TooltipsShows item attributes (attack damage, armor) visually with colored up/down arrows relative to your currently equipped item. Replaces the raw NBT-style attribute list.
Food TooltipsDisplays food value in hunger shank icons and saturation as a small bar. Configurable foodDivisor for modpack hunger overhauls.
Shulker Box TooltipsRenders a miniature grid of the shulker box’s contents in the tooltip. Optionally requires Shift. Color coding mirrors the box color (shulkerBoxUseColors).
Map TooltipsShows a thumbnail preview of a filled map in its tooltip. Optionally requires Shift.
Enchanting TooltipsOn enchanted books, shows the items that enchantment applies to (configurable list in enchantingStacks).
Fuel TooltipsDisplays how many items a fuel item can smelt (fuelTimeDivisor, default 200 ticks per item).
Attribute tooltips show a green up-arrow when the compared stat beats your equipped gear, and a red down-arrow when it falls behind. Set showUpgradeStatus = false to show all attributes in white instead.
This module is purely client-side — other players on the server see their own unmodified tooltips regardless of whether they have Quark.

Chest Searching

Adds a search bar to any container screen (chests, barrels, shulker boxes, etc.). Click the filter icon button (top-right of the container) to open it, or right-click to clear the search field. Search syntax:
  • Plain text → matches item display name (substring, case-insensitive)
  • "exact" → exact match (wrap in double quotes)
  • /regex/ → regular expression match (wrap in forward slashes)
Search also matches against:
  • Enchantment names on enchanted items and books
  • Potion effect names on potions
  • Creative mode tab names
  • The owning mod’s display name
  • Contents of Shulker Boxes (searches nested items recursively)
Non-matching slots are dimmed with a configurable overlay color. The search text turns red if no items match.
Chest Searching is entirely client-side — no data leaves your machine. The server only sees that you opened a container; the search itself is local rendering only.

Usage Ticker

Displays a small animated HUD element that pops up above the hotbar when the count or durability of your held items or equipped armor changes. The ticker slides in from below, displays the item with its total inventory count, then fades out. What it tracks:
  • Main Hand — shows total count of that item across all inventory slots; for bows/crossbows, shows the matching ammo count instead.
  • Off Hand — same logic as main hand.
  • Armor slots — shows each armor piece’s durability state.
The item shown and the total count displayed are driven by the IUsageTickerOverride API, so mods can customize what count is shown for their own items. Config options: invert swaps armor to the main-hand side, shiftLeft/shiftRight offset the position, and each slot group can be independently disabled (enableMainHand, enableOffHand, enableArmor).

Camera Mode

Press F12 (default keybind) to enter Camera Mode — a screenshot-focused interface that hides the game HUD and exposes composition tools. While in camera mode, press keys 1–5 to cycle:
KeyOption
1Post-processing filter (grayscale, sepia, desaturate, cool, warm, colorblind modes, etc.)
2Composition ruler (rule of thirds, golden ratio, center lines)
3Border / aspect ratio crop (Square, 4:3, 16:9, 21:9, Polaroid)
4Text overlay (date, postcard “Greetings from…”, player name watermark, held item name)
5 + ShiftReset all settings
EnterTake a screenshot
The date overlay format is configurable via dateFormat (default MM/dd/yyyy).
Camera Mode is purely visual — it does not pause the game or freeze entities. Take screenshots during actual gameplay for natural action shots.

Greener Grass

Applies a color convolution matrix to grass, foliage, and optionally water to make them more saturated and vivid. The effect is applied at render time and does not modify textures. Defaults: A mild green shift on grass and fern-like blocks. Leaves are also affected (affectLeaves = true). Water color adjustment is off by default (affectWater = false). Two built-in presets are available (“Dreary” and “Vibrant”) in addition to the default matrix. The convolution values can be fully customized per-channel via the colorMatrix config entry. The block list and leaves list are both configurable and include support for common modded blocks (Atmospheric, Autumnity, Environmental, Valhelsia Structures). This module is purely client-side — grass renders normally for players without Quark.

Variant Animal Textures

Animals spawn with alternate skin textures chosen deterministically from their UUID, so the same mob always has the same skin. Additionally, any animal has a 1-in-2048 (configurable) chance of being shiny — shown with a special gold/iridescent texture and occasional sparkle particles. Variant animals:
  • Cow — 4 alternate textures + 1 shiny
  • Pig — 3 alternate textures + 1 shiny
  • Chicken — 6 alternate textures + 1 shiny
  • Allay — 5 alternate textures + 1 shiny
  • Rabbit, Llama, Dolphin, Slime, Armadillo, Frog — shiny texture only (no alternate skin variants)
Bees: ~5.6% of bees render with an LGBTQ+ pride flag texture, selected from a pool of 17 variants by UUID. Custom named bees with a variant name (e.g. transbee) always show that flag. Set everyBeeIsLGBT = true to apply to all bees. All variant sub-features are individually toggleable. This module is purely client-side.
Shiny animals emit happy-villager sparkle particles every 10 ticks. This is a visual-only effect with no gameplay difference.

Buckets Show Inhabitants

Mob buckets display a model-based preview of their contents:
  • Axolotl Bucket — tints the bucket texture to match the axolotl’s color variant.
  • Tropical Fish Bucket — shows the fish’s base color and pattern on the bucket item.
  • Crab Bucket (if the Crabs module is enabled) — shows the crab’s shell color.
  • Slime in a Bucket — shows a shiny tint on the bucket if the slime was a shiny variant.
Each type can be toggled independently. This is done through item model properties and is purely cosmetic and client-side.

Elytra Indicator

When you wear an Elytra (or any item that can grant Elytra flight) in your chest slot, a small wing icon appears in the armor HUD row next to your armor bars. If your armor value is below the maximum (20), the icon shifts the armor display slightly so both fit on screen without overlapping. This is purely client-side — it renders a single additional icon and adjusts the armor bar position.

Long Range Pick Block

In Creative mode, middle-click pick-block now works up to 200 blocks away instead of the normal arm-reach range. If the normal raycast returns a miss, Quark fires a secondary 200-block raycast and uses that result instead. This only applies when the normal crosshair hit returns air or misses — it will never override a valid close-range block hit. Entity hits are also passed through normally. This is a client-only feature — it only changes what item gets placed in your hand locally.

Microcraft Helper

In the Crafting Table GUI with the Recipe Book open, right-clicking a ghost recipe ingredient (a semi-transparent item showing what you need) opens the recipe for that ingredient directly in the recipe book — effectively drilling down into sub-recipes. A small breadcrumb trail of items appears above the crafting grid, showing the recipe chain you’ve navigated. Right-clicking deeper ingredients continues drilling; when you have enough materials, the recipe book auto-pops back up the stack. A tooltip “Right-click to craft” appears on hoverable ghost slots to hint at the feature. This module is purely client-side.

Soul Candles

Candles placed on or above Soul Sand or Soul Soil (any block in BlockTags.SOUL_FIRE_BASE_BLOCKS) burn with a blue soul-fire flame and emit Soul Fire Flame particles instead of the normal orange flame. The smoke particle is also occasionally replaced with a Soul particle. Detection works one block above the soul fire base block (to allow candles on a slab or carpet over soul soil). This is purely client-side (particle and flame rendering only).

Auto Walk Keybind

Adds an Auto Walk toggle keybind (unbound by default, in the Quark misc keybind group). Press it once to start walking forward automatically; press the forward movement key or the auto-walk key again to stop. Auto-jump is enabled while auto-walking if your step height is below 1 block. An optional HUD message (drawHud = true) displays “Auto Walking” at the top-center of the screen with a blinking animation while active. Keybind: Unbound by default — set it in Controls → Quark - Misc. This is a client-only keybind feature.

Back Button Keybind

Binds Mouse Button 4 (the browser back button on most mice, by default) to act as a “Back”, “Done”, or “Cancel” button in any open Minecraft screen. The button searches the current screen for the first visible, active button whose label matches common back/close labels. Labels checked (in priority order): Back, Done, Cancel, To Title, To Menu, and Quark’s Save button. If no matching button is found but a world is loaded, the screen is simply closed (onClose()). Keybind: Mouse Button 4 by default. Can be rebound to any key or mouse button in Controls → Quark - Misc. Setting it to a mouse button on the Keybinds screen won’t instantly close the screen (a guard prevents that). This is a client-only feature.

Uses for Curses

Gives the two curse enchantments practical visual uses:
  • Curse of Vanishing on a Carved Pumpkin helmet hides the pumpkin blur overlay that normally obscures your vision while wearing one. The pumpkin still provides the same head slot protection — the overlay is just hidden.
  • Curse of Binding on a Player Head placed in an armor stand’s helmet slot makes the armor stand render using the player skin model (with arms, body proportions, etc.) instead of the armor stand model. The head must carry Curse of Binding for this transformation to apply.
Both behaviors are purely client-side.

Wool Shuts Up Minecarts

Minecarts traveling over Wool blocks (or any block in BlockTags.DAMPENS_VIBRATIONS, the same tag that suppresses sculk sensors) produce no rail sound. The check is performed against the block directly below the cart’s bounding box. This applies to all minecart variants (empty, chest, hopper, furnace, etc.). While the check logic runs on the server (for sound suppression), the audible result only differs on clients — the feature is safe to run on vanilla servers.

Build docs developers (and LLMs) love