Publishing
Release a mod for others to play.
modlock publish builds the mod and runs the same check every host runs before
loading it. The module may import only Modlock and WASI functions, and it must
start and answer its first event within the time limits. Then the command
uploads the mod to the destination you choose with --to:
--to | Effect |
|---|---|
hyperline | The default. Upload the mod to hyperline.gg. |
archive | Write SLUG-VERSION.zip to --out: the mod, modlock.exe and Play.cmd to run it on Windows. |
github | Attach that zip to the GitHub release SLUG-vVERSION, creating the release if needed. |
On your first upload to hyperline.gg, the command opens your browser to sign
in, as modlock login does, and saves the sign-in for later commands. During
the alpha, you can publish there only once you have access, which you can ask
for in the Hyperline Discord. To publish to
another service with the same API, pass its address with --origin. The
github destination publishes with the gh command
line, signed in as gh is.
The build copies every field that Modlock itself does not read, such as a
description for a store, into the built mod.json. The destination reads those
fields there. Hyperline accepts each version only once: raise version in
mod.json before you publish again.
Pass --notes to say what changed: hyperline.gg shows the notes on the game's
page, and the github destination puts them on the new release.
--prerelease publishes a version such as 0.2.0-pre.1 to hyperline.gg for the
mod's testers only. Every game keeps playing its current release. For each of
the mod's games, hyperline.gg adds a Draft copy that plays the prerelease, such
as "Zombie Tag Prerelease". Anyone a tester invites may join that copy. A later
prerelease replaces the one before it. When you choose the Draft copy as current
on hyperline.gg, the same build becomes the release without another publish.
After the upload, modlock publish tells you where the release can be
played. A mod with code plays on hyperline.gg's game servers at once, and on
players' own PCs after a reviewer approves it. A trusted creator's releases play
everywhere as soon as they are published. When your mod has its own layouts,
models or sounds, modlock publish uploads them with it, as client
content explains.