diff --git a/README.md b/README.md index eb466c9..57aa08d 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,14 @@ This interface was initially designed for Bethesda games such as the Elder Scrol 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 `.ini` file or a very simple python class. +providing a very simple python class. ## How to install? -Download [the archive](https://github.com/ModOrganizer2/modorganizer-basic_games/archive/master.zip) -and extract it directly into your MO2 `plugins` folder. +Download the archive for your MO2 version and extract it directly into your MO2 `plugins` folder. + +- [Download for 2.3.2](https://github.com/ModOrganizer2/modorganizer-basic_games/archive/v2.3.x.zip) +- [Download for 2.4.x (dev-build)](https://github.com/ModOrganizer2/modorganizer-basic_games/archive/master.zip) **Important:** Extract the *folder* in your `plugins` folder, not the individual files. Your `plugins` folder should look like this: @@ -23,7 +25,7 @@ and extract it directly into your MO2 `plugins` folder. dlls/ plugins/ data/ - modorganizer-basic_games-master/ + modorganizer-basic_games-xxx/ games/ __init__.py ... @@ -35,60 +37,31 @@ plugins/ ModOrganizer.exe ``` -You can rename `modorganizer-basic_games-master` to whatever you want (e.g., `basic_games`). - -**Note:** You can also clone this repository in your `plugins/` folder: -``` -cd $MO2_PATH/plugins -git clone https://github.com/ModOrganizer2/modorganizer-basic_games basic_games -``` +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](https://store.steampowered.com/app/250900/The_Binding_of_Isaac_Rebirth/) |[EzioTheDeadPoet](https://github.com/EzioTheDeadPoet)|[game_thebindingofisaacrebirth.py](games/game_thebindingofisaacrebirth.py)|| -| [Dark Messiah of Might & Magic](https://store.steampowered.com/app/2100/Dark_Messiah_of_Might__Magic/) | Holt59 | [game_darkmessiah[...].py](games/game_darkmessiahofmightandmagic.py) | | -| [Darkest Dungeon](https://store.steampowered.com/app/262060/Darkest_Dungeon/) | [erri120](https://github.com/erri120) | [game_darkestdungeon.py](games/game_darkestdungeon.py) | | -| [Dungeon Siege II](https://store.steampowered.com/app/39200/Dungeon_Siege_II/) | Holt59 | [game_dungeonsiege2.py](games/game_dungeonsiege2.py) | | -|[Mirror's Edge](https://www.gog.com/game/mirrors_edge)|[EzioTheDeadPoet](https://github.com/EzioTheDeadPoet)|[game_mirrorsedge.py](games/game_mirrorsedge.py)|| -| [Mount & Blade II: Bannerlord](https://store.steampowered.com/app/261550/Mount__Blade_II_Bannerlord/) | Holt59 | | | -| [S.T.A.L.K.E.R. Anomaly](https://www.stalker-anomaly.com/) | [Qudix](https://github.com/Qudix) | [game_stalkeranomaly.py](games/game_stalkeranomaly.py) | | -| [Stardew Valley](https://store.steampowered.com/app/413150/Stardew_Valley/) | [Syer10](https://github.com/Syer10), Holt59 | [game_stardewvalley.py](games/game_stardewvalley.py) | | -| [The Witcher 3: Wild Hunt](https://store.steampowered.com/app/292030/The_Witcher_3_Wild_Hunt/) | Holt59 | [game_witcher3.py](games/game_witcher3.py) | | -| [Zeus and Poseidon](https://store.steampowered.com/app/566050/Zeus__Poseidon/) | Holt59 | [game_zeusandpoiseidon.py](games/game_zeusandpoiseidon.py) | | +|[The Binding of Isaac:Rebirth](https://store.steampowered.com/app/250900/The_Binding_of_Isaac_Rebirth/) |[EzioTheDeadPoet](https://github.com/EzioTheDeadPoet)|[game_thebindingofisaacrebirth.py](games/game_thebindingofisaacrebirth.py)|| +| [Darkest Dungeon](https://store.steampowered.com/app/262060/Darkest_Dungeon/) | [erri120](https://github.com/erri120) | [game_darkestdungeon.py](games/game_darkestdungeon.py) | | +| [Dark Messiah of Might & Magic](https://store.steampowered.com/app/2100/Dark_Messiah_of_Might__Magic/) | [Holt59](https://github.com/holt59/) | [game_darkmessiah[...].py](games/game_darkmessiahofmightandmagic.py) | | +| [Dark Souls](https://store.steampowered.com/app/211420/DARK_SOULS_Prepare_To_Die_Edition/) | [Holt59](https://github.com/holt59/) | [game_darkestdungeon.py](games/game_darkestdungeon.py) | | +| [Dungeon Siege II](https://store.steampowered.com/app/39200/Dungeon_Siege_II/) | [Holt59](https://github.com/holt59/) | [game_dungeonsiege2.py](games/game_dungeonsiege2.py) | | +|[Mirror's Edge](https://www.gog.com/game/mirrors_edge)|[EzioTheDeadPoet](https://github.com/EzioTheDeadPoet)|[game_mirrorsedge.py](games/game_mirrorsedge.py)| | +| [Mount & Blade II: Bannerlord](https://store.steampowered.com/app/261550/Mount__Blade_II_Bannerlord/) | [Holt59](https://github.com/holt59/) | | | +| [S.T.A.L.K.E.R. Anomaly](https://www.stalker-anomaly.com/) | [Qudix](https://github.com/Qudix) | [game_stalkeranomaly.py](games/game_stalkeranomaly.py) | | +| [Stardew Valley](https://store.steampowered.com/app/413150/Stardew_Valley/) | [Syer10](https://github.com/Syer10), [Holt59](https://github.com/holt59/) | [game_stardewvalley.py](games/game_stardewvalley.py) | | +| [The Witcher 3: Wild Hunt](https://store.steampowered.com/app/292030/The_Witcher_3_Wild_Hunt/) | [Holt59](https://github.com/holt59/) | [game_witcher3.py](games/game_witcher3.py) | | +| [Zeus and Poseidon](https://store.steampowered.com/app/566050/Zeus__Poseidon/) | [Holt59](https://github.com/holt59/) | [game_zeusandpoiseidon.py](games/game_zeusandpoiseidon.py) | | ## How to add a new game? -You can create a plugin by providing a python class or a `.ini` file in the `games` -folder. +You can create a plugin by providing a python classin 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. -### Using a `.ini` file - -You simply need to createa your `game_XX.ini` file in the `games` folder with the following -content (see below for the full list of supported attributes): - -```ini -[DEFAULT] -# Plugin details - this is the name of the plugin, not the name of the game! -Name=Witcher 3 Support Plugin -Author=Holt59 -Version=1.0.0 - -# Game details: -GameName=The Witcher 3 -GameShortName=witcher3 -GameBinary=bin/x64/witcher3.exe -GameDataPath=mods -GameSaveExtension=sav -GameSteamId=292030 -``` - -### Using a Python 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](games/game_witcher3.py)): @@ -150,25 +123,25 @@ class Witcher3Game(BasicGame): If the column `Ini` is empty, it means it only accepts a basic string. -| Name | Description | `IPluginGame` method | Python | Ini | -|------|-------------|----------------------|--------|-----| -| 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` | `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 | 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` | | -| 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` | | +| 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` | +| 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` | You can use the following variables for `str`: @@ -191,4 +164,3 @@ Game IDs can be found here: - For Steam on [Steam Database](https://steamdb.info/) - For GOG on [GOG Database](https://www.gogdb.org/) -