docs: point readers at the documentation that is still maintained
The pointer to the new site was taken down in September because the site was
still a work in progress. It is not any more: it has its own address, a page
per topic, search, and one documentation version per mod release.
Both places, because a search engine drops people onto a deep page far more
often than onto Home: the banner at the top of Home, and a line in the sidebar
that shows on every page.
The line claiming this wiki is always aligned with the latest version comes
out. It stopped being true the day the pages froze, and it sat directly under
a banner saying the opposite.
6c0a93d
Revert the pointer to the Docusaurus site
The new wiki is still work in progress, so sending people there from the old
one is premature. Goes back in when it is ready to be read.
ba9523f
docs: point to the new Docusaurus site
8d5f05f
docs: put the tag examples in the namespace that exists
Every tag in the examples was written as forge:, which is the 1.20.1
spelling. On the version these pages describe the common namespace is c:,
so forge:ores/iron matches nothing at all -- a reader copying an example
got a stage that gated nothing and no error saying why.
The sword example moves to minecraft:swords rather than a c: tag, because
NeoForge 1.21 has no sword tag and vanilla gained one in 1.21.
ad26e73
docs: an undocumented config section and three wrong block ids
Found by checking the pages against the code rather than by reading them.
- [recipe_book] was missing from Configuration entirely. Its one key is on
by default and changes what players see: a locked recipe now disappears
from the vanilla recipe book instead of sitting there refusing to craft.
- The pedestal tier table named blocks that do not exist. Tier II was
missing an underscore, and tiers III and IV were listed under a
"multiblock_" prefix that was never a registry name. Every /give and
every recipe written from that table failed.
99c5ccd
docs: fix the scope rules on Global vs Individual
Five claims on that page were wrong rather than merely incomplete, and
four of them would have cost a packmaker an afternoon.
- The per-entry action list was documented under its legacy name, which
stores the locked actions. The field written today stores the free ones,
so the worked example produced the opposite of what the text promised.
- An ID used in both global/ and individual/ was described as a collision
the individual side loses. The two trees keep separate name tables and
both files load; that is how a dual-phase lock is written in the first
place. Collisions happen within a tree, between folders.
- Global stages were listed as supporting three requirement kinds. They
support five: item tags arrived with 6.0.0 and scoreboard was never
individual-only.
- The individual_stages dependency was missing its third mode.
- The dual-phase list named seven categories. Every category takes part
except mod exceptions and spawn locks.
Per-player recipe locks also stop claiming the four vanilla stations are
the whole story: a mod can register its own recipe type since 6.0.0, with
the promise that comes attached to doing so.
Two matching corrections elsewhere: the requirement scope sentence on
Stage Configuration forgot XP level, and the graph's panel section now
says that sections with no switch of their own are always shown.
b81afb5
docs: drop the version-match note from Getting Started
Matching server and client is ordinary Minecraft, not something this mod
needs its own section for. The release notes carry the one release where
it actually bites.
5430e91
docs: bring the wiki up to 6.0.0
6.0.0 is out, so the API pages drop the "not published yet" banner and the
feature pages catch up with what shipped.
New ground:
- Fluid locks, including the two things that read as bugs without an
explanation: why one entry covers every bucket in the pack, and why
recipes nobody listed disappear. Plus the limits at pumps and pipes.
- Zones, with the shapes, the per-zone rules and what happens when two of
them overlap. Marked beta.
- Spawn rules: phase, conditions and extra biomes, the four limits around
worldgen and weather, and the editor dialog they are written in.
- The map background that changes as a player unlocks stages.
- item_tag as a ninth requirement, and why a tag entry settles on the
first deposit instead of staying open.
- The world chapter of the open scroll now covers zones, trades and fluids.
- /history zone, /history temporary and three debug subcommands.
Corrections, all of them things a reader would have tripped over:
- The dependency format was documented with a per-condition "type" field
that does not exist, and half the field names were wrong. Anyone copying
it got a stage that never opened. Both examples are fixed with it.
- Lock-Categories still claimed the attack lock indexes spawn entries.
That coupling is gone in 6.0.0; the paragraph keeps the lesson and drops
the false present tense.
- Category and requirement counts were two short.
Behaviour changes that show up silently get a box where the setting lives,
not only in the release notes: spawn locks no longer imply attack locks,
the trade action counts as locked in files written before it existed, and
a 6.0.0 client cannot join an older server.
a28a6ff
docs: tighten one sentence on requirement progress keys
9fc3c98
docs: the composite tab, and a widget list that named the wrong types
The widget table says of itself that it is everything under `api.editor.widget`, which is a
claim worth checking rather than reading. It was wrong in three ways: `SegmentBar` was listed
but lived under `client/`, so nothing outside the mod could reach it; `TradeRowGeometry` was in
the package and in no row; and the count in the sentence above matched neither the table nor the
package. Both classes are where the page said they were now, and the number is counted rather
than remembered.
That left `CompositeCategoryTab` undocumented while the `SegmentBar` row described a tab showing
sections under one label as though an addon could build one. It can, and this says how -- what
the host draws versus what the tab owns, why load and store reach every section rather than the
visible one, and how a section that the current stage cannot use is greyed instead of hidden.
`createTab` takes the scope now, in the signature and in the demo snippet. A tab with sections
cannot work out which kind of stage it is editing, and it needs that to grey the right sections.
5c3bc3d
docs: correct the API pages the trade locks made wrong
The addon page taught villager trades as the thing History Stages cannot
do, so an addon has to hook it. That stopped being true — merchant offers
are three built-in categories now — and an example that invites someone
to rebuild what ships is worse than no example. Moved it to quest
rewards, which we still know nothing about, and said plainly what
happened so the next reader is not left wondering.
The toolkit's note that only the dependency editor honours a tab's icon
and badge is out of date: the stage editor asks the tab as well, after
its own decorations, and badges stack instead of overwriting. That note
was a documented dead end that no longer exists. Added the segment bar
beside the on/off switch and its geometry, and the add-button hook, which
moved up from the dependency contract to the one both axes share.
The built-in count was already off by one before this — the fluids were
never listed — and is fifteen now.
3b82a49
docs: the two recipe-type registration windows
Neither adds anything, which is why they sit apart from the five extension points rather than in
their table: they describe recipe types History Stages already sees, so it stops guessing about
them. One says what a type looks like in the editor, the other that it can be gated per player.
The bus each is fired on is written down because getting it wrong fails silently -- a listener on
the wrong one is simply never called. The appearance event runs in client setup, since everything
it carries is UI; the per-player one in common setup, since it gates and stores.
The warning about only registering a station with its own menu is the one that costs an evening
otherwise: the editor offers the per-player lock, the entry lands in the stage file, and nothing
ever happens.
The count of api types naming the loader moves from nine to eleven. That number is the evidence
for the claim around it, so a stale one argues against itself.
056c648
docs: a third way for an addon to author a trigger
An id list covers a trigger whose content is an id, and a count dialog covers one that
is a number. Neither covers a small fixed vocabulary — a rarity, a weather state — where
searching three rows is ceremony and a number cannot say "rare".
ChoiceScreen is that third shape, and ChoiceOverlay is the same list for a host that
drives its own overlays. Both are on the widget table now, with the tier table on the
auto-trigger page saying which question each one answers.
858f4b9
docs: add a wiki footer with the Discord, the tracker and the licence notice
GitHub renders _Footer under every page, which is where a copyright notice
belongs — repeating it per page would be noise and forgetting it on one page
would be worse. "All Rights Reserved" links to LICENSE.txt rather than quoting
any of it, and the copyright line is taken from that file verbatim.
The link goes through /blob/HEAD/ instead of naming a branch: LICENSE.txt does
not exist on main, and HEAD follows whatever the default branch is.
0a45b78
docs(license): add a page on porting to other versions and loaders
61bc30c
docs: split Integrations & API and retire the one-page developer section
The page was two things under one title, and its own headings admitted it: a
table of mod integrations marked "For Modpack Developers", sitting in a sidebar
section called "For Mod Developers". The table is now its own page, Mod
Compatibility, where pack authors will look for it.
The developer half was largely a thinner copy of Stage State & Events, which
covers the same four events with the accessors, the every-path guarantee, the
creative-scroll gap and the mod-bus/game-bus trap the old page never mentioned.
Only two pieces were unique and they move there: the table of where the event
class lives before and after 6.0.0, and the Fabric Event<> listeners.
That leaves "For Mod Developers" with nothing in it, so it goes. The two
audiences it was trying to serve already have sections of their own.
91a3a84
docs(scripting): drop the section arguing why scripts cannot define stages
The page said what scripts cannot do and then spent three paragraphs
defending it. The boundary itself is worth one sentence in the intro, which
already carries it; the reasoning belongs to the design, not to the page
someone opens to look up a method.
e5477e4
docs(scripting): give KubeJS and CraftTweaker a page of their own
Until now both could only reach History Stages by naming a Java event class as
a string, and nothing warned when that string was wrong. 6.0.0 gives them named
events, stage queries and unlocking from a script, so the raw bus events stop
being the answer for pack authors.
The page documents the pre-6.0.0 form beside the new one instead of replacing
it: packs written that way keep working, and on 5.6.x and Forge 1.20 it is
still the only option. It also spells out what scripts deliberately cannot do —
define stages or decide what a stage locks, which stays with the in-game
editor.
Integrations & API now points here and marks its own KubeJS example as the old
way.
a694b4d
docs(widgets): add the shared on/off switch
59979ed
docs(requirements): name the group's key rather than its index
The context hands out the group's identity now, not its position, and an addon
storing progress of its own has a place to put it. Neither was written down.
76f9db1
docs: add an addon development section for the 6.0.0 API
Eight pages covering the five extension points, the editor toolkit and the
stage state API, with every example lifted from the demo addon rather than
written by hand, so the build breaks before an example can go stale.
Also fixes the existing developer API section, which named a class path that
6.0.0 moved and listed two of the four stage events. Both KubeJS variants are
now shown side by side, since the old path is still correct on 5.6.x and
Forge 1.20.
a62b835
Document 5.6.0 features: folders, biome/interaction locks, structure generation caps, lose on death, per-player unlock, Stage Graph, scroll tooltip config, open scroll document
7e0d396
Updated Research System (markdown)
e16f49d
Updated Research System (markdown)
572467a
Updated _Sidebar (markdown)
6b396c4
Update license to All Rights Reserved (was outdated GPLv3)
0726b50
Add Discord invite to Home page and sidebar
f75d322
docs: document comparator output on Research Pedestal
98cb995
docs: add scoreboard dependency to Global vs Individual Stages page
d204c7c
docs: update wiki for 5.5.0 release
- Add Stage Modes page (default, auto, external, temporary)
- Add hidden_display section to Stage Configuration
- Add NBT criteria on tag entries section
- Add place vs use lock clarification
- Add unlock_dimensions to spawnlock documentation
- Add scoreboard dependency type
- Add Dependency Graph to In-Game Editor
- Update FTB Quests integration (searchable stage picker)
- Add Spell Engine / Better Combat compatibility entry
- Note JEI/EMI feature parity
- Update _Sidebar with Stage Modes link
7665acd