Skip to content

Creating a new mod

Jump to bottom
takatto edited this page Dec 21, 2025 · 3 revisions

How to Create Mods for takattoFS2 Patcher

Creating mods for takattoFS2 Patcher is easy! This guide will walk you through the process step by step, from setting up your mod folder to configuring the necessary files for the patcher.

1. Create a Mod Folder

Start by creating a folder with a name of your choice. This will be the folder where you place all your mod files.

2. Add the info.json File

Inside the folder you created, you need to add a file called info.json. This file contains metadata and configuration for your mod. Here's the structure for info.json:

{
  "name": "string",
  "type": "string",
  "version": "string",
  "description": "string",
  "author": "string",
  "image": "string",
  "download": "string",
  
  "files": [
    "string"
  ]
}

Fields Explained:

  • name: The name of your mod. It should be short, informative, and unique.
  • type: The type of mod you are creating. There are four supported types:
    • "ui": Mods that apply UI files into the game. If this is the type, just include your modded UI files in the folder with the info.json file. No further configuration is needed.
    • "extra": Mods that download and replace files in the game folder. This requires the files field (explained below). Your mod folder structure should mirror the game’s folder structure.
    • "dlc": Similar to "extra", but no tracking is involved, and no files field is required. This type is useful for temporary file replacements.
    • "patch": Similar to "extra", but no files field is needed. Files are replaced at runtime and revert to default after the session ends.
  • version: The version of your mod (e.g., "1.0"). Start with "1.0" and increment with each update.
  • description: A brief description of what your mod does.
  • author: Your unique name for identifying the mod.
  • image: A URL linking to an image of your mod (for preview purposes).
  • download: A URL for downloading your mod. It’s recommended to zip your mod's content and upload it to GitHub, then link to it.

Example for download and image URLs:

The recommended way to host your mod is by zipping the mod content and uploading it to your GitHub repository. Use the following URL format for the image and download links:

  • https://github.com/takattowo/fs2maiden-mods/raw/refs/heads/main/mods/<your_mod_folder>/<your_mod_link>.zip

Example info.json:

{
  "name": "My Custom UI",
  "type": "ui",
  "version": "1.0",
  "description": "A custom user interface mod for better gameplay experience.",
  "author": "JohnDoe",
  "image": "https://github.com/takattowo/fs2maiden-mods/raw/refs/heads/main/mods/my_custom_ui/my_custom_ui_image.jpg",
  "download": "https://github.com/takattowo/fs2maiden-mods/raw/refs/heads/main/mods/my_custom_ui/my_custom_ui.zip",
  "files": []
}

3. Add Mod Files to Your Folder

Your mod folder should look like this:

<your_mod_folder>
  ├── info.json
  └── <your_mod_file>.zip
  • info.json: The configuration file with metadata about your mod.
  • <your_mod_file>.zip: The zip file containing your mod files for the game.

For "ui" Mods:

Just place the modded UI files into the folder alongside info.json. No further configuration is needed.

For "extra" Mods:

  • Your folder structure should mirror the game's folder structure.
  • The files field in info.json should list all the files you wish to add or replace in the game.

Example of files:

"files": [
  "Data/Stage/cubemap/stage00_takatto_cmap_night.png",
  "Data/Stage/data/stage00_katto",
  "Data/Stage/stage00_katto"
]

For the extra type, make sure that these files exist in your mod folder with the same paths as listed in files. If any file is missing, the patcher will ignore the entire mod.

For "dlc" Mods:

This is similar to "extra", but there’s no need to track files, and no files field is required. This type allows you to replace files temporarily without tracking them.

For "patch" Mods:

Like "extra", but again no need to specify files. Files are replaced during runtime and revert after the session ends.

4. Upload to GitHub

Once your mod folder is complete with the info.json and all necessary files, zip the folder and upload it to GitHub. You can use GitHub Pages to host your mod download or simply upload it directly to your repository.

5. Refer to Example Mods

For more guidance on how mods are structured, visit the [mod page on GitHub]. This will give you practical examples of how mods are set up and how the patcher works.

Feel free to reach out on the [GitHub discussions] if you have any questions or need help with creating your mod!

Clone this wiki locally