Updated Wiki content

OrcaSlicerBot
2026-01-24 16:32:41 +00:00
parent 4151489374
commit 5fa2ad0266
12 changed files with 81 additions and 77 deletions

@@ -53,13 +53,13 @@ This test will be set detect automatically your printer firmware type and will a
- Klipper:
- Skeleton:
```gcode
```pwsh
SET_VELOCITY_LIMIT SQUARE_CORNER_VELOCITY=#SquareCornerVelocity
```
Example:
```gcode
```pwsh
SET_VELOCITY_LIMIT SQUARE_CORNER_VELOCITY=5.0
```
@@ -90,7 +90,7 @@ This test will be set detect automatically your printer firmware type and will a
```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):

@@ -84,13 +84,13 @@ Pre-requisites:
- Klipper:
- Skeleton:
```gcode
```pwsh
SET_INPUT_SHAPER SHAPER_TYPE=TYPE SHAPER_FREQ_X=#Xfrequency DAMPING_RATIO_X=#XDamping SHAPER_FREQ_Y=#Yfrequency DAMPING_RATIO_Y=#YDamping
```
- Example:
```gcode
```pwsh
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
```

@@ -35,38 +35,38 @@ How to building with Visual Studio on Windows 64-bit.
- [Visual Studio](https://visualstudio.microsoft.com/vs/) 2026, 2022 or Visual Studio 2019
```shell
```pwsh
winget install --id=Microsoft.VisualStudio.Community -e
```
- [CMake](https://cmake.org/)
```shell
```pwsh
winget install --id=Kitware.CMake -e
```
- [Strawberry Perl](https://strawberryperl.com/)
```shell
```pwsh
winget install --id=StrawberryPerl.StrawberryPerl -e
```
- [Git](https://git-scm.com/)
```shell
```pwsh
winget install --id=Git.Git -e
```
- [git-lfs](https://git-lfs.com/)
```shell
```pwsh
winget install --id=GitHub.GitLFS -e
```
> [!TIP]
> GitHub Desktop (optional): A GUI for Git and Git LFS, which already includes both tools.
>
> ```shell
> ```pwsh
> winget install --id=GitHub.GitHubDesktop -e
> ```
@@ -92,13 +92,13 @@ How to building with Visual Studio on Windows 64-bit.
- If using the command line:
1. Clone the repository:
```shell
```pwsh
git clone https://github.com/OrcaSlicer/OrcaSlicer
```
2. Run lfs to download tools on Windows:
```shell
```pwsh
git lfs pull
```
@@ -110,19 +110,19 @@ How to building with Visual Studio on Windows 64-bit.
1. Navigate to correct drive (if needed), e.g.:
```shell
```pwsh
N:
```
2. Change directory to the cloned repository, e.g.:
```shell
```pwsh
cd N:\Repos\OrcaSlicer
```
3. Run the build script:
```shell
```pwsh
build_release_vs.bat
```
@@ -136,7 +136,7 @@ How to building with Visual Studio on Windows 64-bit.
3. If successful, you will find the Visual Studio solution file in:
```shell
```pwsh
build\OrcaSlicer.slnx
```
@@ -144,7 +144,7 @@ How to building with Visual Studio on Windows 64-bit.
![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
```pwsh
\build\src\Release\orca-slicer.exe
```
@@ -162,7 +162,7 @@ How to building with Visual Studio on Windows 64-bit.
>
> 1. Locate the `winrt` folder in your Windows SDK installation. For example:
>
> ```shell
> ```pwsh
> C:\Program Files (x86)\Windows Kits\10\Include\10.0.26100.0\winrt
> ```
>
@@ -193,7 +193,7 @@ How to building with Xcode on MacOS 64-bit.
> [!TIP]
> You can install most of them by running:
>
> ```shell
> ```pwsh
> brew install gettext libtool automake autoconf texinfo
> ```
@@ -209,7 +209,7 @@ Homebrew currently only offers the latest version of CMake (e.g. **4.X**), which
4. Restart the terminal and check the version:
```sh
```pwsh
cmake --version
```
@@ -222,20 +222,20 @@ Homebrew currently only offers the latest version of CMake (e.g. **4.X**), which
1. Clone the repository:
```shell
```pwsh
git clone https://github.com/OrcaSlicer/OrcaSlicer
cd OrcaSlicer
```
2. Build the application:
```shell
```pwsh
./build_release_macos.sh
```
3. Open the application:
```shell
```pwsh
open build/arm64/OrcaSlicer/OrcaSlicer.app
```
@@ -245,7 +245,7 @@ To build and debug directly in Xcode:
1. Open the Xcode project:
```shell
```pwsh
open build/arm64/OrcaSlicer.xcodeproj
```
@@ -271,7 +271,7 @@ How to build and run OrcaSlicer using Docker.
#### Docker Instructions
```shell
```pwsh
git clone https://github.com/OrcaSlicer/OrcaSlicer && cd OrcaSlicer && ./scripts/DockerBuild.sh && ./scripts/DockerRun.sh
```
@@ -340,31 +340,31 @@ The build system supports multiple Linux distributions including Ubuntu/Debian a
1. **Install system dependencies:**
```shell
```pwsh
./build_linux.sh -u
```
2. **Build dependencies:**
```shell
```pwsh
./build_linux.sh -d
```
3. **Build OrcaSlicer with tests:**
```shell
```pwsh
./build_linux.sh -st
```
4. **Build AppImage (optional):**
```shell
```pwsh
./build_linux.sh -i
```
5. **All-in-one build (recommended):**
```shell
```pwsh
./build_linux.sh -dsti
```
@@ -406,7 +406,7 @@ This allows for multiple self-contained installations with separate user data.
### Example folder structure
```shell
```pwsh
OrcaSlicer.exe
data_dir/
```

@@ -61,7 +61,7 @@ resources\profiles\
Template files for profiles are available in:
```shell
```pwsh
OrcaSlicer\resources\profiles_template\Template
```
@@ -217,7 +217,7 @@ Process profiles define print quality and behavior. They follow a structure simi
- Vendor-specific process profiles should inherit from the base using the `inherits` field.
- Profiles are stored under:
```shell
```pwsh
resources\profiles\vendor_name\process\
```
@@ -245,13 +245,13 @@ Example:
- Example fields: `nozzle_diameter`, `bed_model`, `bed_texture`, `model_id`, etc.
- Stored in:
```shell
```pwsh
resources\profiles\vendor_name\machine\
```
- Each vendor's folder may contain an 240x240px image named:
```shell
```pwsh
[machine_model_list.name]_cover.png
```
@@ -305,13 +305,13 @@ Example variant profile:
- The `model` directory under the vendor folder is intended to behave similarly to `machine` profiles.
- Used for additional printer-related 3D models or definitions, stored at:
```shell
```pwsh
resources\profiles\vendor_name\model\
```
## Vendor Meta File
```shell
```pwsh
resources\profiles\vendor_name.json
```
@@ -370,7 +370,7 @@ The process is the same if you want to add a new brand filament profile into the
#### Usage
```shell
```css
-h [ --help ] help
-p [ --path ] arg profile folder
-v [ --vendor ] arg Vendor name. Optional, all profiles present in the folder will be validated if not specified
@@ -379,13 +379,13 @@ The process is the same if you want to add a new brand filament profile into the
#### Example
```shell
```pwsh
./OrcaSlicer_profile_validator -p ~/codes/OrcaSlicer/resources/profiles -l 2 -v Custom
```
#### Sample result with errors
```shell
```pwsh
PS D:\codes\OrcaSlicer> ."D:/codes/OrcaSlicer/build/src/Release/OrcaSlicer_profile_validator.exe" --path d:\codes\OrcaSlicer\resources\profiles -l 2 -v Custom
[2024-02-28 21:23:06.102138] [0x0000a4e8] [error] Slic3r::ConfigBase::load_from_json: parse d:\codes\OrcaSlicer\resources\profiles/Custom/machine/fdm_klipper_common.json got a nlohmann::detail::parse_error, reason = [json.exception.parse_error.101] parse error at line 9, column 38: syntax error while parsing object - unexpected string literal; expected '}'
...
@@ -394,7 +394,7 @@ Validation failed
#### Sample result with success
```shell
```pwsh
PS D:\codes\OrcaSlicer\build\src\RelWithDebInfo> ."D:/codes/OrcaSlicer/build/src/Release/OrcaSlicer_profile_validator.exe" --path d:\codes\OrcaSlicer\resources\profiles -l 2 -v Custom
Validation completed successfully
```
@@ -414,7 +414,7 @@ In addition to the Orca validator, you should run the `orca_extra_profile_check.
#### Example command
```shell
```pwsh
python ./orca_extra_profile_check.py
```
@@ -428,7 +428,7 @@ You can also enable or disable specific checks:
#### Sample usage with all checks enabled
```shell
```pwsh
python ./orca_extra_profile_check.py --vendor="vendor_name" --check-filaments --check-materials
```

@@ -6,7 +6,7 @@ This wiki page describes how to build and run tests on Linux. It should eventual
Can be built with the `-t` flag for `build_linux.sh`:
```shell
```pwsh
build_linux.sh -t
```
@@ -20,7 +20,7 @@ Test binaries will then appear under `build/tests` or `build-dbginfo/tests` or `
For rebuilding after changes, you can look into `build_linux.sh` for the cmake command which triggers the build and adapt it to running independently. You'll be able to use something like:
```shell
```pwsh
# Obviously only use the appropriate one
BUILD_CONFIG=Release
BUILD_CONFIG=RelWithDebInfo
@@ -38,14 +38,14 @@ If you change any CMakeLists.txt file, you'll need to rerun the configuration ge
### Run All
```shell
```pwsh
cd $BUILD_DIR # build or build-dbginfo probably
ctest --test-dir tests
```
### Run a Specific Set
```shell
```pwsh
cd $BUILD_DIR # build or build-dbginfo probably
ctest --test-dir tests/slic3rutils
```

@@ -53,7 +53,7 @@ If you add new file resource, add it to the list of files containing macro `L()`
2. Create template file(*.POT) with GNUgettext command:
```shell
```pwsh
xgettext --keyword=L --add-comments=TRN --from-code=UTF-8 --debug -o OrcaSlicer.pot -f list.txt
```
@@ -64,7 +64,7 @@ If you add new file resource, add it to the list of files containing macro `L()`
4. To merge old PO-file with strings from created new POT-file use command:
```shell
```pwsh
msgmerge -N -o new.po old.po new.pot
```
@@ -72,13 +72,13 @@ If you add new file resource, add it to the list of files containing macro `L()`
5. To concatenate old PO-file with strings from new PO-file use command:
```shell
```pwsh
msgcat -o new.po old.po
```
6. Create an English translation catalog with command:
```shell
```pwsh
msgen -o new.po old.po
```
@@ -107,6 +107,6 @@ When you have Catalog to translation open POT or PO file in PoEdit and start tra
- For units of measurement, use the international system of units. Use "s" instead of "sec".
- If the phrase doesn't have a dot at the end, don't add it. And if it does, then don't forget to :)
- If the phrase doesn't have a dot at the end, don't add it. And if it does, then don't forget to :).
- It is useful to stick to the same terminology in the application (especially with basic terms such as "filament" and similar). Stay consistent. Otherwise it will confuse users.

@@ -78,7 +78,7 @@ For PLA, PETG, TPU, PVA, and other low-temperature materials, this option should
If enabled, this parameter also sets a G-code variable named chamber_temperature, which can be used to pass the desired chamber temperature to your print start macro, or a heat soak macro like this:
```gcode
```pwsh
PRINT_START (other variables) CHAMBER_TEMP=[chamber_temperature]
```

@@ -55,9 +55,6 @@ plugins:
# Markdown extensions (using built-in extensions to avoid extra dependencies)
markdown_extensions:
- codehilite:
guess_lang: false
- fenced_code
- tables
- toc:
permalink: true
@@ -72,6 +69,13 @@ markdown_extensions:
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.arithmatex:
generic: true
- pymdownx.highlight:
anchor_linenums: true
use_pygments: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.superfences
extra:
generator: false # hides "Made with Material for MkDocs" from footer

@@ -7,6 +7,6 @@ Check the script's documentation for dependencies, available parameters and usag
Example Python script:
```shell
```pwsh
"C:\Your\Path\To\Python\python.exe" "C:\Your\Path\To\Script\pythonScript.py" -parameterToScript 1994;
```

@@ -227,7 +227,7 @@ Bellow is a reference configuration for Klipper.
> [!IMPORTANT]
> Don't forget to change the pin name/values to the actual values you are using in the configuration.
```gcode
```pwsh
[heater_generic chamber_heater]
heater_pin:PB10
max_power:1.0

@@ -52,7 +52,7 @@ G29 L{adaptive_bed_mesh_min[0]} R{adaptive_bed_mesh_max[0]} F{adaptive_bed_mesh_
### Klipper
```gcode
```pwsh
; Always pass `ADAPTIVE_MARGIN=0` because Orca has already handled `adaptive_bed_mesh_margin` internally
; Make sure to set ADAPTIVE to 0 otherwise Klipper will use it's own adaptive bed mesh logic
BED_MESH_CALIBRATE mesh_min={adaptive_bed_mesh_min[0]},{adaptive_bed_mesh_min[1]} mesh_max={adaptive_bed_mesh_max[0]},{adaptive_bed_mesh_max[1]} ALGORITHM=[bed_mesh_algo] PROBE_COUNT={bed_mesh_probe_count[0]},{bed_mesh_probe_count[1]} ADAPTIVE=0 ADAPTIVE_MARGIN=0
@@ -60,7 +60,7 @@ BED_MESH_CALIBRATE mesh_min={adaptive_bed_mesh_min[0]},{adaptive_bed_mesh_min[1]
### RRF
```gcode
```c++
M557 X{adaptive_bed_mesh_min[0]}:{adaptive_bed_mesh_max[0]} Y{adaptive_bed_mesh_min[1]}:{adaptive_bed_mesh_max[1]} P{bed_mesh_probe_count[0]}:{bed_mesh_probe_count[1]}
```

@@ -22,23 +22,23 @@
--md-footer-bg-color: var(--md-primary-fg-color) !important;
--md-footer-fg-color: #FFFFFF;
--md-code-bg-color: #F2F2F2;
/* --md-code-bg-color: #F2F2F2; */
/* Use single color for codes. otherwise some parts gCodes etc. is hard to read */
--md-code-hl-color: var(--md-code-fg-color);
--md-code-hl-number-color: var(--md-code-fg-color);
--md-code-hl-special-color: var(--md-code-fg-color);
--md-code-hl-function-color: var(--md-code-fg-color);
--md-code-hl-constant-color: var(--md-code-fg-color); /* variables, gcodes */
--md-code-hl-keyword-color: var(--md-code-fg-color);
--md-code-hl-string-color: var(--md-code-fg-color);
--md-code-hl-name-color: var(--md-code-fg-color);
--md-code-hl-color--light: var(--md-default-fg-color--light);
--md-code-hl-operator-color: var(--md-default-fg-color--light);
--md-code-hl-punctuation-color: var(--md-default-fg-color--light);
--md-code-hl-comment-color: var(--md-default-fg-color--light);
--md-code-hl-generic-color: var(--md-default-fg-color--light);
--md-code-hl-variable-color: var(--md-default-fg-color--light);
/* --md-code-hl-color: var(--md-code-fg-color); */
/* --md-code-hl-number-color: var(--md-code-fg-color); */
/* --md-code-hl-special-color: var(--md-code-fg-color); */
/* --md-code-hl-function-color: var(--md-code-fg-color); */
/* --md-code-hl-constant-color: var(--md-code-fg-color); *//* variables, gcodes */
/* --md-code-hl-keyword-color: var(--md-code-fg-color); */
/* --md-code-hl-string-color: var(--md-code-fg-color); */
/* --md-code-hl-name-color: var(--md-code-fg-color); */
/* --md-code-hl-color--light: var(--md-default-fg-color--light); */
/* --md-code-hl-operator-color: var(--md-default-fg-color--light); */
/* --md-code-hl-punctuation-color: var(--md-default-fg-color--light); */
/* --md-code-hl-comment-color: var(--md-default-fg-color--light); */
/* --md-code-hl-generic-color: var(--md-default-fg-color--light); */
/* --md-code-hl-variable-color: var(--md-default-fg-color--light); */
}
[data-md-color-scheme=slate]{
@@ -46,7 +46,7 @@
--md-default-fg-color: #EFEFF0;
--md-primary-fg-color: #00675B;
--md-footer-bg-color--dark: #00000052;
--md-code-bg-color: #36363C;
--md-code-bg-color: #242428;
}
/* /////// HEADER */