0% found this document useful (0 votes)
11 views2 pages

Loading Portraits in MekHQ Guide

The document provides instructions on how portraits are loaded in MekHQ based on a person's gender and role, listing the folder structure and possible portrait locations. Primary, specialist, and general grouping folders are checked in order to find an eligible portrait, with the search stopping once a portrait is found. Examples of folder paths are given for different portrait types.

Uploaded by

bewotey862
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
11 views2 pages

Loading Portraits in MekHQ Guide

The document provides instructions on how portraits are loaded in MekHQ based on a person's gender and role, listing the folder structure and possible portrait locations. Primary, specialist, and general grouping folders are checked in order to find an eligible portrait, with the search stopping once a portrait is found. Examples of folder paths are given for different portrait types.

Uploaded by

bewotey862
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as TXT, PDF, TXT or read online on Scribd

Windchild's Guide to Loading Portraits in MekHQ

Written 08-Feb-2020, Updated 05-Aug-2020


MekHQ version 0.47.8

How Portrait Loading Works:


The basic structure for loading a portrait is that it first determines the gender
of the person, then looks for a folder located under the gender for a folder with
the exact name of the primary role (see below for a list of possible primary
roles). If that folder doesn't exist, is empty, or contains only pictures which are
already assigned, the system continues with the next round of checking.
The system then checks for specialist grouping folders (see below), if it applies
to the role. If that folder doesn't exist, is empty, or contains only pictures
which are already assigned, the system continues with the next round of checking.
Next, the system looks in the general grouping folders (see below). If that folder
doesn't exist, is empty, or contains only pictures which are already assigned, the
system continues with the next round of checking.
Finally, it checks the gendered folders.

If the system finds at least one eligible picture in one of the checked folders, it
stops searching the folders and picks a random picture from the eligible ones in
that folder. Note that this stops the search, so if you put pictures in both
/Male/MechWarrior and /Male/Combat, Male MechWarriors will never be assigned one of
the pictures in the combat folder unless all the Male MechWarrior-specific pictures
are already assigned.

Folder Lists:
To be loaded, the portrait must be located in one of the following folders. To
determine the path required, you take the Primary Folder and add the Gendered
Folder, then the folder beneath it (outside of the Admin subtypes, which will
require the creation of the general Admin folder followed by their specification
folder)
For example, I want to load a group of portraits that are only for Male
MechWarriors in version 0.46.1. The folder I would need to have to place these
portraits into would therefore be
mekhq-windows-0.46.1/data/images/portraits/Male/MechWarrior
As a second example, I have a portrait that can be used by Female Admin in version
0.46.1. The folder I would need to place this portrait in would be mekhq-windows-
0.46.1/data/images/portraits/Female/Admin
As a third example, I have a portrait that can only be used by Female Admin/HR in
version 0.46.1. The folder I would need to have to place this portrait in would be
mekhq-windows-0.46.1/data/images/portraits/Female/Admin/HR

Primary Folder: All portraits are located in the portraits folder, just replace the
version of mekhq with the current version.
mekhq-windows-0.46.1/data/images/portraits

The following follows the format:


Grouping /Folder Name

Gendered Folders: Note that all of the below MUST be added to one of the two
gendered folders or the portraits will not load
Male Portraits: /Male
Female Portraits: /Female

Primary Role Folders:


None: /None
Mechwarrior: /MechWarrior
Vehicle Driver: /Vehicle Driver
Naval Driver: /Naval Driver
VTOL Pilot: /VTOL Pilot
Vehicle Gunner: /Vehicle Gunner
Conventional Aircraft Pilot: /Conventional Aircraft Pilot
Aero Pilot: /Aerospace Pilot
Proto Pilot: /ProtoMech Pilot
Battle Armor (Clan): /Elemental
Battle Armour: /Battle Armor Pilot
Soldier: /Soldier
Vessel Pilot: /Vessel Pilot
Vessel Crewmember: /Vessel Crewmember
Vessel Gunner: /Vessel Gunner
Hyperspace Navigator: /Hyperspace Navigator
Mech Tech: /Mech Tech
Mechanic: /Mechanic
Aero Tech: /Aero Tech
Battle Armor Tech: /Battle Armor Tech
Astech: /Astech
Doctor: /Doctor
Medic: /Medic
Admin/Command: /Admin/Command
Admin/Logistical: /Admin/Logistical
Admin/Transport: /Admin/Transport
Admin/HR: /Admin/HR
LAM Pilot: /LAM Pilot
Vehicle Crew: /Vehicle Crew

Specialist Grouping Folders: (see below for what are in these groupings)
Administrators: /Admin
Techs: /Tech
Medical Staff: /Medical
Vessel Crewmembers: /Vessel Crew

General Grouping Folders:


Combat Personnel: /Combat
Support Personnel: /Support

For the Specialist Grouping Folder, the following roles are included in the
groupings:
Administrators: Admin/Command, Admin/HR, Admin/Logistical, Admin/Transport
Techs: Mech Tech, Aero Tech, Mechanic, Battle Armor Tech
Medical Staff: Doctor, Medic
Vessel Crewmembers: Vessel Crewmember, Vessel Pilot, Vessel Gunner, Hyperspace
Navigator

Common questions

Powered by AI

The mechanism balances specificity and flexibility by starting with highly specific primary role folders and progressively checking less specific folders like specialist and general groups. This hierarchy ensures detailed portraits for specialized roles while also accommodating general assignments when specific folders are depleted. Improvement could involve a prioritization toggle for users to decide if they prefer role specificity over general assignment, further enhancing customization .

Deciding whether 'Soldier' should be a primary role or within a general folder depends on the specificity required in the portrait assignment. If soldiers represent a wide variety of tasks and settings, placing them in a general grouping folder like 'Combat Personnel' allows for flexibility. However, if roles are distinct enough, a primary role folder ensures sharper categorization and assignment .

Challenges include ensuring a diverse and sufficiently large pool of portraits so that individuals within the same role don't end up using the same portrait. Additionally, when specific folders are depleted, there's a risk of overusing certain portraits from less specialized folders, reducing uniqueness .

The system first checks for folders under the gender folder, specifically the Male folder, for a MechWarrior folder. If no pictures are available or all pictures are assigned, it moves on to specialist grouping folders. If none are found, it checks the general grouping folders, and finally, other gendered folders. If a valid, unassigned picture is found in any folder, the system randomly selects one and stops searching further .

Having general grouping folders like 'Combat Personnel' is effective as it provides a fallback category for portraits that are not specified for primary roles or specialist groups. This structure ensures that personnel can still be assigned portraits when specific role folders are insufficient, maintaining visual coherence and representation .

The 'Vessel Crew' general grouping folder would contain portraits for roles like Vessel Crewmember, Vessel Pilot, Vessel Gunner, and Hyperspace Navigator. This categorization is significant as it allows for centralized portrait management for roles that serve in related but distinct capacities aboard vessels, ensuring consistency and efficiency in portrait assignment .

Based on existing role classifications, the 'Techs' specialist grouping folder might be a logical place to place the 'Cyber Specialist' role, given the technological nature of the existing roles within this group .

The 'Techs' specialist grouping folder includes the following roles: Mech Tech, Aero Tech, Mechanic, and Battle Armor Tech .

The necessity of adding gendered folders is to accurately categorize and manage portraits based on gender, ensuring appropriate representation and avoiding mismatches. Not adhering to this requirement will result in portraits failing to load, disrupting the visual organization and potentially misrepresenting characters within the system .

For a Female Admin/HR role in MekHQ version 0.46.1, the portrait must be placed in the following folder path: mekhq-windows-0.46.1/data/images/portraits/Female/Admin/HR .

You might also like