Description

* π **[Wiki](https://github.com/Flix100000/History-Stages/wiki)** β full documentation, config fields, JSON examples & developer API
* π¬ **[Discord](https://discord.gg/BeZzxyZ9c4)** β support, questions & sneak peeks
* π **[Issue Tracker](https://github.com/Flix100000/History-Stages/issues)** β bug reports & feature requests
**History Stages** is a progression and gatekeeping mod for modpack creators. Lock items, recipes, dimensions, structures, mobs, enchantments, and loot behind custom eras β and let players unlock them however you want: research, in-game triggers, quests, or commands.
Stages can unlock **server-wide** (global), **per player** (individual), or as **Dual-Phase** β locked globally first, then per-player once the era is reached. You decide how progression works in your pack.
***
## π **What You Can Lock**
Almost everything β not just item usage:
* **Items & Tags** (incl. NBT criteria), **entire Mods**, **Recipes**
* **Dimensions** & **Structures** (with optional force-field zones)
* **Mobs** β spawnlock & attacklock
* **Loot** β chests & mob drops, removed or replaced
* **Blocks** β breaking, GUIs & container access
* **Enchantments** β anvil & enchanting table
* **Armor Stands & Item Frames** β displayed locked items are protected
On top of that, locked items can **hide or replace their names and tooltips**, and per-entry `unlock_actions` let you allow specific interactions (e.g. pickup) while everything else stays locked.
***
## π **Unlock It Your Way**
The Research Pedestal is just the default, not a requirement β every stage has a **mode** that defines how it unlocks:
* **Default** β classic research with Scrolls at the Pedestal
* **Auto** β unlocks via in-game triggers: item pickup, entering a biome/dimension/structure, entity kill/interact, block place/break, advancements, playtime (any/all combinable)
* **External** β unlock only via `/history`, KubeJS/CraftTweaker, or as **FTB Quests reward**
* **Temporary** β unlocks and re-locks on a timer, with cooldowns & trigger limits
Mix all of these freely in the same pack β research-driven eras, exploration-based unlocks, and quest rewards can live side by side.
***
## π¬ **Research System**
Players physically bring **Research Scrolls** to the **Research Pedestal** and spend time researching the next era. Four pedestal tiers (IβIV), placeable **Research Boosters**, and per-stage research times let you tune the pacing. With the **Dependency System**, stages can additionally require XP levels, mob kills, statistics, advancements, scoreboard objectives, or items deposited directly into the pedestal.
***
## π οΈ **In-Game Editor**
Build and tweak your entire stage setup **without ever touching a config file** β straight from the pause menu (OP required):
* Searchable multi-select lists & a **dependency graph viewer**
* Dedicated editors for Dependencies, NBT & Lock-Actions β **Ctrl-click** any inventory slot to import its NBT
* Overlap warnings between global & individual stages, plus a full **in-game config editor**
***
## π¨ **Feedback & Integrations**
Players always know _why_ something is locked: lock icons in inventories and **JEI/EMI**, "Locked" recipe overlays, toasts with custom per-stage icons, and configurable actionbar/chat messages.
* **FTB Quests** β native stage task & reward types (global + individual)
* **KubeJS / CraftTweaker** β `StageEvent.Unlocked` / `Locked` events
* **Jade**, **Curios** & **Accessories** support
***
## π **Creating Stages**
Use the **in-game editor**, or write simple JSONs in `config/historystages/global/` and `individual/` β full field reference: [Stage Configuration](https://github.com/Flix100000/History-Stages/wiki/Stage-Configuration).
The mod intentionally ships **without default recipes** for the Pedestal, Boosters & Scrolls β you decide how players obtain them (KubeJS, datapack, quest rewards, β¦). Give a scroll via:
```
/give @s historystages:research_scroll{StageResearch:"YOUR_STAGE_NAME"}
```
***
## π¦ **Dependencies**
* **Lootr** β required
* _Optional:_ JEI, EMI, FTB Quests, Jade, Curios, Accessories
***
## β **FAQ**
Can stages be unlocked per player instead of server-wide?
Yes β global, individual, or both mixed in the same pack (overlaps become Dual-Phase locks).
Is Lootr really required?
Yes, loot filtering is built on Lootr's container system. Without loot locking it just sits there quietly.
Do I need FTB Quests?
No β the integration only activates when it's installed.
Which versions are supported?
* **1.20.1** β Forge (latest features)
* **1.21.1** β NeoForge (latest features)
* **1.21.1** β Fabric (currently a few versions behind)
* **1.19.2** β Forge (legacy, no longer updated)
***
Questions or found a bug? Join the **[Discord](https://discord.gg/BeZzxyZ9c4)** or [open an issue](https://github.com/Flix100000/History-Stages/issues/new/choose) β we read everything! π