🛠️ Idle Reincarnator Modding Guide

Welcome to the official Modding Guide for Idle Reincarnator. This guide will walk you through the steps to create your own mod and add custom content to the game.

Getting started

To start creating a mod and have your mod folder, follow these steps:

1. Launch the game and go to the Mods section.
2. Click Create Mod.
3. Navigate to your mod folder: %APPDATA%/Roaming/my_mods/[Your Mod Name]
4. Start editing the files in this folder to add your content.

Adding content

What game content can you add?

You can add the following action types:

Let's focus on how to to add a custom job first. To create a custom job, create a 'jobs' folder inside your mod folder, and inside the 'jobs' folder, create a 'data.json' file. The 'data.json' file should look like below if you are not adding a new category:

{
  "types": {
  }
}

If you are adding a category, it your data.json should look like this:

{
  "types": {
    "[job_category]": {
      "name": "[Your job category display name]",
      "tab_name": "[The name of the tab in the job buttons]",
      "description": "[description]",
      "lockable": false,
      "requirements": {}
    },
    "[job_category]": {
      "name": "[Your job category display name]",
      "tab_name": "[The name of the tab in the job buttons]",
      "description": "[description]",
      "lockable": false,
      "requirements": {}
    },
    ...
  }
}

The current job categories can be found here.

Afterwards, create folders based on the job_category you defined in your data.json. For example, if you defined a job_category called "test", create a folder called "test" inside the jobs folder.

Inside your job_category folder, create a file called 'content.json'. This file will contain the data for your jobs. Follow the structure below:

{
  "content": {
    "[job_id]": {
      "name": "[Job Name]",
      "description": "[Description]",
      "base_income": [Income],
      "is_passive_income": [Whether income is passive or not],
      "base_exp_req": [Base exp requirement],
      "hidden": [Whether job is hidden],
      "effects": {[Effects]},
      "lockable": [Whether job is lockable],
      "requirements": {[Requirements]}
    },
    "[job_id]": {
      "name": "[Job Name]",
      "description": "[Description]",
      "base_income": [Income],
      "is_passive_income": [Whether income is passive or not],
      "base_exp_req": [Base exp requirement],
      "hidden": [Whether job is hidden],
      "effects": {[Effects]},
      "lockable": [Whether job will be locked after unlock if requirements are not met],
      "requirements": {[Requirements]}
    },
    ...
  }
}

Example: Adding a "Cleaner" Job

Here's a working example of a modded job entry in the content.json:

{
  "content": {
    "cleaner": {
      "name": "Cleaner",
      "description": "Clean the streets of Eldoria.",
      "base_income": 1.9,
      "is_passive_income": false,
      "base_exp_req": 80,
      "hidden": true,
      "effects": {
        "jobs": {
          "content": {
            "common": {
              "content": {
                "cleaner": {
                  "exp_gain": {
                    "scaling_type": "linear",
                    "base": 1,
                    "scaling": 0
                  }
                }
              }
            }
          }
        },
        "skills": {
          "content": {
            "fundamentals": {
              "content": {
                "cleanliness": {
                  "exp_gain": {
                    "scaling_type": "linear",
                    "base": 1,
                    "scaling": 0.2
                  }
                }
              }
            },
            "scavenging": {
              "content": {
                "awareness": {
                  "exp-gain": {
                    "scaling_type": "linear",
                    "base": 1,
                    "scaling": 0.2
                  }
                }
              }
            }
          }
        }
      },
      "lockable": false,
      "requirements": {}
    }
  }
}

For how jobs are made in the base game, you can see them here.

To add an image for your job, create a folder named "images" inside your job category folder and place a .png file in the images folder with the same name as your job ID. You can get image borders that you can use in your images here

Once you are done, your folder structure should look like this:

[Your Mod Folder]/
├── jobs/
│   ├── data.json
│   └── [job_category]/
│       ├── content.json    ← Add your custom job(s) here
│       └── images/
│           └── [job_id].png (image for your job)

Adding more content types

As to how to add other content like trainings, skills, etc. you can see how they are made in the base game here.

⚙️ Effects Reference

Effects modify gameplay in various ways and are grouped into categories. Each effect can have scaling properties to change how it evolves with content levels.

Overall Effects

Example

"effects": {
  "overall": {
    "[effect_name]": {
      "scaling_type": "linear",
      "base": 1000,
      "scaling": 0
    }
  }
}

Action Type, Category, and Specific Effects

Example

#Action-wide Effect
"[action_type]": {
  "[effect_name]": {
    "scaling_type": "linear" // or "logarithmic"/"exponential",
    "base": [A base value],
    "scaling": [scaling factor]
  }
}

#Category-wide Effect
"[action_type]": {
  "content": {
    "[category]": {
      "[effect_name]": {
        "scaling_type": "linear" // or "logarithmic"/"exponential",
        "base": [A base value],
        "scaling": [scaling factor]
      }
    }
  }
}

#Individual action Effect
"[action_type]": {
  "content": {
    "[category]": {
      "content": {
        "[action_name]": {
          "[effect_name]": {
            "scaling_type": "linear" // or "logarithmic"/"exponential",
            "base": [A base value],
            "scaling": [scaling factor]
          }
        }
      }
    }
  }
}

Requirements Structure

Requirements define the conditions for unlocking a content. These are grouped by numeric keys ("0", "1", etc.), where each group represents an OR condition. Within each group, conditions are evaluated by an AND condition. Below are the requirement types:

Overall Requirements

Category Requirements

Individual Action Requirements

Requirements Example

"requirements": {
  "0": {
    "jobs": {
      "noble": {
        "baron": {
          "current_level": 50
        }
      }
    },
    "renown": 5000,
    "gold": 50000
  },
  "1": {
    "explorations": {
      "ancient_crypt": {
        "boss": {
          "max_level": 1
        }
      }
    }
  }
}

Only 1 requirement group must be fulfilled to unlock the item.

📚 Need More Examples?

Check out the game_assets in the modding repo for real content examples used by the base game.

Publishing Your Mod

When you're ready, upload your mod to the Steam Workshop via the in-game mod menu. Just open your mod in the popup and press the Upload button.

Once uploaded, your mod will show in Steam workshop but the visibility is set to private. If you are ready for your mod to be shown to the public, set the visibility to public in the Steam Workshop.