API reference / @jsprismarine/prismarine / version

version

Variables

SOFTWARE_NAME

const SOFTWARE_NAME: "JSPrismarine" = 'JSPrismarine'

Defined in: prismarine/src/version.ts:6

The software name this server reports beside its version.

Functions

serverVersion()

serverVersion(): string

Defined in: prismarine/src/version.ts:16

The version this server reports: the version a release or nightly build stamped in, or the package version when running from source.

Reads only the package manifest, so the host process and --version can call it without loading the protocol codecs. about.ts adds the protocol side.

Returns

string

The version, without a leading v.

---

softwareLabel()

softwareLabel(highlight?): string

Defined in: prismarine/src/version.ts:23

The software and its version as every surface names them, such as JSPrismarine v0.20.0.

Parameters

highlight?

boolean = false

Wraps the version in §e/§r, for the startup log and chat.

Returns

string

The software label.