optionsPrefix - CarlosLeyvaAyala/MH-Rise-Modding-Scripts GitHub Wiki

REQUIRED

For each armor option, this prefix will be prepended to the folder name for that option.

This is an anti-collision measure so your mod will play nicely with Fluffy Manager and other mods made for it.

The collision issue

Name collisions happen when you add two different mods with the same folder name to Fluffy.

When that happens, the second installed folder becomes invisible and the user can't see your mod.

For example, if you had installed these two files:

Astalos.rar
  00 Main
  Chest 01 - Variant 1

Kamura.rar
  00 Main
  Legs 01 - Pants

You would see option 00 Main for Astalos, but not for Kamura, since the folder names have exactly the same name.

The easiest way to solve this is to make sure all folder options are different, for example:

Astalos.rar
  my_own_name_astalos_armor_00_main
  my_own_name_astalos_armor_chest_01_Variant_1

Kamura.rar
  my_own_name_kamura_armor_00_main
  my_own_name_kamura_armor_legs_01_pants

This variable is used for that.

Usage

If you had:

optionsPrefix=sick gains 210

This is what you would get:

All options folder names have the same form:

sick_gains_210_option_name

Where option_name is taken from modinfo.ini.
See ==modinfo.ini== for more information on how option names are generated.

Name normalization

All folder names for your armor options are "normalized" this way:

  1. ,, - and spaces are replaced with _.
  2. Eveything is transformed to lowercase.
  3. If there are many _ in a row, all of them get transformed to a single _.

Notice how this normalization procedure applies to the value of optionsPrefix as well, so you would only care about using a readable name and let the program do the normalization by itself.

Naming suggestions

Since there are thousands of mods out there with names waiting to collide with yours, it's a good idea to follow some guidelines to greatly lower the chance of name collisions.

  • Use relatively long names (many words) for your prefixes.
    Probability says: for each word you add, you greatly lower the chance that other person will use exactly the same words as you in the exact same order.
  • It's a good idea you somehow add your name or some consistent name so other people (specially, other modders) know you made this mod.
    This greatly lowers the chance other people use the same name as you.
  • Use a key of some sorts for each mod you release, this way you won't get collisions with yourself.

Following those guidelines, I came up with:

sick gains armorId

For all my EBB mods.