[Devs] Quests Packs

This is the quests & datapack page for devs.

Pack Limits

Default quests can be disabled in 1.1.2. Please use /datapack disable or turn it off in world settings.

Grimoire is built for pack integration to expand its quest pool, however it does have an upper and lower limit before things are diluted or stale.

On 1.0, the soft ceiling is around 15 quests per tiers 1-3 before the pool is diluted, offer repeats start to get rare.

This does not account for quests using one-and-done mechanics, so tread carefully.

Soft caps:

• 15-16 for tiers 1-3
• 10-12 for Tier 4
• 5-6 for Tier 5

Quest File Reference

Here's the reference template for quests.

{
  "title": "Title here.",
  "lore": "Short log line.",
  "description": "Lengthy description.",
  "patron": "patron",
  "format": 1,
  "tier": x,
  "required_item": "itemid",
  "required_count": x,
  "rewards": [
    { "item": "itemid", "count": x },
    { "item": "minecraft:chorus_flower", "count": 4 },
    { "item": "minecraft:chorus_fruit", "count": 64 },
    { "item": "minecraft:ender_pearl", "count": 16 }
  ],
  "requires_quest" : "prereq quest",
  "repeatable": false 
}

• Title - it is required, and the mod won't load an empty title
• Lore - this is the log line in the bargains display
• Description - viewed by clicking the title, additional context is optional
• Patron - this is a value called by a future feature. please use lowercase and no spaces
• Format - does nothing in 1.0, default 1
• Tier - adjusts tier requirement
• required item - explains itself, use proper syntax, but if you typo it'll warn you properly
• reward item - self explanatory also, same thing. LEGACY
• 1.1 AND BEYOND ONLY: reward array: supports an item array.
• requires - uses the directory of the bounty, example "tier1/stone_bounty"
• repeatable - mark "false" if you don't want it to repeat, otherwise do not add that line

Bad files will warn and skip, it shouldn't break the load. It'll warn you for unknown items, bad syntax, empty items, missing titles, and bad counts (and malformed json will stack trace)

Please name your quest files the same way. BAD file paths or changes to it will change the quest identity, player progress will reset.

Datapack Creation

Making a data pack is simple to deliver. Please follow the right instructions for making a data pack for minecraft, here.

For minecraft 1.20.1, please use this as your pack.mcmeta:

 {
  "pack": {
    "pack_format": 15,
    "description": "My Grimoire quest pack"
  }
}

Everything must follow a data/grimoire directory, or else it will not be read.

Following that, use:

data/grimoire/namehere/quests/tierX

Example finalized directory that will work correctly: data/grimoire/culinary/quests/tier3/beef_bounty.json

IMPORTANT! Renaming a quest file will change its identity, meaning player progress will be lost.

Currently on 1.1.1, there is no custom tiers support. Please use the tiers that come in the base mod.

Loading the Pack

Use Paxi for modpacks or something similar.

For servers, simply navigate to world/datapack and drop it in.

Players load the datapack as they would any other.

Use /datapack list to confirm it's loaded.