Cura Engine

If you're trying to embed Cura Engine into your web application, check out Cura WASM instead (Which uses this package under the hood).

Installation

wapm install cloud-cnc-bot/cura-engine

Note: you'll need to install WAPM first.

Usage

# Print help message
wapm run cura-engine -- help

# Slice Benchy for an Ultimaker 2
git clone https://github.com/ultimaker/cura.git

wget https://github.com/CreativeTools/3DBenchy/raw/master/Single-part/3DBenchy.stl -O benchy.stl

wapm run cura-engine --dir=./cura/resources/definitions --dir=. -- slice -j ./cura/resources/definitions/ultimaker2.def.json -o ./benchy.gcode -l ./data/benchy.stl

Development

Building

Check out the code
Build the Docker container:

docker build . -f docker/build.dockerfile -t cloud-cnc/cura-engine

Run the Docker container:

docker run -it --name cura-engine cloud-cnc/cura-engine

Build Cura Engine:

# This should be run within the container
./build.sh

FAQ

What is this fork for?

This fork contains a version of Cura Engine compatible with and optimized for WASM.

How close is this fork supposed to remain to the source?

Fairly close to reduce the amount of time it takes to support new versions of Cura Engine.

Can I contribute?

Yes, absolutely. If you're looking for something specific to help with, performance improvements are always welcome.

How does this fork work?

Every Saturday at 00:00 UTC, sync.yml will create a pull request to synchronize this fork with it's upstream source and attempt to automatically merge it. On each push, build.yml will build and test this fork. When a new release is created, publish.yml will publish it to WAPM.

License Obligations

Downstream Modifications

You can view downstream modifications by running:

# Add the upstream repository
git remote add upstream https://github.com/ultimaker/curaengine.git

# Pull commits from upstream
git pull upstream master

# Show the differences between the upstream and downstream
git diff upstream/master..origin/main