NeoQuests

A modern, performant FTB-Quests-class quest mod for NeoForge with first-class in-game and standalone Windows editors.

Targets: Minecraft 1.21.1 (NeoForge 21.1.x) and Minecraft 26.1 / 26.1.1 / 26.1.2 (NeoForge 26.1.x). Status: Pre-alpha. Phase 1 closed (v0.1.0-alpha); Phase 2 in progress — perf foundation (2A + 2B) and most of the catalog + pack loading (2C) shipped to main. See CHANGELOG.md for the per-phase log and BUILD.md for the road to v1.0.

---

Why NeoQuests

• Day-1 support for MC 26.1.x. No other quest mod exists there yet.
• 5–20× lower per-tick CPU than FTB Quests on event-heavy servers — see the signal architecture.
• Standalone Windows editor. Author offline. Live-link to a running game for instant preview.
• Imports from FTB Quests, Heracles, HQM, and Better Questing. Full mapping documented in IMPORTERS.md.
• HQM migration preserves lives and reputation natively — no other 1.21+ quest mod has these.
• Mod authors post signals; pack authors build quests against them. Zero per-mod integration code.
• Datapack-first distribution. Ship quests inside a mod jar with no extra files.

---

Documentation

For pack authors

• Quickstart — your first quest in 5 minutes.
• In-game editor reference
• Desktop editor reference
• Task reference — every built-in task type.
• Reward reference — every built-in reward type.
• Reward tables (coming with v0.3)
• Pack format reference — JSON files on disk.
• KubeJS scripting

For migrators

• Importer overview — mapping tables for every supported source.
• docs/importing/ — per-source migration guides (in development).

For mod developers

• Mod author guide — recipes for the three integration levels.
• API reference — the full Java API contract.

For NeoQuests developers

• Architecture plan — the design source of truth.
• Build & deployment plan — phased roadmap to 1.0.

---

Project layout

neoquests/
├── PLAN.md                      # Architecture (source of truth for design)
├── BUILD.md                     # Phase-by-phase build plan
├── IMPORTERS.md                 # Importer design (FTBQ, Heracles, BQ, HQM)
├── API.md                       # Public Java API contract
├── README.md                    # You are here
│
├── common/                      # pure-Java quest model, codecs, no MC types
├── platform/
│   ├── neoforge-21.1/           # MC 1.21.1 platform implementation
│   └── neoforge-26.1/           # MC 26.1.x platform implementation
├── editor/
│   ├── core/                    # Tauri Rust core (file IO, importers)
│   └── ui/                      # React + TypeScript UI
├── schema/                      # JSON Schemas (canonical format definitions)
├── scaletest/                   # CI scale harness + synthetic pack generator
└── docs/                        # Pack-author and mod-author docs

---

Quick install (when v1.0 ships)

Players

1. Install NeoForge for your MC version (1.21.1 or 26.1.x).
2. Drop neoquests-<mcversion>-x.y.z.jar into your mods/ folder.
3. Launch.
4. Press Esc → Quest Book.

Pack authors

1. Install the desktop editor: NeoQuestsEditor-Setup-x.y.z.exe.
2. Read the quickstart.
3. Or import an existing pack: File → Import Pack…

Mod developers

repositories { maven("https://maven.neoquests.dev/releases") }
dependencies { compileOnly("dev.neoquests:neoquests-api-1.21.1:1.0.0") }

See the mod author guide.

---

Differentiation summary

Feature	NeoQuests	FTB Quests	Heracles	HQM	Better Questing
MC 1.21.1 support	✅	✅	✅	❌	❌
MC 26.1.x support	✅	❌	❌	❌	❌
In-game editor	✅	✅	✅	✅	✅
Standalone editor	✅	❌	❌	❌	❌
Live-link editor↔game	✅	❌	❌	❌	❌
Lives system	✅	❌	❌	✅	❌
Reputation system	✅	❌	❌	✅	❌
NPC quest-givers	✅ (Phase 5)	❌	❌	❌	❌
Datapack-first distribution	✅	❌	❌	❌	❌
Predicate-based task targeting	✅	partial	partial	❌	partial
Custom signal API for mods	✅	❌	❌	❌	❌
Imports from competitors	All four	❌	❌	❌	❌
Auto-claim by default	✅	configurable	❌	❌	❌

---

Versioning

• Mod versions track NeoForge: neoquests-1.21.1-x.y.z and neoquests-26.1-x.y.z.
• API versions are independent and follow strict semver: dev.neoquests:neoquests-api-<mcversion>:1.0.0.
• Pack format version is a single integer in pack.json. Changes ship with a DataFixer migration; no manual rewrites needed.

---

Roadmap

• v0.1 alpha — vertical slice: one task type, one reward type, end-to-end.
• v0.2 alpha — full task/reward catalog, chapter canvas.
• v0.3 alpha — in-game and desktop editors. FTB Quests + Heracles importers.
• v0.4 beta — KubeJS, hardcoded mod integrations.
• v0.5 beta — lives, reputation, NPCs. HQM + Better Questing importers.
• v1.0 — production release on Modrinth + CurseForge.

Full schedule and exit criteria: BUILD.md.

---

License

(To be decided — MIT recommended; see PLAN.md §18.)

---

Contributing

• Bug reports / feature requests: GitHub Issues.
• Code: see CONTRIBUTING.md (written in Phase 0).
• Translations: PR a <locale>.json to the mod's own assets/neoquests/lang/.
• Pack-format addons: post a custom TaskType or RewardType via the API. PR a registry entry to feature it on the docs site.

---

Links

• Issues: github.com/neoquests/neoquests/issues (repo not yet created)
• Discord: discord.gg/neoquests (not yet created)
• Docs site: docs.neoquests.dev (not yet live)
• Maven: maven.neoquests.dev (not yet live)

This document tracks the eventual state. Phase 0 wires up the actual hosting.