docs: add Lua authoring guide and reorganize docs folder#4
Merged
Conversation
Add a comprehensive Lua authoring guide (docs/lua-authoring-guide.md) covering the full API surface for game creators: constructors, rules, conditions, effects, templates, dialogue, built-in verbs, patterns, and validation errors. All content verified against source code. Also reorganizes docs/ by moving design documents into docs/design/, adds development invariants to CLAUDE.md, and adds ideas tracking. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add a comprehensive Lua authoring guide (
docs/lua-authoring-guide.md) — the complete reference for game creators. Covers constructors, rules, conditions, effects, templates, dialogue, built-in verbs, common patterns, and validation errors. Also reorganizesdocs/by moving design documents intodocs/design/, adds development invariants toCLAUDE.md, and adds ideas tracking.Purpose
There was no documentation for someone wanting to write a game in QuestCore. Authors would have to reverse-engineer
loader/api.goand the Lost Crown source. This guide makes QuestCore usable by anyone beyond the core developers.Related plan:
docs/plans/game-creator-guide.mdTests Performed
loader/api.goengine/effects/effects.goengine/effects/effects.gointerpolationengine/parser/parser.goloader/validate.goTests Not Performed
make cinot run (no code changes)CI Checks
make cipasses locallyAI Assisted
🤖 Generated with Claude Code