Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Cura 5555 ufp specification #12

Open
wants to merge 6 commits into
base: master/s-line
Choose a base branch
from
Open

Cura 5555 ufp specification #12

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fcbe403
Added simple description of ufp file extension
alekseisasin Aug 24, 2018
058bd9d
Update ufp.md
alekseisasin Aug 24, 2018
539c76b
Merge branch 'master' into CURA-5555_ufp_specification
Aug 24, 2018
f01e8aa
Update ufp.md
alekseisasin Aug 27, 2018
6403723
Update ufp.md
alekseisasin Aug 27, 2018
a01319b
Update UFP specification so that it contains more of the rationale be…
nallath Sep 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/ufp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Ultimaker Format Package (UFP)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall the documentation is very marginal. I'm missing things like:

  • The fact that it is based on the Open Packaging Convention
  • More elaborate goal of the format (combine tool path + preview images + metadata)
  • Backwards compatibility policy
  • Versioning policy
  • Implementation details in the libCharon library
  • The plan to make this the default filetype for all UM printers
  • Why it is different than 3MF (which could also have been an option, but we decided to not add the original 3D file which is a 3MF requirement)
  • The plan to make it forward-compatible with 3MF if we ever decide to add the original 3D model anyways (for example for cloud based re-slicing)
  • What is this Ultimaker G-code flavour?
  • The allowed file type and size for the thumbnail
  • Future support for multiple thumbnails (this was in the original spec iirc)
  • A representative example?
  • Probably some more things...


## Purpose:

The goal of this file type is to provide required data for the 3D printer to perform a print job.

## Structure:

A UFP file contains the following files:</br>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In Markdown you can use the following format for a list:

  • item 1
  • item 2
  • item 3
    • subitem

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not make 1 list with the file path and description per list item?

`\.rels`</br>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why backslashes?

`\Metadata\thumbnail.png`</br>
`\Cura\`</br>
`\3D\model.gcode`</br>
`\[Content_Types].xml`</br>

* The rels and content type files are filled with the required XML data.
* The thumbnail.png is a medium sized rendering of the 3D shape to show during file selection. There can be only one thumbnail.
* The model.gcode describes how a 3D printer should print a job.
* Possible content of Cura folder :
* *.xml.fdm_material – files describe materials specifications which might be needed for a print job.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing the material signature file (which is why this whole thing is needed).


## Notes:

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just use this:

  • item 1
  • item 2

etc.

* For the interchange of files between the Slicer and Printers, currently, ASCII GCODE files are used, in a specific Ultimaker flavor.
* In future development, the content of folder Cura might be changed.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is kind of vague. In documentation you don't want to be vague.