OpenNest/README.md

OpenNest

A Windows desktop app for CNC nesting — imports DXF drawings, arranges parts on plates and exports layouts as DXF or G-code for cutting.

OpenNest takes your part drawings, lets you define your sheet (plate) sizes, and arranges the parts to make efficient use of material. The result can be exported as DXF files or post-processed into G-code that your CNC cutting machine understands.

Features

• DXF Import/Export — Load part drawings from DXF files and export completed nest layouts
• Multiple Fill Strategies — Grid-based linear fill and rectangle bin packing
• Part Rotation — Automatically tries different rotation angles to find better fits
• Gravity Compaction — After placing parts, pushes them together to close gaps
• Multi-Plate Support — Work with multiple plates of different sizes and materials in a single nest
• G-code Output — Post-process nested layouts to G-code for CNC cutting machines
• Built-in Shapes — Create basic geometric parts (circles, rectangles, triangles, etc.) without needing a DXF file
• Interactive Editing — Zoom, pan, select, clone, and manually arrange parts on the plate view
• Lead-in/Lead-out & Tabs — Cutting parameters like approach paths and holding tabs (engine support, UI coming soon)

Prerequisites

• Windows 10 or later
• .NET 8 SDK

Getting Started

Build

git clone https://github.com/ajisaacs/OpenNest.git
cd OpenNest
dotnet build OpenNest.sln

Run

dotnet run --project OpenNest/OpenNest.csproj

Or open OpenNest.sln in Visual Studio and run the OpenNest project.

Quick Walkthrough

1. Create a nest — File > New Nest
2. Add drawings — Import DXF files or create built-in shapes (rectangles, circles, etc.). DXF drawings should be 1:1 scale CAD files.
3. Set up a plate — Define the plate size and material
4. Fill the plate — The nesting engine will automatically arrange parts on the plate
5. Export — Save as a .nest file, export to DXF, or post-process to G-code

Command-Line Interface

OpenNest includes a CLI for batch nesting without the GUI — useful for automation, scripting, and CI pipelines.

dotnet run --project OpenNest.Console/OpenNest.Console.csproj -- <input-files> [options]

Import DXF files and nest onto a plate:

# Import a DXF and fill a 60x120 plate
dotnet run --project OpenNest.Console/OpenNest.Console.csproj -- part.dxf --size 60x120

# Import multiple DXFs with mixed-part auto-nesting (experimental)
dotnet run --project OpenNest.Console/OpenNest.Console.csproj -- part1.dxf part2.dxf --size 60x120 --autonest

Work with existing nest files:

# Re-fill an existing nest file
dotnet run --project OpenNest.Console/OpenNest.Console.csproj -- project.zip

# Add a new DXF to an existing nest and auto-nest
dotnet run --project OpenNest.Console/OpenNest.Console.csproj -- project.zip extra-part.dxf --autonest

Options:

Option	Description
--size <WxL>	Plate size (e.g. 60x120). Required for DXF-only mode.
--autonest	Use mixed-part nesting instead of linear fill (experimental)
--drawing <name>	Select which drawing to fill with (default: first)
--quantity <n>	Max parts to place (default: unlimited)
--spacing <value>	Override part spacing
--template <path>	Load plate defaults (thickness, quadrant, material, spacing) from a nest file
--output <path>	Output file path (default: <input>-result.zip)
--keep-parts	Keep existing parts instead of clearing before fill
--check-overlaps	Run overlap detection after fill (exits with code 1 if found)
--engine <name>	Select a registered nesting engine
--no-save	Skip saving the output file
--no-log	Skip writing the debug log

Project Structure

OpenNest.sln
├── OpenNest/              # WinForms desktop application (UI)
├── OpenNest.Core/         # Domain model, geometry, and CNC primitives
├── OpenNest.Engine/       # Nesting algorithms (fill, pack, compact)
├── OpenNest.IO/           # File I/O — DXF import/export, nest file format
├── OpenNest.Console/      # Command-line interface for batch nesting
├── OpenNest.Gpu/          # GPU-accelerated nesting evaluation
├── OpenNest.Training/     # ML training data collection
├── OpenNest.Mcp/          # MCP server for AI tool integration
└── OpenNest.Tests/        # Unit tests

For most users, only these matter:

Project	What it does
OpenNest	The app you run. WinForms UI with plate viewer, drawing list, and dialogs.
OpenNest.Console	Command-line interface for batch nesting, scripting, and automation.
OpenNest.Core	The building blocks — parts, plates, drawings, geometry, G-code representation.
OpenNest.Engine	The brains — algorithms that decide where parts go on a plate.
OpenNest.IO	Reads and writes files — DXF (via ACadSharp), G-code, and the .nest ZIP format.

Keyboard Shortcuts

Key	Action
Ctrl+F	Fill the area around the cursor with the selected drawing
F	Zoom to fit the plate view
Shift + Mouse Wheel	Rotate parts when a drawing is selected
Shift + Left Click	Push the selected group of parts to the bottom-left most point
X	Push selected parts left (negative X)
Shift+X	Push selected parts right (positive X)
Y	Push selected parts down (negative Y)
Shift+Y	Push selected parts up (positive Y)
Arrow Keys	Nudge selected parts by an increment
Shift + Arrow Keys	Push selected parts in that direction

Supported Formats

Format	Import	Export
DXF (AutoCAD Drawing Exchange)	Yes	Yes
DWG (AutoCAD Drawing)	Yes	No
G-code	No	Yes (via post-processors)

Roadmap

• NFP-based nesting — No Fit Polygon algorithms and simulated annealing optimizer exist in the engine but aren't integrated into the UI or engine registry yet
• Lead-in/Lead-out UI — Engine support for lead-ins, lead-outs, and tabs is implemented; needs a UI for configuration
• Sheet cut-offs — Cut the sheet to size after nesting to reduce waste
• Post-processors — Plugin interface (IPostProcessor) is in place; need to ship built-in post-processors for common CNC controllers
• Shape library UI — Built-in shape generation code exists; needs a browsable library UI for quick access

Status

OpenNest is under active development. The core nesting workflows function, but there's plenty of room for improvement in packing efficiency, UI polish, and format support. Contributions and feedback are welcome.

License

This project is licensed under the MIT License.