neoforge

func (*Provider) Download ¶

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

Download downloads the NeoForge installer 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 NeoForge installer 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.21.6", "25w14craftmine", "1.21").
• serverVersion: the NeoForge loader version.
• installDir: the directory where the installer 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 NeoForge server file 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, serverVersion string) (string, error)

DownloadURLContext returns the download URL for the NeoForge server file for a given game version and loader version with context support. It determines the correct URL format based on the game version.

Parameters:

• ctx: the context to control the request lifetime.
• gameVersion: the Minecraft version string (e.g., "1.21.6", "25w14craftmine", "1.21").
• serverVersion: the NeoForge loader version string (e.g., "21.0.142-beta", "0.25w14craftmine.5-beta").

Returns:

• string: the direct download URL for the NeoForge 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 XML decoding issues occur.

func (*Provider) GameVersions ¶

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

GameVersions fetches the list of all Minecraft NeoForge-supported game versions from the official NeoForged maven metadata. 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 NeoForge-supported game versions from the official NeoForged maven metadata with context support.

Parameters:

• ctx: the context to control the request lifetime.

Returns:

• []string: a slice of Minecraft versions supported by NeoForge (e.g., "1.21.6", "25w14craftmine", "1.21").
• error: an error if any HTTP or XML decoding issues occur.

func (*Provider) ServerVersions ¶

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

ServerVersions fetches a list of available NeoForge loader versions for a given Minecraft 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 a list of available NeoForge loader versions for a given Minecraft version with context support. It retrieves the data from the official NeoForged maven metadata.

Parameters:

• ctx: the context to control the request lifetime.
• gameVersion: the Minecraft version string (e.g., "1.21.6", "25w14craftmine", "1.21").

Returns:

• []string: a slice of NeoForge loader versions (e.g., "21.0.142-beta", "0.25w14craftmine.5-beta").
• error: an error if the game version is not supported or if any HTTP or XML decoding issues occur.