Options
All
  • Public
  • Public/Protected
  • All
Menu

Module install/advanced

This module provides a ready-to-use "advanced" installer, designed mostly for use with UE4 games.

In particular, this installer allows for interactive user selection during files of what files/variants to install, as well as being highly configurable so that game-specific behaviour can be handled without having to reinvent the wheel.

Import types from this module using

import { AdvancedInstallerBuilder } from 'vortex-ext-common/install/advanced'

Index

Enumerations

Classes

Interfaces

Type aliases

Functions

Type aliases

CompatibilityTest

CompatibilityTest: { message: string; shortMessage: string; test: (files: string[], destinationPath: string) => CompatibilityResult }

A simple type for testing the compatibility of an in-progress installer, useful for catching errors that can only be picked up during install, or which can be corrected automatically.

Type declaration

InstallSupportedTest

InstallSupportedTest: (files: string[], gameId: string, state: IState) => Promise<ISupportedResult>

A test to determine if an installer supports a given file installation.

Type declaration

    • (files: string[], gameId: string, state: IState): Promise<ISupportedResult>

    • Parameters

      • files: string[]
      • gameId: string
      • state: IState

      Returns Promise<ISupportedResult>

InstructionExtender

InstructionExtender: (instructions: IInstruction[], files: string[], modName: string) => PromiseLike<IInstruction[]>

An instruction extender can be used to add instructions to a mod during the install process. These can be additional files or attributes.

param

This will include the compiled instructions for only the files chosen by the user.

param

This will be all the files passed to the installer.

param

The current mod name.

Type declaration

    • (instructions: IInstruction[], files: string[], modName: string): PromiseLike<IInstruction[]>

    • Parameters

      • instructions: IInstruction[]
      • files: string[]
      • modName: string

      Returns PromiseLike<IInstruction[]>

Functions

addInstalledPaksAttribute

  • A convenience function to create an extender that will add the file names of all files of a specific extension being installed. This will add them to the installedPaks attribute as an array of the source instruction.

    Parameters

    • fileExt: string = '.pak'

      The mod file extension (including leading period)

    Returns InstructionExtender

Generated using TypeDoc