Changes between Version 1 and Version 2 of Internals


Ignore:
Timestamp:
03/05/09 14:57:15 (17 years ago)
Author:
Henrik Heimbuerger
Comment:

wrote installer section

Legend:

Unmodified
Added
Removed
Modified

  • Internals

    v1 v2  
    1 Coming soon.
     1= Internals =
     2
     3== MDL files ==
     4
     5== The dialogs variable ==
     6
     7== The installer ==
     8
     9The installer has been created using the excellent [http://nsis.sourceforge.net/ Nullsoft Scriptable Install System], a free and open-source installer creator. The definition files are all [source:/trunk/ in the repository], the only external part required to build the installer is the [http://nsis.sourceforge.net/FindProcDLL_plug-in !FindProc plug-in], which is [source:/trunk/FindProc/ also in the repository].
     10
     11When running the installer, it goes through the following steps:
     12
     13 1. Giving a basic introduction and allowing the user to choose the components to install.
     14 2. Making sure Allegiance is not currently running.
     15 3. Presenting the user with the customization dialog.
     16 4. Determining where Allegiance is installed using the registry key.
     17 5. Letting the user confirm the detection was successful.
     18 6. Preparing the uninstaller.
     19 7. Creating a backup of the files it is going to overwrite in `%Alleg%\artwork\mods\CortUI\Backup <date>`.
     20 8. Installing all the CortUI-specific files to `%Alleg%\artwork\mods\CortUI\`. Overwriting all the modified files in `%Alleg%\artwork\`.
     21 9. Writing the basic `cortui_settings.mdl` to `%Alleg%`. Opening it and modifying the values to those chosen by the user in step 3.
     22 10. Finishing the installation and suggesting to read the release notes.
     23
     24The `cortui_settings.mdl` is the only file the installer is ever going to edit. All other files are either copied or not, depending on the choices the user has made in the customization dialog. All HUDs are always installed, even if the user doesn't select them. That way, they can still be switched later on through changes in the `cortui_settings.mdl`.
     25
     26The uninstaller does not actually revert anything. It just deletes files specific to CortUI and replaces files with special 'stock' versions included in the uninstaller. This is somewhat unstable, e.g. if the stock files change in between CortUI releases, and should eventually be looked into.