Skip to content

DarkEdif Fusion user features

Phi edited this page Sep 1, 2020 · 7 revisions

DarkEdif SDK is a continuation of Edif SDK with changes mostly coded by Phi, with some code contributions from LB and other developers. CT forum thread.

This page is a breakdown of features the usual Fusion user is exposed to.

INI Settings

The Fusion users can edit how DarkEdif extensions work via a DarkEdif.ini file located in Fusion root\Extensions\DarkEdif.ini. This INI file only affects Editor builds, as runtime builds cannot be edited or altered during Fusion's build process.

When a DarkEdif extension first boots, it looks for this INI file; if not found, default settings are assumed. A basic file used to be generated with Language preset to the system locale's language, English US, and English; however, now no INI will be generated, and the INI will assume there is no language preference and use the first language in the extension's JSON file.

This INI can be viewed and edited in Notepad.

Languages

This is a semicolon-delimited list of languages, in English, in preferred order.

An example DarkEdif.ini languages may look like this:

Languages = UK English; French

The leftmost language is looked for first in the extension's JSON file, then the second, etc.
If none of the preferred languages match, then the first in the extension's JSON is used.

Image demonstrating language switch to French

Advanced INI settings:

DisableUpdateCheckFor

This is a semicolon-delimited list of extensions:

DisableUpdateCheckFor = DarkEdif Template; Second Ext Name To Not Update

This uses the C++ project name, which is usually what appears in Fusion's object property About > Name.

If you wish to disable updates for every DarkEdif extension, set it to:

DisableUpdateCheckFor = *

Note this property does not support wildcards, and obviously does not affect non-DarkEdif extensions. The updater must be activated by the extension's developer.

MsgBoxForMajorUpdate

Set it to true or false. Default is true.

Tells the SDK updater whether to create a pop-up box for major updates.
The icon of the extension will change in frame significantly, whether the message box is turned off or not.

Major update message box and icon change demo

MsgBoxForMinorUpdate

Set it to true or false. Default is false.

Tells the SDK updater to create a pop-up box for minor updates. By default, this is false, and only major updates will create a message box.
The icon of the extension will change in frame.

Minor update icon change demo

SDK updater

The SDK updater contacts a server to check if the extension is the latest version.

What does it do?

When an update is available, the updater will modify the extension's icon in the frame editor, and for major updates, will create a popup with details of what the updates change about the extension.
The popup can feature a Yes/No button to open a URL in your default browser; the URL is set by the extension's developer. When the popup is closed, it will only pop up again when you stop using the extension (as in, all MFAs using it are closed), and then start using the extension again.

In built EXEs and Run Application, no changes are made to the display; the update check isn't run, and in fact the code for it isn't even in the built EXEs at all.
For more details, see here.

What does it send to the server?

The updater passes no personal information; only the extension name, version, SDK version, and whether it was built in debug mode or not. (For the paranoid, feel free to check.)

How do I change updater settings?

You can modify how the updater functions to an extent; you can:

  • disable the updater for specific extensions, or all of them (see (here)[https://github.com/SortaCore/MMF2Exts/wiki/DarkEdif-Fusion-user-features#disableupdatecheckfor])
  • disable popups for major updates (see (here)[https://github.com/SortaCore/MMF2Exts/wiki/DarkEdif-Fusion-user-features#msgboxformajorupdate])
  • enable popups for minor updates so you can see the minor update changelog (see (here)[https://github.com/SortaCore/MMF2Exts/wiki/DarkEdif-Fusion-user-features#msgboxforminorupdate])
Clone this wiki locally