Releasing a Soldier Class Ranks framework, give me opinions

[DameLoony]

Shorter version of questions: https://www.reddit.com/r/xdev/comments/47488x/soldier_class_ranks_framework_prerelease_questions/

 

My framework provides an easy-access location for players to alter their rank lists without scrolling through their .int/etc file, but also allows classes and subclasses to specify a rank list to use. Think of it like Psi Ops or Long War EW officer ranks. In vanilla, only the "PsiOperative" class template triggers a different rank list.

 

There are two remaining issues: I'm unsure how to manage the subclasses variable(s) included in the core framework, and I need to specify some guidelines so mods that use this framework don't override one another accidentally.

 

A mod author only need include a rank list specifier (text file) in their mod and the UI will pull the correct ranks to go with their class template. I allow this by adding optional variables to GetRankName/GetShortName functions from X2ExperienceConfig.uc and overriding about 20 UI calls. There's slightly more complexity to it but that's the gist.

 

For example, I use both the Long War Leader Pack mod (5 ranks) and a full Officer Class mod (7) ranks. As a subclass takes a bit more configuring, I have the Leader pack using a standard "OfficerNames" list beginning at rank 3.

 

Please tell me:

• What naming convention should I suggest for rank lists attached to a specific template? ______Names[#]/_____ShortNames[#] by soldier-class template is simple but in the case of Officers or other name conflicts may cause issue. It also may even be "not my problem" but I aim to be user-friendly and maximize compatibility.
  
• What conventions should I suggest for subclass rank lists? Should they always use unique lists with a rank pulled from their attached .uc compatibility patch At present this is just the Leader Pack compatibility patch I made for the framework and uses the mod's OfficerRank to set a separate OfficerClassRank variable at OfficerRank+2.
  
• Should I include a subclass rank variable? Is it my place to when PsiRank is already in the game? It would be ideal if all subclasses like Leader or EU's Psionic abilities shared a singular subclass rank variable but I'd be effectively forcing them to be exclusive. To avoid buggy gameplay I'd need to explicitly make them exclusive (which would require more design time). Though I prefer that gameplay-wise it may be over-reaching for a framework and resource. Especially as most subclasses have no real reason to overwrite ranks (such as Psion or Cyborg for example).
  
• Alternatively, a subclass framework that attaches itself on top of this release may be ideal but involves setting standards that I'd like to come from consensus. If such a framework were rushed it would probably owe far more to reverse-engineering the Leader Pack than is fair without explicit permission. (JLump, Amineri, you'd need to give me a thumbs-up.)

The framework should be released on Nexus and Steam "very soon", with a couple default ranklist versions. At launch I'll have compatibility options for at least the Leader Pack and let other Psi classes specify the PsiNames ranks. Any further potential releases will be separated in the Steam release to preserve user config/.int files.