diff --git a/README.md b/README.md index 11d27e2441..88d6624d07 100644 --- a/README.md +++ b/README.md @@ -1,235 +1,51 @@ -
+# OrcaSlicer-KX - - OrcaSlicer logo - +**OrcaSlicer builds with extra Anycubic Kobra X patches** -OrcaSlicer%2FOrcaSlicer | Trendshift +Pre-built [OrcaSlicer](https://github.com/SoftFever/OrcaSlicer) binaries that bundle in-progress PRs improving Kobra X support — recommended for use with [KX-Bridge](https://gitea.it-drui.de/viewit/KX-Bridge-Release). -[![GitHub Repo stars](https://img.shields.io/github/stars/OrcaSlicer/OrcaSlicer)](https://github.com/OrcaSlicer/OrcaSlicer/stargazers) [![Build all](https://github.com/OrcaSlicer/OrcaSlicer/actions/workflows/build_all.yml/badge.svg?branch=main)](https://github.com/OrcaSlicer/OrcaSlicer/actions/workflows/build_all.yml) +[![Download](https://img.shields.io/badge/Download-Releases-2EA043?style=for-the-badge&logo=gitea&logoColor=white)](https://gitea.it-drui.de/viewit/OrcaSlicer-KX/releases) -OrcaSlicer: an open source Next-Gen Slicing Software for Precision 3D Prints. -Optimize your prints with ultra-fast slicing, intelligent support generation, and seamless printer compatibility—engineered for perfection. -

+--- -# Official links and community +## Custom Filament Presets & KX-Bridge -#### Official Website: +📄 [How to create, verify and import custom filament presets](https://gitea.it-drui.de/viewit/KX-Bridge-Release/src/branch/master/docs/filament-preset-bridge-guide.md) -OrcaSlicer.com +--- -#### Github Repository: +## Included patches -GitHub Logo +- **[PR #13372](https://github.com/SoftFever/OrcaSlicer/pull/13372)** — Moonraker / Happy-Hare AMS sync fix +- **[PR #13529](https://github.com/SoftFever/OrcaSlicer/pull/13529)** — Anycubic Kobra X printer profiles +- **[PR #13677](https://github.com/SoftFever/OrcaSlicer/pull/13677)** — Kobra X G-code fix +- **[PR #13719](https://github.com/SoftFever/OrcaSlicer/pull/13719)** — Vendor + name matching for Moonraker filament sync +- KX-specific filament-hint patches (unique `filament_id` for user presets, 3-pass matching, sub-brands) -#### Follow us: +--- -X Logo -YouTube Logo +## Download -#### Join our Discord community: +Get the latest binaries from the [Releases page](https://gitea.it-drui.de/viewit/OrcaSlicer-KX/releases): -discord logo +- **Linux:** `OrcaSlicer_Linux_V*.AppImage` — `chmod +x` and run +- **Windows:** `OrcaSlicer-Windows-x64.zip` — extract and run `orca-slicer.exe` - - - - -
-⚠️ CAUTION:
-Several clickbait and malicious websites, such as orca-slicer[.]com and orcaslicer[.]net, are pretending to be the official OrcaSlicer site. These sites may redirect you to dangerous downloads or contain misleading information.
-Our only official website is www.orcaslicer.com.

-If you come across any of these in search results, please report them as unsafe or phishing to help keep the community secure with:
- - Google Safe Browsing
- - Microsoft Security Intelligence
- - IPThreat -
+Checksums in `SHA256SUMS.txt`. macOS is not provided here — build from upstream. -

+> ⚠ This is an **alpha build** (OrcaSlicer 2.4.0-alpha). Use at your own risk. -# Main features +--- -- **[Advanced Calibration Tools](https://www.orcaslicer.com/wiki/calibration_guide)** - Comprehensive suite: temperature towers, flow rate, retraction & more for optimal performance. -- **[Precise Wall](https://www.orcaslicer.com/wiki/quality_settings_precision#precise-wall) and [Seam Control](https://www.orcaslicer.com/wiki/quality_settings_seam)** - Adjust outer wall spacing and apply scarf seams to enhance print accuracy. -- **[Sandwich Mode](https://www.orcaslicer.com/wiki/quality_settings_wall_and_surfaces#innerouterinner) and [Polyholes](https://www.orcaslicer.com/wiki/quality_settings_precision#polyholes) Support** - Use varied infill [patterns](https://www.orcaslicer.com/wiki/strength_settings_patterns) and accurate hole shapes for improved clarity. -- **[Overhang](https://www.orcaslicer.com/wiki/quality_settings_overhangs) and [Support Optimization](https://www.orcaslicer.com/wiki#support-settings)** - Modify geometry for printable overhangs with precise support placement. -- **[Granular Controls and Customization](https://www.orcaslicer.com/wiki#process-settings)** - Fine-tune print speed, layer height, pressure, and temperature with precision. -- **Network Printer Support** - Seamless integration with Klipper, PrusaLink, and OctoPrint for remote control. -- **[Mouse Ear Brims](https://www.orcaslicer.com/wiki/others_settings_brim) & [Adaptive Bed Mesh](https://www.orcaslicer.com/wiki/printer_basic_information_adaptive_bed_mesh)** - Automatic brims and adaptive mesh calibration ensure consistent adhesion. -- **User-Friendly Interface** - Intuitive drag-and-drop design with pre-made profiles for popular printers. -- **[Open-Source](https://github.com/OrcaSlicer/OrcaSlicer) & [Community Driven](https://discord.gg/P4VE9UY9gJ)** - Regular updates fueled by continuous community contributions. -- **Wide Printer Compatibility** - Supports a broad range of printers: Bambu Lab, Prusa, Creality, Voron, and more. -- Additional features can be found in the [change notes](https://github.com/OrcaSlicer/OrcaSlicer/releases/). +## Why a separate repo? -# Wiki +KX-Bridge itself is hosted at [viewit/KX-Bridge-Release](https://gitea.it-drui.de/viewit/KX-Bridge-Release). +OrcaSlicer is a different project under a different license (AGPL-3.0) — kept separate so licenses, source provenance and update cycles do not get tangled. -The [wiki](https://www.orcaslicer.com/wiki) aims to provide a detailed explanation of the slicer settings, including how to maximize their use and how to calibrate and set up your printer. +--- -- **[Access the wiki here](https://www.orcaslicer.com/wiki)** -- **[Contribute to the wiki](https://www.orcaslicer.com/wiki/how_to_wiki)** +## License & source -# Download +These builds are derivatives of [OrcaSlicer](https://github.com/SoftFever/OrcaSlicer), licensed under **GNU AGPL-3.0**. +The KX-specific patches live on branch [`build-alpha-pr-kx-filament-hint`](https://gitea.it-drui.de/viewit/OrcaSlicer-KX/src/branch/build-alpha-pr-kx-filament-hint) of this repository. -## Stable Release - -📥 **[Download the Latest Stable Release](https://github.com/OrcaSlicer/OrcaSlicer/releases/latest)** -Visit our GitHub Releases page for the latest stable version of OrcaSlicer, recommended for most users. - -## Nightly Builds - -🌙 **[Download the Latest Nightly Build](https://github.com/OrcaSlicer/OrcaSlicer/releases/tag/nightly-builds)** -Explore the latest developments in OrcaSlicer with our nightly builds. Feedback on these versions is highly appreciated. - -# How to install - -## Windows - -Download the **Windows Installer exe** for your preferred version from the [releases page](https://github.com/OrcaSlicer/OrcaSlicer/releases). - -- *For convenience there is also a portable build available.* -
- Troubleshooting - - - *If you have troubles to run the build, you might need to install following runtimes:* - - [MicrosoftEdgeWebView2RuntimeInstallerX64](https://github.com/OrcaSlicer/OrcaSlicer/releases/download/v1.0.10-sf2/MicrosoftEdgeWebView2RuntimeInstallerX64.exe) - - [Details of this runtime](https://aka.ms/webview2) - - [Alternative Download Link Hosted by Microsoft](https://go.microsoft.com/fwlink/p/?LinkId=2124703) - - [vcredist2019_x64](https://github.com/OrcaSlicer/OrcaSlicer/releases/download/v1.0.10-sf2/vcredist2019_x64.exe) - - [Alternative Download Link Hosted by Microsoft](https://aka.ms/vs/17/release/vc_redist.x64.exe) - - This file may already be available on your computer if you've installed visual studio. Check the following location: `%VCINSTALLDIR%Redist\MSVC\v142` -
- -Windows Package Manager - -```shell -winget install --id=SoftFever.OrcaSlicer -e -``` - -## Mac - -1. Download the DMG for your computer: `arm64` version for Apple Silicon and `x86_64` for Intel CPU. -2. Drag OrcaSlicer.app to Application folder. -3. *If you want to run a build from a PR, you also need to follow the instructions below:* - -
- Quarantine - - - Option 1 (You only need to do this once. After that the app can be opened normally.): - - Step 1: Hold _cmd_ and right click the app, from the context menu choose **Open**. - - Step 2: A warning window will pop up, click _Open_ - - - Option 2: - Execute this command in terminal: - - ```shell - xattr -dr com.apple.quarantine /Applications/OrcaSlicer.app - ``` - - - Option 3: - - Step 1: open the app, a warning window will pop up - ![mac_cant_open](./SoftFever_doc/mac_cant_open.png) - - Step 2: in `System Settings` -> `Privacy & Security`, click `Open Anyway`: - ![mac_security_setting](./SoftFever_doc/mac_security_setting.png) -
- -## Linux - -### Flathub (Recommended) - -OrcaSlicer is available through FlatHub: - -Download on Flathub - -Install from the command line: - -```shell -flatpak install flathub com.orcaslicer.OrcaSlicer -flatpak run com.orcaslicer.OrcaSlicer -``` - -It can also be installed through graphical software managers (KDE Discover, GNOME Software, etc.) when Flathub is enabled. Search for **OrcaSlicer** in your software center. - -### AppImage - - 1. Download App image from the [releases page](https://github.com/OrcaSlicer/OrcaSlicer/releases). - 2. Double click the downloaded file to run it. - - 3. If you run into trouble executing it, try this command in the terminal: - `chmod +x /path_to_appimage/OrcaSlicer_Linux.AppImage` - -# How to Compile - -All updated build instructions for Windows, macOS, and Linux are now available on the official [OrcaSlicer Wiki - How to build](https://www.orcaslicer.com/wiki/how_to_build) page. - -Please refer to the wiki to ensure you're following the latest and most accurate steps for your platform. - -# Klipper Note - -If you're running Klipper, it's recommended to add the following configuration to your `printer.cfg` file. - -```gcode -# Enable object exclusion -[exclude_object] - -# Enable arcs support -[gcode_arcs] -resolution: 0.1 -``` - -# Supports - -**OrcaSlicer** is an open-source project and I'm deeply grateful to all my sponsors and backers. -Their generous support enables me to purchase filaments and other essential 3D printing materials for the project. -Thank you! :) - -## Sponsors - - - - - - -
- - QIDI - - - - BIGTREE TECH - -
- -## Backers: - -**Ko-fi supporters** ☕: [Backers list](https://github.com/user-attachments/files/16147016/Supporters_638561417699952499.csv) - -## Support me - - - - - -## Some Background - -Open-source slicing has always been built on a tradition of collaboration and attribution. [Slic3r](https://github.com/Slic3r/Slic3r), created by Alessandro Ranellucci and the RepRap community, laid the foundation. [PrusaSlicer](https://github.com/prusa3d/PrusaSlicer) by Prusa Research built on Slic3r and acknowledged that heritage. [Bambu Studio](https://github.com/bambulab/BambuStudio) in turn forked from PrusaSlicer, and [SuperSlicer](https://github.com/supermerill/SuperSlicer) by @supermerill extended PrusaSlicer with community-driven enhancements. Each project carried the work of its predecessors forward, crediting those who came before. - -OrcaSlicer began in that same spirit, drawing from BambuStudio, PrusaSlicer, and ideas inspired by CuraSlicer and SuperSlicer. But it has since grown far beyond its origins. Through relentless innovation — introducing advanced calibration tools, precise wall and seam control, tree supports, adaptive slicing, and hundreds of other features — OrcaSlicer has become the most widely used and actively developed open-source slicer in the 3D printing community. Many of its innovations have been adopted by other slicers, making it a driving force for the entire industry. - -The OrcaSlicer logo was designed by community member [Justin Levine](https://github.com/jal-co). - -# License - -- **OrcaSlicer** is licensed under the GNU Affero General Public License, version 3. -- The **GNU Affero General Public License**, version 3 ensures that if you use any part of this software in any way (even behind a web server), your software must be released under the same license. -- OrcaSlicer includes a **pressure advance calibration pattern test** adapted from Andrew Ellis' generator, which is licensed under GNU General Public License, version 3. Ellis' generator is itself adapted from a generator developed by Sineos for Marlin, which is licensed under GNU General Public License, version 3. -- The **Bambu networking plugin** is based on non-free libraries from BambuLab. It is optional to the OrcaSlicer and provides extended functionalities for Bambulab printer users.