Mod.ini Unsupported Options

Introduction

This page covers mod.ini options that are currently unsupported but that may become supported in future releases. Please see [Mod.ini options page](mod.ini options) for the list of currently supported options.

[extremeforce]

[extremeforce]
forcedflagson  = -tbp -ship_choice_3d
forcedflagsoff = -3dradar -infotext

Now we're getting technical.

In this section you can specifically name some flags that must be always enabled or always disabled for the users of your mod.

Use extreme caution when adding flags to this section. Be very sure that your mod needs those particular flags to be always enabled or disabled, or you might end up with an avalanche of hate mail in your inbox. Worst case scenario, we'll get them too for allowing you to force some flags.

Be careful with the flags set in this sections. Even better, try to have no flags in there if possible. And keep in mind all the user has to do is open your mod.ini file to remove this.

Note: forcedflagson takes precedence over forcedflagsoff. That is, if you specify a flag on both lists the flag will be forced on. This allows the default forcedflagsoff flags to be enabled for the mods that use those flags. See forceflagsoff for details.

Also Note: If you find it necessary to use these options, you should also bring it up with the SCP as it is likely something that should be moved into the tables. As this feature is currently not implemented, and is unlikly to be implement, asking the SCP to move the feature to a table is the best option.

forcedflagson

A list of flags that are a must for your mod to work. The format is very simple. List flags one after another (including the "-" character) and separated with one empty space. Take a look at the sample above for an example.

forcedflagsoff

This section does the opposite of the one above. It disallows the user to activate some flags that you know it will break your MOD or will add gameplay-altering elements to it.

Note: -tbp and -wcsaga are always on this list.

[flagsetideal]

[flagsetideal]
name = Use these for best effect - full detail
flagset = -ambient_factor 70 ... -targetinfo -warp_flash
notes = The recommended ... if the gameplay gets choppy.

This section allows you to set a set of flags that are the ones you feel it will give the user the best gameplay experience possible. This set will be listed in the "Quick configuration" droplist on the advanced settings page.

This particular flagset (note the word "ideal" in it's name) will have the added benefit of marking the listed options with a special symbol in the advanced settings page in order to be easily spotted by the users. Also, this set will be listed first in the "Quick settings" droplist.

name

Give your sets names for an easy selection. Remember that users are not as technical as a MOD author, so use descriptive non-technical names if possible. "Nicest-looking settings" or similar might be a good starting point. Try to keep it short as possible, using as many adjectives as possible, as this name will directly appear in the launcher itself.

flagset

The actual list of flags. List flags one after another (including the "-" character) and separated with one empty space. Take a look at the sample.ini above in the introduction for an example.

notes

You can define a text that will pop-up when the user selects this flagset. It might contain a technical note (like the specs of the minimum recommended system configuration, the recommended resolution, etc) or whatever you want. Don't overuse it though. Pop-ups tend to be annoying in large numbers.

Like any string, this text must be written on a single line in the mod.ini. You can however add a newline with the "\n" character (without quotes, of course).

[flagset#]

[flagset1]
name = Medium detail
flagset = -ambient_factor 70 ... -snd_preload
notes = You ... 800x600 or ... choppy gameplay

[flagset2]
name = Lowest detail setting
flagset = -ambient_factor 70 ... -snd_preload
notes = We recommend you use a 640x480x16 ...

These sections (you can have as many as you want, provided the numbering starts with 1 and doesn't skip any integer) list extra sets of flags that you feel the user might need.

They have the same internal composition as the ideal flagset and they will be listed in the "Quick configuration" droplist below the ideal flagset (if it exists) and in the ascending order of the number found in the section name.

name

See name above.

flagset

See flagset above.

notes

See notes above.

[language_name_in_english]

[Romanian]
modname   = The Descent
infotext = Imensa nava plutea in liniste printre ....
welcometext = <p><b>Bine ati venit ... </p>

[French]
modname = The Descent
infotext = Le géant du vieillissement flottait ....
welcometext = <p><b>Bienvenue à wxLauncher, votre ... </p>

This is what we call the localization section. Since the launcher is available in several languages, you are given the option to present the description of your MOD in another language.

What will happen is that if the user switches his launcher language from the default English to, let's say French, and you have a section titled [French] in your mod.ini, the description present in the French section will be displayed for the user instead of the English description.

NOTE: Currently English, French, German, Polish, and Romanian are searched for. The names must have the first letter capitalized and the rest lower case.