client

Documentation

Index

• Variables
• func CheckForClosure(Result string) bool
• func Login(clientid string) error
• func LoginLoop()
• func Logout()
• func SetActivity(activity *Activity) error
• type Activity
• type Args
• type AuthenticatedStruct
• type Button
• type Frame
• type Handshake
• type Party
• type PayloadActivity
• type PayloadAssets
• type PayloadButton
• type PayloadParty
• type PayloadSecrets
• type PayloadTimestamps
• type ReceivedPayloadStruct
• type Secrets
• type Timestamps

Variables

var AuthenticationUpdate = sync.WaitGroup{}

var CachedClientId string

var LogLooping bool

Functions

func CheckForClosure

func CheckForClosure(Result string) bool

func Login

func Login(clientid string) error

func LoginLoop

func LoginLoop()

func Logout

func Logout()

func SetActivity

func SetActivity(activity *Activity) error

Types

type Activity

type Activity struct {
	// What the player is currently doing
	Details string
	// The user's current party status
	State string
	// The id for a large asset of the activity, usually a snowflake
	LargeImage string
	// Text displayed when hovering over the large image of the activity
	LargeText string
	// The id for a small asset of the activity, usually a snowflake
	SmallImage string
	// Text displayed when hovering over the small image of the activity
	SmallText string
	// Information for the current party of the player
	Party *Party
	// Unix timestamps for start and/or end of the game
	Timestamps *Timestamps
	// Secrets for Rich Presence joining and spectating
	Secrets *Secrets
	// Clickable buttons that open a URL in the browser
	Buttons []*Button
}

Activity holds the data for discord rich presence

type Args

type Args struct {
	Pid      int              `json:"pid"`
	Activity *PayloadActivity `json:"activity"`
}

type AuthenticatedStruct

type AuthenticatedStruct struct {
	Id            string `json:"id"`
	Username      string `json:"username"`
	Discriminator string `json:"discriminator"`
	Avatar        string `json:"avatar"`
}

var Authentication *AuthenticatedStruct

type Button

type Button struct {
	// The label of the button
	Label string
	// The URL of the button
	Url string
}

Button holds a label and the corresponding URL that is opened on press

type Frame

type Frame struct {
	Cmd   string `json:"cmd"`
	Args  Args   `json:"args"`
	Nonce string `json:"nonce"`
}

type Handshake

type Handshake struct {
	V        string `json:"v"`
	ClientId string `json:"client_id"`
}

type Party

type Party struct {
	// The ID of the party
	ID string
	// Used to show the party's current size
	Players int
	// Used to show the party's maximum size
	MaxPlayers int
}

Party holds information for the current party of the player

type PayloadActivity

type PayloadActivity struct {
	Details    string             `json:"details,omitempty"`
	State      string             `json:"state,omitempty"`
	Assets     PayloadAssets      `json:"assets,omitempty"`
	Party      *PayloadParty      `json:"party,omitempty"`
	Timestamps *PayloadTimestamps `json:"timestamps,omitempty"`
	Secrets    *PayloadSecrets    `json:"secrets,omitempty"`
	Buttons    []*PayloadButton   `json:"buttons,omitempty"`
}

type PayloadAssets

type PayloadAssets struct {
	LargeImage string `json:"large_image,omitempty"`
	LargeText  string `json:"large_text,omitempty"`
	SmallImage string `json:"small_image,omitempty"`
	SmallText  string `json:"small_text,omitempty"`
}

type PayloadButton

type PayloadButton struct {
	Label string `json:"label,omitempty"`
	Url   string `json:"url,omitempty"`
}

type PayloadParty

type PayloadParty struct {
	ID   string `json:"id,omitempty"`
	Size [2]int `json:"size,omitempty"`
}

type PayloadSecrets

type PayloadSecrets struct {
	Match    string `json:"match,omitempty"`
	Join     string `json:"join,omitempty"`
	Spectate string `json:"spectate,omitempty"`
}

type PayloadTimestamps

type PayloadTimestamps struct {
	Start *uint64 `json:"start,omitempty"`
	End   *uint64 `json:"end,omitempty"`
}

type ReceivedPayloadStruct

type ReceivedPayloadStruct struct {
	Evt  string `json:"evt"`
	Data struct {
		User AuthenticatedStruct `json:"user"`
	} `json:"data"`
}

type Secrets

type Secrets struct {
	// The secret for a specific instanced match
	Match string
	// The secret for joining a party
	Join string
	// The secret for spectating a game
	Spectate string
}

Secrets holds secrets for Rich Presence joining and spectating

type Timestamps

type Timestamps struct {
	// unix time (in milliseconds) of when the activity started
	Start *time.Time
	// unix time (in milliseconds) of when the activity ends
	End *time.Time
}

Timestamps holds unix timestamps for start and/or end of the game