Options - bcssov/ironymodmanager GitHub Wiki

2021-02-19_20-13-30

Language

Allows you to change the application language.

Actions

Allows you to perform the following:

  • Open DLC Manager (see DLC Manager for more info)
  • Open Irony wiki page in the browser
  • Open Irony logs directory in file explorer (ex. windows explorer)
  • Open Selected game error.log in default text editor

Game

Allows you to change to the game.

Options

Allows you to set game specific and global application options. See options screen for more info.

Themes

Allows you to select one of the available application themes.

DLC Manager

By toggling this actions option will open the DLC Manager screen where you can either check or uncheck a DLC. To apply settings press the close button.

Options screen

2021-02-19_20-17-25

Game Options

  • Configure all

This option raises the folder browse dialog and if you point it towards your game installation directory Irony should figure out automatically:

  1. Executable path
  2. Data directory path (ex. Documents\Paradox Interactive\Stellaris)
  3. Executable launch arguments

NOTE: Ensure that you point towards root game install directory ex. ..\steamapps\common\Stellaris

  • Game executable

Specify which executable Irony will run when launch game option is clicked

  • Game args

Set any additional executable parameters you'd like Irony to send to the game executable

  • Data directory

Root game data directory where the game holds its settings, mods etc. An example would be for Stellaris: Documents\Paradox Interactive\Stellaris

  • Custom mod directory

If this option is set Irony will use this as an additional folder from where it will look for mods. If set it'll also use this folder to create merged mods and patch mods.

  • Refresh descriptors before playing

Irony will delete and recreate all descriptors before launching the game

  • Close After Launching Game

If disabled Irony will not shut itself down after you launch the game using Irony.

External Editor Options

This option is used in Conflict Solver which allows you to specify an external diff compare editor which you can launch using the context menu on the Irony virtual definition.

  • Editor Executable

The patch to the binary of the external diff editor (ex. winmerge.exe)

  • Editor Args

Arguments that Irony will send to the external diff editor

NOTE: You can share your external editor args with others here

Conflict Solver Options

  • Allowed languages

These toggles allow you to prevent Irony from parsing certain languages that you don't support. If you only play the game using English localization you don't want Irony parsing German localization files for example. These options are global.

  • New Diff Viewer Colors

Allows customization of new diff viewer colors.

Mod Merge Options

  • Mod Template

Allows customization of the naming format when compress merge is performed. Must contain {Name} and {Merged} formatting tags.

  • Collection Template

Allows customization of the naming format when merged collection name is generated. Must contain {Name} and {Merged} formatting tags.

Update Options

  • Check for updates at startup

Irony will at each app run check for available updates and notify you if there are any.

  • Update to prerelease versions

This will allow you to either just download stable releases or to update to latest alpha\beta\rc\stable releases.

  • Download and install

If an update is available this option will initiate download and installation process.

How to update and how does it work

At first run you'll be greeted by this message (only once):

update_check

If you allow the prompt or if you do a manual update check it'll connect to this feed: https://bcssov.github.io/IronyModManager/appcast.xml.

This is a simple xml holding all the download links and info about available updates. In short a simple GET request is performed at the mentioned address. If you selected yes at the initial prompt Irony will automatically at each app start check for updates. You can always turn it off in the options screen.

If there are updates available you should see something like this:

updates_available

Toggling install updates Irony will connect to the Irony GitHub releases page and download the appropriate release package for your OS. And in case of Windows either a portable or installer version (depending on what you initially downloaded and installed). Irony will proceed and download the package to %appdata%\Mario\IronyModManager-Updates. It'll verify the downloaded archive signature to make sure it was downloaded correctly and then do one of the following:

  1. Porbable installation -> Irony will unpack the zip and run a console updater app. The console updater app will wait for 5 seconds before proceeding with the update (to allow Irony process to stop). It'll then copy all the downloaded files into the install folder and re-run Irony and console app will shut itself down. For OSX\Linux users it'll hopefully successfully set proper chmod +X permissions.

  2. Installer installation -> Irony will unpack the zip and run the setup installer and that's done.

The downloaded files will remain there for about 3 days before Irony will delete them.