ModManager Service

This is the ModManager service, which lets you install packaged modifications (mods) to your DCS server.

Configuration

To activate the ModManager service, you need to add an optional plugin in your main.yaml first like so:

opt_plugins:
  - modmanager

The service itself is configured via yaml. There is an additional plugin to provide Discord commands to operate the service.

DEFAULT:
  SavedGames: '%USERPROFILE%\Documents\ModManager\SavedGames'  # folder to store plugins that should be installed into Saved Games
  RootFolder: '%USERPROFILE%\Documents\ModManager\RootFolder'  # folder to store plugins that should go into the base game directories
DCS.release_server:
  packages:
    - name: Community_A-4E-C    # The community A-4E-C model can be used out of the box with this service
      version: latest           # we will always use the latest available version on disk
      source: SavedGames        # the mod will be placed inside the Saved Games folder structure
      repo: https://github.com/heclak/community-a4e-c  # optional: if specified with "latest", the bot will auto-update your versions from GitHub

“latest” means, that the package with the highest version number will be installed. If a newer package is provided, it will be automatically taken on the next restart of the bot or reload of this plugin.
A strict version number means that this exact version will be installed. If a newer version has been installed manually (e.g. by updating), the bot will not replace the newer version with an older one. A warning will be printed instead.
If using the “repo” parameter, the bot can download any version from this repository. Please keep in mind that an asset has to be attached to the relevant releases in there, containing a zip file that matches the naming pattern

_v.zip, e.g. DCSOlympus_v1.0.3.zip and the packages has to be in the OvGME format. > [!IMPORTANT] > Root packages will be installed into your DCS installation and are active in any instance that you run on this node. > Therefore, you need to define the root packages either in your DEFAULT tag, to make them available on the whole node > or - if you run a multi-node system - you need to define the YAML structure with Node + Instance like so: > ```yaml > DEFAULT: > xx > NodeName: > InstanceName: > packages: > - xxx > ``` > [!NOTE] > On every DCS update (that is performed by the bot!), this plugin will automatically __uninstall__ and __reinstall__ all > packages configured for the "RootFolder", so that after the update, all packages should be up-to-date and re-applied. ### Package Structure All packages must have a strict naming convention, that follows (package_name)_v(version). Packages might be provided either as a directory or as a ZIP file. The structure of the directory / ZIP file must follow the OvGME rules, which means, that the directory structure inside the package must be the same as how the package will be unpacked over either the Saved Games\DCS(...) folder or over the DCS World installation directory. ### Backups Every installed package creates a backup folder. This is stored below the directory provided in the configuration ("SavedGames" or "RootFolder").
The backup will be found in

``` .(instance_name) |_ (package)_v(version) |_install.log |_ ... ``` `install.log` contains a detailed log about every file that has been installed into the DCS World directories.
Besides that, the folder contains all files that are being overwritten by the package on installation for a later restore.