View source for Imports:How to make a new race

== Tips ==

* use the vanilla folder structure in your mod. If you do not, the game may occasionally forget where a file is and the player thinks your mod is broken. This happens often with animations
* Do not be afraid of shape keys or animations, they have a learning curve, but the reward is great!
* Making a race is one thing, but adding the race to the game world makes the mod! What is the lore? Where are they from? What faction they belong to? Who hates them? What unique characters of this race roams the world? Can the player recruit them? 

== Creating a new race in the FCS ==
# Open FCS
# Navigate to the Races tab.
# Duplicate an existing race. This way you see what things you need to make for the race. Also having vanilla files there allows you to test the race without the fear of the game doing some weird stuff if a file contents is missing.
# Add the race to a race group, or make a new one. NOTE: this is important for two reasons, without adding it to a race group a player cannot select that race for their starting characters (and you cannot test them) plus race group is what dictates many NPC dialogue options. If you make a new race group, you should also consider adding it to all of the Holy Nation dialogues, unless you WANT them to treat the race as evil. Most people just add their new race as a part of the human race and call it a day.

== Editor limits AKA editor_data.xml file  and about Shape Keys/Sliders ==
Every humanoid race must have an editor limits file set to it. The game will crash without. If you duplicated an existing race, your new race has a vanilla editor limits file assigned to it. If you are using vanilla skeleton and mesh, you can just leave it as is. 

But for the common modder the editor_data.xml is where they make their race look different. '''Skin color, height and girth limits are set here.''' 

You need either Visual Studio Community or a Notepad++ to open and edit editor limits files.

When you open the file, you see a bunch of names numbers and brackets. '''Do not touch the brackets!''' If you by accident delete or add one, the entire file stops working and the game will crash.

Editor limits file is divided in two, male and female side. If you are making only one gender race, male is the one the game will use.

[[File:EditorLimitsInRaceFile.png|frameless|429x429px]]

=== Sliders/Shape Keys (advanced modding) ===
All the values you see on the editor limits file are linked to the sliders in the game start character customization AND NPC randomization. They decide how far each feature can go. 

Basically the race developer creates these slider options in Blender when making the race meshes. They are called Shape Keys  in Blender. If you are using the vanilla mesh, '''and you did not add new bones''', then you can use the vanilla slider names and editor limits. You cannot overextend vanilla values. The max they can go is the max shape the original sculptor of the mesh created. If you want exaggerated features, you must redo '''all''' shape keys.

The video [https://www.youtube.com/watch?v=7WGtmADZCzU Blender Tutorial - Shape Key Basics] by Eve Sculpts shows the process. The difference for Kenshi are the shape key '''names.''' The shape key names must match the names of the sliders on the editor_data.xml file. You can rename the sliders in the file to match the names in your Blender, or vice versa. One caveat: all slider names for Kenshi must be one word, no spaces.

You can also opt not to make any Shape Keys for your race. If it is just one character (or you do not care if the world is filled with identical people) you can just not make any Shape Keys. 

Do not forget to export your mesh with export shape keys ticked. 
[[File:ExportShapeKeys.png|center|frameless]]







== How to make a new race/edit character mesh ==
[[File:LimitBoneInfluence.png|none|thumb|536x536px|To make life easier for yourself, limit the bone influence to 3 for the selected mesh.]]


=== Mesh and character body ===

# Import a vanilla character model with its skeleton into Blender (if they are in the same folder, the skeleton will come automatically when you select the mesh)
# Edit the mesh until you like its appearance. (This includes rigging 3rd party mesh to it)
#* If you are making a giant: Select both skeleton and the mesh and go to edit mode, scale them up
#* If you are making a non-standard race and need a tail etc. make your add-ons to the skeleton
# If you are not making a giant, or have a tail etc., skip this step. If you are making a non-standard race: Re-record every animation in the skeleton to match the new scale (this is the tedious part)
# Do steps 1-3 to both genders
# Export the mesh with the skeleton and paste them inside your mod to character/meshes/female_skeleton and male_skeleton folders respectively
# Export both meshes (female and male) again '''without''' the skeleton with different name. Put those in a folder inside your mod that is not the male_skeleton or female_skeleton (this mesh is used as the main mesh on the race file)
# Open FCS and make a new race file, set its mesh to be the new mesh(es) without skeleton you just made for both genders
# Make a new animations file and add the new skeleton to that. Add that new animation file to the new race
# Make a new custom start and have a character spawn as this new race. Test everything works. If they do, you can stop here. 
# For minutiae details: Edit the appearance in the start character editor until you are happy how the character looks like. You might have to adjust the editor_limits file for this race and redo this step a few times to get the minutiae to your liking. Fe. if you want special skin colors, you need to adjust the editor_limits file. Use notepad++ or Visual studio to edit the file.
# Export the character body (unique name so you know which it is)
# Navigate to your ..\Kenshi\data\character\bodies\export folder and move the body file you just made inside your mod's character\bodies folder. (If you do not have one, make one)
# Open FCS and create a new character file. Add this new bod to the character. Add the new race to it. Add a stats file to your character. You need to adjust its strength and moving speed up a lot to meet the expectations of a large creature.
# Make a new custom start or just edit the start you already made. Make the start have this new character.
See also videos: [https://www.youtube.com/watch?v=OJhFajivYDE Rigging a 3rd party character; From A pose to I pose]  and [https://www.youtube.com/watch?v=X4arrclUJZ0 Kenshi Blender 4.0 Tutorial - 3rd Party Mesh For a Character | Part1: Swapping Heads, Meshwork]

=== Skin texture ===
If you edited a vanilla mesh, you probably can use a vanilla skin texture as a base.  Skins can be found in the ..\Steam\steamapps\common\Kenshi\data\character\skins\human_female  or human_male (or shek) folder. The  head files are NOT in 'hu'. The head files are in human_female or human_male folders.

# Open Gimp and double-click a vanilla skin texture file to open. Untag 'load mipmaps'
# Go to channels on the right side panel (next to layers) and untag alpha. Take a screeshot of this (or go to layer - new from visible and export that as png). DO NOT COPY SOMEONE ELSE'S TEXTURES AND LOAD THEM TO STEAM AS YOUR OWN!!! THIS IS ILLEGAL IN MANY COUNTRIES. Only vanilla files can be used like this. You may look what others have made, but you may not copy.
# Paste that to your preferred image editor as a new image. Crop it to be perfectly square.
# Do the same to the head texture.
# Make your changes
# Open them back in Gimp and export as .dds with DXT5 compression. Even tho Photoshop and many other program can do .dds. very often they are too fancy for Kenshi. Kenshi does not support partial transparency on diffuse images and fancier programs very often automatically add a soft edge to your images. Resulting in a texture you cannot use in Kenshi.
# Paste the textures in their correct folders inside your mod folder and link to them in the race file in FCS.

=== Bump map (normal map) ===
Kenshi uses GGG+R. Create (or have) an usual normal map. Then you just split it in RGB channels, save the R channel separately and then replace the original B and R channels with the G channel. Rebind back to a single image. Then you use the saved R channel as an alpha mask.

I have noticed the vanilla normal maps available in the \Steam\steamapps\common\Kenshi\data\character\skins\hu -folder result in seams on the body. Unfortunately that means you have to either manually make seamless ones yourself, or edit the GGG+R dds versions directly in Gimp.

See [[Custom Character Race and Normal Map (displacement map)]]
See: [https://www.youtube.com/watch?v=hPp8jRXzpm8 Kenshi Blender 4.0 Tutorial - 3rd Party Mesh For a Character | Part 2: Swapping Heads, Textures]

=== Masks ===
You need two mask textures for your race: 1. for the head and 2. for the body

The head mask must be magenta in all areas that get the skin color wash and black on the areas where it only gets white. Green parts on the mask will glow. On the body same with black, all the areas that do not get the skin color wash, like underpants. Everything else white on the body mask. Body mask has no glow option.

=== Hair ===
see [[How to make custom hair]]

=== Secondary skeletal mesh ===
When you are done with your edits, you will have to export the race mesh one more time. See [[Character portrait appearing behind other character portraits]]

== Make characters of the custom race and make them recruitable, or add them to a start. ==
Now it is time to make a decision, shall characters of this race be recruitable in the world, or are they available only in a game start.

If you are making the character(s) recruitable, then you need to make a squad for them and set that squad to spawn somewhere (maybe as a town resident or add them to an already existing recruitables list)
[[Category:WIP]]
[[Category:Modding]]
[[Category:Character]]
[[Category:Race]]
[[Category:Races]]