mirror of
https://github.com/OrcaSlicer/OrcaSlicer_WIKI.git
synced 2026-05-17 00:25:45 +03:00
Formating rules and Full update (#107)
* Add editor and markdown configuration files Introduces .editorconfig, .markdownlint.json, and VS Code settings for consistent formatting and markdown linting. These files help standardize code style and markdown indentation across the project. * Full reformat
This commit is contained in:
12
.editorconfig
Normal file
12
.editorconfig
Normal file
@@ -0,0 +1,12 @@
|
||||
root = true
|
||||
|
||||
[*]
|
||||
charset = utf-8
|
||||
end_of_line = lf
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
[*.md]
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
trim_trailing_whitespace = false
|
||||
7
.markdownlint.json
Normal file
7
.markdownlint.json
Normal file
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"MD007": {
|
||||
"indent": 4
|
||||
},
|
||||
"MD013": false,
|
||||
"MD033": false
|
||||
}
|
||||
7
.vscode/settings.json
vendored
Normal file
7
.vscode/settings.json
vendored
Normal file
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"[markdown]": {
|
||||
"editor.detectIndentation": false,
|
||||
"editor.insertSpaces": true,
|
||||
"editor.tabSize": 4
|
||||
}
|
||||
}
|
||||
15
README.md
15
README.md
@@ -18,17 +18,22 @@ We appreciate your patience as we continue to develop and improve it!
|
||||
|
||||
## Official links and community
|
||||
|
||||
#### Official Website:
|
||||
#### Official Website
|
||||
|
||||
<a href="https://www.orcaslicer.com/" style="font-size:2em;">OrcaSlicer.com</a>
|
||||
|
||||
#### OrcaSlicer Repository:
|
||||
#### OrcaSlicer Repository
|
||||
|
||||
<a href="https://github.com/OrcaSlicer/OrcaSlicer"><img src="https://img.shields.io/badge/OrcaSlicer-181717?style=flat&logo=github&logoColor=white" width="200" alt="GitHub Logo"/> </a>
|
||||
|
||||
#### Wiki Repository:
|
||||
#### Wiki Repository
|
||||
|
||||
<a href="https://github.com/OrcaSlicer/OrcaSlicer_WIKI"><img src="https://img.shields.io/badge/OrcaSlicer_Wiki-181717?style=flat&logo=github&logoColor=white" width="200" alt="GitHub Logo"/> </a>
|
||||
|
||||
#### Follow us:
|
||||
#### Follow us
|
||||
|
||||
<a href="https://twitter.com/real_OrcaSlicer"><img src="https://img.shields.io/badge/real__OrcaSlicer-000000?style=flat&logo=x&logoColor=white" width="200" alt="X Logo"/> </a>
|
||||
|
||||
#### Join our Discord community:
|
||||
#### Join our Discord community
|
||||
|
||||
<a href="https://discord.gg/P4VE9UY9gJ"><img src="https://img.shields.io/badge/-Discord-5865F2?style=flat&logo=discord&logoColor=fff" width="200" alt="discord logo"/> </a>
|
||||
|
||||
@@ -83,40 +83,55 @@ Every firmware and even its version may have a different default type but usuall
|
||||
- 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
|
||||
```
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
- Marlin:
|
||||
- Skeleton
|
||||
|
||||
```gcode
|
||||
M593 X F#Xfrequency D#XDamping
|
||||
M593 Y F#Yfrequency D#YDamping
|
||||
M500
|
||||
```
|
||||
|
||||
Example
|
||||
|
||||
```gcode
|
||||
M593 X F37.25 D0.16
|
||||
M593 Y F37.5 D0.06
|
||||
M500
|
||||
```
|
||||
|
||||
- RepRap:
|
||||
- Skeleton for RepRap 3.3 and later
|
||||
|
||||
```gcode
|
||||
M593 P#Type F#frequency S#Damping
|
||||
```
|
||||
|
||||
Example RepRap 3.4 and later
|
||||
|
||||
```gcode
|
||||
M593 P"ZVD" F37.25 S0.16
|
||||
```
|
||||
|
||||
- Skeleton for RepRap 3.2 and earlier
|
||||
|
||||
```gcode
|
||||
M593 F#frequency
|
||||
```
|
||||
|
||||
Example Legacy (RepRap 3.2 and earlier)
|
||||
|
||||
```gcode
|
||||
M593 F37.25
|
||||
```
|
||||
|
||||
@@ -34,22 +34,31 @@ How to building with Visual Studio on Windows 64-bit.
|
||||
### Windows Tools Required
|
||||
|
||||
- [Visual Studio](https://visualstudio.microsoft.com/vs/) 2026, 2022 or Visual Studio 2019
|
||||
|
||||
```shell
|
||||
winget install --id=Microsoft.VisualStudio.Community -e
|
||||
```
|
||||
|
||||
- [CMake](https://cmake.org/)
|
||||
|
||||
```shell
|
||||
winget install --id=Kitware.CMake -e
|
||||
```
|
||||
|
||||
- [Strawberry Perl](https://strawberryperl.com/)
|
||||
|
||||
```shell
|
||||
winget install --id=StrawberryPerl.StrawberryPerl -e
|
||||
```
|
||||
|
||||
- [Git](https://git-scm.com/)
|
||||
|
||||
```shell
|
||||
winget install --id=Git.Git -e
|
||||
```
|
||||
|
||||
- [git-lfs](https://git-lfs.com/)
|
||||
|
||||
```shell
|
||||
winget install --id=GitHub.GitLFS -e
|
||||
```
|
||||
@@ -82,6 +91,7 @@ How to building with Visual Studio on Windows 64-bit.
|
||||
- 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
|
||||
```
|
||||
@@ -90,20 +100,27 @@ How to building with Visual Studio on Windows 64-bit.
|
||||
```shell
|
||||
git lfs pull
|
||||
```
|
||||
|
||||
2. Open the appropriate command prompt:
|
||||
|
||||
```MD
|
||||
x64 Native Tools Command Prompt for VS
|
||||
```
|
||||
|
||||
1. Navigate to correct drive (if needed), e.g.:
|
||||
|
||||
```shell
|
||||
N:
|
||||
```
|
||||
|
||||
2. Change directory to the cloned repository, e.g.:
|
||||
|
||||
```shell
|
||||
cd N:\Repos\OrcaSlicer
|
||||
```
|
||||
|
||||
3. Run the build script:
|
||||
|
||||
```shell
|
||||
build_release_vs.bat
|
||||
```
|
||||
@@ -120,6 +137,7 @@ How to building with Visual Studio on Windows 64-bit.
|
||||
```shell
|
||||
build\OrcaSlicer.slnx
|
||||
```
|
||||
|
||||
4. Open the solution in Visual Studio, set the build configuration to `Release` and run the `Local Windows Debugger`.
|
||||

|
||||
5. Your resulting executable will be located in:
|
||||
@@ -140,9 +158,11 @@ How to building with Visual Studio on Windows 64-bit.
|
||||
> If the "Fix model" option is missing from an object's context menu, it may indicate that your build did not properly include the Windows SDK. To quickly resolve this, follow these steps:
|
||||
>
|
||||
> 1. Locate the `winrt` folder in your Windows SDK installation. For example:
|
||||
>
|
||||
> ```shell
|
||||
> C:\Program Files (x86)\Windows Kits\10\Include\10.0.26100.0\winrt
|
||||
> ```
|
||||
>
|
||||
> _(Note: the exact path may vary depending on your Windows SDK version.)_
|
||||
> 2. In Visual Studio 2022, open the **libslic3r_gui** project properties:
|
||||
> Go to **Configuration Properties > C/C++ > Preprocessor > Preprocessor Definitions**
|
||||
@@ -198,15 +218,20 @@ cmake --version
|
||||
### MacOS Instructions
|
||||
|
||||
1. Clone the repository:
|
||||
|
||||
```shell
|
||||
git clone https://github.com/OrcaSlicer/OrcaSlicer
|
||||
cd OrcaSlicer
|
||||
```
|
||||
|
||||
2. Build the application:
|
||||
|
||||
```shell
|
||||
./build_release_macos.sh
|
||||
```
|
||||
|
||||
3. Open the application:
|
||||
|
||||
```shell
|
||||
open build/arm64/OrcaSlicer/OrcaSlicer.app
|
||||
```
|
||||
@@ -216,9 +241,11 @@ cmake --version
|
||||
To build and debug directly in Xcode:
|
||||
|
||||
1. Open the Xcode project:
|
||||
|
||||
```shell
|
||||
open build/arm64/OrcaSlicer.xcodeproj
|
||||
```
|
||||
|
||||
2. In the menu bar:
|
||||
- **Product > Scheme > OrcaSlicer**
|
||||
- **Product > Scheme > Edit Scheme...**
|
||||
@@ -333,6 +360,7 @@ The build system supports multiple Linux distributions including Ubuntu/Debian a
|
||||
```
|
||||
|
||||
5. **All-in-one build (recommended):**
|
||||
|
||||
```shell
|
||||
./build_linux.sh -dsti
|
||||
```
|
||||
|
||||
@@ -47,8 +47,7 @@ If you add new file resource, add it to the list of files containing macro `L()`
|
||||
|
||||
### Scenario 4. How do I use GNUgettext to localize my own application taking OrcaSlicer as an example
|
||||
|
||||
1. For convenience create a list of files with this macro `L(s)`. We have
|
||||
https://github.com/OrcaSlicer/OrcaSlicer/blob/master/localization/i18n/list.txt.
|
||||
1. For convenience create a list of files with this macro `L(s)`. We have [localization/i18n/list.txt](https://github.com/OrcaSlicer/OrcaSlicer/blob/main/localization/i18n/list.txt).
|
||||
|
||||
2. Create template file(*.POT) with GNUgettext command:
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ If you don't see this when opening a STEP file, check [Don't show again](#dont-s
|
||||
|
||||

|
||||
|
||||
### Parameters:
|
||||
### Parameters
|
||||
|
||||
The transformation uses [Linear Deflection and Angular Deflection](https://dev.opencascade.org/doc/overview/html/occt_user_guides__mesh.html) parameters to control the mesh quality.
|
||||
A finer mesh will result in a more accurate representation of the original surface, but it will also increase the file size and processing time.
|
||||
|
||||
@@ -98,10 +98,13 @@ To mitigate this effect, OrcaSlicer allows you to specify a negative distance th
|
||||
|
||||
The compensation works as follows:
|
||||
When the `current_layer` is <= `input_compensation_layers`
|
||||
|
||||
```c++
|
||||
compensation = input_compensation_distance - (input_compensation_distance / input_compensation_layers) × (current_layer - 1)
|
||||
```
|
||||
|
||||
According to the equation, we can establish the following rules:
|
||||
|
||||
- In the 1st layer, since it is layer `1 - 1 = 0`, compensation is 100%.
|
||||
- The intermediate layers (between the first and input_compensation_layers) will have linear compensation.
|
||||
- Layers above the specified amount will not be compensated.
|
||||
|
||||
@@ -4,7 +4,6 @@
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Every speed setting is limited by several parameters like:
|
||||
>
|
||||
> - [Maximum Volumetric Speed](volumetric-speed-calib)
|
||||
> - Machine / Motion ability
|
||||
> - [Acceleration](speed_settings_acceleration)
|
||||
|
||||
@@ -178,11 +178,11 @@ OrcaSlicer tries to connect two close infill lines to a short perimeter segment.
|
||||
- **Anchor On**
|
||||
|
||||

|
||||
|
||||
## Internal Solid Infill
|
||||
|
||||
Line pattern of internal solid infill. If the [detect narrow internal solid infill](strength_settings_advanced#detect-narrow-internal-solid-infill) be enabled, the [concentric pattern](strength_settings_patterns#concentric) will be used for the small area.
|
||||
|
||||
|
||||
## Extra Solid Infill
|
||||
|
||||
Insert extra solid infills at specific layers to add strength at critical points in your print. This feature allows you to strategically reinforce your part without changing the overall sparse infill density.
|
||||
@@ -192,11 +192,13 @@ Insert extra solid infills at specific layers to add strength at critical points
|
||||
The pattern supports two formats:
|
||||
|
||||
### Interval Pattern
|
||||
|
||||
- **Simple interval**: `N` - Insert 1 solid layer every N layers, equal to `N#1`
|
||||
- **Multiple layers**: `N#K` - Insert K consecutive solid layers every N layers
|
||||
- **Optional K**: `N#` - Shorthand for `N#1`
|
||||
|
||||
Examples:
|
||||
|
||||
```
|
||||
5 or 5#1 # Insert 1 solid layer every 5 layers
|
||||
5# # Same as 5#1
|
||||
@@ -204,6 +206,7 @@ Examples:
|
||||
```
|
||||
|
||||
### Explicit Layer List
|
||||
|
||||
Specify exact layer numbers (1-based) using comma-separated values. Each entry may be a single layer `N` or a range `N#K` to insert K consecutive solid layers starting at layer N:
|
||||
|
||||
```
|
||||
|
||||
@@ -203,7 +203,7 @@ When using this fill, you can individually modify the density of the skeleton an
|
||||
- **Horizontal (X-Y):** Normal-Low 
|
||||
- **Vertical (Z):** Normal-Low 
|
||||
- **Density Calculation:** Similar to [Zig Zag](#zig-zag).
|
||||
Skin density * ( Infill Area - Skin Area + lock depth area) + ( Skin density * Skin area).
|
||||
Skin density *( Infill Area - Skin Area + lock depth area) + ( Skin density* Skin area).
|
||||
- **Material Usage:** Normal-High 
|
||||
- **Print Time:** Normal-High 
|
||||
- **Material/Time (Higher better):** Normal 
|
||||
|
||||
@@ -208,10 +208,13 @@ If your Filament's [Activate temperature control](material_temperatures#print-ch
|
||||
You can use chamber temperature variables in your `Machine G-code` to control the chamber temperature manually, if desired:
|
||||
|
||||
- To set the chamber temperature to the value specified for the first filament:
|
||||
|
||||
```gcode
|
||||
M191 S{chamber_temperature[0]}
|
||||
```
|
||||
|
||||
- To set the chamber temperature to the highest value specified across all filaments:
|
||||
|
||||
```gcode
|
||||
M191 S{overall_chamber_temperature}
|
||||
```
|
||||
|
||||
@@ -100,6 +100,7 @@ This G-code is inserted when the extrusion role is changed.
|
||||
Example G-codes:
|
||||
|
||||
- Marlin g-code to set fan speed to 10% (S25 out of S255) for BridgeInfill role and 30% (S75 out of S255) for other roles:
|
||||
|
||||
```c++
|
||||
{if( extrusion_role == "BridgeInfill")}
|
||||
M106 S25
|
||||
@@ -109,6 +110,7 @@ Example G-codes:
|
||||
```
|
||||
|
||||
- Marlin G-code to set the fan speed to 0% for the ['Internal Sparse Infill' role](strength_settings_infill) and the first three layers, and to 30% `0.3*255` for the other roles. This achieves good layer adhesion while maintaining perimeter quality.:
|
||||
|
||||
```c++
|
||||
{if(extrusion_role)=="InternalInfill" || layer_num < 4 }
|
||||
M106 S0
|
||||
@@ -118,6 +120,7 @@ Example G-codes:
|
||||
```
|
||||
|
||||
- Marlin g-code to set pressure advance to 0 for ['Internal Sparse Infill' role](strength_settings_infill) and restore it to previous value for other roles:
|
||||
|
||||
```c++
|
||||
{if( extrusion_role == "InternalInfill")}
|
||||
M900 K0
|
||||
|
||||
Reference in New Issue
Block a user