Exporting-a-weapon-for-Xonotic.md

   1 ## :rotating_light: :warning: WARNING: This tutorial is under construction! :warning: :rotating_light:
   2
   3 # Modeling requirements
   4 ### To follow this, you need knowledge about modeling using Blender
   5
   6 Blender version recommended: 2.79b or later
   7
   8 Requires these following tools (addons) for Blender:
   9 - [IQM exporter](https://gitlab.com/xonotic/iqm) to export IQM files.
  10 - [MD3 importer/exporter](https://github.com/neumond/blender-md3) to import/export MD3 files.
  11
  12 ***IMPORTANT NOTE**: if you want to contribute, it's strongly important use 2.79b version for compatibility cases, they need to open from this version. Share the .blend file using 2.79b or earlier , make sure to work properly from this version!*<br/>
  13 *If the version of a file is later than 2.79b, we may to make some tweaks and become tedious.*
  14
  15 # Introduction to export a weapon
  16 **Keep in mind about weapon systems:**
  17
  18 - `g_*.md3`: model mesh for item pickup spawn and third person.
  19 - `h_*.iqm`: for first person animations; the skeleton and the bones (the rigging and animation part). Keep in mind, you would need `*.iqm.framegroups` (more info: [Framegroups](framegroups), you can look `*.iqm.framegroups` opening a notepad to see what animations contain and the keyframes where these are set)
  20 - `v_*.md3`: model mesh for first person and a glue of `h_*`; if `h_*.iqm` doesn't match with the animations needed of `v_*.md3`, it will generate spamming errors and bad pivot position.
  21
  22 More info: [Weapon modeling system](Weaponsystem)
  23
  24
  25 # Textures and UV map
  26
  27 ### For MD3 exportation:
  28
  29 You have to add single material with single texture for every mesh object. Name of texture node will be written as is into MD3 data (suffixes like .001, .002 are ignored, feel free to use one texture for many meshes).
  30 <br />
  31 Keep in mind, when you've done your UV map in your model, you need to set this:
  32 <br />
  33 <br />
  34 <img src="uploads/efee46a2a80a232ebe5fa63e30f4e2d9/Md3exp.png" alt="Md3exp" width="300" />
  35 <br />
  36 Texture must:
  37
  38 - be of **Image** type
  39 - mapping type **UV**
  40 - have UV map assigned
  41
  42 otherwise resulting data block will be filled with zeroes.
  43 <br />
  44 <br />
  45 <img src="uploads/c48fb7565453eab24faca2d6ffec4347/Md3_textures.png" alt="Md3_textures" width="360" />
  46 <br />
  47 <br />
  48 If you didn't this, the model will be invisible and it won't be able to interact shaders.
  49 <br />
  50 <br />
  51 [Blender reference about UV in MD3](https://archive.blender.org/wiki/index.php/Extensions:2.6/Py/Scripts/Import-Export/MD3/)
  52
  53 # Starting to export
  54
  55 Keep in mind, you need to set these modifiers for each mesh/model object:
  56
  57 <img src="uploads/447f6abe0f73c6d6cadce97e4ed66e8b/blendermodifiersiqmandmd3.jpg" alt="blendermodifiersiqmandmd3" />
  58
  59 ## MD3
  60
  61 Before to export, you need to select all objects in the scene. (Pressing A, seeing all objects highlighting orange or red)
  62
  63 <img src="uploads/f3f39c9a06a408bffd5e48bc5e07eac6/exporttutorialMD3.jpg" alt="exporttutorialMD3" />
  64
  65 ## IQM
  66
  67 Before to export, you need to select all objects and bones in the scene. (Pressing A, seeing all objects highlighting orange or red)
  68
  69 <img src="uploads/7df860d73a6fae27408c8f0c024122c7/exporttutorialIQM.jpg" alt="exporttutorialIQM" />
  70
  71 <br/>
  72 <br/>
  73 For `h_*.iqm`, you will need to do this:
  74
  75 There is a simple way:
  76
  77 You just can use an iqm model like a regular mdl file, you only need to use each frame as a framegroup.
  78
  79 For example, if you have an iqm called "rocketlauncher.iqm" with 20 frames you need to create a framegroup file with notepad like this:
  80
  81 ```
  82 1 1 1 0
  83 2 1 1 0
  84 3 1 1 0
  85 4 1 1 0
  86 5 1 1 0
  87 6 1 1 0
  88 7 1 1 0
  89 8 1 1 0
  90 9 1 1 0
  91 10 1 1 0
  92 11 1 1 0
  93 12 1 1 0
  94 13 1 1 0
  95 14 1 1 0
  96 15 1 1 0
  97 16 1 1 0
  98 17 1 1 0
  99 18 1 1 0
 100 19 1 1 0
 101 20 1 1 0
 102 ```
 103 So you will save it with the name.
 104
 105 "rocketlauncher.iqm.framegroups" and place it in the same directory where "rocketlauncher.iqm" is located.
 106
 107 About the framegroups file (explained on [Framegroups](framegroups)):
 108
 109 The first number represents the start frame of the animation (.framegroups files always start at frame 0, some modeling software starts at 1, so you might have to subtract 1 for the start frame).
 110
 111 The second number represents how many frames is in that specific frame group.
 112
 113 The third number is the frame rate at which the sequence plays. This is independent from what the monsters "think" rate is, which I have set at 10 frames-per-second.
 114
 115 The fourth number is whether the frame sequence loops. 1 for true, 0 for false. The only frame groups that should loop are the standing, walking and running animations.
 116
 117 It becomes very tedious to make framegroups for models with really many frames, you can use this sample generated for the darkplaces model compiler. It will work in every iqm model (if you wan you only need to cut the specific number of frames in the framegroups file, but it will work anyway)
 118
 119 Reference: [IQM animation framegroups (InsideQC Forums)](https://forums.insideqc.com/viewtopic.php?p=55949&sid=952cd347938ae5f2bb8bde276b5a35cd#p55949)
 120
 121
 122 Sometimes, renaming formats can be useful to save effort. Note: it's a kind of weird way to do stuff, the issue of model resources was found here: https://gitlab.com/xonotic/xonotic-data.pk3dir/-/issues/2629#note_686988936
 123