core

Documentation

Index

• Constants
• Variables
• func MatchHash(data []byte, hashFormat string, hash string) (bool, error)
• type CurseClient
  • func NewCurseClient(apiKey string) *CurseClient
  • func (c *CurseClient) GetDownloadUrl(ctx context.Context, d *CurseforgeData) (string, error)
• type CurseforgeData
  • func ParseCfData(s string) (*CurseforgeData, error)
  • func (d *CurseforgeData) String() string
• type DLType
• type Download
• type IndexToml
• type IndexedfileToml
• type Installer
• type LocalInstaller
  • func NewLocalInstaller(p *Pack, dir string) (*LocalInstaller, error)
  • func (i *LocalInstaller) GetUpdates() (*Updates, error)
  • func (i *LocalInstaller) Install(ctx context.Context) (*Updates, error)
  • func (i *LocalInstaller) InstallMod(ctx context.Context, m *Mod) error
• type MetafileDownload
• type MetafileOption
• type MetafileToml
• type MetafileUpdate
• type Mod
• type Pack
  • func NewPack(r *Repository) (*Pack, error)
• type PackToml
• type RepoOptFn
• type Repository
  • func NewRepository(url *url.URL, hashFormat, hash string) *Repository
  • func (r *Repository) BaseUrl() *url.URL
  • func (r *Repository) IndexUrl() *url.URL
  • func (r *Repository) Load(ctx context.Context) error
• type Side
• type UpdateCurseForge
• type UpdateModrinth
• type Updates
  • func (u *Updates) String() string

Constants

const (
	Side_Client = Side("client")
	Side_Server = Side("server")
	Side_Both   = Side("both")

	DL_Url        = DLType("url")
	DL_Curseforge = DLType("curseforge")
)

Variables

var (
	DefaultCurseClient = NewCurseClient(getApiKey())
)

var PreferredHashList = []string{
	"murmur2",
	"md5",
	"sha1",
	"sha256",
	"sha512",
}

Functions

func MatchHash

func MatchHash(data []byte, hashFormat string, hash string) (bool, error)

Types

type CurseClient

type CurseClient struct {
	// contains filtered or unexported fields
}

func NewCurseClient

func NewCurseClient(apiKey string) *CurseClient

func (*CurseClient) GetDownloadUrl

func (c *CurseClient) GetDownloadUrl(ctx context.Context, d *CurseforgeData) (string, error)

type CurseforgeData

type CurseforgeData struct {
	ProjectID int `json:"projectId"`
	FileID    int `json:"fileId"`
}

func ParseCfData

func ParseCfData(s string) (*CurseforgeData, error)

func (*CurseforgeData) String

func (d *CurseforgeData) String() string

type DLType

type DLType string

type Download

type Download struct {
	Type DLType `json:"type"`
	Data string `json:"data"`
}

type IndexToml

type IndexToml struct {
	HashFormat string            `toml:"hash-format"`
	Files      []IndexedfileToml `toml:"files,omitempty"`
}

type IndexedfileToml

type IndexedfileToml struct {
	File       string `toml:"file"`
	Hash       string `toml:"hash"`
	Alias      string `toml:"alias,omitempty"`
	HashFormat string `toml:"hash-format,omitempty"`
	Metafile   bool   `toml:"metafile,omitempty"`
	Preserve   bool   `toml:"preserve,omitempty"`
}

type Installer

type Installer interface {
	Install() error
	GetUpdates() error
	InstallMod(m *Mod) (bool, error)
}

type LocalInstaller

type LocalInstaller struct {
	BaseDir string
	Pack    *Pack
	// contains filtered or unexported fields
}

func NewLocalInstaller

func NewLocalInstaller(p *Pack, dir string) (*LocalInstaller, error)

func (*LocalInstaller) GetUpdates

func (i *LocalInstaller) GetUpdates() (*Updates, error)

func (*LocalInstaller) Install

func (i *LocalInstaller) Install(ctx context.Context) (*Updates, error)

Install execute install and update modpack

func (*LocalInstaller) InstallMod

func (i *LocalInstaller) InstallMod(ctx context.Context, m *Mod) error

type MetafileDownload

type MetafileDownload struct {
	HashFormat string `toml:"hash-format"`
	Hash       string `toml:"hash"`
	Url        string `toml:"url,omitempty"`
	Mode       string `toml:"mode,omitempty"`
}

type MetafileOption

type MetafileOption struct {
	Optional    bool   `toml:"optional"`
	Default     bool   `toml:"default,omitempty"`
	Description string `toml:"description,omitempty"`
}

type MetafileToml

type MetafileToml struct {
	Filename  string            `toml:"filename"`
	Name      string            `toml:"name"`
	Side      string            `toml:"side,omitempty"`
	Download  *MetafileDownload `toml:"download"`
	Update    *MetafileUpdate   `toml:"update,omitempty"`
	Option    *MetafileOption   `toml:"option,omitempty"`
	IndexName string
}

type MetafileUpdate

type MetafileUpdate struct {
	Modrinth   *UpdateModrinth   `toml:"modrinth,omitempty,nullable"`
	CurseForge *UpdateCurseForge `toml:"curseforge,omitempty,nullable"`
}

type Mod

type Mod struct {
	Path       string    `json:"path"`
	Hash       string    `json:"hash"`
	HashFormat string    `json:"hashFormat"`
	Side       Side      `json:"side,omitempty"`
	Downloads  *Download `json:"download"`
}

type Pack

type Pack struct {
	Name    string `json:"name"`
	Author  string `json:"author,omitempty"`
	Version string `json:"version,omitempty"`
	Mods    []*Mod `json:"files,omitempty"`
}

func NewPack

func NewPack(r *Repository) (*Pack, error)

type PackToml

type PackToml struct {
	Name        string `toml:"name"`
	Author      string `toml:"author,omitempty"`
	Version     string `toml:"version,omitempty"`
	Description string `toml:"description,omitempty"`
	PackFormat  string `toml:"pack-format"`
	Index       struct {
		File       string `toml:"file"`
		HashFormat string `toml:"hash-format"`
		Hash       string `toml:"hash"`
	} `toml:"index"`
	Versions map[string]string `toml:"versions"`
}

type RepoOptFn

type RepoOptFn func(r *Repository)

type Repository

type Repository struct {
	Url            *url.URL
	Pack           *PackToml
	Index          *IndexToml
	Metafiles      []*MetafileToml
	PackHashFormat string
	PackHash       string
	// contains filtered or unexported fields
}

func NewRepository

func NewRepository(url *url.URL, hashFormat, hash string) *Repository

func (*Repository) BaseUrl

func (r *Repository) BaseUrl() *url.URL

func (*Repository) IndexUrl

func (r *Repository) IndexUrl() *url.URL

func (*Repository) Load

func (r *Repository) Load(ctx context.Context) error

type Side

type Side string

type UpdateCurseForge

type UpdateCurseForge struct {
	FileId    int `toml:"file-id,omitempty"`
	ProjectId int `toml:"project-id,omitempty"`
}

type UpdateModrinth

type UpdateModrinth struct {
	ModId   string `toml:"mod-id,omitempty"`
	Version string `toml:"version,omitempty"`
}

type Updates

type Updates struct {
	Added     []*Mod
	Removed   []*Mod
	Unchanged []*Mod
}

func (*Updates) String

func (u *Updates) String() string