internal

Documentation

Overview

Package internal contains utility functions and constants for Spy Cards Online.

Index

• Variables
• func ModifyRequest(r *http.Request) *http.Request
• func SaveSettings(s *Settings)
• func SetActive(b bool)
• func WithConfig(ctx context.Context, config *Config) context.Context
• type AudioSettings
• type ButtonStyle
• type Config
  • func GetConfig(ctx context.Context) *Config
• type ControlsSettings
• type GamepadButton
  • func (gpb GamepadButton) MarshalJSON() ([]byte, error)
  • func (gpb GamepadButton) String() string
  • func (gpb *GamepadButton) UnmarshalJSON(b []byte) error
• type GamepadLayout
• type KeyboardLayout
• type Settings
  • func LoadSettings() *Settings

Variables

var DefaultConfig = &Config{
	UserImageBaseURL: "https://spy-cards.lubar.me/spy-cards/user-img/",
	ArcadeAPIBaseURL: "https://spy-cards.lubar.me/spy-cards/arcade/api/",
}

DefaultConfig is the Config used by the official Spy Cards Online site.

var OnSettingsChanged []func(*Settings)

var Version = [3]uint64{0, 2, 70}

Version is the current version of Spy Cards Online.

Functions

func ModifyRequest

func ModifyRequest(r *http.Request) *http.Request

ModifyRequest modifies an HTTP request before it is sent.

func SaveSettings

func SaveSettings(s *Settings)

func SetActive

func SetActive(b bool)

SetActive sets the active flag for the UI, which hides some UI elements.

func WithConfig

func WithConfig(ctx context.Context, config *Config) context.Context

WithConfig attaches a Config to a context.

Types

type AudioSettings

type AudioSettings struct {
	Music  float64 `json:"music"`
	Sounds float64 `json:"sounds"`
}

type ButtonStyle

type ButtonStyle int

const (
	StyleKeyboard       ButtonStyle = 0
	StyleGenericGamepad ButtonStyle = 1
)

type Config

type Config struct {
	UserImageBaseURL string `json:"user_image_base_url"`
	ArcadeAPIBaseURL string `json:"arcade_api_base_url"`
}

Config holds data about external services used by Spy Cards Online.

func GetConfig

func GetConfig(ctx context.Context) *Config

GetConfig returns the Config associated with a context, or DefaultConfig.

type ControlsSettings

type ControlsSettings struct {
	Keyboard int              `json:"keyboard,omitempty"`
	Gamepad  map[string]int   `json:"gamepad,omitempty"`
	CustomKB []KeyboardLayout `json:"customKB"`
	CustomGP []GamepadLayout  `json:"customGP"`
}

type GamepadButton

type GamepadButton struct {
	Button     int
	IsAxis     bool
	IsPositive bool
}

func (GamepadButton) MarshalJSON

func (gpb GamepadButton) MarshalJSON() ([]byte, error)

func (GamepadButton) String

func (gpb GamepadButton) String() string

func (*GamepadButton) UnmarshalJSON

func (gpb *GamepadButton) UnmarshalJSON(b []byte) error

type GamepadLayout

type GamepadLayout struct {
	Name   string            `json:"name"`
	Button [10]GamepadButton `json:"button"`
	Style  ButtonStyle       `json:"style,omitempty"`
}

type KeyboardLayout

type KeyboardLayout struct {
	Name string     `json:"name"`
	Code [10]string `json:"code"`
}

type Settings

type Settings struct {
	Audio AudioSettings `json:"audio"`

	Character string `json:"character,omitempty"`

	Disable3D  bool `json:"disable3D,omitempty"`
	ForceRelay bool `json:"forceRelay,omitempty"`
	DisableCRT bool `json:"disableCRT,omitempty"`

	LastTermacadeOption int    `json:"lastTermacadeOption"`
	LastTermacadeName   string `json:"lastTermacadeName,omitempty"`

	AutoUploadRecording     bool `json:"autoUploadRecording,omitempty"`
	DisplayTermacadeButtons bool `json:"displayTermacadeButtons,omitempty"`

	Controls ControlsSettings `json:"controls"`
}

func LoadSettings

func LoadSettings() *Settings