rustmaps

package

v1.0.4 Latest Latest Go to latest Published: Sep 11, 2025 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/maintc/rustmaps-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package rustmaps provides functionality for generating and managing Rust game maps

Index ¶

type DownloadLinks
type Generator
- func NewGenerator(baseDir *string) (*Generator, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type DownloadLinks ¶ added in v1.0.1

type DownloadLinks struct {
	MapURL       string `json:"map_url"`
	ImageURL     string `json:"image_url"`
	ImageIconURL string `json:"image_icon_url"`
	ThumbnailURL string `json:"thumbnail_url"`
}

type Generator ¶

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

Generator handles map generation and management

func NewGenerator ¶

func NewGenerator(baseDir *string) (*Generator, error)

NewGenerator creates a new Generator instance

func (*Generator) AddMap ¶

func (g *Generator) AddMap(m *types.Map)

func (*Generator) CanGenerate ¶

func (g *Generator) CanGenerate(log *zap.Logger) bool

func (*Generator) ContainCustomMaps ¶

func (g *Generator) ContainCustomMaps() bool

func (*Generator) DetermineTier ¶

func (g *Generator) DetermineTier(log *zap.Logger) (string, bool)

func (*Generator) Download ¶

func (g *Generator) Download(log *zap.Logger, version string) error

func (*Generator) DownloadFile ¶

func (g *Generator) DownloadFile(log *zap.Logger, url, target string) error

DownloadFile downloads a file using net/http

func (*Generator) Generate ¶

func (g *Generator) Generate(log *zap.Logger) bool

func (*Generator) Generating ¶

func (g *Generator) Generating() bool

func (*Generator) GetConfigPath ¶

func (g *Generator) GetConfigPath() string

func (*Generator) GetDownloadsDir ¶

func (g *Generator) GetDownloadsDir() string

func (*Generator) GetImportDir ¶

func (g *Generator) GetImportDir() string

func (*Generator) GetLogPath ¶

func (g *Generator) GetLogPath() string

func (*Generator) GetMaps ¶

func (g *Generator) GetMaps() []*types.Map

func (*Generator) GetRandomSeed ¶

func (g *Generator) GetRandomSeed() string

func (*Generator) GetStatus ¶

func (g *Generator) GetStatus(log *zap.Logger, m *types.Map) (*api.RustMapsStatusResponse, error)

func (*Generator) Import ¶

func (g *Generator) Import(log *zap.Logger, force bool) error

Import imports a CSV file containing map definitions

func (*Generator) InitDirs ¶

func (g *Generator) InitDirs() error

InitDirs initializes required directories

func (*Generator) IsApiKeySet ¶

func (g *Generator) IsApiKeySet() bool

func (*Generator) LoadCSV ¶

func (g *Generator) LoadCSV(log *zap.Logger, mapsPath string) error

LoadCSV reads the currently selected map file

func (*Generator) LoadConfig ¶

func (g *Generator) LoadConfig() error

LoadConfig loads the configuration from disk

func (*Generator) OverrideDownloadsDir ¶

func (g *Generator) OverrideDownloadsDir(log *zap.Logger, dir string)

func (*Generator) Pending ¶

func (g *Generator) Pending() bool

func (*Generator) SaveConfig ¶

func (g *Generator) SaveConfig() error

SaveConfig saves the current configuration to disk

func (*Generator) SetApiKey ¶

func (g *Generator) SetApiKey(apiKey string)

func (*Generator) SetTier ¶

func (g *Generator) SetTier(tier string)

func (*Generator) SyncStatus ¶

func (g *Generator) SyncStatus(log *zap.Logger, m *types.Map) error

func (*Generator) ValidateAuthentication ¶

func (g *Generator) ValidateAuthentication(log *zap.Logger) error

func (*Generator) ValidateCSV ¶

func (g *Generator) ValidateCSV(log *zap.Logger, mapsPath string) error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL