diff --git a/calibration/Calibration.md b/calibration/Calibration.md index 03fed0c..3ae1b2c 100644 --- a/calibration/Calibration.md +++ b/calibration/Calibration.md @@ -18,7 +18,7 @@ The recommended order for calibration is as follows: 2. **[Max Volumetric Speed](volumetric-speed-calib):** Calibrate the maximum volumetric speed of the filament. This is important for ensuring that the printer can handle the flow rate of the filament without causing issues like under-extrusion. mvf_measurement_point 3. **[Pressure Advance](pressure-advance-calib):** Calibrate the pressure advance settings to improve print quality and reduce artifacts caused by pressure fluctuations in the nozzle. - - **[Adaptive Pressure Advance](adaptive-pressure-advance-calib):** This is an advanced calibration technique that can be used to further optimize the pressure advance settings for different print speeds and geometries. + - **[Adaptive Pressure Advance](adaptive-pressure-advance-calib):** This is an advanced calibration technique that can be used to further optimize the pressure advance settings for different print speeds and geometries. pa-tower 4. **[Flow](flow-rate-calib):** Calibrate the flow rate to ensure that the correct amount of filament is being extruded. This is important for achieving accurate dimensions and good layer adhesion. flowcalibration-example diff --git a/calibration/cornering-calib.md b/calibration/cornering-calib.md index e0ff782..65a1a44 100644 --- a/calibration/cornering-calib.md +++ b/calibration/cornering-calib.md @@ -43,84 +43,84 @@ This test will be set detect automatically your printer firmware type and will a ![jd_second_print_measure](https://github.com/OrcaSlicer/OrcaSlicer_WIKI/blob/main/images/JunctionDeviation/jd_second_print_measure.jpg?raw=true) ![jd_second_slicer_measure](https://github.com/OrcaSlicer/OrcaSlicer_WIKI/blob/main/images/JunctionDeviation/jd_second_slicer_measure.png?raw=true) 3. Save the settings - - Into your OrcaSlicer printer profile (**RECOMMENDED**): - 1. Go to Printer [settings → Motion ability → Jerk limitation](printer_motion_ability#jerk-limitation): - 2. Set your maximum Jerk X and Y or Junction Deviation values. + - Into your OrcaSlicer printer profile (**RECOMMENDED**): + 1. Go to Printer [settings → Motion ability → Jerk limitation](printer_motion_ability#jerk-limitation): + 2. Set your maximum Jerk X and Y or Junction Deviation values. ![jd_printer_jerk_limitation](https://github.com/OrcaSlicer/OrcaSlicer_WIKI/blob/main/images/JunctionDeviation/jd_printer_jerk_limitation.png?raw=true) - - Directly into your printer firmware: - - Restore your 3D Printer settings to avoid keeping high acceleration and jerk values used for the test. + - Directly into your printer firmware: + - Restore your 3D Printer settings to avoid keeping high acceleration and jerk values used for the test. - - Klipper: - - Skeleton + - Klipper: + - Skeleton: - ```gcode - SET_VELOCITY_LIMIT SQUARE_CORNER_VELOCITY=#SquareCornerVelocity - ``` + ```gcode + SET_VELOCITY_LIMIT SQUARE_CORNER_VELOCITY=#SquareCornerVelocity + ``` - Example: + Example: - ```gcode - SET_VELOCITY_LIMIT SQUARE_CORNER_VELOCITY=5.0 - ``` + ```gcode + SET_VELOCITY_LIMIT SQUARE_CORNER_VELOCITY=5.0 + ``` - Note: You can also set `square_corner_velocity` persistently in your `printer.cfg` (restart required). + Note: You can also set `square_corner_velocity` persistently in your `printer.cfg` (restart required). - - Marlin 2 (Junction Deviation enabled): - - Skeleton + - Marlin 2 (Junction Deviation enabled): + - Skeleton: - ```gcode - M205 J#JunctionDeviationValue - M500 - ``` + ```gcode + M205 J#JunctionDeviationValue + M500 + ``` - Example: + - Example: - ```gcode - M205 J0.012 - M500 - ``` + ```gcode + M205 J0.012 + M500 + ``` - - To make the change permanent in firmware, set in `Configuration.h` and recompile: + - To make the change permanent in firmware, set in `Configuration.h` and recompile: - ```cpp - #define JUNCTION_DEVIATION_MM 0.012 // (mm) Distance from real junction edge - ``` + ```cpp + #define JUNCTION_DEVIATION_MM 0.012 // (mm) Distance from real junction edge + ``` - Also ensure classic jerk is disabled if using junction deviation: + Also ensure classic jerk is disabled if using junction deviation: - ```cpp - //#define CLASSIC_JERK - ``` + ```cpp + //#define CLASSIC_JERK + ``` - - Marlin Classic Jerk / Marlin Legacy: - - Skeleton — set the per-axis jerk limits using `M205` (X/Y optional depending on firmware build): + - Marlin Classic Jerk / Marlin Legacy: + - Skeleton: — set the per-axis jerk limits using `M205` (X/Y optional depending on firmware build): - ```gcode - M205 X#JerkX Y#JerkY - M500 - ``` + ```gcode + M205 X#JerkX Y#JerkY + M500 + ``` - Example: + - Example: - ```gcode - M205 X10 Y10 - M500 - ``` + ```gcode + M205 X10 Y10 + M500 + ``` - - RepRap (Duet / RepRapFirmware): - **IMPORTANT:** Set in mm/min so convert from mm/s to mm/min multiply by 60. - - Skeleton + - RepRap (Duet / RepRapFirmware): + **IMPORTANT:** Set in mm/min so convert from mm/s to mm/min multiply by 60. + - Skeleton: - ```gcode - M566 X#max_instantaneous_change Y#max_instantaneous_change - M500 ; if supported by your board - ``` + ```gcode + M566 X#max_instantaneous_change Y#max_instantaneous_change + M500 ; if supported by your board + ``` - Example (Duet-style): + - Example (Duet-style): - ```gcode - M566 X3000 Y3000 - ``` + ```gcode + M566 X3000 Y3000 + ``` > [!NOTE] > RepRapFirmware exposes `M566` to set allowable instantaneous speed changes; some boards may persist settings with `M500` or via their web/config files. diff --git a/calibration/input-shaping-calib.md b/calibration/input-shaping-calib.md index c99ce7a..9c60657 100644 --- a/calibration/input-shaping-calib.md +++ b/calibration/input-shaping-calib.md @@ -73,68 +73,68 @@ Pre-requisites: ![IS_damp_menu](https://github.com/OrcaSlicer/OrcaSlicer_WIKI/blob/main/images/InputShaping/IS_damp_menu.png?raw=true) 1. Measure the X and Y heights and read the damping set at that point in OrcaSlicer. ![IS_damp_marlin_print_measure](https://github.com/OrcaSlicer/OrcaSlicer_WIKI/blob/main/images/InputShaping/IS_damp_marlin_print_measure.jpg?raw=true) - - Marlin: - ![IS_damp_marlin_slicer_measure](https://github.com/OrcaSlicer/OrcaSlicer_WIKI/blob/main/images/InputShaping/IS_damp_marlin_slicer_measure.png?raw=true) - - Klipper: - ![IS_damp_klipper_slicer_measure](https://github.com/OrcaSlicer/OrcaSlicer_WIKI/blob/main/images/InputShaping/IS_damp_klipper_slicer_measure.png?raw=true) + - Marlin: + ![IS_damp_marlin_slicer_measure](https://github.com/OrcaSlicer/OrcaSlicer_WIKI/blob/main/images/InputShaping/IS_damp_marlin_slicer_measure.png?raw=true) + - Klipper: + ![IS_damp_klipper_slicer_measure](https://github.com/OrcaSlicer/OrcaSlicer_WIKI/blob/main/images/InputShaping/IS_damp_klipper_slicer_measure.png?raw=true) 6. **Restore your 3D Printer settings to avoid keep using high acceleration and jerk values.** 7. **Save the settings** - - Into your printer firmware settings save the values you found (Type, frequency/cies and damp) - - Save it into Orca's printer profile settings in Printer settings/ Machine G-code/ Machine start G-code using the following G-code: - - Klipper: - - Skeleton + - Into your printer firmware settings save the values you found (Type, frequency/cies and damp) + - Save it into Orca's printer profile settings in Printer settings/ Machine G-code/ Machine start G-code using the following G-code: + - Klipper: + - Skeleton: - ```gcode - SET_INPUT_SHAPER SHAPER_TYPE=TYPE SHAPER_FREQ_X=#Xfrequency DAMPING_RATIO_X=#XDamping SHAPER_FREQ_Y=#Yfrequency DAMPING_RATIO_Y=#YDamping - ``` + ```gcode + SET_INPUT_SHAPER SHAPER_TYPE=TYPE SHAPER_FREQ_X=#Xfrequency DAMPING_RATIO_X=#XDamping SHAPER_FREQ_Y=#Yfrequency DAMPING_RATIO_Y=#YDamping + ``` - Example + - Example: - ```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 - ``` + ```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 + ``` - - Marlin: - - Skeleton + - Marlin: + - Skeleton: - ```gcode - M593 X F#Xfrequency D#XDamping - M593 Y F#Yfrequency D#YDamping - M500 - ``` + ```gcode + M593 X F#Xfrequency D#XDamping + M593 Y F#Yfrequency D#YDamping + M500 + ``` - Example + - Example - ```gcode - M593 X F37.25 D0.16 - M593 Y F37.5 D0.06 - M500 - ``` + ```gcode + M593 X F37.25 D0.16 + M593 Y F37.5 D0.06 + M500 + ``` - - RepRap: - - Skeleton for RepRap 3.3 and later + - RepRap: + - Skeleton: for RepRap 3.3 and later - ```gcode - M593 P#Type F#frequency S#Damping - ``` + ```gcode + M593 P#Type F#frequency S#Damping + ``` - Example RepRap 3.4 and later + - Example RepRap 3.4 and later - ```gcode - M593 P"ZVD" F37.25 S0.16 - ``` + ```gcode + M593 P"ZVD" F37.25 S0.16 + ``` - - Skeleton for RepRap 3.2 and earlier + - Skeleton: for RepRap 3.2 and earlier - ```gcode - M593 F#frequency - ``` + ```gcode + M593 F#frequency + ``` - Example Legacy (RepRap 3.2 and earlier) + - Example Legacy (RepRap 3.2 and earlier) - ```gcode - M593 F37.25 - ``` + ```gcode + M593 F37.25 + ``` ### Fixed-Time Motion diff --git a/developer-reference/How-to-build.md b/developer-reference/How-to-build.md index 825a581..ec561f3 100644 --- a/developer-reference/How-to-build.md +++ b/developer-reference/How-to-build.md @@ -88,65 +88,65 @@ How to building with Visual Studio on Windows 64-bit. ### Windows Instructions 1. Clone the repository: - - If using GitHub Desktop clone the repository from the GUI. - - If using the command line: - 1. Clone the repository: + - If using GitHub Desktop clone the repository from the GUI. + - If using the command line: + 1. Clone the repository: - ```shell - git clone https://github.com/OrcaSlicer/OrcaSlicer - ``` + ```shell + git clone https://github.com/OrcaSlicer/OrcaSlicer + ``` - 2. Run lfs to download tools on Windows: + 2. Run lfs to download tools on Windows: - ```shell - git lfs pull - ``` + ```shell + git lfs pull + ``` 2. Open the appropriate command prompt: - ```MD - x64 Native Tools Command Prompt for VS - ``` + ```MD + x64 Native Tools Command Prompt for VS + ``` 1. Navigate to correct drive (if needed), e.g.: - ```shell - N: - ``` + ```shell + N: + ``` 2. Change directory to the cloned repository, e.g.: - ```shell - cd N:\Repos\OrcaSlicer - ``` + ```shell + cd N:\Repos\OrcaSlicer + ``` 3. Run the build script: - ```shell - build_release_vs.bat - ``` + ```shell + build_release_vs.bat + ``` - ![vs_cmd](https://github.com/OrcaSlicer/OrcaSlicer_WIKI/blob/main/images/develop/vs_cmd.png?raw=true) + ![vs_cmd](https://github.com/OrcaSlicer/OrcaSlicer_WIKI/blob/main/images/develop/vs_cmd.png?raw=true) - > [!NOTE] - > The build process will take a long time depending on your system but even with high-end hardware it can take up to 40 minutes. + > [!NOTE] + > The build process will take a long time depending on your system but even with high-end hardware it can take up to 40 minutes. - > [!TIP] - > If you encounter issues, you can try to uninstall ZLIB from your Vcpkg library. + > [!TIP] + > If you encounter issues, you can try to uninstall ZLIB from your Vcpkg library. 3. If successful, you will find the Visual Studio solution file in: - ```shell - build\OrcaSlicer.slnx - ``` + ```shell + build\OrcaSlicer.slnx + ``` 4. Open the solution in Visual Studio, set the build configuration to `Release` and run the `Local Windows Debugger`. ![compile_vs_local_debugger](https://github.com/OrcaSlicer/OrcaSlicer_WIKI/blob/main/images/develop/compile_vs_local_debugger.png?raw=true) 5. Your resulting executable will be located in: - ```shell - \build\src\Release\orca-slicer.exe - ``` + ```shell + \build\src\Release\orca-slicer.exe + ``` > [!NOTE] > The first time you build a branch, it will take a long time. @@ -250,11 +250,11 @@ To build and debug directly in Xcode: ``` 2. In the menu bar: - - **Product > Scheme > OrcaSlicer** - - **Product > Scheme > Edit Scheme...** - - Under **Run > Info**, set **Build Configuration** to `RelWithDebInfo` - - Under **Run > Options**, uncheck **Allow debugging when browsing versions** - - **Product > Run** + - **Product > Scheme > OrcaSlicer** + - **Product > Scheme > Edit Scheme...** + - Under **Run > Info**, set **Build Configuration** to `RelWithDebInfo` + - Under **Run > Options**, uncheck **Allow debugging when browsing versions** + - **Product > Run** ## Linux diff --git a/developer-reference/How-to-wiki.md b/developer-reference/How-to-wiki.md index a5c6505..89d5dbe 100644 --- a/developer-reference/How-to-wiki.md +++ b/developer-reference/How-to-wiki.md @@ -68,10 +68,28 @@ For long pages, include a table of contents at the top to help readers find sect ```markdown - [Wiki Structure](#wiki-structure) - - [Home](#home) - - [Index and Navigation](#index-and-navigation) - - [File Naming and Organization](#file-naming-and-organization) + - [Home](#home) + - [Index and Navigation](#index-and-navigation) + - [File Naming and Organization](#file-naming-and-organization) +- [Orca to Wiki Redirection](#orca-to-wiki-redirection) - [Formatting and Style](#formatting-and-style) + - [Markdown Formatting](#markdown-formatting) + - [Alerts and Callouts](#alerts-and-callouts) +- [Images](#images) + - [Image Sources](#image-sources) + - [OrcaSlicer Resources](#orcaslicer-resources) + - [Wiki Images](#wiki-images) + - [Image Naming](#image-naming) + - [Image Placement](#image-placement) + - [Linking Images](#linking-images) + - [Examples](#examples) + - [Avoid the Following](#avoid-the-following) + - [Resize Images](#resize-images) + - [Image Cropping and Highlighting](#image-cropping-and-highlighting) + - [Recommended Formats](#recommended-formats) +- [Structuring Content](#structuring-content) +- [Commands and Code Blocks](#commands-and-code-blocks) +- [External Links](#external-links) ``` > [!NOTE]