Documentation
¶
Index ¶
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 Forge server files to the specified installation directory. It handles both standard installer JARs and legacy zip patches (which require merging with a vanilla server JAR).
Parameters:
- gameVersion: the Minecraft version string (e.g., "1.21.6", "1.7.10-pre4", "1.4").
- serverVersion: the Forge loader version.
- installDir: the directory where the server files will be saved.
- onProgress: a callback function to report download progress.
Returns:
- error: an error if the download or patching (for legacy versions) fails.
func (*Provider) DownloadURL ¶
DownloadURL returns the download URL for the Forge server file for a given game version and loader version. It determines the correct URL format based on the game version.
Parameters:
- gameVersion: the Minecraft version string (e.g., "1.21.6", "1.7.10-pre4", "1.4").
- serverVersion: the Forge loader version string (e.g., "14.23.4.2720").
Returns:
- string: the direct download URL for the Forge server installer/archive 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 Forge-supported game versions from the official Forge maven metadata.
Returns:
- []string: a slice of Minecraft versions supported by Forge (e.g., "1.21.6", "1.7.10-pre4", "1.4").
- error: an error if any HTTP or JSON decoding issues occur.
func (*Provider) ServerVersions ¶
ServerVersions fetches a list of available Forge loader versions for a given Minecraft version. It retrieves the data from the official Forge maven metadata.
Parameters:
- gameVersion: the Minecraft version string (e.g., "1.21.6", "1.7.10-pre4", "1.4").
Returns:
- []string: a slice of Forge loader versions (e.g., "56.0.3", "14.23.4.2720").
- error: an error if the game version is not supported or if any HTTP or JSON decoding issues occur.