Mod-Archive

The Mod-Archive is, so to say, only a zipped version of a valid Directory-Mod. However, because OvGME needs to correctly align mod file tree with root folder file tree and deduct where to seek for data, a valid Mod-Archive must follow some simple rules. If these rules are not respected, the zip file will not be seen as Mod-Archive.

- The zip file MUST be compressed in ZIP format.
  For now, OvGME only supports compressed file in standard ZIP format.
- The zip file MUST contain a properly named contner-folder at its root.
  The zip archive root must contain the contner-folder (and not directly the mod files). Also, this folder must have the same name as the archive itself but without the .zip extension. For example, if you have a mod archive named "My Super Mod.zip", it must contain the contner-folder named "My Super Mod" where mod files are stored. This is because OvGME can't guess which folder into the zip archive must be considered as the root folder and because Mod-Archives can include some other files than only the modified root folder files, it seek for a folder named exactly according the zip file name itself. This is a convention.
- The zip file can optionally contain a description file.
  OvGME automatically checks if a properly named .txt file exists at root of the zip file. If this .txt file is named "description.txt", "readme.txt" or has the same exact name as the mod root folder or zip file itself (but with .txt extension instead of .zip extension), it will take it as the mod description. This file must be a standard ASCII .txt file, OvGME does not currently support rich format.
- The zip file can optionally contain a version file.
  OvGME automatically checks if a properly named "version.txt" file exists at root of the zip file. If this file exists, it will be considered as the version string for this mod. This file must be a standard ASCII .txt file and the version string should follow the format as described in the mod versioning chapter.

For example, if the destination root file tree is the following:

> 📁 MyGame
> 📁 Textures
> 📁 Landscape
> 📄 picture1.dds
> 📄 picture2.dds
> 📁 Vehicles
> 📄 picture1.dds
> 📄 picture2.dds

And if your mod consist of changing some .dds texture files in "MyGame\Textures\Vehicles" your Mod-Archive zip file should be structured as follow:

> 📂 My Texture Mod.zip
> {
> 📄 README.txt (optional)
> 📄 VERSION.txt (optional)
> 📁 My Texture Mod
> 📁 Textures
> 📁 Vehicles
> 📄 picture1.dds
> 📄 picture2.dds
> }

Then, the "My Texture Mod.zip" file must be copier in the mods folder for this configuration or imported using the import function.
Note: To create a Mod-Archive, you also can use the tool provided by OvGME, which generates for you the correct zip file with proper structure from an existing Directory-Mod folder (See the Mods creation chapter).