apply formatting

This commit is contained in:
bakedpotatolord 2025-06-10 21:14:47 -06:00
commit d44ca56d39
17 changed files with 165 additions and 185 deletions

View file

@ -14,11 +14,11 @@ You can access it from the top-right menu:
## Workspace Dimensions
These values define your machine’s cutting envelope. Use your *actual usable* dimensions here, not the marketing ones.
These values define your machine’s cutting envelope. Use your _actual usable_ dimensions here, not the marketing ones.
- **X (width)** — Maximum horizontal travel (left to right)
- **Y (depth)** — Maximum front-to-back travel
- **Z (height)** — Maximum vertical travel (top to bottom)
- **X (width)** — Maximum horizontal travel (left to right)
- **Y (depth)** — Maximum front-to-back travel
- **Z (height)** — Maximum vertical travel (top to bottom)
The units of these values are based on the units set in your global preferences (defaults to mm).
@ -34,9 +34,9 @@ The units of these values are based on the units set in your global preferences
Customize how your G-code is formatted for your controller or post-processor:
- **Strip Comments** — Removes all G-code comments for cleaner, smaller files
- **Token Spacer** — Inserts a space between G-code tokens (e.g., `G1 X1 Y1` vs `G1X1Y1`)
- **Enable Laser** — Enables [Laser](ops#Laser-Mode-Only) operations (typically uses `M3/M5`; adjusts movement strategy)
- **Strip Comments** — Removes all G-code comments for cleaner, smaller files
- **Token Spacer** — Inserts a space between G-code tokens (e.g., `G1 X1 Y1` vs `G1X1Y1`)
- **Enable Laser** — Enables [Laser](ops#Laser-Mode-Only) operations (typically uses `M3/M5`; adjusts movement strategy)
- **File Extension** — Optional override for exported file type (e.g., `.nc`, `.ngc`, `.cnc`, `.cam`, `.gcode`, `.txt`)
---
@ -45,10 +45,10 @@ Customize how your G-code is formatted for your controller or post-processor:
Macros insert custom G-code at key stages of toolpath generation. Each tab corresponds to a different context. In these boxes, you have access to [G-code macros](../gcode-macros). Not all macros are available in all contexts, so be careful!
- **Header** — Runs once at the beginning of the job (e.g., mode override, move to safe Z)
- **Footer** — Runs at the end of the job (e.g., spindle stop, move to safe Z)
- **Tool** — Called when changing tools. Automatic tool changes and tool measurement can be put here.
- **Dwell** — Code for pausing movement/spindle at specified positions
- **Header** — Runs once at the beginning of the job (e.g., mode override, move to safe Z)
- **Footer** — Runs at the end of the job (e.g., spindle stop, move to safe Z)
- **Tool** — Called when changing tools. Automatic tool changes and tool measurement can be put here.
- **Dwell** — Code for pausing movement/spindle at specified positions
- **Spindle** — Code to set spindle RPM
---

View file

@ -2,7 +2,8 @@
description: Keyboard Shortcuts and Mouse Controls
label: ops
---
import { ImageCarousel } from '@site/docs/src/components/carousel.js'
import { ImageCarousel } from "@site/docs/src/components/carousel.js";
# Operations
@ -43,8 +44,8 @@ Operations that apply to all objects in the workspace.
The Outline op generates a toolpath surrounding the edges of a part. It is highly configurable and can select both internal or external edges specifically. The Outline operation is great for:
- Cutting out many objects at once
- Generating a rough/finishing pass on an object
- Cutting out many objects at once
- Generating a rough/finishing pass on an object
- Easily avoiding specific features like pockets or holes
### Level
@ -53,8 +54,8 @@ The Outline op generates a toolpath surrounding the edges of a part. It is highl
The Level op creates a flat-surface clearing toolpath across a selected area. It is designed to remove material to a consistent depth, making it useful for preparing stock, flattening uneven surfaces, or cleaning up residual material. The Level operation is great for:
- Surfacing raw stock before detail cuts
- Creating uniform faces on complex objects
- Surfacing raw stock before detail cuts
- Creating uniform faces on complex objects
- Clearing large areas with consistent depth quickly
### Rough
@ -63,10 +64,10 @@ The Level op creates a flat-surface clearing toolpath across a selected area. It
The Rough op removes large volumes of material quickly using a stepped-down toolpath. It is typically the first pass in a multi-step workflow, clearing space for finishing tools without concern for fine detail. The Rough operation is great for:
- Rapid bulk material removal
- Preparing many parts for finishing simultaneously
- Clearing voids or flat faces for many objects at once
- Preparing a part for finish machining
- Rapid bulk material removal
- Preparing many parts for finishing simultaneously
- Clearing voids or flat faces for many objects at once
- Preparing a part for finish machining
- Preserving tool life by reducing cutting load in later passes
### Contour
@ -76,8 +77,8 @@ The Rough op removes large volumes of material quickly using a stepped-down tool
The Contour op generates detailed toolpaths for complex organic surface geometries.
It can trace along the X or Y axis and has configurable precision. It is useful for:
- Carving 3D shapes with organic or curved profiles
- Finishing complex wall geometries
- Carving 3D shapes with organic or curved profiles
- Finishing complex wall geometries
- Cleaning up a part after [roughing](#rough)
### Register
@ -101,8 +102,8 @@ The Drill op creates pecking toolpaths for a drill tool to follow.
It can also drill holes of other diameters and even mark holes instead of drilling.
It is useful for:
- Generating a toolpath for a drill tool
- Selecting specific holes to remove material from
- Generating a toolpath for a drill tool
- Selecting specific holes to remove material from
- Marking holes to be drilled manually
### Trace
@ -115,9 +116,9 @@ When the type parameter is set to "clear," it can even act like a [Pocket](#pock
clearing the area above the shape created by the selected lines or loop.
While the Trace op can do a lot, some specific use cases include:
- Engraving lettering or other text
- Drilling out a hole helically
- Outlining a part with a nonstandard offset
- Engraving lettering or other text
- Drilling out a hole helically
- Outlining a part with a nonstandard offset
- Outlining only one part on the workspace
### Pocket
@ -128,8 +129,8 @@ The Pocket operation takes a selection of polygon faces and generates a pocket t
The operation has options to expand and smooth the pocket selection, and the contour option even allows
for an approximation of a v-bit carve. Some use cases specific to the Pocket op include:
- Creating one pocket in a part with multiple
- Attempting a v-carve
- Creating one pocket in a part with multiple
- Attempting a v-carve
- Clearing a specific area of a part
### Gcode

View file

@ -1,7 +1,8 @@
---
description: Process options for the CAM mode
---
import { ImageCarousel } from '@site/docs/src/components/carousel.js'
import { ImageCarousel } from "@site/docs/src/components/carousel.js";
# Process Options

View file

@ -13,8 +13,9 @@ Additionally, tools can be imported and exported as `.km` files. The file format
![](/img/CAM/toolMenu.png)
Kiri:Moto currently supports four types of tools:
- End Mills
- Ball Mills
- Taper Mills
Kiri:Moto currently supports four types of tools:
- End Mills
- Ball Mills
- Taper Mills
- Drills