Skip to content

Mod File Format

Crauzer edited this page Jan 3, 2020 · 6 revisions

Mod File Format

All Mods should be stored in a .zip file using the following structure:

├── zipName.zip
│   ├── RAW
|   |   ├── ASSETS
|   |   |   ├── Maps
|   |   |   |   ├── skyboxes
|   |   |   |   |   ├── riots_sru_skybox.dds
│   ├── WAD   
|   |   ├── Map11.wad.client
|   |   |   ├── ASSETS
|   |   |   |   ├── Maps
|   |   |   |   |   ├── skyboxes
|   |   |   |   |   |   ├── riots_sru_skybox.dds
│   ├── META
|   |   |── info.json
|   |   ├── image.png

RAW Folder

This is used to store raw files for the mod installer. There is no special wad placement here. The software detects which WAD files it needs to edit in order to install the files.

Do not place new files into this folder as the software won't be able to know in which WAD they belong

Please do not use this folder when creating fresh new mods. This mod is to help port older mods to current League. You should almost always use WAD files for best performance and mod size


WAD Folder

The best way to store files in a mod archive is the same way as they are stored in the League folder. You create a folder with the same name as the WAD file you want to edit. In that folder you will place the files that should belong to that WAD file.

Instead of creating a folder with a WAD file name you can also just create a WAD file with that name with all the modded files in it.

Remember that Fantome asks you to select a WAD folder because the WAD folder in the ZIP can contain as many WAD folders or files as there are in the game


META Folder

This folder is used to store metadata about the mod.

info.json

Used to store general information about the mod.

Format:

{
  "Name": "Snow Rift",
  "Author": "Crauzer",
  "Version": "1.0.0",
  "Description": "Snow skin for Summoners Rift"
}

Please note that, Fantome for example, serializes and deserializes the Version property into a Version class using a VersionConverter. This is due to the fact that serializing the class without it results in the JSON writer writing the property as a class and not a string.

image.png (optional)

Image that can be displayed to identify the mod.

Clone this wiki locally