paper

func (*Provider) Download ¶

func (p *Provider) Download(gameVersion, serverVersion, installDir string, onProgress func(current, total int64)) error

Download downloads the PaperMC server JAR to the specified installation directory. It uses a default background context.

func (*Provider) DownloadContext ¶ added in v2.1.0

func (p *Provider) DownloadContext(ctx context.Context, gameVersion, serverVersion, installDir string, onProgress func(current, total int64)) error

DownloadContext downloads the PaperMC server JAR to the specified installation directory with context support.

Parameters:

• ctx: the context to control the download cancellation.
• gameVersion: the Minecraft version string (e.g., "1.16.5", "1.13-pre7").
• serverVersion: the Paper build number.
• installDir: the directory where the server JAR will be saved.
• onProgress: a callback function to report download progress.

Returns:

• error: an error if the download fails.

func (*Provider) DownloadURL ¶

func (p *Provider) DownloadURL(gameVersion, serverVersion string) (string, error)

DownloadURL returns the download URL for the PaperMC server JAR for a given game version and build number. It uses a default background context.

func (*Provider) DownloadURLContext ¶ added in v2.1.0

func (p *Provider) DownloadURLContext(ctx context.Context, gameVersion, serverVersion string) (string, error)

DownloadURLContext returns the download URL for the PaperMC server JAR for a given game version and build number with context support.

Parameters:

• ctx: the context to control the request lifetime.
• gameVersion: the Minecraft version string (e.g., "1.16.5", "1.13-pre7").
• serverVersion: the PaperMC build number for the specified version.

Returns:

• string: the direct download URL for the PaperMC server JAR file if the build exists.
• error: an error if the game version or build number is not found, or if any HTTP or JSON decoding issues occur.

func (*Provider) GameVersions ¶

func (p *Provider) GameVersions() ([]string, error)

GameVersions fetches the list of all Minecraft paper server versions from the official PaperMC API version manifest. It uses a default background context.

func (*Provider) GameVersionsContext ¶ added in v2.1.0

func (p *Provider) GameVersionsContext(ctx context.Context) ([]string, error)

GameVersionsContext fetches the list of all Minecraft paper server versions from the official PaperMC API version manifest with context support.

Parameters:

• ctx: the context to control the request lifetime.

Returns:

• []string: a slice of Minecraft paper server versions (e.g., "1.16.5", "1.13-pre7").
• error: an error if any HTTP or JSON decoding issues occur.

func (*Provider) ServerVersions ¶

func (p *Provider) ServerVersions(gameVersion string) ([]string, error)

ServerVersions fetches the list of all available PaperMC build numbers for a given game version. It uses a default background context.

func (*Provider) ServerVersionsContext ¶ added in v2.1.0

func (p *Provider) ServerVersionsContext(ctx context.Context, gameVersion string) ([]string, error)

ServerVersionsContext fetches the list of all available PaperMC build numbers for a given game version with context support.

Parameters:

• ctx: the context to control the request lifetime.
• gameVersion: the Minecraft version string (e.g., "1.16.5", "1.13-pre7").

Returns:

• []string: a slice of build numbers for the specified game version.
• error: an error if the game version is not supported or if any HTTP or JSON decoding issues occur.