Mod Organizer 2 - Simple Games Plugin

Mod Organizer 2 meta-plugin to make creating game plugins easier and faster.

Why?

In order to create a MO2 game plugin, one must implement the IPluginGame interface. This interface was initially designed for Bethesda games such as the Elder Scrolls or Fallout series and thus contains a lot of things that are irrelevant for most games.

The goal of this meta-plugin is to allow creating game plugins for "basic" games by providing a very simple python class.

How to install?

Download the archive for your MO2 version and extract it directly into your MO2 plugins folder.

Mod Organizer 2.3.2: Download and extract in your plugins/ folder (see below).
Mod Organizer 2.4: Basic games is included in Mod Organizer 2.4.
- If you want to use new game plugins that have not been included in the release, download the latest archive and extract the files in the existing basic_games folder, overwriting existing files.

Important: Extract the folder in your plugins folder, not the individual files. Your plugins folder should look like this:

dlls/
plugins/
  data/
  basic_games/
    games/
      __init__.py
      ...
    __init__.py
    basic_game.py
    ...
  bsa_extractor.dll
  ...
ModOrganizer.exe

You can rename modorganizer-basic_games-xxx to whatever you want (e.g., basic_games).

Supported games

Game	Author	File	Extras
The Binding of Isaac: Rebirth — STEAM	EzioTheDeadPoet	game_thebindingofisaacrebirth.py	profile specific ini file
Control — STEAM / GOG / EGS	Zash	game_control.py
Darkest Dungeon — GOG / STEAM	erri120	game_darkestdungeon.py	save slot parsing mod data checker
Dark Messiah of Might & Magic — STEAM	Holt59	game_darkmessiahofmightandmagic.py	save game preview
Dark Souls — STEAM	Holt59	game_darksouls.py
Divinity: Original Sin (Classic) — STEAM	LostDragonist	game_divinityoriginalsin.py	save game preview
Divinity: Original Sin (Enhanced Edition) — STEAM	LostDragonist	game_divinityoriginalsinee.py	save game preview mod data checker
Dragon's Dogma: Dark Arisen — GOG / STEAM	EzioTheDeadPoet	game_dragonsdogmadarkarisen.py
Dungeon Siege II — GOG / STEAM	Holt59	game_dungeonsiege2.py	mod data checker
Kingdom Come: Deliverance — GOG / STEAM / Epic	Silencer711	game_kingdomcomedeliverance.py	profile specific cfg files
METAL GEAR SOLID 2: Sons of Liberty — STEAM	AkiraJkr	game_metalgearsolid2mc.py
METAL GEAR SOLID 3: Snake Eater — STEAM	AkiraJkr	game_metalgearsolid3mc.py
Mirror's Edge — GOG / STEAM	EzioTheDeadPoet	game_mirrorsedge.py
Mount & Blade II: Bannerlord — GOG / STEAM	Holt59	game_mountandblade2.py	mod data checker
No Man's Sky - GOG / Steam	EzioTheDeadPoet	game_nomanssky.py
S.T.A.L.K.E.R. Anomaly — MOD	Qudix	game_stalkeranomaly.py	mod data checker
Stardew Valley — GOG / STEAM	Syer10, Holt59	game_stardewvalley.py	mod data checker
STAR WARS™ Empire at War: Gold Pack - GOG / STEAM	erri120	Empire at War: game_starwars-empire-at-war.py Force of Corruption: game_starwars-empire-at-war-foc.py
Subnautica — STEAM / Epic	dekart811, Zash	game_subnautica.py	mod data checker save game preview
Subnautica: Below Zero — STEAM	dekart811, Zash	game_subnautica-below-zero.py	mod data checker save game preview
Train Simulator Classic — STEAM	Ryan Young	game_trainsimulator.py
Valheim — STEAM	Zash	game_valheim.py	mod data checker overwrite config sync save game support (no preview)
The Witcher: Enhanced Edition - GOG / STEAM	erri120	game_witcher1.py	save game parsing (no preview)
The Witcher 3: Wild Hunt — GOG / STEAM	Holt59	game_witcher3.py	save game preview
Yu-Gi-Oh! Master Duel — STEAM	The Conceptionist & uwx	game_masterduel.py
Zeus and Poseidon — GOG / STEAM	Holt59	game_zeusandpoiseidon.py	mod data checker

How to add a new game?

You can create a plugin by providing a python class in the games folder.

Note: If your game plugin does not load properly, you should set the log level to debug and look at the mo_interface.log file.

You need to create a class that inherits BasicGame and put it in a game_XX.py in games. Below is an example for The Witcher 3 (see also games/game_witcher3.py):

from PyQt6.QtCore import QDir
from ..basic_game import BasicGame


class Witcher3Game(BasicGame):

    Name = "Witcher 3 Support Plugin"
    Author = "Holt59"
    Version = "1.0.0a"

    GameName = "The Witcher 3"
    GameShortName = "witcher3"
    GameBinary = "bin/x64/witcher3.exe"
    GameDataPath = "Mods"
    GameSaveExtension = "sav"
    GameSteamId = 292030

    def savesDirectory(self):
        return QDir(self.documentsDirectory().absoluteFilePath("gamesaves"))

BasicGame inherits IPluginGame so you can override methods if you need to. Each attribute you provide corresponds to a method (e.g., Version corresponds to the version method, see the table below). If you override the method, you do not have to provide the attribute:

from PyQt6.QtCore import QDir
from ..basic_game import BasicGame

import mobase


class Witcher3Game(BasicGame):

    Name = "Witcher 3 Support Plugin"
    Author = "Holt59"

    GameName = "The Witcher 3"
    GameShortName = "witcher3"
    GameBinary = "bin/x64/witcher3.exe"
    GameDataPath = "Mods"
    GameSaveExtension = "sav"
    GameSteamId = 292030

    def version(self):
        # Don't forget to import mobase!
        return mobase.VersionInfo(1, 0, 0, mobase.ReleaseType.final)

    def savesDirectory(self):
        return QDir(self.documentsDirectory().absoluteFilePath("gamesaves"))

List of valid keys

Name	Description	`IPluginGame` method	Python
Name	Name of the plugin	`name`	`str`
Author	Author of the plugin	`author`	`str`
Version	Version of the plugin	`version`	`str` or `mobase.VersionInfo`
Description	Description (Optional)	`description`	`str`
GameName	Name of the game, as displayed by MO2	`gameName`	`str`
GameShortName	Short name of the game	`gameShortName`	`str`
GameNexusName	Nexus name of the game (Optional, default to `GameShortName`)	`gameNexusName`	`str`
GameValidShortNames	Other valid short names (Optional)	`validShortNames`	`List[str]` or comma-separated list of values
GameNexusId	Nexus ID of the game (Optional)	`nexusGameID`	`str` or `int`
GameBinary	Name of the game executable, relative to the game path	`binaryName`	`str`
GameLauncher	Name of the game launcher, relative to the game path (Optional)	`getLauncherName`	`str`
GameDataPath	Name of the folder containing mods, relative to game folder	`dataDirectory`
GameDocumentsDirectory	Documents directory (Optional)	`documentsDirectory`	`str` or `QDir`
GameIniFiles	Config files in documents, for profile specific config (Optional)	`iniFiles`	`str` or `List[str]`
GameSavesDirectory	Directory containing saves (Optional, default to `GameDocumentsDirectory`)	`savesDirectory`	`str` or `QDir`
GameSaveExtension	Save file extension (Optional) `savegameExtension`	`str`
GameSteamId	Steam ID of the game (Optional)	`steamAPPId`	`List[str]` or `str` or `int`
GameGogId	GOG ID of the game (Optional)	`gogAPPId`	`List[str]` or `str` or `int`
GameOriginManifestIds	Origin Manifest ID of the game (Optional)	`originManifestIds`	`List[str]` or `str`
GameOriginWatcherExecutables	Executables to watch for Origin DRM (Optional)	`originWatcherExecutables`	`List[str]` or `str`
GameEpicId	Epic ID (`AppName`) of the game (Optional)	`epicAPPId`	`List[str]` or `str`
GameEaDesktopId	EA Desktop ID of the game (Optional)	`eaDesktopContentId`	`List[str]` or `str` or `int`

You can use the following variables for str:

%DOCUMENTS% will be replaced by the standard Documents folder.
%GAME_PATH% will be replaced by the path to the game folder.
%GAME_DOCUMENTS% will be replaced by the value of GameDocumentsDirectory.

Extra features

The meta-plugin provides some useful extra feature:

Automatic Steam, GOG, Origin, Epic Games and EA Desktop detection: If you provide Steam, GOG, Origin or Epic IDs for the game (via GameSteamId, GameGogId, GameOriginManifestIds, GameEpicId or GameEaDesktopId), the game will be listed in the list of available games when creating a new MO2 instance (if the game is installed via Steam, GOG, Origin, Epic Games / Legendary or EA Desktop).
Basic save game preview / metadata (Python): If you can easily obtain a picture (file) and/or metadata (like from json) for any saves, you can provide basic save-game preview by using the BasicGameSaveGameInfo. See games/game_witcher3.py and games/game_bladeandsorcery.py for more details.
Basic local save games (Python): profile specific save games, as in games/game_valheim.py.
Basic mod data checker (Python): Check and fix different mod archive layouts for an automatic installation with the proper file structure, using simple (glob) patterns via BasicModDataChecker. See games/game_valheim.py and game_subnautica.py for an example.

Game IDs can be found here:

For Steam on Steam Database
For GOG on GOG Database
For Origin from C:\ProgramData\Origin\LocalContent (.mfst files)
For Epic Games (AppName) from:
- C:\ProgramData\Epic\EpicGamesLauncher\Data\Manifests\ (.item files)
- or: C:\ProgramData\Epic\EpicGamesLauncher\UnrealEngineLauncher\LauncherInstalled.dat
For Legendary (alt. Epic launcher) via command legendary list-games or from: %USERPROFILE%\.config\legendary\installed.json
For EA Desktop from <EA Games install location>\<game title>\__Installer\installerdata.xml

Contribute

We recommend using a dedicated Python environment to write a new basic game plugins.

Install the required version of Python --- Currently Python 3.11 (MO2 2.5).
Remove the repository at ${MO2_INSTALL}/plugins/basic_games.
Clone this repository at the location of the old plugin ( ${MO2_INSTALL}/plugins/basic_games).
Place yourself inside the cloned folder and:

# create a virtual environment (recommended)
py -3.11 -m venv .\venv
.\venv\scripts\Activate.ps1

# "install" poetry and the development package
pip install poetry
poetry install

AkiraJkr/modorganizer-basic_games