Documentation

Index page for all documentation currently covered on this site. Includes documentation on current and future mod plans, online versions of in game books, data pack and resource pack formats, along with knowledge for addon developers.

Unless stated otherwise, all documentation pages are applicable to all versions of the mod since 1.16.5. Version specific information will be noted as applicable, or if its significant will be split out into a separate page.

• Table of Contents
  1. Gameplay
  2. Guides
  3. Commands
  4. JSON Format
     1. Data Packs
        1. Tinkers’ Construct
     2. Resource Packs
        1. Mantle
        2. Tinkers’ Construct
  5. Other Documentation

Gameplay

• Tinkers’ Construct 3 Overview: Gives a player focused overview of Tinkers’ Construct 3, which is the mod since Minecraft 1.16.
• Tinkers’ Construct 2 Overview: Gives a player focused overview of Tinkers’ Construct 2, which is the mod from Minecraft 1.8 to 1.12.
• Online Books: Links to online versions of many books from SlimeKnights mods.
• What’s New?: Covers all major changes made to Tinkers’ Construct 3 compared to Tinkers’ Construct 2.
  • Roadmap: Discusses various future plans for our mods, along with current work.
  • Removed Features: Covers features from older versions of Tinkers’ Construct that were removed in the latest versions, along with some reasoning or alternatives.
• Design Docs: Developer docs used to organize, balance, and plan out content in the mod.

Guides

• Gradle Setup: Describes how to add Tinkers’ Construct to a development workspace in Gradle.
• Low Code Mod: Describes how to create a low code mod, which allows making mods and Tinkers’ Construct addons without writing any Java.
• Adding a Material: Describes how to add a material to Tinkers’ Construct in an addon or datapack.
• Adding a Tool Part: Describes how to add a new tool part to Tinkers’ Construct in an addon or low code mod.
• Adding a Tool: Describes how to add a new tool to Tinkers’ Construct in an addon or low code mod.
• Texture Generators: Details how to use the material texture generators provided by Tinkers’ Construct.
• Persistent Inventory Crafting Blocks: Details how to handle the crafting station in mods wanting to do weird things in their crafting recipes (like player access which is not available in vanilla without hacks).

Commands

• Mantle Commands: Documentation for all commands added by Mantle.
• Tinkers’ Construct Commands: Documentation for all commands added by Tinkers’ Construct.
• Discord Commands: Documentation for commands on our discord server. Cannot be run inside Minecraft, simply are informational commands.

JSON Format

The following pages cover pages on general JSON formats, which may be used in data packs, resource packs, or thing packs:

• Basic Types: Common types of fields that occur in various JSON formats.
• Resource Locations: Covers the common resource location format, along with how to use it to locate and modify resources in resource packs and data packs.
• Conditions: Format for JSON condition types added by SlimeKnights mods.
• Ingredients: JSON object representing the input to a recipe, which is able to list all matching entries.
• Predicates: JSON object representing a condition on a part of a JSON component. Unlike ingredients, predicates do not display all matching entries.
• Results: Common result field types, occuring primarily in recipes.
• Json Things support (1.18): Documentation for all block and item types that Tinkers’ Construct adds to Json Things’ “Thing Packs”.

Data Packs

The following pages are specific to data pack formats:

• Tags: Details tags in data packs, including their format, the Forge extensions, convention tags, and notable tags in Tinkers’ Construct.
• Fluid Transfer: JSON format for the Mantle system that allows interacting with fluids in items outside of Forge capabilities.
• Loot Injectors: JSON format for adding new entries to a loot table without needing to override the loot table JSON.
• Recipe Format: Index page for pages on different recipe formats.

Tinkers’ Construct

The following pages cover data pack concepts specific to in Tinkers’ Construct:

• Fluid Effects (1.18): Documentation for defining effects of fluids in various fluid effect modifiers.
• Materials: Documentation for defining materials.
• Material Stat Types (1.16-1.18): List of all stat types available to materials.
• Modifiers (Serializers): Documentation for adding custom modifiers via JSON.
• Modifier Slot Types: Documentation for modifier slot types.
• Station Slot Layouts: JSON defining the arrangement of slots in the tinker station or tinker’s anvil, used for in game documentation about how to craft tools.
• Tool Definitions (1.16-1.18): Format for tool definitions, which define the properties of a tool item.
• Tool Stats: Documentation for all tool stats usable by tools.

Resource Packs

• Models: Documentation for the custom model loaders added by SlimeKnights mods. Applicable anywhere vanilla models are used.

Mantle

• Fluid Textures: JSON format for defining the textures of fluids for Mantle mods.
• Fluid Tooltips: JSON format for defining fluid unit lists for tooltips.
• Resource Colors: Documentation for Mantle’s resource color system, primarily used for tooltip text colors.

Tinkers’ Construct

• Armor Models: Documentation for the model format for modifiable armor from Tinkers’ Construct.

Other Documentation

• Mantle GitHub Wiki: Documentation specific to Mantle, the library mod used by SlimeKnights’ mods. Will eventually be migrated to this website.
• Tinkers’ Construct GitHub Wiki: Documentation for Tinkers’ Construct content, along with general FAQs. Will eventually be migrated to this website.
• Unofficial Alternatives: Mods similar to Tinkers’ Construct on various Minecraft platforms.