GroomLab

GroomLab app

The standalone GroomLab app for Windows (beta) - installing it, its layout, brushes, graph, look-dev, cards and export.

Beta

The standalone app is in beta on Windows. It is usable, but details may change before the first release. Keep backups of important grooms, and report problems to support@getgroomlab.com with the log file (see below).

The GroomLab app grooms, lights and exports grooms without Maya. It uses the same evaluation core as the Maya plug-in, so a .groom file evaluates to the same strands in both.

Quick start

Your first groom, from a head mesh to an exported file. Install the app first.

Start a groom on a mesh

Choose File > New Groom on Mesh... (Ctrl+N), or New groom on mesh on the start card, and pick the head as an .obj or .abc file (or try GroomLab > Add Sample Mesh). The groom starts with the default graph and no guides, so it has no hair until you place some. (A .groom file from Maya or Blender opens with File > Open Groom..., Ctrl+O.)

Place guides

In Groom Tools on the left, pick Place (or Place some guides on the Your first groom card over the viewport) and click or drag on the scalp. Shape the guides with Comb. Hold B and drag to size the brush, or hold Y and click for the marking menu. For more detail, choose Edit Guides > Children under Guide groups.

Pick a look

In the Graph Editor at the bottom, open Presets, pick a category and a preset and choose Apply. The preset is fitted to your scalp and grows from your guides. For the hair color, switch to Look mode (View > Mode > Look, Ctrl+2) and use the Material tab in Properties.

Tweak it in the graph

Click a node in the Graph Editor, for example the Clump, and drag its sliders in the settings beside the graph; the groom updates as you drag. Tab over the graph adds a node.

Save and export

File > Save (Ctrl+S) writes a .groom file that Maya and Blender open. Export mode (Ctrl+4, or File > Export, Ctrl+E) writes Alembic, USD, an Unreal groom, Unity strands or glTF cards; the Export tab of Properties and GroomLab > Export have the same targets.

Install

The app needs Windows 10 or 11 (64-bit) and a graphics card with Direct3D 11. There is no installer:

  1. Download the GroomLab app (also on the Download page, with its SHA-256).
  2. Unzip the whole folder anywhere you can write to, and run GroomLab.exe in it. Windows SmartScreen may warn about a new download: choose More info, then Run anyway.
  3. It is free, with every feature and export enabled. Help > Support GroomLab opens the Ko-fi page.

Help > Check for Updates... reports a newer version. To update, download it, close GroomLab and unzip it over the old folder; settings and recent files are kept. The log file for bug reports is %LOCALAPPDATA%\GroomLab\logs\GroomLab.log. README_BETA.txt in the app folder repeats these notes.

Open a groom

With no groom open, the viewport shows Open groom, New groom on mesh, Start from a preset and the recent files; the Graph Editor's menus and Render wait until a groom is open. Start from a preset (or Presets > Apply on a Mesh...) asks for a mesh, makes the groom on it and applies the look. After New Groom on Mesh a small Your first groom card over the viewport (bottom left, in Groom mode) lists the first steps (place some guides, give it a look), the next one highlighted and the done ones struck through; the cross hides it for good. View > Tool Labels turns the tool tiles' names off for compact icon tiles.

  • File > Open Groom... (Ctrl+O) opens a .groom file, saved here or from Maya.
  • File > Open Recent lists the last files opened or saved (a file that is gone is greyed out; Remove Missing Files and Clear Recent Files tidy the list).
  • File > New Groom on Mesh... (Ctrl+N) starts a groom on an .obj or .abc mesh, with the default graph and no guides. An animated Alembic mesh becomes the groom's scalp cache, so the animation is kept. GroomLab > Add Sample Mesh starts one on a shipped head (Nika, Manny) or the wolf.
  • Or drop a .groom, .obj or .abc file on the window.
  • File > Add Prop Mesh... loads another mesh beside the groom (a body, clothes, a hat). Props are drawn and lit with the groom, and a ColliderMesh node can name one to keep the strands off it (Colliders).
  • File > Add Eye... adds an eye: a prompt over the viewport takes its center, the direction it looks and its radius (prefilled in front of the scene), as --eye does on the command line.
  • File > Save Image... saves the current view as a PNG.

File > Reload from File (Ctrl+R) reads the saved file again. When the groom has unsaved changes, Reload, closing the window, Quit (Ctrl+Q), Open, New and a dropped or recent file ask first in a prompt over the viewport: Save, Discard or Cancel. GroomLab > Utilities > Transfer Groom to Scalp... moves the groom onto another mesh in the same two-view window as Maya's: pick a method, then click marker pairs on both meshes or import them from a JSON file (Utilities). Open, New Groom on Mesh and Transfer show a busy cursor and say what they are doing while they work. GroomLab > Guides from Photos (experimental)... grows guides from reference photos (Guides from photos), and View > Turntable turns the camera around the groom.

Autosave

File > Autosave saves a groom with unsaved changes every 5 minutes (or 1, 10, 15 or 30; Off turns it off) to a copy beside its file (hair.groom~; an untitled groom's goes in the settings folder). Saving, discarding the changes or closing the window lets the copy go. If GroomLab closes before that (a crash), the next start offers it in a prompt: Recover opens it in the file's place with the changes unsaved, Discard deletes it, Later asks again next time.

The layout

The window is laid out as Maya's: a menu bar, the viewport in the middle and docked panels around it. There is no tool bar.

WhereWhat
TopThe menu bar: File, Edit, View, GroomLab (the same menu as Maya's and Blender's GroomLab menu, in the same order) and Help. In its right corner: the groom's file name, Render and Export, the menus of what comes after grooming. The window's title is the file's name; * means unsaved edits.
LeftGroom Tools: the brushes, guide groups, maps, correctives and photos.
RightProperties: what the mode is about (the groom's settings, the look, the cards or the export).
BottomThe Graph Editor with the selected node's settings beside it, and the timeline under it while the groom animates.
Viewport, top rightUndo and Redo.
Viewport, top left and bottomThe active tool's name, the strand count line (GroomLab > Review > Strand Count HUD), messages and, for a new groom, the Your first groom card.

Both side docks have an icon rail on their outer edge in place of tabs. The Groom Tools rail holds Tools, Paint, Correctives and Photos; the Properties rail holds the app's modes: Attributes, Material, Lighting and Render (grooming and the look, with the Groom Tools), Cards and Export. Hover an icon for its name; the open page's name is the title at the top of the dock. View > Mode picks the pages too: Ctrl+1 Attributes, Ctrl+2 Material, Ctrl+3 Cards, Ctrl+4 Export. The Render page also holds the render actions (RenderMan, V-Ray).

Click the open page's icon again to fold the dock down to its rail and give the viewport the room; a small bar marks the page it opens on. Any icon (or a mode's shortcut) opens it again at its width. View > Panels > Fold Groom Tools and Fold Properties do the same from the keyboard (Ctrl+[ and Ctrl+], or Alt+Shift+Left and Alt+Shift+Right on keyboards where brackets need AltGr); Shift+1 to Shift+4 open the Groom Tools' pages. Docks can be moved, tabbed together or floated (a floated dock always opens); View > Panels shows or hides each one, and the layout, folds included, is kept for the next start. The Graph button at the bottom of the viewport shows or hides the Graph Editor (Tab too).

A timeline bar appears under the viewport when the groom is animated (a scalp or guide cache, or a graph that reads the time). It supports play, scrub and loop; Follow toggles follow-the-scalp. With a Simulate node in the graph it also shows Simulate, Bake and Clear (also in GroomLab > Simulate); while it runs, Simulate reads Cancel (the frames made stay in the cache).

Groom Tools

The Groom Tools dock holds the same pieces as Maya's Groom Tools window, from the same shared definitions, and the whole dock scrolls. At the top: the groom's name with its eyes (the hair alone: the strands, instances and cards go and come back at once while the guides stay; and the guides alone: every guide group; View > Guides On/Off and Alt+Shift+G too), the Graph Editor and More buttons, the tabs and the tool grid (tiles of one size, as many to a row as the dock's width holds, at most four; on the Paint tab one full-width Paint button). Under the grid, the tab's list, then the picked tool's card:

  • Tools: every tool as a tile (Create, Shape, Trim and Paint brushes, then Select, Freeze and Unfreeze All), the tool's card and Guide groups.
  • Paint: Paint's card and the painted maps (vertex maps, textures, guide layers) with their bar and right-click menu (Painting maps).
  • Correctives: shot-sculpt layers (Correctives).
  • Photos: reference photos to groom to (Photos).
  • Outliner: the document's grooms, each under its scalp (Several grooms).

Simulate Range, Studio, Transfer Groom to Scalp... and Import are in the GroomLab menu; the render actions are also in the Render tab of Properties, and the export in its Export tab.

Groom with brushes

Pick a tool tile in Groom Tools. The tiles hold the same brushes as Maya, in the same order: Create, Shape, Trim and Paint, then Select and Freeze. See Guides and brushes for what each does.

  • Drag on the groom to stroke. Shift smooths; a negative strength reverses a brush that works both ways.
  • Freeze paints a per-guide freeze mask; other brushes skip frozen guides, which draw blue. Ctrl unfreezes; Unfreeze All clears the mask.
  • Shift+drag smooths with any brush: the guides, a painted map, the Tube brush's channel. Select guides with the Select tool (Select mode). Ctrl does the brush's opposite. Page Up and Page Down step the level. Solo new guides on the Place card solos guides as you place them; Select mode solos the selection.
  • Hold B and drag, or middle-drag, to set the radius. Hold M and drag, or Shift+middle-drag, to set the strength.
  • Alt+Shift+X turns symmetry on or off.
  • Hold Y and click for the marking menu.
  • Alt with any mouse button moves the camera, whatever the tool.
  • Esc leaves the brush for the camera.

The active tool's card holds its settings in Maya's blocks and order: Brush (Radius, Strength, Falloff, Smooth; the chips Pressure, Keep off scalp, Stretch (Comb), Straighten (Smooth), Falloff curve, Root to tip, and the app's own Propagate and Pointwise), the tool's own block, then Applies to (Guides, Parts, Flow and Mirror: World X, Topology, or the app's World Y and Z). A tool tile's tooltip has the tool's whole hint and, for a brush, the gestures. How the strands draw while you sculpt is in Properties > Sculpting.

Guide groups lists the guide groups, always open right under the tool grid (over the card): click a row to pick the group the brushes edit and new guides go into; its eye hides it; double-click to rename it; right-click for its menu. Isolate (the eye in the section header) shows only the picked group and its child groups at full color, and + adds a root or child group. The picked group's box under the list renames, selects or removes it, resamples guides (Segments) and has Edit Guides (children, sync and mirror, reparent, promote or demote). Part lines drawn with the Part brush are listed on its card. See Guide groups.

Tubes

The tool cards set the cross-section the guides' tubes have. Place and Draw's Tube block picks the shape new guides get, with its Width, Flatness and Twist. The Tube card have Profile (the shape: round, flat, your own drawn in the outline editor and kept in the groom's library; Apply gives it to the selected or soloed guides) and Selected guides (their Width, Flatness, Twist and Smooth). Width shows in the length unit picked in the Graph Editor's Edit > Units. The Tube brush paints width, flatness or twist along a guide. Fill Tubes and Tube Blend are the Interpolate node's settings.

The marking menu

Hold Y and press the left mouse button over the viewport: the marking menu opens around the cursor, as Maya's GroomLab marking menu does. Comb, Slide, Smooth, Cut, Place, Draw, Length and Lift sit at the compass points; the rest of the brushes are listed below them, then Select, Freeze and Groom Tools.

  • Drag toward an item and let go to pick it. A compass item is picked by direction alone, so a short flick is enough.
  • Let go without moving and the menu stays open: click an item. Click in the middle, or press Esc, to close it.

The Graph Editor

The Graph Editor is docked at the bottom, with the selected node's settings at its right (as in Maya). GroomLab > Graph Editor (or Tab) shows it and puts the focus on it. Its bar has Add Node, Presets and Edit menus and a status line.

  • Tab over the graph searches for a node to add, by name, by what it does (symmetry finds Mirror, frizz finds Noise) or by category. Enter adds it, wired after the selected node when their ports match. Add Node lists the nodes by category, and new script nodes, imported nodes and the nodes folder.
  • Drag from an output port to an input to wire them. Drag a wire off an input to disconnect it. Dropping a node on a wire inserts it there.
  • Click a node to select it; its params show beside the graph. Ctrl+click toggles a node in the selection, Shift+click adds one, and dragging on empty space selects in a box; dragging a selected node moves them all. Delete and B act on the whole selection; Ctrl+C / Ctrl+V copy and paste the selected nodes with the links between them.
  • V (View Up to Here) shows the groom up to the selected node instead of the output's (the node says VIEWING; V again goes back). Exports and renders still use the output.
  • A node that fails to evaluate gets a red ring and a ! badge; its error is in its tooltip and under the title in its settings.
  • Dragging a link over a port it can't feed says why; dropping it there changes nothing.
  • Ctrl+G groups the selected nodes into one Compound node, as in Maya's Graph Editor: the links from outside become its inputs, and one of the nodes must feed the rest of the graph. Double-click a Compound (or select it and press Ctrl+Shift+G) to open it: its nodes go back into the graph where they were. Ctrl+Z undoes either in one step.
  • Backdrops frame part of the graph: right-click a node > Add Backdrop Around Selection, or right-click the canvas > Add Backdrop, and type its title. Drag its title bar to move it with the nodes on it, drag its corner to resize it, double-click the title to rename it, right-click it for Color and Delete Backdrop (or select it and press Delete).
  • Pins tidy the wires, as in Maya's Graph Editor (Unreal's reroute nodes): double-click a wire for a pin, drag it to route the wire, drop it on another pin of the same output to bundle them, drag from its right side for another wire of its signal, drop a wire from an output on it to feed all its wires from there; Delete removes a selected pin. Snap on the Graph Editor's bar puts nodes and pins on the grid as you drag them.
  • Right-click a node for Maya's node menu: rename, duplicate, bypass, delete, set as the output, bake, upgrade and more. Right-click the canvas to add a node or a backdrop, tidy the layout or frame the graph.
  • Middle-drag pans; scroll to zoom. F frames the selected node (none: the whole graph), A the whole graph. Alt+drag moves the camera. Esc gives the keys back to the viewport.

The Edit menu has undo and redo, framing, Tidy Layout (Ctrl+L), grouping, copy and paste, Units (show lengths, widths and densities in centimeters, millimeters, micrometers, inches or scene units), the theme, GPU Preview and Reload from Groom. Each edit is one undo step. See Node graph for the nodes.

Presets

The Graph Editor's Presets menu (or View > Graph Presets) lists the presets by category; hover one for its description. Each preset has two actions:

  • Apply replaces the graph with the preset.
  • Insert after selected node keeps your graph and adds the preset's look as one Compound node after the selected node, or before the output when nothing is selected.

In both cases the preset's lengths and densities are scaled to your scalp, any maps it reads are created, and the change is one undo step. The same menu has Save as Preset..., Copy Graph and Paste Graph (the graph as JSON text, to share or paste onto another groom). See Presets.

Parameters

Click a node in the graph (or in Node List, from View > Panels) to edit it.

  • Params are grouped under collapsible headers. Rarely used params are in Advanced, collapsed.
  • A param is hidden while the node's other settings make it inactive.
  • Numbers show their unit (percentage, degrees, turns, seconds or pixels; lengths, widths and densities as Edit > Units picks).
  • Ramps have a curve editor. Mappable params can take a constant, a painted map, a texture, a color set, an expression or a field. Right-click a param for its menu (paint it, link it, expose it as an input, Drive with Slider).
  • Bypass passes the node's input through unchanged.
  • Upgrade appears beside the title when the node was saved with an older version of its operator. It switches the node to the newest behaviour, as one undo step.

Dragging a slider updates the groom during the drag. With GPU Preview on, the GPU evaluates the preview during the drag and the CPU evaluation runs on release.

Painting maps

Open the Paint tab in Groom Tools. + New Map creates a vertex map, a texture map or a guide layer, grayscale or color. Pick a map and click Paint this map; the brush paints toward the set value or color, Ctrl toward 0 on a grayscale map (toward 1 when the value is 0) and toward the inverse color on a color map. Show on scalp displays the map on the scalp. Import... brings an image in as a map; right-click a map to rename, convert or delete it, make it color or gray, or relink or reload a texture map's image.

To paint a setting, choose + New Map > for a setting (Density, Width, Length, Clump strength, Curl, Noise amplitude, Flyaways, or any mappable param of the graph), pick vertex or texture map, and create it: a white map is created, connected to the setting, selected and painted with the paint brush, in one undo step (if the setting already reads a map, that map is selected instead). Strokes paint toward the value (1: the setting's full value); Ctrl paints toward 0, so Ctrl on the density map removes hair. A mappable param's Paint pill does the same for that param. See Painting maps.

Correctives

The Correctives tab holds shot-sculpt layers applied over the animated groom. A New layer applies on every frame; Fix this frame creates a layer at full weight on the current frame that fades in and out over six frames. Pick a layer under Sculpt into to send brush strokes to it instead of the guides. Right-click a layer to solo it or key its weight.

Photos

The Photos tab holds reference photos to groom to, each with its own camera. Double-click a photo (or Look Through) to see the groom through its camera with the photo in the frame; Lock keeps the camera there. Opacity, in front or behind and the eye set how the photo shows; Focal Length sets the camera's lens. Align Photo... opens the Photos window on the picked photo: the photo and the mesh side by side, point pairs clicked on each, the camera lined up as you go. Guides from Photos opens the same window's Guides stage (Reference photos).

Several grooms

A document holds several grooms, each on its own scalp, as a Maya scene or a .blend does: hair and a beard, or a character's fur and its creature's. The Outliner tab lists the scalps with the grooms on them.

  • Add Groom... grows another groom on a mesh file (.obj or .abc), named after it, and makes it the one you work on. Pick a groom file (.groom) instead and its grooms join the document: Maya and Blender save one groom a file, so a character's grooms come together here.
  • Click a groom to work on it: every tool, panel, the Graph Editor, undo and the exports work on that groom. The others are drawn as plain gray strands with their scalps; the box beside one shows or hides it. Frame All fits every groom.
  • Double-click to rename; the right-click menu has Remove Groom (the last one stays).
  • Save writes every groom into the one .groom file, and opening it brings them all back. Each groom's painted maps and card bakes go in its own folder, groomlab/<file name>/masks/<groom>/ and cards/<groom>/. Maya's and Blender's Import Groom bring in every groom of such a file, each on its own scalp; a GroomLab older than 0.44 opens the first.

Properties

The Properties dock follows the mode:

  • Groom mode: the groom's settings in the order of Maya's Attribute Editor: Groom (preview density, point budget), Inputs (the scalp, rest and guides, the collider, the file), Controls, Hair Color, Display (guides, strand shading), Sculpting (how the strands draw while a stroke is live, and their density), Game Cards and Rendering. The point budget is 0 (no limit) by default; set one to keep very large grooms interactive (past it the preview thins itself). Each Inputs row has a small icon button for its action: transfer the groom to another scalp, edit the guides, add a collider, reload or save the file.
  • Look mode: the look card (Look).
  • Cards mode: the cards panel (Game cards).
  • Export mode: the export panel (Export).

Scalp Subdivision

Inputs > Scalp Subdivision (Off, 1, 2, 3) smooths a low-poly scalp with Catmull-Clark subdivision, as Maya's smooth mesh preview (the 3 key) or Arnold's subdivision does. The hair grows on the smoothed surface, and the viewport draws that surface instead of the mesh itself. Brushes, Place and Draw, part and flow strokes, map painting, and the picks in Transfer and Guides from Photos all land on the smoothed surface.

  • Each level makes four times the triangles. The count beside the setting shows how many the hair grows on; it turns to the warning color past 2 million, where brushes and the viewport slow down.
  • Painted vertex maps stay on the mesh's own vertices and blend smoothly across the smoothed surface, as in Maya.
  • The Scalp node's default (Match Render) follows this setting. A Scalp node set to a level of its own wins; the count then says so.
  • One undo step. Saved in the .groom file as the scalp's subdivision level: a groom saved from Maya with a smoothed scalp opens at its level.

Look

Look mode (Ctrl+2) shows the look card in Properties, with three tabs:

  • Material: hair color swatches (the groom's own, black, brown, blonde, red, white, dyed), HairColor's two ways (Natural: Melanin and Redness; Picked color: a Color), Roughness, Tip color and Tip strength, Hue random and Saturation random. These edit the groom's HairColor node, so they are saved with the groom. More settings shows every hair material setting and the other surfaces (scalp, props, eyes).
  • Lighting: presets (studio, daylight, overcast, sunset, rim), exposure, the lights, an environment, the tone map and the background. GroomLab > Studio applies the same presets.
  • Render: interactive or refine quality, refine samples and resolution scale.

With refine quality the viewport accumulates samples until it converges; File > Save Image... then saves the view as a PNG. All settings opens Look Settings (every look setting, including texture files).

Render in V-Ray

With V-Ray Standalone installed (V-Ray 7 tested), GroomLab > Render > Render Frame in V-Ray renders the groom at this frame as the viewport shows it: every strand (not the preview density), the viewport's camera, the lighting preset's lights and environment, the background, the exposure and the scalp. GroomLab > Render > Render Turntable in V-Ray renders 36 frames with the camera going once around the groom. A window shows the progress and the image as it comes; Cancel stops V-Ray, Save Image... saves the image and Show in Folder opens the folder with the images and the scene files.

  • The hair is GroomLab's V-Ray hair, as the V-Ray scene export writes it: each strand's color and a VRayHairNextMtl shader set up from the groom's look (Other renderers). The look panel's swatches render when they are the groom's own HairColor settings; an override material that only the viewport uses does not.
  • The image is V-Ray's linear result saved as an sRGB PNG, without the viewport's tone map: compare it with the viewport set to Tone map: None.
  • Props and eyes, shadow softness and ambient occlusion stay in the viewport.
  • The app looks for vray.exe in the GROOMLAB_VRAY environment variable, then the one picked with GroomLab > Render > V-Ray Standalone Location..., then V-Ray's default install folder (C:\Program Files\Chaos\V-Ray\Standalone for x64\bin) and the PATH.
  • V-Ray runs as its own process, so the app stays usable while it renders.
  • From a script: GroomLab hair.groom --render-vray frame.png --size 1920x1080 renders without a window and quits (--vray-turntable 36 for a turntable: frame.0001.png and on).

Render in RenderMan

With RenderMan Pro Server installed (RenderMan 27.3 tested; free for non-commercial use), GroomLab > Render > Render Frame in RenderMan and Render Turntable in RenderMan render the same way in RenderMan's prman, in the same window: the groom as it is now is written to a .groom file that GroomLab's RenderMan procedural (in the app's procedurals/renderman folder) evaluates at render time, every strand, shaded by PxrHairColor and PxrMarschnerHair set up from the groom's look (RenderMan); the viewport's camera, the lighting preset's lights (PxrDistantLight) and environment (PxrDomeLight), the background, the exposure and the scalp go to a RIB beside it.

  • The image is prman's linear result saved as an sRGB PNG, without the viewport's tone map.
  • Under a strong key light, light hair renders a little darker than in the viewport and V-Ray.
  • The app looks for prman in the GROOMLAB_PRMAN environment variable, then the one picked with GroomLab > Render > RenderMan Location..., then RMANTREE, RenderMan's default install folder (C:\Program Files\Pixar\RenderManProServer-*\bin) and the PATH.
  • From a script: GroomLab hair.groom --render-prman frame.png --size 1920x1080 renders without a window and quits (--prman-turntable 36 for a turntable).

Game cards

Cards mode (Ctrl+3) generates hair cards from the groom; its panel is in Properties. Click Add Cards node if the graph has none.

  • Strands or Cards switches what the viewport shows. Maps shows the baked maps on the cards, alpha-tested by coverage as in Maya and in a game engine. Before a bake the cards are untextured.
  • LOD picks Hero, Mid, Low or Custom. Sliders set cards per clump, layers, width, segments, variations, the atlas size and a card budget.
  • Bake maps writes the cards' maps (depth, coverage, tangent, attribute, color, occlusion) as TGA files in the groom's cards folder (groomlab/<file name>/cards/<file name>/ beside the saved groom file; an unsaved groom's go along when it is first saved), with a busy cursor while it bakes. The baked atlas shows in the panel.

The panel shows card, triangle and texture counts, and indicates when the cards have changed since the last bake. See Game export.

Export

Export mode (Ctrl+4, or File > Export, Ctrl+E) writes the groom to other formats. Pick a target:

TargetWhat you get
Alembic curvesEvery strand with its ID, attributes, color and root UV (Strand attributes).
USD curvesBasisCurves in a text .usda layer.
Unreal groomAlembic for Unreal's groom importer, with the guides it simulates.
Cards (glTF)The cards at this frame as .glb (or .gltf), maps inside, with the hair cap.
Unity strandsAlembic for Unity's hair package, resampled to a fixed point count.
Card mapsThe cards' texture maps as a preset packs them (Unreal, Unity HDRP, every map on its own, your own), TGA, PNG, TIFF or EXR up to 8K; the output is a folder and a name (Export card maps).
V-Ray sceneThe strands and their V-Ray hair shader as a .vrscene for V-Ray Standalone or V-Ray for Maya (V-Ray).

Set the frames (the current frame, or a range for an animated groom), the density and the target's options, then the output file (type a path or pick it with ...). Export shows progress and can be cancelled. The same targets are in GroomLab > Export, with Scales Instancer (USD)... and the FBX exports, as in Maya and Blender:

  • Unreal Cards... and Unity Cards... (also on a Cards node's panel): into a folder you pick (the groom's exports folder to start), the card maps (Unreal's TGAs in its hair card layout, or Unity's HDRP PNGs), the hair cap's maps, a manifest of what each map holds and how to import them, and the cards and hair cap as FBX (Unity's in meters, its materials on the base color maps).
  • Unity Feathers...: the strands for Unity's hair package (a curves object per groom group), the feathers' rachis as an FBX to skin, and a manifest.
  • Scales Mesh (FBX)...: the scales bent onto the skin as one mesh.

Save and open in Maya

File > Save (Ctrl+S) and File > Save As... (Ctrl+Shift+S) write a .groom file: the graph, guides, scalp, maps, parts, flow and correctives. Export mode has Save and Save as... too.

A groom file is a document of named grooms, written the same way by every host. Maya and Blender save the scene's grooms (the selected ones, else all) into one file beside the scene, named after it (shot_v002.groom: outside the scene's groomlab folder; two versions of a scene in one folder never share one, and Save As takes it along under the new name). Each groom is linked to the file and saving or reloading it touches its own entry, the others stay. The files a groom owns (its texture maps, card bake and Simulate bakes) go in the file's own folder, groomlab/<file name>/masks|cards|caches/<groom>/: the scene's own when the file is named after the scene (nothing copied), copies when it has another name, so the file always stands alone. The app keeps the files it makes for a groom in a groomlab/<file name>/ folder beside it, one folder per kind as Maya keeps a scene's: masks (texture maps, in the groom's own masks/<file name>/ as Maya keeps each groom's), cards (card bakes), exports, caches (simulation bakes in the groom's own folder too, guide exports), renders and references (photos, copied in). Save As takes them along: the groom's files are copied into the new file's folder and the groom names the copies (the old file keeps its own; a file already there with other content is never written over). An unsaved groom's files wait in a temp folder until the first save.

In Maya, choose GroomLab > Groom Files > Import Groom File.... Select the scalp mesh first if the scene has it; otherwise GroomLab creates the scalp from the file, with the quads and n-gons of the mesh the groom was made on. The app splits a mesh's quads into triangles as Maya does, so a groom from the app sits on the same triangles in Maya; a groom saved by an app before 0.44 (its quads split the other way) has its roots moved onto Maya's triangles at the same places. To pull later edits into a groom linked to the file, save in the app, then choose GroomLab > Groom Files > Reload from Groom File in Maya (one undo step). See The .groom format.

A file of several grooms (the Outliner's) imports into Maya as every groom, each on a mesh made from its own scalp and named after it. A groom's other scalps (Maya's Add > Scalp: an ear, a patch) come in as meshes of their own, kept as its other scalps. Each groom is linked to the file: Save to Groom File writes its own entry back, the others stay.

Keys on params

A param's right-click menu in the Graph Editor has Set Key, Delete Key and Remove Animation, as in Maya and Blender. A keyed param is driven by a Control node of its own (as Drive with Slider makes one); its value is keyed at the timeline's frame, the groom takes it as the frame changes (smooth between keys, never past them), and the keys are saved with the groom ("controlKeys"). Move the slider in Properties > Controls, then Set Key again to key the new value. Remove Animation drops the keys and keeps the value it has now.

Not in the app yet

These are in Maya but not in the app. Grooms that use them still open and evaluate in the app as made.

  • Import: From XGen... and From Yeti... (Importing). Alembic curves come in through GroomLab > Import > Alembic Curves... (an ImportCurves node).
  • Rendering: Arnold and Redshift, and Maya's Render Turntable... (the app renders RenderMan and V-Ray frames and turntables: Render in RenderMan, Render in V-Ray). The app's viewport refines; export Alembic or USD for other renderers.
  • Animation: Maya's nHair (Simulate > Legacy). The app plays a groom file's caches and runs the Simulate node.
  • Copy Graph to Other Grooms... (in the app, Copy Graph and Paste Graph under Presets carry a look between grooms).

Themes

GroomLab > Theme (also in the Graph Editor's Edit menu) picks the app's colors from the same themes as Maya: Charcoal (the default: neutral grey panels with thin borders, one blue accent for the primary buttons and what is on, the Inter font, underlined tabs, uppercase section headers and node headers filled with their category's color), Playful (translucent panels, bright primaries), Studio and Paper (light). The window restyles at once, and the choice is kept for the next start. A scripted run takes --theme charcoal (or another name) for that run alone.

Your own themes are JSON files in your themes folder (the same one as Maya's, Documents\maya\groomlab\themes; the GROOMLAB_USER_THEMES environment variable names another) and in the folders listed in GROOMLAB_THEME_PATH. New Theme from Current... writes a copy of the current theme there to edit, Reload Theme reads the files again after an edit, and Open Themes Folder opens the folder. See Themes for the file format.

Settings

The app keeps its settings (recent files, the theme, autosave, units, the panels' layout) in %APPDATA%\GroomLab\GroomLab.ini. A scripted run (--ui-screenshot, --screenshot, the exports, --render-vray, the benchmarks) never reads or writes them: it uses a throwaway folder, or the folder GROOMLAB_SETTINGS_DIR names.

Keyboard shortcuts

Help > Keyboard Shortcuts shows the same list in the app.

KeysWhat it does
File
Ctrl+OOpen a groom
Ctrl+NNew groom on a mesh
Ctrl+S / Ctrl+Shift+SSave / Save as
Ctrl+RReload from disk
Ctrl+EExport
Ctrl+Z / Ctrl+YUndo / redo
Ctrl+QQuit
Modes
Ctrl+1 / 2 / 3 / 4Attributes / Material / Cards / Export
Shift+1 / 2 / 3 / 4Tools / Paint / Correctives / Photos
Ctrl+[ / Ctrl+]Fold the Groom Tools / the Properties to their rails
Alt+Shift+Left / Alt+Shift+RightFold the Groom Tools / the Properties (any keyboard layout)
Brush
BLast brush
B + dragBrush radius
Middle-dragBrush radius
M + dragBrush strength
Shift + middle-dragBrush strength
Ctrl (stroke)Reverse the brush
Shift + dragSmooth with any brush
SSelect guides
Page Up / Page DownBrush level up / down
Alt+Shift+XToggle symmetry
Y + clickBrush marking menu
Viewport
EscLeave the brush
TabGraph Editor / add node
FFrame the groom
Alt+dragOrbit
Alt+middle-drag / Alt+right-dragPan / dolly the camera
Mouse wheelDolly / zoom
DeleteDelete selection
Alt+Shift+GToggle guides
Graph
Ctrl+DDuplicate nodes
Ctrl+G / Ctrl+Shift+GGroup / ungroup
Ctrl+LTidy layout
BBypass nodes
VView up to node
FFrame selection
AFrame all
F2 / double-clickRename node
DeleteDelete nodes or link
Ctrl+C / Ctrl+VCopy / paste nodes
Ctrl+click / Shift+click / dragSelect nodes
Middle-drag / wheelPan / zoom
Right-clickContext menu

On this page