mirror of
https://github.com/SoftFever/OrcaSlicer.git
synced 2025-12-26 01:28:37 -07:00
275f3a7f1e
* Actually build tests on Linux and allow RelWithDebInfo
They weren't being built.
Also cleaned up --config flags which enables RelWithDebInfo on Linux,
now that Ninja Multi-Config is used, it's quite trivial.
* Remove obsolete Slic3r Perl tests
The directory doesn't exist, they're already gone.
* Add GH job for running unit tests
* Move unit test execution to script and upload test results
* Don't run scheduled builds on forks
* Only deploy from SoftFever/OrcaSlicer
Will stop failures on forks
* Use artifact instead of cache
* Tweak archive and checkout paths
Keep getting error:
```
/home/runner/work/_temp/902d0a0a-6d23-4fe0-a643-8b5cc4efd25b.sh: line 1: scripts/run_unit_tests.sh: Permission denied
```
That seems to be because I didn't use actions/checkout, the working
directory is never setup correctly? So using checkout to get scripts
directory. Unsure if archive will preserve the `build/tests/` prefix;
will find out soon.
* Use tar to package directory and write results to correct directory
Tar preserves filenames and directory structure
* Use tar -xvf not -xzf
Muscle memory failed me
* Add testing wiki page
* Save test logs on failure and choose correct directory for junit
* Consolidate apt install steps, use for unit tests too, disable non-Linux builds
Temporarily disable non-Linux builds to save time while developing
this.
Cache the apt packages to save some time searching apt and downloading
them again (though I realize this is also downloading, but hopefully
by something closer and faster).
Remove all the redundant packages listed in the workflow and debian
distribution lists.
* Remove apt install steps from workflow
`./build-linux.sh -u` is supposed to install all needed packages, so
it should build without needing anything besides that. If I'm wrong
this commit will be dropped.
* Need composite action checked out locally
* Re-enable non-Linux builds now that it's working
* Skip a deploy and a notarize in forks
They only succeed in the main repo.
* Fix multi-build for non-Release builds: share CONFIG
* Correct build errors in unit tests
Indeterminate method signatures resolved. Updated script to build all
the tests.
* Fix -g vs -e for RelWithDebInfo
* Change CONFIG->BUILD_CONFIG
Missed one in prior commits
* Reduce wasteful redundant build artifact copies
1. Don't copy the artifacts and leave them; make a hard link first;
only make a copy only while creating AppImage.
2. Don't tar up the `package` directory; nothing uses this tar AFAICT
* Fix directory name
* Change jigsaw auth test URLs to httpbin.org
No idea why the basic auth doesn't work, but it doesn't work for
`curl` CLI either. This does.
* Remove force-build
It got reverted at
e3f049829b
for unknown reasons.
* Add timeout for unit tests in GitHub Actions workflow (#11146)
---------
Co-authored-by: SoftFever <softfeverever@gmail.com>
259 lines
9.9 KiB
Markdown
259 lines
9.9 KiB
Markdown
# CLAUDE.md
|
|
|
|
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
|
|
|
## Overview
|
|
|
|
OrcaSlicer is an open-source 3D slicer application forked from Bambu Studio, built using C++ with wxWidgets for the GUI and CMake as the build system. The project uses a modular architecture with separate libraries for core slicing functionality, GUI components, and platform-specific code.
|
|
|
|
## Build Commands
|
|
|
|
### Building on Windows
|
|
```bash
|
|
# Build everything
|
|
build_release_vs2022.bat
|
|
|
|
# Build with debug symbols
|
|
build_release_vs2022.bat debug
|
|
|
|
# Build only dependencies
|
|
build_release_vs2022.bat deps
|
|
|
|
# Build only slicer (after deps are built)
|
|
build_release_vs2022.bat slicer
|
|
|
|
|
|
```
|
|
|
|
### Building on macOS
|
|
```bash
|
|
# Build everything (dependencies and slicer)
|
|
./build_release_macos.sh
|
|
|
|
# Build only dependencies
|
|
./build_release_macos.sh -d
|
|
|
|
# Build only slicer (after deps are built)
|
|
./build_release_macos.sh -s
|
|
|
|
# Use Ninja generator for faster builds
|
|
./build_release_macos.sh -x
|
|
|
|
# Build for specific architecture
|
|
./build_release_macos.sh -a arm64 # or x86_64 or universal
|
|
|
|
# Build for specific macOS version target
|
|
./build_release_macos.sh -t 11.3
|
|
```
|
|
|
|
### Building on Linux
|
|
```bash
|
|
# First time setup - install system dependencies
|
|
./build_linux.sh -u
|
|
|
|
# Build dependencies and slicer
|
|
./build_linux.sh -dsi
|
|
|
|
# Build everything (alternative)
|
|
./build_linux.sh -dsi
|
|
|
|
# Individual options:
|
|
./build_linux.sh -d # dependencies only
|
|
./build_linux.sh -s # slicer only
|
|
./build_linux.sh -i # build AppImage
|
|
|
|
# Performance and debug options:
|
|
./build_linux.sh -j N # limit to N cores
|
|
./build_linux.sh -1 # single core build
|
|
./build_linux.sh -b # Debug build
|
|
./build_linux.sh -e # RelWithDebInfo build
|
|
./build_linux.sh -c # clean build
|
|
./build_linux.sh -r # skip RAM/disk checks
|
|
./build_linux.sh -l # use Clang instead of GCC
|
|
```
|
|
|
|
### Build System
|
|
- Uses CMake with minimum version 3.13 (maximum 3.31.x on Windows)
|
|
- Primary build directory: `build/`
|
|
- Dependencies are built in `deps/build/`
|
|
- The build process is split into dependency building and main application building
|
|
- Windows builds use Visual Studio generators
|
|
- macOS builds use Xcode by default, Ninja with -x flag
|
|
- Linux builds use Ninja generator
|
|
|
|
### Testing
|
|
Tests are located in the `tests/` directory and use the Catch2 testing framework. Test structure:
|
|
- `tests/libslic3r/` - Core library tests (21 test files)
|
|
- Geometry processing, algorithms, file formats (STL, 3MF, AMF)
|
|
- Polygon operations, clipper utilities, Voronoi diagrams
|
|
- `tests/fff_print/` - Fused Filament Fabrication tests (12 test files)
|
|
- Slicing algorithms, G-code generation, print mechanics
|
|
- Fill patterns, extrusion, support material
|
|
- `tests/sla_print/` - Stereolithography tests (4 test files)
|
|
- SLA-specific printing algorithms, support generation
|
|
- `tests/libnest2d/` - 2D nesting algorithm tests
|
|
- `tests/slic3rutils/` - Utility function tests
|
|
- `tests/sandboxes/` - Experimental/sandbox test code
|
|
|
|
Run all tests after building:
|
|
```bash
|
|
cd build && ctest
|
|
```
|
|
|
|
Run tests with verbose output:
|
|
```bash
|
|
cd build && ctest --output-on-failure
|
|
```
|
|
|
|
Run individual test suites:
|
|
```bash
|
|
# From build directory
|
|
ctest --test-dir ./tests/libslic3r/libslic3r_tests
|
|
ctest --test-dir ./tests/fff_print/fff_print_tests
|
|
ctest --test-dir ./tests/sla_print/sla_print_tests
|
|
# and so on
|
|
```
|
|
|
|
## Architecture
|
|
|
|
### Core Libraries
|
|
- **libslic3r/**: Core slicing engine and algorithms (platform-independent)
|
|
- Main slicing logic, geometry processing, G-code generation
|
|
- Key classes: Print, PrintObject, Layer, GCode, Config
|
|
- Modular design with specialized subdirectories:
|
|
- `GCode/` - G-code generation, cooling, pressure equalization, thumbnails
|
|
- `Fill/` - Infill pattern implementations (gyroid, honeycomb, lightning, etc.)
|
|
- `Support/` - Tree supports and traditional support generation
|
|
- `Geometry/` - Advanced geometry operations, Voronoi diagrams, medial axis
|
|
- `Format/` - File I/O for 3MF, AMF, STL, OBJ, STEP formats
|
|
- `SLA/` - SLA-specific print processing and support generation
|
|
- `Arachne/` - Advanced wall generation using skeletal trapezoidation
|
|
|
|
- **src/slic3r/**: Main application framework and GUI
|
|
- GUI application built with wxWidgets
|
|
- Integration between libslic3r core and user interface
|
|
- Located in `src/slic3r/GUI/` (not shown in this directory but exists)
|
|
|
|
### Key Algorithmic Components
|
|
- **Arachne Wall Generation**: Variable-width perimeter generation using skeletal trapezoidation
|
|
- **Tree Supports**: Organic support generation algorithm
|
|
- **Lightning Infill**: Sparse infill optimization for internal structures
|
|
- **Adaptive Slicing**: Variable layer height based on geometry
|
|
- **Multi-material**: Multi-extruder and soluble support processing
|
|
- **G-code Post-processing**: Cooling, fan control, pressure advance, conflict checking
|
|
|
|
### File Format Support
|
|
- **3MF/BBS_3MF**: Native format with extensions for multi-material and metadata
|
|
- **STL**: Standard tessellation language for 3D models
|
|
- **AMF**: Additive Manufacturing Format with color/material support
|
|
- **OBJ**: Wavefront OBJ with material definitions
|
|
- **STEP**: CAD format support for precise geometry
|
|
- **G-code**: Output format with extensive post-processing capabilities
|
|
|
|
### External Dependencies
|
|
- **Clipper2**: Advanced 2D polygon clipping and offsetting
|
|
- **libigl**: Computational geometry library for mesh operations
|
|
- **TBB**: Intel Threading Building Blocks for parallelization
|
|
- **wxWidgets**: Cross-platform GUI framework
|
|
- **OpenGL**: 3D graphics rendering and visualization
|
|
- **CGAL**: Computational Geometry Algorithms Library (selective use)
|
|
- **OpenVDB**: Volumetric data structures for advanced operations
|
|
- **Eigen**: Linear algebra library for mathematical operations
|
|
|
|
## File Organization
|
|
|
|
### Resources and Configuration
|
|
- `resources/profiles/` - Printer and material profiles organized by manufacturer
|
|
- `resources/printers/` - Printer-specific configurations and G-code templates
|
|
- `resources/images/` - UI icons, logos, calibration images
|
|
- `resources/calib/` - Calibration test patterns and data
|
|
- `resources/handy_models/` - Built-in test models (benchy, calibration cubes)
|
|
|
|
### Internationalization and Localization
|
|
- `localization/i18n/` - Source translation files (.pot, .po)
|
|
- `resources/i18n/` - Runtime language resources
|
|
- Translation managed via `scripts/run_gettext.sh` / `scripts/run_gettext.bat`
|
|
|
|
### Platform-Specific Code
|
|
- `src/libslic3r/Platform.cpp` - Platform abstractions and utilities
|
|
- `src/libslic3r/MacUtils.mm` - macOS-specific utilities (Objective-C++)
|
|
- Windows-specific build scripts and configurations
|
|
- Linux distribution support scripts in `scripts/linux.d/`
|
|
|
|
### Build and Development Tools
|
|
- `cmake/modules/` - Custom CMake find modules and utilities
|
|
- `scripts/` - Python utilities for profile generation and validation
|
|
- `tools/` - Windows build tools (gettext utilities)
|
|
- `deps/` - External dependency build configurations
|
|
|
|
## Development Workflow
|
|
|
|
### Code Style and Standards
|
|
- **C++17 standard** with selective C++20 features
|
|
- **Naming conventions**: PascalCase for classes, snake_case for functions/variables
|
|
- **Header guards**: Use `#pragma once`
|
|
- **Memory management**: Prefer smart pointers, RAII patterns
|
|
- **Thread safety**: Use TBB for parallelization, be mindful of shared state
|
|
|
|
### Common Development Tasks
|
|
|
|
#### Adding New Print Settings
|
|
1. Define setting in `PrintConfig.cpp` with proper bounds and defaults
|
|
2. Add UI controls in appropriate GUI components
|
|
3. Update serialization in config save/load
|
|
4. Add tooltips and help text for user guidance
|
|
5. Test with different printer profiles
|
|
|
|
#### Modifying Slicing Algorithms
|
|
1. Core algorithms live in `libslic3r/` subdirectories
|
|
2. Performance-critical code should be profiled and optimized
|
|
3. Consider multi-threading implications (TBB integration)
|
|
4. Validate changes don't break existing profiles
|
|
5. Add regression tests where appropriate
|
|
|
|
#### GUI Development
|
|
1. GUI code resides in `src/slic3r/GUI/` (not visible in current tree)
|
|
2. Use existing wxWidgets patterns and custom controls
|
|
3. Support both light and dark themes
|
|
4. Consider DPI scaling on high-resolution displays
|
|
5. Maintain cross-platform compatibility
|
|
|
|
#### Adding Printer Support
|
|
1. Create JSON profile in `resources/profiles/[manufacturer].json`
|
|
2. Add printer-specific start/end G-code templates
|
|
3. Configure build volume, capabilities, and material compatibility
|
|
4. Test thoroughly with actual hardware when possible
|
|
5. Follow existing profile structure and naming conventions
|
|
|
|
### Dependencies and Build System
|
|
- **CMake-based** with separate dependency building phase
|
|
- **Dependencies** built once in `deps/build/`, then linked to main application
|
|
- **Cross-platform** considerations important for all changes
|
|
- **Resource files** embedded at build time, platform-specific handling
|
|
|
|
### Performance Considerations
|
|
- **Slicing algorithms** are CPU-intensive, profile before optimizing
|
|
- **Memory usage** can be substantial with complex models
|
|
- **Multi-threading** extensively used via TBB
|
|
- **File I/O** optimized for large 3MF files with embedded textures
|
|
- **Real-time preview** requires efficient mesh processing
|
|
|
|
## Important Development Notes
|
|
|
|
### Codebase Navigation
|
|
- Use search tools extensively - codebase has 500k+ lines
|
|
- Key entry points: `src/OrcaSlicer.cpp` for application startup
|
|
- Core slicing: `libslic3r/Print.cpp` orchestrates the slicing pipeline
|
|
- Configuration: `PrintConfig.cpp` defines all print/printer/material settings
|
|
|
|
### Compatibility and Stability
|
|
- **Backward compatibility** maintained for project files and profiles
|
|
- **Cross-platform** support essential (Windows/macOS/Linux)
|
|
- **File format** changes require careful version handling
|
|
- **Profile migrations** needed when settings change significantly
|
|
|
|
### Quality and Testing
|
|
- **Regression testing** important due to algorithm complexity
|
|
- **Performance benchmarks** help catch performance regressions
|
|
- **Memory leak** detection important for long-running GUI application
|
|
- **Cross-platform** testing required before releases
|