epicalert/facecam2d
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Add description section

Browse source
This commit is contained in:
Epicalert 2021-03-01 00:56:30 +08:00
parent 941c2043cd
commit bd69bfea16
No known key found for this signature in database
GPG key ID: CAA46F858D0979BD
1 changed files with 33 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
docs/model-format.man Normal file
View file

@ -0,0 +1,33 @@
.TH FC2D_MODEL 5 "Facecam2D Model Format 0.3 Manual"
.
.SH NAME
fc2d_model \- Facecam2D model file format
.
.
.SH DESCRIPTION
Facecam2D uses
.B zip
archive files using the
.I .fma (Facecam2D model archive)
file extension, to store models.
.
These zip files contain a mandatory
.I toml
file called
.B model.toml,
which describes the model and its parts.
.
This file is called the
.B model descriptor.
.
Any model file that does not contain
.B model.toml
in the root of the archive is invalid.
.
.PP
.
In addition to the model descriptor, the model archive can contain other
files (e.g. textures) that can be anywhere in the archive, including the root.
.
Unnecessary files should not be present in the archive, but archives with
unnecessary files are still valid.