modorganizer-basic_games/README.md

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?

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
Need for Speed: High Stakes	uwx	game_nfshs.py
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)
Test Drive Unlimited	uwx	game_tdu.py
Test Drive Unlimited 2 — STEAM	uwx	game_tdu2.py
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
Tony Hawk's Pro Skater 3	uwx	game_thps3.py
Tony Hawk's Pro Skater 4	uwx	game_thps4.py
Tony Hawk's Underground	uwx	game_thug.py
Tony Hawk's Underground 2	uwx	game_thug2.py
Trackmania United Forever — STEAM	uwx	game_tmuf.py
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?

See CONTRIBUTING.