@jsprismarine/mcfunction 0.0.0 → 0.16.0-unstable-20261029132853

package/CHANGELOG.md

@@ -0,0 +1,48 @@
+# @jsprismarine/mcfunction
+
+## 0.16.0-unstable-20261029132853
+
+### Minor Changes
+
+- [#2628](https://github.com/JSPrismarine/JSPrismarine/pull/2628) [`de3128c`](https://github.com/JSPrismarine/JSPrismarine/commit/de3128cc89765361b2afd2a3533756d50f8754b0) Thanks [@filiphsps](https://github.com/filiphsps)! - Add `/return` and make `execute if function` read it.
+  
+  `execute if function` tested `runFunction(...) !== 0` against a count of command lines, so any
+  function that ran at least one line matched. It now follows Java's 1.20.3 rule: a function matches
+  when it returned a non-zero value through `/return`, and one that reaches its last line returns
+  nothing and does not match. A function tag matches when any of its members did.
+  
+  `/return <value>`, `/return fail` and `/return run <command>` are what produce a value for it to
+  read, which brings the registered set to 60 commands.
+  
+  Durations now parse the way Java's `minecraft:time` argument does. `/schedule function foo 5s` is
+  100 ticks and `2d` is 48000, where both were parse failures before; the same argument reads
+  `/weather`, `/title times`, `/time set` and `/time add`.
+  
+  A registry argument validates against the content the host loaded rather than against Mojang's
+  frozen enum alone. `/summon mypack:dragon` failed at parse for an entity the server can spawn;
+  `CommandRegistryOptions.content` now carries the server's own entity, block, item and enchantment
+  ids, which are accepted alongside Mojang's list and offered to the client with it.
+  
+  `/summon villager` reached the pre-1.11 `minecraft:villager` rather than Bedrock's current
+  `minecraft:villager_v2`, because Mojang's command enum still lists the old spelling. The
+  identifier resolves through `javaEntityTypeToBedrock`, the same seam the brain registry reads.
+  
+  Breaking: `buildVanillaCommands` takes the loaded registry ids rather than a boolean.
+  `DataCommandHost.runFunction` answers a `FunctionOutcome` rather than a number, and the
+  interface gains `returnFromFunction`. `ExecutionReport` gains `returnValues`, `CommandOutcome`
+  gains an optional `returned`, and `FunctionRuntime.run` answers an outcome rather than a line
+  count.
+
+### Patch Changes
+
+- [#2628](https://github.com/JSPrismarine/JSPrismarine/pull/2628) [`a751da2`](https://github.com/JSPrismarine/JSPrismarine/commit/a751da28fed5879c5d941bc1cebd369560271dfb) Thanks [@filiphsps](https://github.com/filiphsps)! - Add `@jsprismarine/mcfunction`, the Java Edition function runtime. It loads `.mcfunction` files and
+  function tags from a pack stack, compiles each file once, and runs it against an injected
+  `CommandRunner`, so the package implements no commands of its own. It parses the line format
+  including `#` comments, `\` continuation and `$` macro lines, substitutes `$(variable)` from an
+  argument compound with Java's no-suffix number rules and an 8-entry parse cache per macro function,
+  resolves `#namespace:tag` references including nested tags and the two lifecycle tags
+  `minecraft:load` and `minecraft:tick`, and executes through an explicit frame queue that bounds a
+  run with `maxCommandSequenceLength` and `maxCommandForks` (both defaulting to 65536, a figure
+  Mojang has never published) and reports a tripped limit instead of throwing. Nesting 20000 calls
+  deep does not touch the JavaScript stack, and a tail call replaces its frame rather than stacking
+  on it.

package/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -0,0 +1,182 @@
+# @jsprismarine/mcfunction
+
+[![Join the Discord Server](https://img.shields.io/discord/704967868885762108?color=%237289DA&label=Discord)](https://discord.gg/6w8JWhy)
+[![npm](https://img.shields.io/npm/dt/@jsprismarine/mcfunction)](https://www.npmjs.com/package/@jsprismarine/mcfunction)
+
+The Java Edition mcfunction runtime: it loads `.mcfunction` files and function tags from a pack
+stack, compiles them once, and runs them against a command runner you supply. It parses the file
+format, expands macro lines, resolves function tags, and bounds a run with the two gamerules that
+Java bounds it with. It does not implement a single command.
+
+```ts
+import { FunctionExecutor, RecordingCommandRunner, loadFunctions } from '@jsprismarine/mcfunction';
+
+const { functions, tags, diagnostics } = loadFunctions([{ name: 'my pack', files }]);
+const runner = new RecordingCommandRunner();
+const executor = new FunctionExecutor({ functions, tags, runner });
+
+executor.runLoad({ source: console }); // once, after the packs load
+executor.runTick({ source: console }); // once per server tick
+```
+
+## What this buys, and what it does not
+
+Vanilla ships no functions. The Java 26.3 server jar has 9884 files under `data/minecraft/` and
+zero of them are `.mcfunction`; it has 883 tag files and none of them tags the function registry.
+Bedrock is the same: `Mojang/bedrock-samples` at 1.26.50.4 has 22258 files, no `.mcfunction` and
+no `tick.json`. Both editions have a function runtime and neither uses it for vanilla gameplay.
+
+So this package buys no vanilla parity on its own. What it buys is the ability to run a third-party
+Java datapack, and a place to write server behavior as data rather than as TypeScript. Parity comes
+from the commands a function calls into, which live elsewhere.
+
+## The file format
+
+One command per line, written without a leading slash. A line is a comment when its first
+non-whitespace character is `#`, and blank lines are skipped. A line whose last non-whitespace
+character is `\` continues into the next line, whose leading and trailing whitespace is stripped
+before it is appended. A command may be at most 2000000 characters.
+
+Two mistakes are rejected rather than guessed at, because Java rejects them by name: a line that
+starts with `//`, which is not a comment marker here, and a line that starts with `/`. A file with
+any error does not load at all, which is what the Java server does when
+`CommandFunction.fromLines` throws.
+
+A function id comes from its path. `data/pack/function/setup/stage.mcfunction` loads as
+`pack:setup/stage`, using the singular `function` directory that 26.3 uses.
+
+### Macro lines
+
+A line whose first non-whitespace character is `$` is a macro line. It carries one or more
+`$(variable)` substitutions, and the call must pass a compound holding an entry for each of them.
+Extra entries in the compound are ignored, and a plain function called with a compound ignores it
+entirely.
+
+```mcfunction
+say starting
+$say hello $(name), you have $(count) items
+```
+
+A `$` is literal unless `(` follows it, which is the only escape the format has. A string argument
+goes in raw, with no quoting and no escaping, so a value carrying a quote can produce a command
+that no longer parses. Numbers go in without the type suffix they would carry in NBT, matching the
+1.20.2 fix; a nested compound or list is rendered as SNBT, where suffixes are back because the text
+is NBT again. A missing entry reports
+`the macro arguments have no entry for '<name>'` and the whole call is skipped, the way Java skips
+a call whose macro cannot be instantiated.
+
+Macro lines are the one part of the format that costs something per call, because the substituted
+text has to be parsed again. Each macro function keeps the 8 most recent argument sets, matching
+`MAX_CACHE_ENTRIES` in Java's `MacroFunction`, and keys them on the values the macro actually
+references, so extra compound entries do not split the cache.
+
+## Function tags
+
+A `function #namespace:tag` line runs every function the tag names, in order, with nested tags
+expanded where they appear. A function named twice runs once. A cycle between tags is reported and
+cut rather than followed.
+
+Two tags are special, and they are the only two the Java server looks up by name:
+`minecraft:load`, which runs once after the packs load, and `minecraft:tick`, which runs on every
+server tick. `FunctionExecutor` exposes them as `runLoad` and `runTick`.
+
+Tags merge across the stack rather than replacing. Two packs that both add to `minecraft:tick`
+both run, unless the later one sets `"replace": true`. Functions are the opposite: a later pack
+that declares the same id replaces the earlier file whole. `loadFunctions` applies both rules, and
+`FunctionTagRegistry` is the lookup `FunctionExecutor` resolves tags through. The lookup is
+injected, so a server that already holds its tags somewhere else can pass its own.
+
+## The limits, and how sure we are of them
+
+A run is bounded by the two gamerules Java bounds it with. Both were renamed in 1.21.11, so the
+camelCase names you may have seen are stale.
+
+| Rule | Counts | Default here |
+| --- | --- | --- |
+| `minecraft:max_command_sequence_length` (was `maxCommandChainLength`) | operations | 65536 |
+| `minecraft:max_command_forks` (was `maxCommandForkCount`) | contexts | 65536 |
+
+Mojang has never published either default. The figure 65536 has two independent secondary
+confirmations, minecraft.wiki's gamerule page and Pumpkin's extraction from the real 26.3 server
+jar, and 65536 is in the `GameRules` class constant pool, but no Mojang document attributes the
+value to either rule. Treat it as a well-corroborated default rather than a confirmed one. Both are
+configurable per executor:
+
+```ts
+new FunctionExecutor({ functions, runner, limits: { maxCommandSequenceLength: 10_000 } });
+```
+
+An operation here is one command line run or one function invoked, which is this runtime's reading
+of the three kinds the 1.20.3 changelog enumerates. A context is whatever a command reports as
+`forks`: `execute as @e` matching five entities reports 5, and the runner is what knows that, so
+fork counting is only as accurate as the runner's reporting.
+
+Reaching either limit stops the run, records the reason in `report.stopped`, and adds a diagnostic.
+Nothing throws. Everything a call reaches shares one budget, so the report covers the whole tree
+below the entry point.
+
+Bedrock's equivalent is a smaller per-call cap, 10000 commands, exported as
+`BEDROCK_MAX_COMMANDS_PER_FUNCTION`. This runtime runs Java functions and does not apply it; pass
+it as `maxCommandSequenceLength` if you want Bedrock's ceiling.
+
+## The command seam
+
+This package implements no commands. Every line it does not handle itself goes to a
+`CommandRunner`:
+
+```ts
+interface CommandRunner<TSource> {
+    run(commandLine: string, context: CommandContext<TSource>): { result?: number; forks?: number };
+}
+```
+
+The context carries the source you passed to the run, plus the function id and line number the
+command came from, which is what diagnostics and logs need. The server's Brigadier dispatcher is
+the real adapter at this seam - `packages/prismarine/src/command/function/` holds it, and routes
+every line into the `@jsprismarine/commands` tree with the source made silent, as Java does.
+`RecordingCommandRunner` is the other one, and it records what a function would run so a test or
+a pack author can inspect it without a world.
+
+A runner may throw. The executor reports the failure and continues with the next line, because one
+failing command does not abort a Java function.
+
+`/return` is split across the seam. The runner implements the command, because it is one, and
+reports it back as `returned`; only the executor can act on it, because ending a function means
+dropping a frame. A line that reports `returned` ends the function it came from, and the loop
+carries on with whatever called it. `returned.value` is what the function returns, and a
+`/return fail` or a `return run` whose command failed ends the function without one. The report
+collects the values of the functions the entry point invoked directly, in `returnValues`, so
+`#a:tag` whose three members returned 0, nothing and 5 reports `[0, 5]`. A `/return` deeper in the
+call tree ends its own function and contributes nothing, which is Java's rule: `/return` returns
+from one function, not from its caller.
+
+The one exception is a `function` line, which the executor reads itself. A call is control flow
+rather than a command, and handling it here is what keeps nesting on the queue. The line form is
+`function <id>`, `function #<tag>`, or either of those followed by an argument compound. The
+compound is read as JSON by default, because SNBT needs a parser this package does not own; pass
+`parseArguments` to supply one. Java's `function <id> with block|entity|storage` forms need a world
+to read from and are not supported yet.
+
+## Why the executor uses a queue
+
+Java rewrote function execution in 23w41a, moving the call stack onto the heap: `ExecutionContext`
+holds a `Deque` of queued commands, a `commandQuota` and a `Frame` type carrying its own depth.
+That rewrite is what lets the gamerules bound work and what closed MC-265805, where a
+tail-recursive function consumed memory linearly with depth.
+
+This executor has the same shape: an array of frames, one loop, and a counter charged per
+operation. Nesting 20000 functions deep does not touch the JavaScript stack, and a call made from
+the last line of a function replaces its frame instead of stacking on it, so a tail-recursive
+function runs at constant depth until the operation limit stops it. Both are covered by tests.
+
+## Reporting
+
+Loading, compiling and running all report problems instead of throwing. Each diagnostic carries a
+severity, a stable `code`, a message, and whichever of `functionId`, `line` and `pack` apply. A
+broken file is left out of the registry and the rest of the stack still loads.
+
+## Further reading
+
+[The research note on commands, functions and datapack execution](../../docs/research/commands-functions-and-datapack-execution.md)
+is where the facts above come from, including what was measured in Mojang's own files and what
+could not be confirmed.