Documentation
¶
Index ¶
- type Provider
- func (p *Provider) Download(gameVersion, serverVersion, installDir string, ...) error
- func (p *Provider) DownloadContext(ctx context.Context, gameVersion, serverVersion, installDir string, ...) error
- func (p *Provider) DownloadURL(gameVersion, serverVersion string) (string, error)
- func (p *Provider) DownloadURLContext(ctx context.Context, gameVersion string, serverVersion string) (string, error)
- func (p *Provider) GameVersions() ([]string, error)
- func (p *Provider) GameVersionsContext(ctx context.Context) ([]string, error)
- func (p *Provider) ServerVersions(gameVersion string) ([]string, error)
- func (p *Provider) ServerVersionsContext(ctx context.Context, gameVersion string) ([]string, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Provider ¶
type Provider struct {
provider.BaseProvider
}
func (*Provider) Download ¶
func (p *Provider) Download(gameVersion, serverVersion, installDir string, onProgress func(current, total int64)) error
Download downloads the Fabric 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 Fabric 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.20.5", "1.18-pre2", "20w51a").
- serverVersion: the Fabric loader version.
- 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 ¶
DownloadURL returns the download URL for the Fabric server JAR for a given game version and loader version. It uses a default background context.
func (*Provider) DownloadURLContext ¶ added in v2.1.0
func (p *Provider) DownloadURLContext(ctx context.Context, gameVersion string, serverVersion string) (string, error)
DownloadURLContext returns the download URL for the Fabric server JAR for a given game version and loader version with context support.
Parameters:
- ctx: the context to control the request lifetime.
- gameVersion: the Minecraft version string (e.g., "1.21.5", "25w14craftmine", "1.18-pre2").
- serverVersion: the Fabric loader version string (e.g., "0.16.14").
Returns:
- string: the direct download URL for the Fabric server JAR file if the versions exist.
- error: an error if the game version or loader version is not found, or if any HTTP or JSON decoding issues occur.
func (*Provider) GameVersions ¶
GameVersions fetches the list of all Minecraft Fabric-supported game versions from the official FabricMC API. It uses a default background context.
func (*Provider) GameVersionsContext ¶ added in v2.1.0
GameVersionsContext fetches the list of all Minecraft Fabric-supported game versions from the official FabricMC API with context support.
Parameters:
- ctx: the context to control the request lifetime.
Returns:
- []string: a slice of Minecraft versions supported by Fabric (e.g., "1.20.5", "1.18-pre2", "20w51a").
- error: an error if any HTTP or JSON decoding issues occur.
func (*Provider) ServerVersions ¶
ServerVersions fetches the list of all available Fabric loader versions from the official FabricMC API. It uses a default background context.
func (*Provider) ServerVersionsContext ¶ added in v2.1.0
ServerVersionsContext fetches the list of all available Fabric loader versions from the official FabricMC API with context support. It also verifies that the provided game version is supported by Fabric.
Parameters:
- ctx: the context to control the request lifetime.
- gameVersion: the Minecraft version string (e.g., "1.21.5", "25w14craftmine", "1.18-pre2").
Returns:
- []string: a slice of Fabric loader versions (e.g., "0.16.14", "0.15.11").
- error: an error if the game version is not supported or if any HTTP or JSON decoding issues occur.