OrcaSlicer

https://www.orcaslicer.com/wiki/
Admin
OrcaSlicer is a powerful open-source slicer for FFF (FDM) 3D Printers, providing detailed...
Tokens:82,685
Snippets:1,395
Trust Score:8.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Git

Source: https://www.orcaslicer.com/wiki/developer_reference/how_to_build

Installs Git for Windows.

```powershell
winget install --id=Git.Git -e
```

--------------------------------

### Install system dependencies

Source: https://www.orcaslicer.com/wiki/developer_reference/how_to_build

Run this command to install the required system dependencies for the build process.

```bash
./build_linux.sh -u
```

--------------------------------

### Windows SDK Path

Source: https://www.orcaslicer.com/wiki/developer_reference/how_to_build

Example path to the winrt folder within the Windows SDK installation.

```text
C:\Program Files (x86)\Windows Kits\10\Include\10.0.26100.0\winrt
```

--------------------------------

### Install GitHub Desktop

Source: https://www.orcaslicer.com/wiki/developer_reference/how_to_build

Installs the optional GitHub Desktop GUI.

```powershell
winget install --id=GitHub.GitHubDesktop -e
```

--------------------------------

### Machine Start G-code Example

Source: https://www.orcaslicer.com/wiki/printer_settings/machine%20gcode/printer_machine_gcode

Executed at the beginning of a print job. Prepares the printer by homing axes, heating components, and performing checks. Includes optional custom notifications and a purge line sequence.

```gcode
G90 ; use absolute coordinates
M83 ; extruder relative mode
M140 S[bed_temperature_initial_layer_single] ; set final bed temp
M104 S150 ; set temporary nozzle temp to prevent oozing during homing
G4 S10 ; allow partial nozzle warmup
G28 ; home all axis
G1 Z25 F240 ; lift nozzle
G1 X2 Y10 F3000 ; move to front left
M104 S[nozzle_temperature_initial_layer] ; set final nozzle temp
M190 S[bed_temperature_initial_layer_single] ; wait for bed temp to stabilize
M109 S[nozzle_temperature_initial_layer] ; wait for nozzle temp to stabilize
; Start Beep to indicate ready to print
M300 P136 S622
M300 P136 S0
M300 P136 S311
M300 P136 S466
M300 P273 S0
M300 P136 S415
M300 P409 S0
M300 P136 S622
M300 P136 S0
M300 P545 S466
; Purge Line
G1 Z0.28 F240 ; move to a custom layer height for purge
G1 X{first_layer_print_min[0]-15} Y{first_layer_print_min[1]} Z0.8 F6000.0 ; position 15mm left from the lower left of the first layer
G1 X{first_layer_print_min[0]-15} Y{first_layer_print_min[1]+30} E30 F360.0 ; extrude 30mm of filament in the y direction
G92 E0.0 ; reset extruder
G1 E-0.5 F2100 ; small retraction
G1 Y{first_layer_print_min[1]+40} F6000.0 ; move an additional 10mm without extruding
G92 E0.0 ; reset extruder
```

--------------------------------

### Navigate to Drive

Source: https://www.orcaslicer.com/wiki/developer_reference/how_to_build

Example command to switch to the drive containing the repository.

```text
N:
```

--------------------------------

### Install CMake

Source: https://www.orcaslicer.com/wiki/developer_reference/how_to_build

Installs the CMake build tool.

```powershell
winget install --id=Kitware.CMake -e
```

--------------------------------

### Install Visual Studio with C++ Workload

Source: https://www.orcaslicer.com/wiki/developer_reference/how_to_build

Installs Visual Studio Community with the required Desktop development with C++ workload.

```powershell
winget install --id=Microsoft.VisualStudio.Community -e --override "--add Microsoft.VisualStudio.Workload.NativeDesktop --includeRecommended --passive --wait"
```

--------------------------------

### Change Directory

Source: https://www.orcaslicer.com/wiki/developer_reference/how_to_build

Example command to navigate to the cloned repository folder.

```text
cd N:\Repos\OrcaSlicer
```

--------------------------------

### Example Plugin Configuration JSON

Source: https://www.orcaslicer.com/wiki/developer_reference/plugin_development/plugin_system

A sample JSON structure showing how plugins and capabilities are mapped within a preset.

```json
{
  "plugins": [
    "Sample Plugin;1f998ea9-0183-4cc5-957f-4eef659ba4e6;G-code Benchmark (.py)",
    "master_plugin;;header-stamp"
  ],
  "post_process_plugin": ["G-code Benchmark (.py)", "header-stamp"]
}
```

--------------------------------

### Build and Configure Portable Installation

Source: https://www.orcaslicer.com/wiki/developer_reference/how_to_build

Commands for managing build processes and setting up a portable data directory.

```bash
./build_linux.sh -u
```

```bash
./build_linux.sh -dsti
```

```text
OrcaSlicer.exe
data_dir/
```

--------------------------------

### Install Strawberry Perl

Source: https://www.orcaslicer.com/wiki/developer_reference/how_to_build

Installs Strawberry Perl.

```powershell
winget install --id=StrawberryPerl.StrawberryPerl -e
```

--------------------------------

### Klipper Input Shaper G-code Example

Source: https://www.orcaslicer.com/wiki/calibration/input_shaping_calib

An example of setting input shaper parameters for Klipper firmware with specific values for MZV type.

```gcode
SET_INPUT_SHAPER SHAPER_TYPE=MZV SHAPER_FREQ_X=37.25 DAMPING_RATIO_X=0.16 SHAPER_FREQ_Y=37.5 DAMPING_RATIO_Y=0.06

```

--------------------------------

### Install MacOS build dependencies

Source: https://www.orcaslicer.com/wiki/developer_reference/how_to_build

Use Homebrew to install the required build tools for MacOS.

```bash
brew install cmake gettext libtool automake autoconf texinfo
```

--------------------------------

### Basic Infill Rotation Examples

Source: https://www.orcaslicer.com/wiki/print_settings/strength/strength_settings_infill_rotation_template_metalanguage

Demonstrates various simple infill rotation patterns. These are fixed directions or simple layer-by-layer alternations.

```text
0
```

```text
0, 90
```

```text
0, 15, 30
```

```text
+90
```

```text
+45
```

```text
+30/50%
```

```text
+45/10#
```

```text
+15#10
```

```text
B!, +30
```

```text
0, +30, +90
```

--------------------------------

### Run OrcaSlicer Profile Validator

Source: https://www.orcaslicer.com/wiki/guides/how_to_create_profiles

Example command to execute the profile validator for a specific vendor.

```bash
./OrcaSlicer_profile_validator -p ~/codes/OrcaSlicer/resources/profiles -l 2 -v Custom
```

--------------------------------

### Define plugin dependencies

Source: https://www.orcaslicer.com/wiki/developer_reference/plugin_development/plugin_development

Specifies third-party requirements using the PEP 723 dependencies array for automatic resolution during installation.

```toml
# dependencies = ["requests==2.32.3", "humanize"]
```

--------------------------------

### Extra Solid Infill Interval Patterns

Source: https://www.orcaslicer.com/wiki/print_settings/strength/strength_settings_infill

Examples of interval-based patterns for inserting solid layers at specific layer frequencies.

```text
5 or 5#1    # Insert 1 solid layer every 5 layers
5#          # Same as 5#1
10#2        # Insert 2 consecutive solid layers every 10 layers
```

--------------------------------

### Define a Slicing Pipeline Plugin Capability

Source: https://www.orcaslicer.com/wiki/developer_reference/plugin_development/plugin_development

Example of a plugin capability header defining the context structure and the virtual execution method.

```cpp
#ifndef slic3r_SlicingPipelinePluginCapability_hpp_
#define slic3r_SlicingPipelinePluginCapability_hpp_

#include "../../PythonPluginInterface.hpp"

namespace Slic3r {

struct SlicingPipelineContext {
    std::string orca_version;
    SlicingPipelineStepPlugin step;
    Print* print;
    const PrintObject* object;
    std::string gcode_path;
    std::string host;
    std::string output_name;
};

class SlicingPipelinePluginCapability : public PluginCapabilityInterface
{
public:
    PluginCapabilityType get_type() const override { return PluginCapabilityType::SlicingPipeline; }

    virtual ExecutionResult execute(SlicingPipelineContext& ctx) = 0;

    static void RegisterBindings(pybind11::module_ &module,
                                 pybind11::enum_<PluginCapabilityType> &pluginTypes);
};

} // namespace Slic3r

#endif /* slic3r_SlicingPipelinePluginCapability_hpp_ */
```

--------------------------------

### Extra Solid Infill Explicit Layer List

Source: https://www.orcaslicer.com/wiki/print_settings/strength/strength_settings_infill

Examples of comma-separated layer lists to specify exact layers or ranges for solid infill insertion.

```text
1,7,9       # Insert solid layers at layers 1, 7, and 9
5,15,25     # Insert solid layers at layers 5, 15, and 25
5,9#2,18    # Insert at 5; at 9 and 10 (because #2); and at 18
```

--------------------------------

### Registering Python Bindings for a Plugin Capability

Source: https://www.orcaslicer.com/wiki/developer_reference/plugin_development/plugin_development

Implement the RegisterBindings method to expose C++ classes and structs to Python via pybind11. This example demonstrates binding a context struct and a base class with a trampoline.

```cpp
void SlicingPipelinePluginCapability::RegisterBindings(pybind11::module_& module, pybind11::enum_<PluginCapabilityType>& pluginTypes)
{
    (void) pluginTypes;

    auto slicing = module.def_submodule("slicing", "Slicing pipeline API");

    py::class_<SlicingPipelineContext>(slicing, "SlicingPipelineContext")
        .def(py::init<>())
        .def_readonly("step", &SlicingPipelineContext::step)
        .def_readonly("gcode_path", &SlicingPipelineContext::gcode_path)
        .def_readonly("host", &SlicingPipelineContext::host)
        .def_readonly("output_name", &SlicingPipelineContext::output_name);

    py::class_<SlicingPipelinePluginCapability, PluginCapabilityInterface, PySlicingPipelinePluginCapabilityTrampoline, std::shared_ptr<SlicingPipelinePluginCapability>>(slicing, "SlicingPipelineCapabilityBase")
        .def(py::init<>())
        .def("get_type", &SlicingPipelinePluginCapability::get_type)
        .def("execute", &SlicingPipelinePluginCapability::execute);
}
```

--------------------------------

### Example Calculation for Max Volumetric Speed

Source: https://www.orcaslicer.com/wiki/calibration/volumetric_speed_calib

An example calculation demonstrating how to apply the formula with given start and step values. This helps determine the appropriate flow rate for your filament.

```plaintext
5 + (19 * 0.5) = 14.5mm³/s
```

--------------------------------

### Open the built application

Source: https://www.orcaslicer.com/wiki/developer_reference/how_to_build

Launch the compiled application from the build directory.

```bash
open build/arm64/OrcaSlicer/OrcaSlicer.app
```

--------------------------------

### Implementing a Configurable Script Plugin

Source: https://www.orcaslicer.com/wiki/developer_reference/plugin_development/plugin_development

Demonstrates how to define default configurations, execute logic based on stored settings, and handle configuration migration.

```python
import json
import orca

class ConfigurableScript(orca.script.ScriptPluginCapabilityBase):
    def get_name(self):
        return "Configurable Script"

    def get_default_config(self):
        return {"greeting": "Hello", "repeat": 1}

    def execute(self):
        config = json.loads(self.get_config())
        greeting = config.get("greeting", "Hello")
        return orca.ExecutionResult.success(greeting * int(config.get("repeat", 1)))

    def migrate_config_if_needed(self):
        version = self.get_config_version()
        config = json.loads(self.get_config())
        # Validate or migrate config here, then write it back with save_config().
        return version, config
```

--------------------------------

### All-in-one build

Source: https://www.orcaslicer.com/wiki/developer_reference/how_to_build

Run this command to perform a complete build process including dependencies, tests, and AppImage creation.

```bash
./build_linux.sh -dsti
```

--------------------------------

### Template Expression Examples

Source: https://www.orcaslicer.com/wiki/developer_reference/built_in_placeholders_variables

Examples of arithmetic, string concatenation, and conditional logic using the built-in expression language.

```text
{used_filament * 1000}
```

```text
{"v" + layer_num}
```

```text
{if printer_notes =~ /.*BAMBU.*/}bambu{endif}
```

```text
{int(13.9)}
```

```text
{zdigits(5, 4)}
```

```text
{if layer_num == 1}first{else}later{endif}
```

```text
{local name = "part"}{name}
```

```text
{nozzle_temperature[0]}
```

--------------------------------

### Run Build Script

Source: https://www.orcaslicer.com/wiki/developer_reference/how_to_build

Executes the build process for the release configuration.

```text
build_release_vs.bat
```

--------------------------------

### Build dependencies

Source: https://www.orcaslicer.com/wiki/developer_reference/how_to_build

Run this command to build the necessary dependencies for the project.

```bash
./build_linux.sh -d
```

--------------------------------

### RepRap Input Shaper G-code Example (Legacy)

Source: https://www.orcaslicer.com/wiki/calibration/input_shaping_calib

Example of setting input shaper frequency for RepRap firmware version 3.2 and earlier.

```gcode
M593 F37.25

```

--------------------------------

### Marlin Input Shaper G-code Example

Source: https://www.orcaslicer.com/wiki/calibration/input_shaping_calib

An example of setting input shaper parameters for Marlin firmware with specific frequency and damping values.

```gcode
M593 X F37.25 D0.16
M593 Y F37.5 D0.06
M500

```

--------------------------------

### Build AppImage

Source: https://www.orcaslicer.com/wiki/developer_reference/how_to_build

Run this command to generate an AppImage of the application.

```bash
./build_linux.sh -i
```

--------------------------------

### Pass Chamber Temperature to Print Start Macro

Source: https://www.orcaslicer.com/wiki/material_settings/filament/material_temperatures

Use the chamber_temperature variable to pass the target temperature to a custom print start macro.

```gcode
PRINT_START (other variables) CHAMBER_TEMP=[chamber_temperature]
```

--------------------------------

### Create a multi-capability plugin

Source: https://www.orcaslicer.com/wiki/developer_reference/plugin_development/plugin_development

Demonstrates bundling multiple capabilities, such as slicing-pipeline and script capabilities, into a single plugin package.

```python
# /// script
# [tool.orcaslicer.plugin]
# name = "Sample Plugin"
# description = "Demonstrates registering several capabilities from one plugin."
# author = "Your Name"
# version = "1.0.0"
# ///
import orca


class EnvironmentReport(orca.slicing.SlicingPipelineCapabilityBase):
    def get_name(self):
        return "Environment Report"

    def execute(self, ctx):
        # Post-process the exported file at the dedicated pipeline seam.
        if ctx.step != orca.slicing.Step.psGCodePostProcess:
            return orca.ExecutionResult.success()
        try:
            with open(ctx.gcode_path, "a", encoding="utf-8") as f:
                f.write(f"\n; processed by Environment Report for {ctx.output_name}\n")
        except Exception as exc:
            return orca.ExecutionResult.failure(
                orca.PluginResult.RecoverableError,
                f"could not append report: {exc}")
        return orca.ExecutionResult.success("report appended")


class GCodeBenchmark(orca.script.ScriptPluginCapabilityBase):
    def get_name(self):
        return "G-code Benchmark"

    def execute(self):
        return orca.ExecutionResult.success("benchmark complete")


@orca.plugin
class SamplePlugin(orca.base):
    def register_capabilities(self):
        orca.register_capability(EnvironmentReport)
        orca.register_capability(GCodeBenchmark)
```

--------------------------------

### RepRap Input Shaper G-code Example (3.4+)

Source: https://www.orcaslicer.com/wiki/calibration/input_shaping_calib

Example of setting input shaper parameters for RepRap firmware version 3.4 and later, using ZVD type.

```gcode
M593 P"ZVD" F37.25 S0.16

```

--------------------------------

### Joint Sign Examples for Infill Rotation

Source: https://www.orcaslicer.com/wiki/print_settings/strength/strength_settings_infill_rotation_template_metalanguage

Provides examples of various joint signs used to define the connection method for infill rotation, illustrating different displacement and function types.

```text
/ - linear displacement
```

```text
# - multiple layers with vertical displacement at finish angle
```

```text
#- - multiple layers with vertical displacement at initial angle
```

```text
| - multiple layers with vertical displacement at middle angle
```

```text
N - sinus function (vertical connection)
```

```text
n - sinus function (vertical connection, lazy)
```

```text
Z - sinus function (horizontal connection)
```

```text
z - sinus function (horizontal connection, lazy)
```

```text
L - quarter of circle (horizontal to vertical connection)
```

```text
l - quarter of circle (vertical to horizontal connection)
```

```text
U - squared function
```

```text
u- - squared function (inverse)
```

```text
Q - cubic function
```

```text
q- - cubic function (inverse)
```

```text
$ - arcsinus method
```

```text
~ - random angle
```

```text
^ - pseudorandom angle
```
Tokens:
Raw