ss

Documentation

Index

• Variables
• type DevInfo
• type Game
• type GameDates
• type GameDesc
• type GameGenre
• type GameInfoReq
• type GameInfoResp
  • func GameInfo(dev DevInfo, user UserInfo, req GameInfoReq) (*GameInfoResp, error)
• type GameMedia
• type GameNames
• type UserInfo

Variables

var ErrNotFound = errors.New("not found")

ErrNotFound is the error returned when a ROM isn't found.

Types

type DevInfo

type DevInfo struct {
	ID       string
	Password string
	Name     string
}

DevInfo is the information about the developer and used across APIs.

type Game

type Game struct {
	ID        int       `xml:"id"`
	Name      string    `xml:"nom"`
	Names     GameNames `xml:"noms"`
	Region    string    `xml:"region"`
	Publisher string    `xml:"editeur"`
	Developer string    `xml:"developpeur"`
	Players   string    `xml:"joueurs"`
	Rating    float64   `xml:"note"`
	Desc      GameDesc  `xml:"synopsis"`
	Genre     GameGenre `xml:"genres"`
	Media     GameMedia `xml:"medias"`
	Dates     GameDates `xml:"dates"`
}

Game represents a game in SS.

type GameDates

type GameDates struct {
	US string `xml:"date_us"`
	FR string `xml:"date_fr"`
	EU string `xml:"date_eu"`
	JP string `xml:"date_jp"`
	XX string `xml:"date_xx"`
}

GameDates is the date for many regions.

type GameDesc

type GameDesc struct {
	EN string `xml:"synopsis_us"`
	FR string `xml:"synopsis_fr"`
	DE string `xml:"synopsis_de"`
	ES string `xml:"synopsis_es"`
	PT string `xml:"synopsis_pt"`
}

GameDesc is the desc in many languages.

type GameGenre

type GameGenre struct {
	EN []string `xml:"genres_us>genre_us"`
	FR []string `xml:"genres_fr>genre_fr"`
	DE []string `xml:"genres_de>genre_de"`
	ES []string `xml:"genres_es>genre_es"`
	PT []string `xml:"genres_pt>genre_pt"`
}

GameGenre is the genre in many languages.

type GameInfoReq

type GameInfoReq struct {
	SHA1    string
	RomType string
}

GameInfoReq is the information we use in the GameInfo command.

type GameInfoResp

type GameInfoResp struct {
	Game Game `xml:"jeu"`
}

GameInfoResp is the response from GameInfo.

func GameInfo

func GameInfo(dev DevInfo, user UserInfo, req GameInfoReq) (*GameInfoResp, error)

GameInfo is the call to get game info.

type GameMedia

type GameMedia struct {
	ScreenShot string `xml:"media_screenshot"`
	BoxUS      string `xml:"media_boxs>media_boxs2d>media_box2d_us"`
	BoxFR      string `xml:"media_boxs>media_boxs2d>media_box2d_fr"`
	BoxEU      string `xml:"media_boxs>media_boxs2d>media_box2d_eu"`
	BoxJP      string `xml:"media_boxs>media_boxs2d>media_box2d_jp"`
	BoxXX      string `xml:"media_boxs>media_boxs2d>media_box2d_xx"`
	Box3DUS    string `xml:"media_boxs>media_boxs3d>media_box3d_us"`
	Box3DFR    string `xml:"media_boxs>media_boxs3d>media_box3d_fr"`
	Box3DEU    string `xml:"media_boxs>media_boxs3d>media_box3d_eu"`
	Box3DJP    string `xml:"media_boxs>media_boxs3d>media_box3d_jp"`
	Box3DXX    string `xml:"media_boxs>media_boxs3d>media_box3d_xx"`
}

GameMedia is the media for many regions.

type GameNames

type GameNames struct {
	Original string `xml:"nom_origine"`
	EN       string `xml:"nom_us"`
	FR       string `xml:"nom_fr"`
	DE       string `xml:"nom_de"`
	ES       string `xml:"nom_es"`
	PT       string `xml:"nom_pt"`
}

GameNames is the name in many languages.

type UserInfo

type UserInfo struct {
	ID       string
	Password string
}

UserInfo is information about the user making the call.