Skip to content
Andre Issa edited this page Feb 9, 2021 · 5 revisions

This is not a tutorial on how to install mods, for that see Installing Mods | The Mods Folder

Advantages
Limitations

This is a page discussing the methods and motivations behind the format and its advantages and limitations
to be expanded upon

Advantages

  1. Base lua files do not need to be overwritten aside from the one import statement
  2. ^ Multiple mods can edit the same base file without needing to be merged
  3. Mods are encouraged to be built in a way that makes them more customisable using standard configs.
  4. Updates will not force mods to update as often (users typically just need to import the mods again and they will still work)
  5. Mods do not need to include all the things that they did not edit from the base
  6. Mods can edit eachother (will be improved and idomatic in the future)
  7. The loader can map sjson, xml, csv files so many of the advantages for lua scripts also apply to that too:
    • Same capabilities as mapping data tables
    • Don't need to include things not edited from the base
    • Mods can edit eachother
    • Re-installation is simple (but not as simple as for lua files)

Limitations

There are limitations to this format:

  1. It is not possible to delete specific hook calls from the base files or other mod files without heuristics
  2. Not all file types are mergeable yet

It remains a priority to eliminate/mitigate them as soon as possible