Chapters

The window

Everything you see in the 3DCraft window, and how to look around, play the history and point at things.

The window (craft3d) is where you watch the agent work, look at a design and show the agent what you mean. 3DCraft has no toolbar of modelling buttons: every change to a design comes in as a command. An agent sends it (Install › Connect an AI agent), a Jig's form sends it (Using a Jig), or a program does (Programs on 3DCraft).

What the window does by itself is open, save, import and export files, and let you look, play, click and select.

The window with the T-slot profile, marked 1 to 10

Part What it is for
1 File, Edit, View and Help menus Files, recent files, Jigs; Undo and Redo; panels and light or dark; the guide, the keys, updates, About
2 Tabs One per open document
3 Feature list The history of the design, in order, with each step's status
4 Eye Hides a feature's body, sketch or datum in the view
5 Checks The checks (assertions) the design must pass
6 History player Watch the design being built, step by step
7 View buttons Fit, Iso, Persp, Ortho, Studio and Analysis
8 View cube Click a side, edge or corner to look from there
9 Display bar Sketches, Datums, Edges, See-through and Section
10 Agent pill How agents stand, and what one does now

The status bar

At the bottom is the status bar. It shows the document's units, its file, when it was autosaved, the last command and its answer, and which renderer drew the picture.

When 3DCraft works for more than a moment, a small spinner on the right says what it is doing: Opening gridfinity-bin… 41/57 while a file's features are built, then Checking 27 assertions… 5/27 while its checks are measured. The model is already there to look at. Quick work never shows the spinner, and once shown it stays a little while, so it does not blink.

Until a newly opened file has something to show, the middle of the view says Opening …. While a motion plays, the status bar says Playing and the moment's t. An error shows at once and stays.

At the right end of the status bar is the agent pill. Its colour says how agents stand:

Click it for the agent panel (Install › Connect an AI agent). The browser has no pill: agents drive the desktop app only.

The start screen

Without a document, the window shows the start screen (its picture is in Your first five minutes):

  1. At the top, the name and version, with Check for updates beside the version, and the line Parametric CAD built with and for AI. Start a document, open one, or let an agent model while you watch. Check for updates opens a page of the website in your browser that says whether there is a newer version (Install › Installing a newer version). The web version has no such link: it is always the latest.
  2. New part, New assembly and Open….
  3. Examples, with three tabs at its right: Parts, Jigs and Assemblies. Only the chosen tab's cards show. The tab you chose stays chosen while 3DCraft runs.
  4. A line that says what the tab holds, with More examples at its right. More examples opens the gallery of every example, Jig and assembly, 3dcraft.dev/examples, in your browser, at the part for the tab you are on.
  5. The cards. A click on a card opens it in a new tab, named after the example. Nothing is asked when you close it again, unless you changed something: then 3DCraft asks whether to save your version. One that takes a while to open says so on its picture, such as about 3 s.
    • Parts: ten finished parts, with their whole history to play back. The first two, the steel bookend and the T-slot aluminium profile, are marked Start here: they are the simplest. A part with sizes you may change opens on its Parameters tab.
    • Jigs: the laser-cut box, the Gridfinity bin, the dovetail drawer, the sheet-metal enclosure, the planetary gearbox and the sundial. Each opens on its Parameters tab (Using a Jig).
    • Assemblies: the toggle clamp, the Jansen walker, the scissor jack and the radial engine. Each opens on its Assembly tab with its player on Motion: press play and it moves (Assemblies). Its sizes, where it has any, are on the Parameters tab beside it.
  6. Recent at the left: the files you opened or saved last, each with the icon of its kind and how long ago it changed. Connect an AI agent at the right: the same panel as the agent pill's, with the Allow AI agents switch, the work folder, and the buttons that copy the configuration for your AI tool. In the browser, it says instead: In the browser an agent cannot drive 3DCraft yet. Use the desktop app to connect one.

The start screen comes back when you close the last tab.

Tabs run along the top, one per open document, each with a small icon of its kind (a part, an assembly, a Jig). A Jig opened to be used also says Jig. An amber dot at a tab's right marks unsaved changes; the close × takes its place under the pointer.

Ctrl+Tab goes to the next tab and Ctrl+Shift+Tab to the previous one. Ctrl+W closes one, and asks first when it has unsaved changes (Save, Don't Save, Cancel). On a Mac, ⌘W closes a tab; Ctrl+Tab stays Ctrl+Tab.

The File menu:

Item Keys Does
New Part Ctrl+N A new, empty part in a new tab
New Assembly Ctrl+Shift+N A new, empty assembly in a new tab (Assemblies)
Open… Ctrl+O Opens a .3dcraft document, a .3dcraftjig Jig or a .3dcraftasm assembly (a STEP file is imported with Import…)
Open for editing For a Jig in use: a new untitled model of it, to change as you like (Using a Jig)
Save Ctrl+S Saves to the document's file (asks for a name the first time)
Save As… Ctrl+Shift+S Saves under a new name
Import… Ctrl+I Reads a STEP file or a FreeCAD document into the document
Export… Ctrl+E Writes STEP, STL, 3MF, OBJ, DXF or SVG (Files, export and drawings)
Export as Jig… Publishes a document with parameters as a .3dcraftjig (Making Jigs)
Open recent The last ten files opened or saved, by you or by an agent, newest first; Clear recent empties the list
Close Ctrl+W Closes the active tab

Under them are the open documents: click one to switch to it. A recent file that is not there any more is greyed out. The list is kept in 3dcraft/recent-files.json in your state folder, next to the autosaves, and two windows open at once each keep what the other added. The browser keeps no recent files.

The Edit menu:

Item Keys Does
Undo Ctrl+Z Undoes the last change to the active document; the item names it (Undo Set teeth)
Redo Ctrl+Shift+Z or Ctrl+Y Redoes the change last undone

Every change counts, whoever made it: you, or an agent over MCP. An item is greyed out when there is nothing to undo or redo, and while a parameter is being dragged or set. While you type into a field, Ctrl+Z undoes your typing instead. In a Jig in use the only changes are those of its parameters, so Undo takes back the last parameter you set.

The View menu:

Item Keys Does
Side panel Ctrl+B Shows or puts away the panel on the left
Status bar Shows or puts away the bar at the bottom
System, Light, Dark The appearance: the panels and dialogs light or dark. System, the default, follows your desktop's setting (in the browser, the browser's)
Full screen F11 The window over the whole screen (the desktop app)

The appearance changes the panels, the start screen and the dialogs. The menu bar, the tabs, the status bar, the menus and the popovers stay dark, and the model's view stays as it is, so pictures look the same whichever you choose.

The Help menu:

The side panel

The left panel has tabs, chosen by the kind of document:

When the tabs do not fit, the rest are behind ⋯. Drag the panel's right edge to make it wider or narrower; it keeps that width whatever it shows.

Features

One row per step of the history: an icon for its kind (sketches in indigo, datums in petrol, as in the view), its name, and its key value at the right, such as Extrude 8 mm, R18 × 60 mm (a cylinder), 3 × 22 mm (a pattern) or − Bore (a subtraction and its tool).

Checks sit under the list: Checks 7 · all pass, then each check measured against its limit, such as 7 mm ≥ 5 mm. A failing check is red, with its reason under it, and the line at the top says 1 of 7 checks fails. A check that is not proven, neither passed nor failed, has a grey dot, with what it must be and why under it (Measuring and assertions › Assertions); the Moka pot in the studio picture below has one. Click a check to fly to what it measures. The checks fold to their heading while something is selected, or when the panel is short, to make room.

What is selected shows at the foot of the panel:

Made by links to the feature that made it, and Name is its persistent name, the name an agent uses. Measure measures a face's wall thickness, or the distance between the first two things selected; Copy name copies the name.

A hole selected: the foot of the side panel names its surface, its area and axis, the feature that made it and its name

Variables

The document's variables as a table: name, value or formula, result. Variables are grouped by the group a public parameter was given, or by a prefix two of them share (base_t, base_r under Base). A formula is written in indigo on a line of its own, its result at the right.

Click a value or a formula to edit it: Enter sets it, as one step to undo; one that does not work out says why under it. Add variable opens a new one to fill in; Enter makes it. The document's units and tolerance fold away at the foot.

Bodies

One row per body the design ends with: its colour, its name, its mass (or its volume without a material) and its eye. Click a body for its card: Material (choose a preset: it sets the density and the look), density, colour, volume, mass, area, box, faces and edges, and whether it is a valid closed solid.

When the body's faces carry colours of their own, the card has Clear face colour (or Clear 3 face colours, with their number), and a Shared row when some of those colours are shared with another body (Modelling features › Colours and materials). The totals are at the foot. The bodies that booleans used up are folded under Tool bodies: open it to see them and where they went.

Parameters

A Jig opens on Parameters, its form (Using a Jig). Its other tabs are there to look at.

Agent

While agents are allowed, or once an agent has worked on the document, the side panel has an Agent tab. It shows who is connected, then what agents did to this document, newest first: when and which agent, the command in words, the features it made, why a command failed, and in italics what the agent said it meant to do.

A feature an agent made, or last changed, carries a small indigo ✦ after its name in the Features tab. The desktop app only: in the browser, agents cannot connect.

The history player

At the foot of the side panel is the timeline: drag it to see the design as it was after any step of its history. Features after that step are greyed, and the step is named at the top of the view, such as Step 2/6 · Extruded profile · extrude (its place, the number of steps, its name and its kind). Looking back never changes the document.

Under the timeline is the player, one row like a video player's. The round amber button plays and pauses, and where you are is beside it (3 / 6).

The history player

Button Key Does
Step back ← One step back
▶ Play / ⏸ Pause Space Plays the history step by step, or pauses
Step forward → One step forward
Home Shows the first step (the timeline's start)
End Back to the whole design (the timeline's end)
1× The speed: 0.5×, 1× or 2× (click to change)
Loop Starts again at the first step after the last
Orbit Turns the camera slowly while it plays

The keys work while the pointer is over the view or the feature list and you are not typing in a field. In a narrow feature panel Orbit is left out.

Each step is shown once its model is built, and for at least 0.8 s at 1×, so a heavy model never skips a step. Playing stops at the end, when the document changes or when you switch tabs. While you play, the row of the step shown is outlined with a dashed line in the feature list, which scrolls to keep it in view.

Every step is shown as finely meshed as the whole design, so a part that does not change between steps keeps its look, and stepping through a history you have seen before is immediate.

The roll-back bar

The amber roll-back bar in the feature list sits after the last step built. Drag it up to a step, or choose Roll back to here on a row's menu, and the design is built only up to that step. New features then go in right after it: a way to insert something early in the history.

Drag it back to the end, or choose Roll forward to end (on the last row's menu, or a right click on the bar), to build the whole history again. Unlike the timeline, the bar changes what is built. While you look back with the timeline, clicks in the view do not select; press End first.

Playing a motion

A design can also move: a crank that turns, a lid that opens. Its motion is driven by a timeline variable t, a plain number from 0 to 1, and formulas of t, such as a crank angle 360 deg * t (Engineering checks › Over a motion). A t with a unit (a thickness called t) is not a timeline: rename it first.

With a timeline, History and Motion appear above the player. In Motion:

The moment shows beside the play button (t 0.500). While it plays, the status bar says Playing; after an agent shows a moment (view.motion, as in the picture below), the status bar names it too (t = 0.500). Nothing is written over the view while the player is in sight. When it is not (the side panel on its Parameters or Agent tab, or put away), the view names the moment itself, such as t = 0.500 · collision: Wall and Crank.

As with the history, nothing in the document changes. Only the features that use t are rebuilt for each moment, so a heavy model plays slower rather than skipping. An assembly has no history of its own, so it shows only Motion: its parts are moved, not rebuilt (Assemblies).

The toggle clamp in Motion mode at t 0.500: the slider over t, Back and forth and Collisions switched on, and 2 colliding under the player

In this picture Collisions finds two pairs in the toggle clamp, drawn in red: the spindle's rod and each of the two nuts on it. That is the tool doing its job. The nuts are drawn with a 5 mm hole, the size drilled for an M6 thread, on a 6 mm rod, so they overlap where their threads grip. Rod and nuts move together, so the pairs are the same at every moment of the motion. The collisions to look at are the ones that come and go as it moves. The handle's grip is red by its own colour.

While a motion plays, the view draws lighter so it keeps up. In the studio look it leaves out the frames a still picture averages, the depth of field, the ambient occlusion and the reflections; the shadows stay. As soon as you pause or stop, the full look comes back and settles. Screenshots and recordings are always at full quality.

When the moments of a motion are slow to make (an assembly whose parts are rebuilt as it moves, a heavy part), the player asks This motion is heavy — bake first? under the slider. Bake makes the moments of a play ahead (motion.bake) while it goes on playing, with a bar that shows how far it is; afterwards it plays smoothly. Not now hides the question for that document until you close 3DCraft. A motion that is quick to show, but whose parts are rebuilt as it moves, is baked by itself the first time it plays.

An agent drives the motion with commands of its own (Reference › The window, for agents and programs).

Looking around

Do To
Drag with the left button Orbit
Drag with the right or middle button, or Shift and the left Pan
Wheel, or pinch on a touchpad Zoom about the point under the pointer
F Fly to the selection, or frame the whole model when nothing is selected
Fit Frame the whole model
Iso, or a click on the view cube A standard view (Iso looks from the front-right corner)
Persp / Ortho Perspective, or orthographic (to scale, no vanishing point)
Studio The studio look on or off; the ▾ caret on its right opens or closes its options
Analysis A surface analysis on or off; its ▾ caret opens or closes its options and legend

The display bar at the bottom of the view:

The pictures in this guide show a window 1400 points wide (the start screen's 960 high). In a smaller one, such as the 1280 × 800 that 3DCraft first opens with, Sketches, Datums and Edges show their icons without words, and the start screen scrolls to show its last panels. Narrower still, Fit, Iso, Studio, Analysis and Section show their icons only too, and the See-through and Offset sliders lose their labels. Hover for the names.

A new document keeps everything that is shown in view as it is built, sketches included. A document you open is framed on its bodies (on its sketches when it has no body), and the view keeps them framed as the model changes. Fit, and F with nothing selected, frame everything that is shown, sketches included, and the view keeps that framed from then on; so do Iso and the view cube. Once you pan or zoom, the view stays where you put it.

None of this changes the document. Each tab remembers its own camera, section and see-through. A heavy model first shows a quick picture, then the sharp one (the status bar says refining).

On a phone or a tablet

The browser on a phone or a tablet, and any window narrower than about 800 points, gets a narrow layout:

Do To
Drag one finger Orbit
Drag two fingers Pan
Pinch Zoom about the middle of your fingers
Tap Select, as a click does
Double-tap What F does: fly to what you tapped, or frame the whole model
Press and hold The list of everything under your finger (as a right click)
☰ at the left of the menu bar Open or close the feature list, Parameters and the player as a drawer (a tap beside it, or Escape, closes it too)

The studio look

Studio, beside Persp and Ortho at the top right, switches between two looks:

The studio look with its options open: the environment, exposure, background, ground, tone, shadows and the lens

Three environments come with 3DCraft: studio (soft boxes, the default), outdoor (sky and sun) and workshop. The light falls from the environment's brightest direction and casts soft shadows on the model and on a ground under it; corners and grooves darken where little light reaches. A see-through or cut-open view is lit the same way.

Studio is a split button. The chip switches the look on and off; the small ▾ caret on its right opens and closes the look's options. Switching the look on opens them in a popover under the button row:

A change shows at once. Click the caret again, or press Escape, to close the options: the look stays on. In a short window the options scroll inside the popover.

The lens. Lens switches depth of field on. Aperture is a slider of the usual f-stops, f/1.4 (most blur) to f/22 (nearly all sharp). Focus says where it focuses:

With nothing selected, a selection that is hidden, or no click yet, the lens focuses on the centre, and the popover says so. In an orthographic view there is no lens, and nothing is blurred. While the lens is on, what is selected keeps its own colour and is marked by its outline. The blur follows the document's length unit, as a real camera would: a small part seen close up has a shallow depth of field.

While the camera stands still, the window keeps refining the picture, so edges smooth out and the blur fills in. Moving the camera starts again from a sharp first frame.

In the browser the studio look is drawn simpler while you turn, pan or zoom the view, and in full again a moment after you let go. On older graphics (WebGL2) it has no shadows, no darkening in corners, no reflections and no depth of field.

The look is a view: the document does not change. Colours, metals and materials are given to the bodies themselves (Modelling features › Colours and materials). An agent sets the same look with ui.set, and craft3d-cli render takes it too (Reference › The window, for agents and programs).

Surface analysis

Analysis, beside Studio, shows the quality of the surfaces instead of their shading. It is a split button as Studio is: its popover chooses what to show, with its options as sliders and a legend that says what the colours mean. Its ▾ caret (or Escape) closes the popover and keeps the analysis on. While an analysis is on, the view is drawn plainly, so the studio look's caret is greyed out until the analysis is off.

Zebra stripes on the ship propeller's blades, with the analysis options open

Combs draw the curvature of edges as spikes standing off the curve, as long as the curvature: where the comb's outline jumps, the curvature does.

The analysis is a view, like the look: the document does not change. The numbers behind the colours are measures too (Measuring and assertions › Surface quality).

Pointing at things

A click selects what is under the pointer: a corner (vertex) when one is within a few points, else an edge, else the face.

Do To
Click Select a vertex, an edge or a face
Shift+click Add to or take from the selection
Click again at the same place, or Alt+click Select the next face behind
Right click List every face under the pointer, to choose one
Double-click in the view Select the whole body
Ctrl+drag Select what lies inside a box
Click empty space, or Escape Clear the selection (Escape first folds an open Studio or Analysis panel)

The agent sees your selection. The selection belongs to the document, not to the window, so the agent reads it: each item with its name, the body, the feature that made it, its shape (a hole's radius and axis, a face's direction) and the size that drives it. So you can say:

Make the hole I selected 6.5 mm.

and the agent finds the size behind that hole and changes it.

The other way round, the agent can show you what it means. It can light up a face, an edge or a corner in your view, set the selection you see, fly the camera to a feature, play the history, and take a picture of the window to look at itself (Programs on 3DCraft › The window's control channel).

When something goes wrong

When a command fails, the status bar shows it in red with its message, and a Copy details button that copies a short report for a bug report. When a file action you started yourself fails (Open, Save, Import, Export), a dialog says what went wrong (Troubleshooting › Reporting a problem).

When 3DCraft was not closed properly (a crash, a power cut), the next start shows a bar under the menu that offers to Recover what was autosaved (Troubleshooting › After a crash).

Without the window

An agent working headless looks at its work with doc_render_preview (the command view.render): the same picture craft3d-cli render makes. view.pick answers "what is at this pixel of that picture", as a click does in the window.

Next: Using a Jig.

This page on GitHub