From bd69bfea16e4dc0b0e8979b1a64445c48cc6b828 Mon Sep 17 00:00:00 2001 From: Epicalert Date: Mon, 1 Mar 2021 00:56:30 +0800 Subject: [PATCH] Add description section --- docs/model-format.man | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 docs/model-format.man diff --git a/docs/model-format.man b/docs/model-format.man new file mode 100644 index 0000000..3f1cd3d --- /dev/null +++ b/docs/model-format.man @@ -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.