core: parse and store ConVars (#97)

- add GameState.ConVars()
- add events.ConVarsUpdated()

Author: markus-wa

README.md

@@ -101,7 +101,7 @@ Check out the [examples](examples) folder for more examples, like [how to genera
 ## Features
 
 * Game events (kills, shots, round starts/ends, footsteps etc.) - [docs](https://godoc.org/github.com/markus-wa/demoinfocs-golang/events) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/print-events)
-* Tracking of game-state (players, teams, grenades etc.) - [docs](https://godoc.org/github.com/markus-wa/demoinfocs-golang#GameState)
+* Tracking of game-state (players, teams, grenades, ConVars etc.) - [docs](https://godoc.org/github.com/markus-wa/demoinfocs-golang#GameState)
 * Grenade projectiles / trajectories - [docs](https://godoc.org/github.com/markus-wa/demoinfocs-golang#GameState.GrenadeProjectiles) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/nade-trajectories)
 * Access to entities, server-classes & data-tables - [docs](https://godoc.org/github.com/markus-wa/demoinfocs-golang/sendtables#ServerClasses) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/entities)
 * Access to all net-messages - [docs](https://godoc.org/github.com/markus-wa/demoinfocs-golang#NetMessageCreator) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/net-messages)

convars.go

@@ -0,0 +1,18 @@
+package demoinfocs
+
+import (
+	"github.com/markus-wa/demoinfocs-golang/events"
+	"github.com/markus-wa/demoinfocs-golang/msg"
+)
+
+func (p *Parser) handleSetConVar(setConVar *msg.CNETMsg_SetConVar) {
+	updated := make(map[string]string)
+	for _, cvar := range setConVar.Convars.Cvars {
+		updated[cvar.Name] = cvar.Value
+		p.gameState.conVars[cvar.Name] = cvar.Value
+	}
+
+	p.eventDispatcher.Dispatch(events.ConVarsUpdated{
+		UpdatedConVars: updated,
+	})
+}

events/events.go

@@ -536,3 +536,9 @@ type IsWarmupPeriodChanged struct {
 type PlayerSpottersChanged struct {
 	Spotted *common.Player
 }
+
+// ConVarsUpdated signals that ConVars/CVars have been updated.
+// See GameState.ConVars().
+type ConVarsUpdated struct {
+	UpdatedConVars map[string]string
+}

fake/game_state.go

@@ -1,10 +1,10 @@
 package fake
 
 import (
-	mock "github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/mock"
 
 	dem "github.com/markus-wa/demoinfocs-golang"
-	common "github.com/markus-wa/demoinfocs-golang/common"
+	"github.com/markus-wa/demoinfocs-golang/common"
 	st "github.com/markus-wa/demoinfocs-golang/sendtables"
 )
 
@@ -79,3 +79,8 @@ func (gs *GameState) IsWarmupPeriod() bool {
 func (gs *GameState) IsMatchStarted() bool {
 	return gs.Called().Bool(0)
 }
+
+// ConVars is a mock-implementation of IGameState.ConVars().
+func (gs *GameState) ConVars() map[string]string {
+	return gs.Called().Get(0).(map[string]string)
+}

game_state.go

@@ -18,6 +18,7 @@ type GameState struct {
 	grenadeProjectiles map[int]*common.GrenadeProjectile // Maps entity-IDs to active nade-projectiles. That's grenades that have been thrown, but have not yet detonated.
 	infernos           map[int]*common.Inferno           // Maps entity-IDs to active infernos.
 	entities           map[int]*st.Entity                // Maps entity IDs to entities
+	conVars            map[string]string
 	bomb               common.Bomb
 	totalRoundsPlayed  int
 	gamePhase          common.GamePhase
@@ -121,13 +122,21 @@ func (gs GameState) IsMatchStarted() bool {
 	return gs.isMatchStarted
 }
 
+// ConVars returns a map of CVar keys and values.
+// Not all values might be set.
+// See also: https://developer.valvesoftware.com/wiki/List_of_CS:GO_Cvars.
+func (gs *GameState) ConVars() map[string]string {
+	return gs.conVars
+}
+
 func newGameState() *GameState {
 	gs := &GameState{
 		playersByEntityID:  make(map[int]*common.Player),
 		playersByUserID:    make(map[int]*common.Player),
 		grenadeProjectiles: make(map[int]*common.GrenadeProjectile),
 		infernos:           make(map[int]*common.Inferno),
 		entities:           make(map[int]*st.Entity),
+		conVars:            make(map[string]string),
 	}
 
 	gs.tState = common.NewTeamState(common.TeamTerrorists, gs.Participants().TeamMembers)

game_state_interface.go

@@ -50,4 +50,8 @@ type IGameState interface {
 	IsWarmupPeriod() bool
 	// IsMatchStarted returns whether the match has started according to CCSGameRulesProxy.
 	IsMatchStarted() bool
+	// ConVars returns a map of CVar keys and values.
+	// Not all values might be set.
+	// See also: https://developer.valvesoftware.com/wiki/List_of_CS:GO_Cvars.
+	ConVars() map[string]string
 }

game_state_test.go

@@ -54,6 +54,13 @@ func TestGameState_Participants(t *testing.T) {
 	assert.NotEqual(t, byUserID, ptcp.ByUserID())
 }
 
+func TestGameState_ConVars(t *testing.T) {
+	cvars := make(map[string]string)
+	gs := GameState{conVars: cvars}
+
+	assert.Equal(t, cvars, gs.ConVars())
+}
+
 func TestParticipants_All(t *testing.T) {
 	pl := newPlayer()
 	ptcps := Participants{

parser.go

@@ -253,6 +253,7 @@ func NewParserWithConfig(demostream io.Reader, config ParserConfig) *Parser {
 	p.msgDispatcher.RegisterHandler(p.handleCreateStringTable)
 	p.msgDispatcher.RegisterHandler(p.handleUpdateStringTable)
 	p.msgDispatcher.RegisterHandler(p.handleUserMessage)
+	p.msgDispatcher.RegisterHandler(p.handleSetConVar)
 	p.msgDispatcher.RegisterHandler(p.handleFrameParsed)
 	p.msgDispatcher.RegisterHandler(p.gameState.handleIngameTickNumber)
 

parsing.go

@@ -261,6 +261,7 @@ var defaultNetMessageCreators = map[int]NetMessageCreator{
 	int(msg.SVC_Messages_svc_CreateStringTable): func() proto.Message { return new(msg.CSVCMsg_CreateStringTable) },
 	int(msg.SVC_Messages_svc_UpdateStringTable): func() proto.Message { return new(msg.CSVCMsg_UpdateStringTable) },
 	int(msg.SVC_Messages_svc_UserMessage):       func() proto.Message { return new(msg.CSVCMsg_UserMessage) },
+	int(msg.NET_Messages_net_SetConVar):         func() proto.Message { return new(msg.CNETMsg_SetConVar) },
 }
 
 func (p *Parser) parsePacket() {