ffxiv

README

go-ffxiv

Go client (scraper) for some FFXIV stuff.

License

MPL 2.0.

Documentation

Overview

Package ffxiv implements functions to read some data from FFXIV website.

Index

• Constants
• type Client
  • func NewClient() (Client, error)
• type ServerCategory
• type ServerStatus
• type WorldStatus
  • func ParseWorldStatusPage(r io.Reader) ([]WorldStatus, error)

Constants

const Version = 1

Version is used to keep track of breaking changes in the structs.

Types

type Client

type Client interface {
	WorldStatus() ([]WorldStatus, error)
}

func NewClient

func NewClient() (Client, error)

type ServerCategory

type ServerCategory string

const (
	CategoryStandard  ServerCategory = "Standard"
	CategoryPreferred ServerCategory = "Preferred"
	CategoryCongested ServerCategory = "Congested"
	CategoryNew       ServerCategory = "New"
)

type ServerStatus

type ServerStatus string

const (
	StatusUnknown            ServerStatus = ""
	StatusMaintenance        ServerStatus = "maintenance"
	StatusPartialMaintenance ServerStatus = "partial_maintenance"
	StatusOnline             ServerStatus = "online"
)

type WorldStatus

type WorldStatus struct {
	Group string

	Name         string
	Category     ServerCategory
	ServerStatus ServerStatus

	CanCreateNewCharacters bool
}

func ParseWorldStatusPage

func ParseWorldStatusPage(r io.Reader) ([]WorldStatus, error)