TR Tools Modding API (BETA)

INSTALLATION

• []Make sure BepinEx 6 is installed.

  []Extract the entire “TRTools.zip” into the “Dinkum/BepinEx/plugins” folder so that inside the plugins folder there is a “TR Tools” folder and within that is the dll and other files.

  []Do not delete the “item_icons” folder. Do not rename the “TR Tools” folder.

  []WE HAVE DETAILED DOCUMENTATION AND INSTRUCTIONS FOR BOTH MOD USERS AND MOD DEVELOPERS. READ IT THOROUGHLY BEFORE ASKING QUESTIONS.

FEATURES FOR EVERYONE

• []Mod Update Checker: Easily check for updates to your mods from the main menu.

  []Quick Item Design: Create your own custom clothing, path, wallpaper, or flooring items easily. No coding required!

  []Better Inventory Icons: Furniture, clothing, flooring and wallpaper items now use real icons that look like the item itself.

  []Automatic Save Backup: Backs up your save file every time you sleep. (Can be disabled)

FEATURES FOR MOD CREATORS

• []Custom Items: Create your own items of almost any type using asset bundles, or create some types of items more quickly using the Quick Item system.

  []Custom Licenses: Create licenses to lock your features behind player progression.

  []Chat Commands: Add your own custom chat commands.

  []Custom Save Data: Save and load your own mod data on a per-slot or global basis.

  []Load Custom Assets: Easily load custom textures and asset bundles.

  []Custom Icon Packs: Create your own item icons to replace existing ones just by replacing one of the files in the item_icons folder.

Get detailed instructions on how to create and/or use any TR Tools feature.

Roadmap (Planned Features)

Read about our plans, and comment on them with your suggestions or requests.

Full Modlist

A list of all known mods that have TR Tools as a prerequisite.

Support (Discord)

We are active in the Dinkum discord server. Look for the TR Tools threads in both the #modding_space and #modding_dev channels.

• []TR Tools Modding API (Mod update checker and modding framework)

  []Craft From Storage (Makes crafting stations and shops, and cooking stations use materials from nearby storage)

  []Time Management (Control the flow of time, pause time in the journal, and get notifications when stores open/close)

  []Inventory Management (Send items to nearby chests and auto-sort your inventory/chests)

  []Improved Minimap (Biome indicator, animal markers, zoom in/out, or toggle minimap visibility)

  []Held Interactions (Much easier use of machines and other interactions)

  []Infinite Wheelbarrow (Makes the wheelbarrow infinite both when putting dirt in or taking dirt out)

  []Better Movement & Vehicles (Improves tile selection and vehicle handling)

• Save Backup Manager (Automatically creates a backup of your save when going to sleep)