Skip to content

Commit 7210d4f

Browse files
authored
Merge pull request #5 from Parallel-7/feature/update-readme-parser-info
Update README with Parser Details
2 parents e718970 + 4fa401c commit 7210d4f

1 file changed

Lines changed: 9 additions & 5 deletions

File tree

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,15 @@ For more specific use cases, you can use the individual parsers directly. This c
5959

6060
The following parsers are available:
6161

62-
- `GCodeParser`
63-
- `FlashPrintParser`
64-
- `OrcaFlashForgeParser`
65-
- `GXParser`
66-
- `ThreeMfParser`
62+
- **`GCodeParser`**: A universal parser for G-code files. It automatically detects the slicer (`FlashPrint`, `Orca-FlashForge`, or `Legacy GX`) based on the file's header and delegates to the appropriate specialized parser. This is the recommended parser for most G-code files.
63+
64+
- **`FlashPrintParser`**: Parses G-code files generated by the **FlashPrint** slicer. It extracts basic metadata like printer model and filament type from the file's comments.
65+
66+
- **`OrcaFlashForgeParser`**: Specifically designed for G-code files from **Orca Slicer** (particularly the FlashForge version). It handles the detailed block-based metadata format, extracting information on filament usage, print time estimates, and Base64 encoded thumbnails.
67+
68+
- **`GXParser`**: Handles `.gx` files, which are a binary format used by older FlashForge printers. It can extract the embedded thumbnail and parse G-code comments to determine printer model, filament type, and other metadata. It supports both native `.gx` files from FlashPrint and `.gx` files that were converted from standard G-code.
69+
70+
- **`ThreeMfParser`**: Parses `.3mf` files, which are ZIP archives containing model, metadata, and G-code information. This parser is optimized for `.3mf` files created by **Orca Slicer** (FlashForge version). It extracts a rich set of data, including printer settings, detailed filament information (type, color, usage), model filenames, and the plate thumbnail image. It also internally uses the `GCodeParser` to analyze the embedded G-code for additional details.
6771

6872
### Example
6973

0 commit comments

Comments
 (0)