mirror of
https://github.com/SoftFever/OrcaSlicer.git
synced 2025-07-20 13:17:54 -06:00
3900042280
Some checks failed
Publish docs to Wiki / Publish docs to Wiki (push) Has been cancelled
* chore: update how to build doc * chore: add how to validate profiles doc * remove old build info from readme.md * fix: typo * fix: typo * chore: minor fix * fix: typo * chore: minor fix * chore: minor fix * chore: remove lfs * fix: note 2 procedure for repair build * fix: update CMake installation instructions for macOS to specify version 3.31.x * fix: clarify CMake installation instructions for macOS and remove outdated commands * fix: enhance documentation for profile structure and templates in OrcaSlicer * fix: update profile validation documentation and remove obsolete guide * chore: update path for building on mac
140 lines
3.9 KiB
Markdown
140 lines
3.9 KiB
Markdown
# How to Compile
|
|
|
|
## Windows 64-bit
|
|
|
|
### Tools Required
|
|
- [Visual Studio 2022](https://visualstudio.microsoft.com/vs/) or Visual Studio 2019
|
|
- [CMake (version 3.31)](https://cmake.org/) — **⚠️ version 3.31.x is mandatory**
|
|
- [Strawberry Perl](https://strawberryperl.com/)
|
|
- [Git](https://git-scm.com/)
|
|
|
|
### Instructions
|
|
1. Clone the repository:
|
|
```sh
|
|
git clone https://github.com/SoftFever/OrcaSlicer
|
|
```
|
|
2. Open the appropriate command prompt:
|
|
- For Visual Studio 2019:
|
|
Open **x64 Native Tools Command Prompt for VS 2019** and run:
|
|
```sh
|
|
build_release.bat
|
|
```
|
|
- For Visual Studio 2022:
|
|
Open **x64 Native Tools Command Prompt for VS 2022** and run:
|
|
```sh
|
|
build_release_vs2022.bat
|
|
```
|
|
|
|
**⚠️ Note 1:** 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 2:** ⚠️ 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
|
|
|
|
You can install most dependencies via Homebrew:
|
|
```sh
|
|
brew install git 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/](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`):
|
|
```sh
|
|
export PATH="/Applications/CMake.app/Contents/bin:$PATH"
|
|
```
|
|
4. Restart the terminal and check the version:
|
|
```sh
|
|
cmake --version
|
|
```
|
|
5. Make sure it reports a **3.31.x** version.
|
|
|
|
|
|
**⚠️ Note 1:** 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:
|
|
```sh
|
|
git clone https://github.com/SoftFever/OrcaSlicer
|
|
cd OrcaSlicer
|
|
```
|
|
2. Build the application:
|
|
```sh
|
|
./build_release_macos.sh
|
|
```
|
|
3. Open the application:
|
|
```sh
|
|
open build/arm64/OrcaSlicer/OrcaSlicer.app
|
|
```
|
|
|
|
### Debugging in Xcode
|
|
To build and debug directly in Xcode:
|
|
|
|
1. Open the Xcode project:
|
|
```sh
|
|
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
|
|
```sh
|
|
git clone https://github.com/SoftFever/OrcaSlicer
|
|
cd OrcaSlicer
|
|
./DockerBuild.sh
|
|
./DockerRun.sh
|
|
```
|
|
|
|
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
|
|
- libosmesa6-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
|
|
```sh
|
|
sudo ./BuildLinux.sh -u # Install dependencies
|
|
./BuildLinux.sh -dsi # Build OrcaSlicer
|
|
```
|