3D-printing/OrcaSlicer
1
0
Fork 0
mirror of https://github.com/SoftFever/OrcaSlicer.git synced 2025-06-26 09:25:26 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
OrcaSlicer/doc/developer-reference/How-to-build.md
Ian Bassi 4ec16fd714
Some checks are pending
Build all / Build All (push) Waiting to run
Details
Build all / Flatpak (push) Waiting to run
Details
Publish docs to Wiki / Publish docs to Wiki (push) Waiting to run
Details
Wiki Update part 5 (#9873) 
* BASE

* precise wall and z moved

* PolyHoles

* Arc-fitting

* X-Y Compensation

* Elephant foot + moved images

* Update quality_settings_precision.md

* Wall generator and more

* Full Reorder

* TPMS-D bases

* Update strength_settings_infill.md

* Image Fix + Infill desc calculator

* Descriptions + image fix

Co-Authored-By: Rodrigo <162915171+RF47@users.noreply.github.com>

* Update cornering-calib.md

* minor fixes

* Wip updated

* Missing fills

* Update infill_desc_calculator.xlsx

* Update infill_desc_calculator.xlsx

* Update infill documentation and images

Removed outdated 'iso' infill images and updated 'top' infill images with new versions. Added new images for adaptive cubic and 2D honeycomb infill patterns. Updated strength_settings_infill.md to revise infill strength values, descriptions, and remove references to deleted images. Introduced documentation for 2D honeycomb infill and made minor corrections and clarifications throughout.

* Revise infill pattern documentation and add comparison table

Updated strength_settings_infill.md to clarify infill density calculation, add a comprehensive comparison table of infill patterns, and standardize terminology for strength and print time. Expanded pattern descriptions to use qualitative strength ratings instead of numeric values. Updated infill_desc_calculator.xlsx to reflect these changes.

* Indentation in  code examples

Adjusted the indentation of code blocks in the cornering calibration documentation for clarity and consistency with the rest of the document.

* Update 3D Honeycomb infill strength ratings

Adjusted the horizontal strength rating for 3D Honeycomb infill from 'Normal' to 'Normal-High' in the strength settings documentation and table. Updated the infill_desc_calculator.xlsx file to reflect these changes.

* Formatting and fix in ERS documentation

Updated headings to use consistent Markdown syntax, improved clarity in explanations, and reworded references for better readability.

* Fix wall generator doc link and filename

Updated the Home.md to reference the correct 'quality_settings_wall_generator' section and renamed the corresponding documentation file for consistency.

---------

Co-authored-by: Rodrigo <162915171+RF47@users.noreply.github.com>
2025-06-20 10:19:48 +08:00

4.9 KiB
Raw Blame History

How to Build

Windows 64-bit

This guide is for building your Visual Studio 2022 solution for OrcaSlicer on Windows 64-bit.

Tools Required

  • Visual Studio 2022 or Visual Studio 2019 
    winget install --id=Microsoft.VisualStudio.2022.Professional -e
  • CMake (version 3.31) — ⚠️ version 3.31.x is mandatory 
    winget install --id=Kitware.CMake -v "3.31.6" -e
  • Strawberry Perl 
    winget install --id=StrawberryPerl.StrawberryPerl -e
  • Git 
    winget install --id=Git.Git -e
  • git-lfs 
    winget install --id=GitHub.GitLFS -e

Tip

GitHub Desktop (optional): A GUI for Git and Git LFS, which already includes both tools.

winget install --id=GitHub.GitHubDesktop -e

Instructions

  1. Clone the repository:
    • If using GitHub Desktop clone the repository from the GUI.
    • If using the command line:
      1. Clone the repository:
      git clone https://github.com/SoftFever/OrcaSlicer
      1. Run lfs to download tools on Windows:
      git lfs pull
  2. Open the appropriate command prompt:
    • For Visual Studio 2019:
      Open x64 Native Tools Command Prompt for VS 2019 and run: 
      build_release.bat
    • For Visual Studio 2022:
      Open x64 Native Tools Command Prompt for VS 2022 and run: 
      build_release_vs2022.bat

Note

If you encounter issues, you can try to uninstall ZLIB from your Vcpkg library.

  1. If successful, you will find the VS 2022 solution file in: 
    build\OrcaSlicer.sln

Important

Make sure that CMake version 3.31.x is actually being used. Run cmake --version and verify it returns a 3.31.x version. If you see an older version (e.g. 3.29), it's likely due to another copy in your system's PATH (e.g. from Strawberry Perl). You can run where cmake to check the active paths and rearrange your System Environment Variables > PATH, ensuring the correct CMake (e.g. C:\Program Files\CMake\bin) appears before others like C:\Strawberry\c\bin.

Note

If the build fails, try deleting the build/ and deps/build/ directories to clear any cached build data. Rebuilding after a clean-up is usually sufficient to resolve most issues.

macOS 64-bit

Tools Required

  • Xcode
  • CMake (version 3.31.x is mandatory)
  • Git
  • gettext
  • libtool
  • automake
  • autoconf
  • texinfo

Tip

You can install most of them by running:

brew install gettext libtool automake autoconf texinfo

Homebrew currently only offers the latest version of CMake (e.g. 4.X), which is not compatible. To install the required version 3.31.X, follow these steps:

  1. Download CMake 3.31.7 from: https://cmake.org/download/
  2. Install the application (drag it to /Applications).
  3. Add the following line to your shell configuration file (~/.zshrc or ~/.bash_profile):
export PATH="/Applications/CMake.app/Contents/bin:$PATH"
  1. Restart the terminal and check the version:
cmake --version
  1. Make sure it reports a 3.31.x version.

Important

If you've recently upgraded Xcode, be sure to open Xcode at least once and install the required macOS build support.

Instructions

  1. Clone the repository: 
    git clone https://github.com/SoftFever/OrcaSlicer
cd OrcaSlicer
  2. Build the application: 
    ./build_release_macos.sh
  3. Open the application: 
    open build/arm64/OrcaSlicer/OrcaSlicer.app

Debugging in Xcode

To build and debug directly in Xcode:

  1. Open the Xcode project: 
    open build/arm64/OrcaSlicer.xcodeproj
  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

Linux

Using Docker (Recommended)

Dependencies

  • Docker
  • Git

Instructions

git clone https://github.com/SoftFever/OrcaSlicer && cd OrcaSlicer && ./DockerBuild.sh && ./DockerRun.sh

Note

To troubleshoot common Docker-related errors, refer to the comments in

DockerRun.sh

Ubuntu

Dependencies

All required dependencies will be installed automatically by the provided shell script, including:

  • libmspack-dev
  • libgstreamerd-3-dev
  • libsecret-1-dev
  • libwebkit2gtk-4.0-dev
  • libssl-dev
  • libcurl4-openssl-dev
  • eglexternalplatform-dev
  • libudev-dev
  • libdbus-1-dev
  • extra-cmake-modules
  • libgtk2.0-dev
  • libglew-dev
  • cmake
  • git
  • texinfo

Instructions

`./build_linux.sh -u`      # install dependencies
`./build_linux.sh -disr`    # build OrcaSlicer