Research

Schema: Research Branch

Fields

Example JSON

Example path: <namespace>/researches/<branch-id>.json

Field	Type	Default value	Description
branch-name	String	com.<namespace>.research.<path>.name	The displayed name of the branch, presented to the user. May be a translation key.
branch-type	String	default	An override for more specialized research branches. For now, unlockables disables research level checks. Otherwise, sets to default behavior.
subtitle	String		A subtitle for the branch, displayed when hovering over the research in the GUI. May be a translation key.
sortOrder	Integer	1	Controls the vertical position of the branch on the University GUI. Lower numbers are placed first on the list, while higher numbers are placed closer to the bottom of the list.
hidden	Boolean	false	If true, and if all primary researches on the branch are hidden, prevents access to the branch from the University window.
remove	String, Boolean		Removes a research, regardless of the source. May cause data loss if applied to an existing world. String: Removes all research with a branch of the Resource Location in that String. Boolean (true): Removes all Researches with branches matching the Resource Location of the JSON itself; this form is discouraged for cases where other data packs may apply, as it may be conflicted by those other data packs.

* = Required field

{
    "branch-name": "Expansion",
    "branch-type": "default",
    "subtitle": "Expanding beyond one city",
    "sortOrder": 3,
    "hidden": true,
    "remove": true
}

Schema: Research

Fields

Example JSON

Example path: <namespace>/researches/<branch>/<research-id>.json

Field	Type	Default value	Description
name	String	com.<namespace>.research.<path>.name	The displayed name of the research, presented to the user. May be a translation key.
subtitle	String		A subtitle for the research, displayed on mouse over. May be a translation key.
branch *	String		A Resource Location that indicates which branch the research belongs in.
parentResearch	String		The Resource Location for a parent research, which must be completed before this research may be unlocked. Required for research of a level greater than 1. Must be on the same branch.
researchLevel	Integer	1	The Research Level of the research. Unless the branch is set to "branch-type": "unlockables", requires a University of equal or greater level to begin researches of levels 1 through 5, and only allows one level 6 research to be completed at a time. If above level 1, must have a valid parent one level lower.
sortOrder	Integer	0	Controls the vertical position of the branch on the Research Tree GUI. Lowers numbers are placed higher up, while higer numbers are placed closer to the bottom. Only applies to research with siblings.
exclusiveChildResearch	Boolean	false	If true and the research has more than one descendant research, allows completion of only one of those researches at a time.
no-reset	Boolean	false	If true, prevents undoing the research. Has no effect if the research is already unresettable.
hidden	Boolean	false	If true, does not display the research until its requirements are fulfilled. Has no effect if the research has no requirements or only has item costs.
autostart	Boolean	false	If true, and the research has no item costs, begins the research automatically once its requirements are fulfilled. If the research has item costs, notifies logged-in players that it is available to begin.
instant	Boolean	false	If true, attempts to instantly (or within 30 seconds) complete the research after it has been begun.
requirements[]	Array (Objects)		If true, attempts to instantly (or within 30 seconds) complete the research after it has been begun.
item	String		A Resource Location of an item consumed to begin the research. Multiple items are supported, though having more than 5 may display poorly on some monitors. Optionally pairs with quantity. Items without NBT data match any NBT variant, but do require the item to be undamaged.
quantity	Integer	1	A number of items to be consumed. Pairs with item.
building	String		A specific building that must be present in the colony. Normal building requirements combine the levels from multiple of the same building type. Optionally pairs with level.
mandatory-building	String		A specific building that must be present in the colony, with at least one occurence at least at the specifed level. Optionally pairs with level.
alternate-building	String		A specific building to be added to the list of alternate-buildings. At least one of the alternate-buildings must be present in the colony to begin research. Optionally pairs with level. Acts like building if only one alternate-building object is present.
level	Integer	1	Specifies a building level. Pairs with building, mandatory-building, and alternate-building, otherwise has no effect.
research	String		A specific research by Resource Location that must be completed to unlock this research. Unlike, parentResearch, can be on another branch, or of any research level.
effects[]	Array (Objects)		Contains all of the effects of the research. Can be empty, either for research with no effects or for research that only unlocks crafterrecipes, or contain one or more objects.
<effect key>	Integer	1	The Research Effect identifier as a Resource Location, followed by the level of the effect as an Integer. If the level exceeds the maximum level of the effect, defaults to the maximum level. If no matching effect is found, applies a default strength of 6, enough to unlock a building completely.
remove	String, Boolean		Removes a research branch, and all research on that branch, regardless of the source. May cause data loss if applied to an existing world. String: Removes any research matching the Resource Location in that String. Boolean (true): Removes research matching the Resource Location of the JSON itself; this form is discouraged for cases where other data packs may apply, as it may be conflicted by those other data packs.

* = Required field

{
    "name": "Outposts",
    "subtitle": "Unlock the ability to settle outposts",
    "branch": "minecolonies:civilian",
    "parentResearch": "minecolonies:civilian/outposts",
    "researchLevel": 3,
    "sortOrder": 2,
    "exclusiveChildResearch": false,
    "no-reset": false,
    "hidden": false,
    "autostart": false,
    "instant": false,
    "requirements": [
        {
            "item": "minecraft:book",
            "quantity": 16,
            "building": "library",
            "mandatory-building": "library",
            "alternate-building": "library",
            "level": 1,
            "research": "minecolonies:civilian/outposts"
        }
    ],
    "effects": [
        {
            "<effect key>": 3
        }
    ],
    "remove": true
}

Schema: Research Effect

Fields

Example JSON

Example path: <namespace>/researches/effects/<effect-id>.json

Field	Type	Default value	Description
effect *	Boolean		Required to treat the file as a research effect. Can be any value, usually true.
name	String	com.<namespace>.research.<path>.description	The display name of the effect, shown on mouseover. May be a translation key.
subtitle	String	com.<namespace>.research.<path>.description	The subtitle of the effect, shown on mouseover. May be a translation key.
levels[]	Array (Doubles)	[0, 1]	The effect strengths of the research, by level.

* = Required field

{
    "effect": true,
    "name": "Settle outposts",
    "subtitle": "Unlocks the ability to settle outposts",
    "levels": [
        0,
        0.25,
        0.5,
        0.75,
        1
    ]
}