Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Eisenwave authored Mar 1, 2021
1 parent 6f5d2a4 commit fe53449
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,17 +106,21 @@ Supersampling will usually produce slightly more voxels.

## Supported Formats

- **Wavefront OBJ** (Read)
- **STL (Stereolithography)** (Read)
- **QEF** (Write)
- **VL32** (Write)
- **PLY** (Write)
- **VOX (Magica)** (Write, Experimental)
- **XYZRGB** (Write)

**Warning:** VOX support is still experimental; writing the file in the end can take a long time because building a 255-color palette is somewhat inefficient.
| Name | Extension | Purpose |
| ----------------------- | --------- | ---------- |
| Wavefront OBJ | `obj` | Input |
| Stereolithography | `stl` | Input |
| Stanford Triangle | `ply` | Output |
| Qubicle Exchange Format | `qef` | Output |
| Magica Voxel | `vox` | Output\* |
| VL32 | `vl32` | Output |
| XYZRGB | `xyzrgb` | Output\*\* |

**\*Warning:** VOX support is still experimental; writing the file in the end can take a long time because building a 255-color palette is somewhat inefficient.
Use of streamable formats like VL32 is highly recommended, only use VOX for lower resolutions.

**\*\*Note**: XYZRGB's official extension is `xyzrgb` but the software [*FileToVox*](https://github.com/Zarbuz/FileToVox) uses the extension `xyz` instead. Rename the files before importing into *FileToVox*.

### PLY

The exported PLY files are point clouds consisting of vertices with integer coordinates:
Expand Down

0 comments on commit fe53449

Please sign in to comment.