Portrait modding

From Stellaris Wiki
Jump to: navigation, search

Version

Outliner top.png
This article may contain outdated information that is inaccurate for the current version of the game. It was last updated for 1.6.

There are 2 types of portraits in Stellaris. Static and animated.

Static portraits[edit]

These are very simple, just create a .dds image, with a character cut out so it has no background. Save it somewhere in the /gfx folder. Then add the portrait in the game\gfx\portraits\portraits\00_portraits.txt

portraits = {
   mam1 = {
       spriteType = "GFX_portrait_mam1"
   }
} 

OR

portraits = {
   mam1 = {
       texturefile = "gfx/interface/portraits/YOUR_TEXTURE_NAME.dds"
   }
}


Animated Portraits[edit]

This guide will go over how to create a new portrait using Autodesk Maya, animating it and implementing it in the game.

Portraits in Stellaris are animated 2D characters. It works by having body parts split up on a texture map, assigning each body part to an individual polygonal plane, sorting them correctly in Maya and animating them using the skeleton feature.

To create an animated portrait, you will need a painting software like Adobe Photoshop, as well as Autodesk Maya 2015 / 2016. You will also need a plugin to export your texture to .dds. This can be done with the Photoshop plugin installed with the exporter. But we recommend downloading the Nvidia Photoshop .dds plugin (because it is simpler in this case). https://developer.nvidia.com/nvidia-texture-tools-adobe-photoshop The way this works is that when you “export” the file in Photoshop, it will save one file to your work folder and one file to the game folder. It can also be done manually, but then you have to copy the .dds file to the game folder.

Photoshop[edit]

But, let’s start off, and take Fungoid 11 as an example. First create a texture of your alien. Separate the body parts that will be moving in different layers, and remember to paint behind any moving parts such as arms/tentacles/jaw/ears. The original should look something like Fig.1 (observe the amount of layers):

Portrait rigging fig1.jpg

Fig.1: Source texture file of alien portrait

Next separate each layer and place them a few pixels away from each other like in Fig.2.

Portrait rigging fig2.jpg

Fig.2: Body parts separated

Select all the separated layers, duplicate them, merge the duplicated layers, add the merged layer to the bottom of the folder, rename it to “padding” (this is to prevent alpha bleeding), ctrl-select the padding layer and go to “Select > Modify > Expand”, expand it by around 5 pixels. Make sure that the expansion doesn’t connect to any other selection. Now we want to fill in the expanded area with the same colours as the body parts. This can either be done manually by painting in the area with the body parts’ colours or by using a plug-in that does it for you. A plug-in we have been using is the Free Plug-Ins from Flaming Pear found here: http://www.flamingpear.com/download.html (go to Free Plugins at the bottom), then in Filters, go to Flaming Pear, then Solidify A to fill the selection.

Now when our padding layer is done we want to create an alpha. This is done by ctrl+shift+selecting the layers, go to Channels tab in the layer window and clicking the “Save selection as channel” button at the bottom of the window.

Having our alpha created the texture file should be complete, however it is probably pretty large. Save your .psd file, then resize the image to 512x512 (don’t save the .psd file here!), save the file as a .dds with DXT5 settings and then ctrl+Z to get your original size back to your .psd.

Your texture should now be ready to be rigged in Maya.

Maya[edit]

Open up Maya and start off by creating a new skeleton. See Fig.3 for joint hierarchy.

Portrait rigging fig3.jpg

Fig.3: Joint hierarchy for Fungoid 11

You probably don’t need to create as many joints as can be seen in Fig.3 just yet, so start off by just creating the top ones: “root”, “root_center”, “spine_1”. You can add more as you see fit depending on the design of your character.


Material[edit]

Open up your .dds in Photoshop, open the image size window (ctrl+alt+i) and change the format from pixels to centimeters. The values here are the values we will use to create the polygonal planes in Maya. The Fungoid 11 texture file is 512x512 px which results in 18.06x18.06 centimeters.

Go to Maya and Create > Polygon Primitives > Plane > Option box. Set the axis to Z and then input the size values you got earlier. Now to create a proper material for it. Go to the Hypershader (Windows > Rendering Editors > Hypershader) and create a Phong shader in the menu to your left. Assign the texture to the diffuse channel and assign a black texture to the normalmap and specular map channels. You can do this by assigning a file and never adding an actual texture. Assign the new material to the newly created plane. If your texture isn’t a perfect square you will need to go to the UV Editor and move the UV edge to the texture edge.

Now duplicate your plane to one for each body part like in Fig.4. Move each parts' vertices to exclude the other parts (make sure you have "Preserve UVs" checked in the Move Tool settings) and place them above each other in the correct order. It's easiest to work in the front view by the way. Put them in the same order on the outliner. The one furthest in the back should be at the top of the list and the one most in front at the bottom.

Portrait rigging fig4.jpg

Fig.4: Polygon planes to map out the body parts

Animation[edit]

Cut up the mesh to get more polygons where the mesh will deform.

Now let’s continue on your skeleton, skin the character, animate it and export it. To set them up for export, select the root joint, open the export window and press <add "animation" attr.>. This will add a new parameter to your channel box. You need to set a state for each animation start. And a none state for where each animation ends. To do this, select the joint, click the "edit" drop-down menu above and select "Edit Attribute". In the new window, select the animation attribute and click on any slot under "Enum Names" to add a new state. You will need a new state for each of your animations and a "none" state for when you don't have any animations.

If done correctly, it should look like in Fig.5 (that character has 5 animations )

Portrait rigging fig5.jpg

Fig.5: Graph of “animation” attribute for “root” joint

Ensure that at the start and end of each animation in the timeslider, you select the root joint and change the animation attribute to the correct animation and key it.

Shader[edit]

For the body you should use the shader "PdxMeshPortrait", to use this select the shader your made previously in the Hypershader, then in the Maya exporter window select "Stellaris" and click "add shader attr." and select the mentioned shader in the drop-down menu at the bottom of the attributes in the channel box of the previously made shader (named Shader).

If the list doesn’t contain the Portrait shader, and only contains other kinds of shaders, you can either go to Documents\Paradox Interactive\PdxExporter\settings, open the “clausewitz.txt” file and add the shader you want to the list (remember to also increase the number at the start with 1 for each shader you add).

Alternatively you can select the shader in the Hypershader, go to Modify > Edit Attribute…, select “shader”, click on the empty space below the shaders in the list, then write in the text box the name of the shader to add it. “PdxMeshPortraitClothes” for clothes and “PdxMeshPortraitHair” for hair. More on how to script clothes and hair later.

Export[edit]

Open up the exporter, make sure you check the “Skip Merge” option in the exporter, see Fig.6 for options (normally the export optimizes the mesh by merging separate meshes, to reduce the amount of draw calls when rendering). Set a name and location and press export.

Portrait rigging fig6.jpg

Fig.6: Portrait export options

How to add it to the game[edit]

When you have exported, you need to add the animations manually. Each animation needs an entry in your .asset file (make sure the animations and .asset file is in the same folder).

   animation = {
       name = "molluscoid_14_portrait_happy_animation" # <- this is the shortcut name that you will put in the .gfx file.
       file = "molluscoid_14_portrait_happy.anim" # <- this is the actual animation file name.
   }
   
   animation = {
       name = "molluscoid_14_portrait_happy_2_animation"
       file = "molluscoid_14_portrait_happy_2.anim"
   }

You will then need to add these animations in the .gfx file.

objectTypes = {
       pdxmesh = {
           name = "portrait_molluscoid_14_mesh"
           file = "gfx/models/portraits/molluscoid/molluscoid_14_portrait.mesh"
           animation = { id = "idle"    type = "molluscoid_14_portrait_happy_animation" }
           animation = { id = "idle2"    type = "molluscoid_14_portrait_happy_2_animation" }
           scale = 1.0
       }    
}

Then you will need to add these animations in .asset file with your characer (can be the same file as the animations)

entity = {
   name = "portrait_molluscoid_14_entity"
   pdxmesh = "portrait_molluscoid_14_mesh"
   
   default_state = "idle"
   state = { name = "idle"       animation = "idle"    animation_blend_time = 0 chance = 2.0 looping = no next_state = idle}
   state = { name = "idle"       animation = "idle2"    animation_blend_time = 0 chance = 1.0 looping = no next_state = idle}    
   scale = 1.12
}

If you have many idle animations you can use this option to randomize the idle animations:

state = { name = "idle"       animation = "idle"    chance = 2.0 looping = no next_state = idle}
state = { name = "idle"       animation = "idle2"    chance = 1.0 looping = no next_state = idle}

This will make the animation “idle” be twice as likely to play as the animation “idle2”.

After you’ve done this it is time to add it to the phenotype list! To do this go to the file gfx/portraits/portraits/[##]_portraits_[phenotype].txt. In the bracket “portraits = {}” copy a portrait and change the numbers to whatever you want for your portrait. It should look like this:

mol14 = {    entity = "portrait_molluscoid_14_entity" clothes_selector = "molluscoid_massive_clothes_01" hair_selector = "no_texture"    greeting_sound = "molluscoid_01_greetings"
           character_textures = {
                   "gfx/models/portraits/molluscoid/molluscoid_massive_14_1.dds"
                   "gfx/models/portraits/molluscoid/molluscoid_massive_14_2.dds"
                   "gfx/models/portraits/molluscoid/molluscoid_massive_14_3.dds"
                   "gfx/models/portraits/molluscoid/molluscoid_massive_14_4.dds"
           }
   }


mol14 is the name of the portrait, entity is the entity it will use (which you created earlier), clothes_selector is which clothes to use (if none just write “no_texture” and hair_selector is for the hair it will use (if none just write “no_texture”). In the bracket “character_textures” you can assign different textures. If you only have one you can still add it there by using its search path.


Next open the file “00_species_classes” found in “game\common\species_classes”. Add your portrait name (like rep1) to the list of portraits under the correct phenotype. It should look like this:

FUN = {
   portraits = {
       "fun1"
       "fun2"
       "fun3"
       "fun4"
       "fun6"
       "fun7"
       "fun8"
       "fun9"
       "fun10"
       "fun11"        
       "fun12"        
       "fun13"        
       "fun14"
       "YOUR_PORTRAIT"
   }

graphical_culture = fungoid_01
   move_pop_sound_effect = "fungoid_pops_move"
}

If you have clothes and hair you need to create a file where you can specify those. This file can be found in gfx/portraits/asset_selectors/[phenotype]_[size]_clothes_[##].txt Copy one of the clothes files and change the textures to yours, then do the same to one of the hair files and change the textures. Copy the file names and paste them in the gfx/portraits/portraits/[##]_portraits_[phenotype].txt file in the clothes_selector and hair_selector by replacing the “no_texture” string.


If its all correct it should now show up in the character designer.

References[edit]


Modding
Static modding DefinesStatic modifiersMapSpeciesTraitsEthosGovernmentsEmpiresPoliciesEdictsTechnologyBuildingsShipsFleetsEventsCrisisAnomaliesAgenda
Dynamic modding EffectsConditionsScopesModifiersGameplayDecisionsObjectivesAI
Media/localisation Maya exporterGraphicsPortraitsFlagsEvent picturesEvent soundsInterfaceIconsMusicLocalisation
Other Console commandsSave-game editingSteam Workshop