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

Complete documentation for Model format 0.3

Browse source
This commit is contained in:
Epicalert 2021-11-12 19:51:26 +08:00
parent 57ad5cd47a
commit f077ca5b5f
No known key found for this signature in database
GPG key ID: CAA46F858D0979BD
1 changed files with 37 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
docs/model-format.man
View file

@ -65,6 +65,23 @@ Unnecessary files should not be present in the archive, but archives with
unnecessary files are still valid.
.
.
.SH FORMAT VERSION
.PP
.
Every Facecam2D model has a version code in the
.B model.toml
in the format "major.minor".
A given version of Facecam2D can read model files with the same
major version as the version it is compatible with.
For example, if Facecam2D can read the model format up to version 0.3,
the same build of Facecam2D can also read a model written in format 0.2,
but cannot play a model written in format 1.2 or 0.5.
It is only backwards compatible with the same major version.
Higher minor versions of the model format indicate that there are newer
optional features available, but does not break compatibility with formats
of the same major version.
.
.
.SH KEYS
.SS format
.TP
@ -114,6 +131,26 @@ Float: How far the part will move towards the
point.
If negative, the part will move in the opposite direction.
.
.TP
rot_factor, scale_factor
Float: How much the part will rotate/scale.
Default is 1.0.
Higher values result in more exaggerated rotation or scaling.
.
.TP
origin
Float Array: Origin (pivot point) of the model defined in
normalized coordinates.
Default is [0.0, 0.0].
.
.TP
pos_offset, scale_offset
Float Array: Positional offset or scale of a part.
Default is [0.0, 0.0] for
.B pos_offset
and [1.0, 1.0] for
.B scale_offset.
.
.SS textures
.TP
file