editing guide
[xonotic/xonotic.wiki.git] / Modeling / Framegroups.md
1 .framegroups File
2 =================
3
4 This file is needed to make md3, dpm, or iqm models play some animations in Xonotic.
5
6 For modelers
7 ------------
8
9 It is named `<modelname.extension>.framegroups`. So if you are editing Ignis, it would be called `ignis.iqm.framegroups`.
10
11 Inside the file, the playermodel’s animations are defined one per line.
12
13 Syntax:
14
15     <start frame> <frame count> <fps> <loop/noloop> // animname
16
17 Ex.
18
19     1 100 30 0 // dieone
20
21 Defines a 100 frame death animation that start at frame 1, plays at 30 frames per second and does not loop.
22
23 Animations must be in this order (these are the values for animname):
24
25 1. `dieone`
26 1. `dietwo`
27 1. `draw` \*
28 1. `duck`
29 1. `duckwalk` \*
30 1. `duckjump`
31 1. `duckidle` \*
32 1. `idle` \*
33 1. `jump`
34 1. `painone`
35 1. `paintwo`
36 1. `shoot` \*
37 1. `taunt` \*
38 1. `run` \*
39 1. `runbackwards` \*
40 1. `strafeleft` \*
41 1. `straferight` \*
42 1. `deadone`
43 1. `deadtwo`
44 1. `forwardright` \*
45 1. `forwardleft` \*
46 1. `backright` \*
47 1. `backleft` \*
48 1. `melee`
49
50 Lines marked with a \* need to loop (last number on the line should be `1`).
51
52 If you make 1 looping animation and place model on map as misc\_gamemodel it will be animated.
53
54 For coders
55 ----------
56
57 To play such a self-playing animation you just use `self.frame=1` to play 1st animation, `self.frame=2` to play 2nd animation, etc.
58 If the animation does not loop, it will just stop at the last frame and stay there until you run another animation.
59