README
¶
gocraft-cli
Builds and validates plugin bundles for the GoCraft server.
go install github.com/GoCraft-MC/gocraft-cli@latest
Or download a binary — no Go toolchain needed, which is how the Gradle plugin gets it:
https://github.com/GoCraft-MC/gocraft-cli/releases/download/<tag>/gocraft-cli_<tag>_<os>_<arch>
<os> is linux, darwin or windows and <arch> is amd64 or arm64;
Windows adds .exe. Each release also carries checksums.txt. That naming is a
contract — it is constructed by whoever downloads, so it does not change without
them.
gocraft-cli validate ./my-plugin # check plugin.toml
gocraft-cli build -o my-plugin.gcpkg ./my-plugin
Why it is not part of the server
A plugin author compiles; they never run a server. Installing one to build the other would be absurd, and a build tool that could reach into a server's internals would eventually do it.
Here it cannot: the server is not on this module's graph. The whole dependency
list is gocraft-abi — the wire types, the command tree, and the .gcpkg
format — plus protobuf and a TOML parser underneath them. The rule is enforced
by the compiler rather than by review.
What it does not reimplement
The bundle format and the command tree come from gocraft-abi, and the server
reads them with the same code. That is the property worth the split: a tree this
refuses is a tree the server would have refused, so the failure lands on the
machine that has the source rather than on someone's server at load time.
A second implementation here would agree on the day it was written and drift quietly afterwards, which is the failure the shared contract exists to prevent.
Versioning
It releases on its own clock. A plugin author has no reason to update their build tool because the server fixed something in its world generator, and the Gradle plugin pins a version of this rather than a version of the server.
Documentation
¶
Overview ¶
Command gocraft-cli builds and validates GoCraft plugin bundles.
It is a separate module from the server on purpose: a plugin author compiles, they never run a server, and a build tool that could reach into a server's internals would eventually do it. Here it cannot — the server is not on the module graph, so the rule is enforced by the compiler rather than by review.
The bundle format and its validation are not reimplemented here. They come from gocraft-abi, which the server reads them with too, so a bundle that builds is a bundle that loads: a tree this refuses is a tree the server would have refused, on the machine that has the source.
Source Files