Skip to content

minecraft resource packs but for teardown

License

Notifications You must be signed in to change notification settings

Tresquel/teardown_patcher

Repository files navigation

Teardown patcher

Makes modifying game files easy

screenshot

How does it work?

It takes all the files inside a zip file and copies them into the Teardown folder while also keeping a backup of the original files.

Console arguments

  • --launch | -l
    • Launches the game thru Steam
  • --patch | -p
    • Patches the game with the mods provided in the ./mods folder
  • --restore | -r
    • Restores base game files
  • --list | -L
    • Lists all mods and their info
  • --help | -h
    • Displays the help page
  • --version | -v
    • Displays the version currently running

How do I make my mod work with this?

You need a manifest.toml file inside of the zip file that looks like this:

name = "Name of the mod"
description = "The description"
author = "Author(s)"
ignore = ["README.md", "data/ignore.this"] # optional

Your zip file should also imitate Teardown's folder structure, so for example if you're making a mod that replaces the splash.lua file in the /data/ui folder, your zip file should look like this:

my_mod:
    - data
        - ui
            - splash.lua
    - manifest.toml

I also included a sample mod if you need it

Contributing

All contributions are welcome, just make an issue before making your changes.