User guide
Projects
A project is a repository with a printdeck.yml file at its root. The file lists the parts to print. Each part has its model files, a count, a printer, a Cura profile, a material, and Cura settings. printdeck uses the same file for its builds from GitHub.
Open a project
The web app and the desktop app both open projects. Open the Project tab in the panel, then do one of these:
- Type
owner/repo, or the address of a repository on github.com, and click Open. An address with/tree/<branch>opens that branch. The repository must be public. - Click Open a folder…, and choose the folder of the repository on your computer.
The tab shows the plates of the project, and its parts. The app reads only the files that a plate needs, when you open the plate: the model files of its parts, and the files of profiles/<folder>/.
The parts
Each part has a check box and a count. The count is the number of copies of each file of the part. Clear the check box to leave the part out. The plates change at once.
The plates
zslice puts the chosen parts on plates:
- The parts with the same printer, profile, material, and plate settings share a plate. A plate setting is a setting that zslice keeps for the whole plate, for example the support or the brim. The infill, the walls, and the seam can differ from part to part on one plate.
- A part with
alone: truegets a plate of its own. - A part with variants (for example a fine and a fast quality) is one part for each variant.
Click Open on a plate. zslice then does these steps:
- It reads the Cura profile stack of the plate from
profiles/<folder>/(itscura.json), with the profile and the material of the parts. - It sets the plate settings of the parts.
- It puts the copies of the files on the bed, each part with its own settings, and arranges them.
- It slices the plate.
Then export the G-code, or send it to your printer. If you have a printer with the name of the printer of the plate (for example taz), zslice chooses it for the print. The case of the letters does not matter.
The machine settings of the plate come from the Cura stack of the project. They do not change your printer: while the plate is on the view, zslice does not save a change of a machine setting in the profile of your printer. Choose a printer, or open a model file, to go back to the settings of your printer.
A plate that has no Cura stack is a resin plate. zslice does not slice resin plates yet.
The status of a plate
Each plate has a status: To print, Printing, Printed, or Failed. Set it with the list on the plate. A print that you send to the printer from the plate sets Printing. The tab counts the printed plates.
The project, the counts, the status, and the open plate stay after a reload or a restart:
- The web app keeps them in your browser. A GitHub project gets its files again from GitHub. A folder must be opened again, because the browser forgets the files of a folder.
- The desktop app keeps them in
~/.config/zslice/project.json. A GitHub project gets its list of files again from GitHub, at the same commit. The app opens a folder again from its path.
Close removes the project and the status of its plates.
printdeck.yml
project: robot
parts:
- name: Feet
group: Legs
files: [models/foot.stl]
count: 4
printer: taz
profile: taz-workhorse-se/pla-0.20-standard # profiles/<folder>/ and a profile of its cura.json
material: roll-4 # a material of that cura.json
settings: {support_enable: false, adhesion_type: brim, brim_line_count: 10}
- name: Tower
files: [models/tower.stl]
printer: taz
profile: taz-workhorse-se/pla-0.20-standard
material: roll-4
alone: true
variants:
- name: fine
profile: taz-workhorse-se/pla-0.10-fine
- name: fast
settings: {infill_sparse_density: 10}
The settings use the names of Cura. zslice converts them with the map of its Cura import. A setting that zslice cannot use stops the load of the plate, with the reason.
Privacy
To open a GitHub project, the app reads the repository from api.github.com and raw.githubusercontent.com (and media.githubusercontent.com for a file in Git LFS). It sends no login and no data of yours. The web app and the desktop app make the same requests. See Privacy.