Profiles - VikkoMakesStuff/Fork3X GitHub Wiki

What's a profile?

Profiles are folder containing the UI files, allowing the user to have the choice between multiple interfaces.

How do I make a profile?

To make a profile, you must:

  • Create a folder. Give it any name you want.
  • Copy the UI and Interfaces folders and modify them all by respecting the attribute system to prevent issues.
  • In the CheckProfile function in the Options module, configure as it can select the profile.

Replacing the UI and Interfaces folder out of the profile is unadvised since if your profile is obsolete, this might cause conflicts with the tools and create an error cascade.

Attribute system

To prevent useless items to be added in the new profile's UI, they must have some attributes.

IsNegligible

The IsNegligible attribute is used if you got a lone item without any child that doesn't need to be checked when it's missing in the profile. For example, any lone non-essential object that got completely added (UICorner e. g.) must have the IsNegligible attribute on itself and every of its children.

ChangeAnyway

If you have one object that has multiple children that are different/extra/missing, it is more performance-wise to put the ChangeAnyway attribute so it doesn't check every single item. It is mainly important when switching to the profile you're editing.

Changing the profile in Studio

In Studio, to change the currently used profile, you must put the profile's folder in another folder named Fork3XProfile located in ReplicatedStorage. The plugin will load it the next time you enable it.