Editing FTEQW Model Viewer Documentation

== The FTE Model Viewer ==
There is an in-engine model viewer, it can display any type of model that's supported. This is useful for modellers and animators for debugging purposes. For a list of all possible model formats, see [[FTEQW File Formats]]<br /><br />

== Displaying a model ==
If FTEQW is windowed, you can drag and drop a file onto the program window to display it. You can also do it with a console command:<br />
<code>MODELVIEWER PROGS/FILENAME.EXT</code><br /><br />

== Hud Info ==
<span style="color: red; font-weight: bold;">
Bug: The 'm' key sets one of 7 modes, but the mode you're currently in isn't displayed on the HUD.<br />
</span><br />
<code>Surf 0: surfName</code><br />
The selected surface. A polygon object in the model is known as a surface.<br />

<code>Skin0: "", Material "materialName"</code><br />
The selected skin texture. This will be the name of the material that was assigned to the object in your 3d editor. FTE will look for this skin in the same folder that your model is in. If you want it in a different folder, then the material should be named with a path like this:<br/>
<strong>models/textures/materialName</strong><br/>

<span style="color: red; font-weight: bold;">
Note: some 3d apps won't allow you to put a '/' in the name of your material. You can rename it in a text editor after exporting as an ASCII file format. The FTE IQM-TOOL also has a rename command which can be used for this.
</span><br /><br />

<code>frame0: animName (n poses, n of n secs, Looped/Unlooped)</code><br/>
The selected animation sequence. Even though the hud says frame, it really means <strong>FRAMEGROUP.</strong> A framegroup can contain a single frame, or multiple frames. A frame in a framegroup is known as a <strong>POSE</strong>. If a framegroup contains multiple poses then it will be seen automatically as an animation sequence. The original id1 models use framegroups consisting of 1 pose each. They didn't utilize framegroups correctly at all. That's why their animations can't be played back in the modelviewer, you can only view them as individual poses.<br/>

<span style="color: red; font-weight: bold;">
Bug: There is no way to stop the playback of a looping anim so that you can examine it slowly frame by frame.
</span><br /><br />

<code>Mins: -n -n -n</code><br />
The Mins of the bbox?<br />

<code>Maxs: n n n</code><br />
The Maxs of the bbox?<br />

<code>flags:0 0x1400</code><br />
The bitflags on the model for things like particle trails<br /><br />

== Camera Controls ==
<span style="color: red; font-weight: bold;">
Bug: There are no controls to pan the camera, this prevents looking at a specific part of a model when its zoomed in. It's difficult to see the joints in skeletal models because of this.
</span><br />
{| class="wikitable" style="width:100%; background:#999; text-align:center;" cellpadding="4" cellspacing="1"
|-valign="top" style="background:#F8F8F8"
! Function
! Key Assignment

|-valign="top" style="background:#F8F8F8"
| zoom in
| w

|-valign="top" style="background:#F8F8F8"
| zoom out
| s

|-valign="top" style="background:#F8F8F8"
| tilt up
| up arrow, keypad up arrow, or K_GP_DPAD_UP

|-valign="top" style="background:#F8F8F8"
| tilt down
| dn arrow, keypad dn arrow, or K_GP_DPAD_DOWN

|-valign="top" style="background:#F8F8F8"
| rotate left
| left arrow or keypad left arrow or K_GP_DPAD_LEFT

|-valign="top" style="background:#F8F8F8"
| rotate right
| right arrow or keypad right arrow or K_GP_DPAD_RIGHT

|}<br /><br />

== Selection Commands ==
<span style="color: red; font-weight: bold;">
Bug: When there's a lot of joints in the skeleton, the list of joints will overflow off the bottom of the screen, and using the [ and ] keys will not scroll the list.
</span><br />
{| class="wikitable" style="width:100%; background:#999; text-align:center;" cellpadding="4" cellspacing="1"
|-valign="top" style="background:#F8F8F8"
! Function
! Key Assignment
! Usage

|-valign="top" style="background:#F8F8F8"
| next surface
| ins
| highlites a surf

|-valign="top" style="background:#F8F8F8"
| prev surface
| del
| highlites a surf

|-valign="top" style="background:#F8F8F8"
| next skin
| home
| shows a skin

|-valign="top" style="background:#F8F8F8"
| prev skin
| end
| shows a skin

|-valign="top" style="background:#F8F8F8"
| next frame
| pgup
| shows another anim or frame

|-valign="top" style="background:#F8F8F8"
| prev frame
| pgdn
| shows another anim or frame

|-valign="top" style="background:#F8F8F8"
| next joint
| ]
| highlites a joint

|-valign="top" style="background:#F8F8F8"
| prev joint
| [
| highlites a joint

|}<br /><br />

== Misc Commands ==
{| class="wikitable" style="width:100%; background:#999; text-align:center;" cellpadding="4" cellspacing="1"
|-valign="top" style="background:#F8F8F8"
! Function
! Key Assignment
! Usage

|-valign="top" style="background:#F8F8F8"
| mode
| m
| there are 7 modes: none, bones, shader, texture, collision, events, normals. Keep pressing 'm' to cycle through them.

|-valign="top" style="background:#F8F8F8"
| texture map
| t
| there are 10 types of map: diffuse, normal, specular, upper, lower, paletted, fullbright, reflectcube, reflectmask, displacement. Keep pressing 't' to cycle through them.

|-valign="top" style="background:#F8F8F8"
| reset times
| r
| this seems to restart the animation

|-valign="top" style="background:#F8F8F8"
| flop ragdoll
| f
| I think it pushes a ragdoll so you can see how it looks?

|-valign="top" style="background:#F8F8F8"
| unknown command1
| a
| doesn't seem to do anything

|-valign="top" style="background:#F8F8F8"
| unknown command2
| d
| doesn't seem to do anything

|-valign="top" style="background:#F8F8F8"
| unknown command3
| space
| something related to a shader file?

|-valign="top" style="background:#F8F8F8"
| unknown command4
| keydown[K_MOUSE1] && mods->mousedown
| doesn't seem to do anything

|}<br /><br />

== Troubleshooting Your Model ==
If you're adding new model and texture files to your game folders while FTE is running, you might need to clear the cache for them to be found. If FTE can't find the model, it won't be loaded. If FTE can't find the skin texture, the model will have a pink and black color.

==== Solution for files that aren't found ====
1. Keep FTE running, but exit the model viewer by pressing ESC<br/>
2. Open the console and use ALL of these commands:<br/>
*flush<br/>
*fs_flush<br/>
*vid_reload<br/>
*vid_restart<br/>
3. Now try loading the model into modelviewer again.<br/><br/>

<strong>You might want to bind that command to a key:</strong><br/>
<code>bind f "flush;fs_flush;vid_reload;vid_restart"</code><br/>

Now you can simply press F to fix things quickly.<br/><br/>

==== Help, my model is still pink! ====
If your model is still pink after flushing and reloading, it means either your material name is wrong, or the material isn't in the correct folder.<br/><br/>

In modelviewer's hud, the material might show a path, like this:<br/>
<code>Skin0: "", Material "foo/myMaterial"</code><br />
that means it's looking in your gamedir/foo folder for a texture named myMaterial<br/><br/>

Or it might show with no path, like this:<br/>
<code>Skin0: "", Material "myMaterial"</code><br />
that means it's looking in the same folder as the model<br/><br/>

If you press 't' you can see all locations where FTE is looking to find the skin texture. The folders its searching will be listed like this:<br/>
<code>progs:models</code><br/>

meaning, its trying to find the texture in either the progs or models folder.<br /><br />