catalog

module

v1.2.1 Latest Latest Go to latest Published: Oct 7, 2026 License: AGPL-3.0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

gitlab.com/shardkeep/catalog

Links

Open Source Insights

README ¶

Shardkeep catalog

The central catalog of Shardkeep: Minecraft server software (Vanilla, Paper, Purpur) and server plugins (from Modrinth and Hangar) with compatibility data, published as signed static snapshots at https://catalog.shardkeep.gg/v1/.

Metadata only. The catalog lists official download URLs and the checksums their publishers published; Controllers download from the publishers and verify.
Signed. Each snapshot's index is signed with Ed25519; Shardkeep Controllers ship the public keys and refuse anything else, including older snapshots replayed.
Optional. Controllers cache the last snapshot and keep working without the catalog; operators can switch catalog access off entirely (-offline) or point it at a mirror.
Curated. Plugins above 10,000 downloads, plus curation/allow.json; curation/deny.json keeps harmful plugins and versions out.

Document	Contents
FORMAT.md	The snapshot format Controllers rely on
deploy/README.md	Running the builder, key custody, serving through the CDN
CONTRIBUTING.md	Suggesting plugins, reporting harmful ones, contributing code

go run ./cmd/shardkeep-catalog keygen -private catalog.key
go run ./cmd/shardkeep-catalog build -out out/v1 -key catalog.key
go run ./cmd/shardkeep-catalog verify -dir out/v1 -trust ed25519:...

Part of the Shardkeep project. Licensed under the AGPL-3.0.

Directories ¶

Path	Synopsis
builder Package builder builds catalog snapshots: it asks the upstream sources (Mojang, PaperMC and PurpurMC for server software; Modrinth and Hangar for plugins), applies the curation files, and publishes a signed snapshot in format v1.	Package builder builds catalog snapshots: it asks the upstream sources (Mojang, PaperMC and PurpurMC for server software; Modrinth and Hangar for plugins), applies the curation files, and publishes a signed snapshot in format v1.
cmd
shardkeep-catalog command Command shardkeep-catalog builds, signs and checks Shardkeep catalog snapshots.	Command shardkeep-catalog builds, signs and checks Shardkeep catalog snapshots.
format Package format is version 1 of the Shardkeep catalog snapshot format: the types, their encoding, and Ed25519 signing and verification.	Package format is version 1 of the Shardkeep catalog snapshot format: the types, their encoding, and Ed25519 signing and verification.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL