Merge branch 'master' into v1.0.0

Author: markus-wa

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,26 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Download link to an affected demo: HLTV, ESEA, Matchmaking share link or other
+
+Code:
+```go
+func x() {
+}
+```
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Library version**
+v1.0.0-beta.0
+
+**Additional context**
+Add any other context about the problem here - like your OS if that could be relevant.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Higher goal**
+Describe what you're trying to do on a high level. i.e. 'I want to create a heatmap of x but can't get that data' instead of 'I want a new function A() to provide me with data x'.
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/question---suggestion---other.md

@@ -0,0 +1,7 @@
+---
+name: Question / Suggestion / Other
+about: Anything that isn't exactly a bug or feature
+
+---
+
+<!-- If it's a simple question, you may be able to get help over at https://gitter.im/csgodemos/demoinfo-lib -->

README.md

@@ -1,6 +1,6 @@
-# demoinfocs-golang
+# demoinfocs-golang - A CSGO Demo Parser
 
-Is a high performance CS:GO demo parser written in Go based on [Valve's demoinfogo](https://github.com/ValveSoftware/csgo-demoinfo) and [SatsHelix's demoinfo](https://github.com/StatsHelix/demoinfo).
+Is a Go library for super fast parsing and analysing of Counter Strike: Global Offensive (CSGO) demos (aka replays). It is based on [Valve's demoinfogo](https://github.com/ValveSoftware/csgo-demoinfo) and [SatsHelix's demoinfo](https://github.com/StatsHelix/demoinfo).
 
 [![GoDoc](https://godoc.org/github.com/markus-wa/demoinfocs-golang?status.svg)](https://godoc.org/github.com/markus-wa/demoinfocs-golang)
 [![Build Status](https://travis-ci.org/markus-wa/demoinfocs-golang.svg?branch=master)](https://travis-ci.org/markus-wa/demoinfocs-golang)
@@ -10,8 +10,7 @@ Is a high performance CS:GO demo parser written in Go based on [Valve's demoinfo
 
 ## Discussions / Chat
 
-You can use gitter to ask questions and discuss ideas about this project.<br>
-There are also [some other rooms](https://gitter.im/csgodemos) available around the topic of CS:GO demos.
+You can use gitter to ask questions and discuss ideas about this project.
 
 [![Gitter chat](https://badges.gitter.im/csgodemos/demoinfo-lib.png)](https://gitter.im/csgodemos/demoinfo-lib)
 
@@ -86,12 +85,13 @@ This doesn't look too interesting on it's own but that can be helped by quickly
 
 ## Features
 
-* Game events
-* Grenade projectiles / trajectories - [doc](https://godoc.org/github.com/markus-wa/demoinfocs-golang#GameState.GrenadeProjectiles) [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/nade-trajectories)
+* 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)
+* 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
-* Chat & console messages <sup id="achat1">1</sup>
-* [Easy debugging](#debugging) via build-flags
+* 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)
+* Chat & console messages <sup id="achat1">1</sup> - [docs](https://godoc.org/github.com/markus-wa/demoinfocs-golang/events#ChatMessageEvent) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/print-events)
+* [Easy debugging via build-flags](#debugging)
 * Built with performance & concurrency in mind
 
 1. <small id="f1">Only for some demos; in MM demos the chat is encrypted for example.</small>

events/events.go

@@ -317,30 +317,30 @@ type PlayerDisconnectEvent struct {
 
 // SayTextEvent signals a chat message. It contains the raw
 // network message data for admin / console messages.
-// EntityIndex will probably always be 0
+// EntIdx will probably always be 0
 // See ChatMessageEvent and SayText2Event for player chat messages.
 type SayTextEvent struct {
-	EntityIndex int
-	Text        string
-	IsChat      bool
-	IsChatAll   bool
+	EntIdx    int // Not sure what this is, doesn't seem to be the entity-ID
+	Text      string
+	IsChat    bool // Not sure, from the net-message
+	IsChatAll bool // Seems to always be false, team chat might not be recorded
 }
 
-// SayText2Event signals a chat message. It just contains the raw network message
-// for player chat messages, ChatMessageEvent may be more interesting.
+// SayText2Event signals a chat message. It just contains the raw network message.
+// For player chat messages, ChatMessageEvent may be more interesting.
 // Team chat is generally not recorded so IsChatAll will probably always be false.
 // See SayTextEvent for admin / console messages.
 type SayText2Event struct {
-	Sender    *common.Player
-	MsgName   string
-	Params    []string
-	IsChat    bool
-	IsChatAll bool
+	EntIdx    int      // Not sure what this is, doesn't seem to be the entity-ID
+	MsgName   string   // The message type, e.g. Cstrike_Chat_All for global chat
+	Params    []string // The message's parameters, for Cstrike_Chat_All parameter 1 is the player and 2 the message for example
+	IsChat    bool     // Not sure, from the net-message
+	IsChatAll bool     // Seems to always be false, team chat might not be recorded
 }
 
 // ChatMessageEvent signals a player generated chat message.
 // Since team chat is generally not recorded IsChatAll will probably always be false.
-// See SayTextEvent for admin / console messages and SayText2Event for raw network packages.
+// See SayTextEvent for admin / console messages and SayText2Event for raw network package data.
 type ChatMessageEvent struct {
 	Sender    *common.Player
 	Text      string

examples/README.md

@@ -8,4 +8,4 @@ Here you can find a overview of examples on how to use demoinfocs-golang.
 |[nade-trajectories](nade-trajectories)|Map overview with grenade trajectories|
 |[entities](entities)|Using unhandled data from entities (`Parser.ServerClasses()`)|
 |[net-messages](net-messages)|Parsing and handling custom net-messages|
-|[print-events](print-events)|Printig kills & scores|
+|[print-events](print-events)|Printing kills, scores & chat messages|

examples/print-events/README.md

@@ -1,6 +1,6 @@
 # Printing event infos
 
-This example shows how to use the library to print out information of some key game events - kills and team scores.
+This example shows how to use the library to print out information of some key game events - kills, team scores & chat messages.
 
 ## Running the example
 
@@ -11,6 +11,10 @@ This example shows how to use the library to print out information of some key g
 ```
 Map: de_cache
 [T]xms*ASUS ♥ /F/ <AK-47 (HS)> [CT]crisby
+Chat - [T]to1nou * Seagate says: hf
+Chat - [CT]syrsoNR says: hfhf
+Chat - [CT]keev says: ,.+*`*+.,_,.+*`*+., GL & HF ,.+*`*+.,_,.+*`*+.,
+Chat - [T]ALEX * Intel says: hfhf
 [CT]tiziaN <USP-S (HS)> [T]Ex6TenZ-BALLISTIX
 [CT]tiziaN <USP-S> [T]mistou * Cooler Master
 [CT]tiziaN <USP-S (HS)> [T]ALEX * Intel
@@ -26,8 +30,10 @@ Round finished: winnerSide=CT ; score=1:0
 [CT]crisby <UMP-45 (HS)> [T]to1nou * Seagate
 [CT]kzy LJ∼ <FAMAS> [T]Ex6TenZ-BALLISTIX
 [CT]kzy LJ∼ <FAMAS (HS)> [T]xms*ASUS ♥ /F/
+Chat - [CT]syrsoNR says: ns
 [CT]keev <UMP-45> [T]mistou * Cooler Master
 Round finished: winnerSide=CT ; score=2:0
+Chat - [T]Ex6TenZ-BALLISTIX says: ty
 [CT]crisby <UMP-45 (HS)> [T]to1nou * Seagate
 [CT]kzy LJ∼ <FAMAS (HS)> [T]Ex6TenZ-BALLISTIX
 [CT]crisby <USP-S> [CT]kzy LJ∼
@@ -54,6 +60,9 @@ Round finished: winnerSide=CT ; score=4:0
 [CT]tiziaN <AK-47> [T]ALEX * Intel
 [CT]keev <AWP> [T]Ex6TenZ-BALLISTIX
 Round finished: winnerSide=CT ; score=5:0
+Chat - [T]ALEX * Intel says: hp tiz?
+Chat - [CT]syrsoNR says: 48
+Chat - [T]ALEX * Intel says: ty
 [CT]keev <AWP> [T]mistou * Cooler Master
 [T]Ex6TenZ-BALLISTIX <Tec-9 (HS)> [CT]keev
 [T]Ex6TenZ-BALLISTIX <Tec-9 (HS)> [CT]tiziaN
@@ -130,6 +139,10 @@ Round finished: winnerSide=CT ; score=11:3
 [T]to1nou * Seagate <AK-47> [CT]kzy LJ∼
 [T]xms*ASUS ♥ /F/ <AK-47> [CT]crisby
 Round finished: winnerSide=T  ; score=4:11
+Chat - [T]to1nou * Seagate says: gh
+Chat - [CT]syrsoNR says: gh
+Chat - [T]ALEX * Intel says: gh
+Chat - [T]keev says: ,.+*`*+.,_,.+*`*+., GL & HF ,.+*`*+.,_,.+*`*+.,
 [CT]mistou * Cooler Master <P2000 (HS)> [T]tiziaN
 [CT]mistou * Cooler Master <P2000 (HS)> [T]syrsoNR
 [CT]mistou * Cooler Master <P2000 (HS)> [T]keev
@@ -203,6 +216,15 @@ Round finished: No winner (tie)
 [CT]Ex6TenZ-BALLISTIX <World> [CT]Ex6TenZ-BALLISTIX
 [CT]to1nou * Seagate <World> [CT]to1nou * Seagate
 Round finished: No winner (tie)
+Chat - [T]keev says: we have no money
+Chat - [CT]mistou * Cooler Master says: same here
+Chat - [CT]ALEX * Intel says: we have everything :/
+Chat - [T]crisby says: load backup again
+Chat - [CT]ALEX * Intel says: oh mistou dsnt
+Chat - [T]keev says: haha
+Chat - [T]keev says: need backup agaiN
+Chat - [CT]ALEX * Intel says: yy
+Chat - [CT]mistou * Cooler Master says: yup
 [CT]ALEX * Intel <World> [CT]ALEX * Intel
 [CT]xms*ASUS ♥ /F/ <World> [CT]xms*ASUS ♥ /F/
 [CT]to1nou * Seagate <World> [CT]to1nou * Seagate
@@ -214,6 +236,22 @@ Round finished: No winner (tie)
 [T]keev <World> [T]keev
 [T]crisby <World> [T]crisby
 Round finished: No winner (tie)
+Chat - [CT]mistou * Cooler Master says: good
+Chat - [T]keev says: fine
+Chat - [T]keev says: rdy?
+Chat - [CT]to1nou * Seagate says: 1s
+Chat - [CT]Ex6TenZ-BALLISTIX says: 2s
+Chat - [T]keev says: 1 or 2
+Chat - [CT]ALEX * Intel says: 10
+Chat - [CT]to1nou * Seagate says: 3
+Chat - [T]keev says: :spazdunno:
+Chat - [T]keev says: :D
+Chat - [CT]to1nou * Seagate says: hf rdy
+Chat - [CT]Ex6TenZ-BALLISTIX says: rdy
+Chat - [CT]ALEX * Intel says: !unpause
+Chat - [T]keev says: !pause
+Chat - [T]keev says: cs buG
+Chat - [T]keev says: but liv
 [CT]mistou * Cooler Master <AWP> [T]tiziaN
 [T]kzy LJ∼ <p250> [CT]mistou * Cooler Master
 [T]keev <Tec-9> [CT]xms*ASUS ♥ /F/
@@ -222,6 +260,11 @@ Round finished: No winner (tie)
 [CT]to1nou * Seagate <AWP> [T]syrsoNR
 [CT]to1nou * Seagate <AWP> [T]crisby
 Round finished: winnerSide=T  ; score=14:10
+Chat - [T]keev says: rdy?
+Chat - [CT]to1nou * Seagate says: yes
+Chat - [T]keev says: !unpause
+Chat - [CT]to1nou * Seagate says: hf
+Chat - [T]keev says: hfhf
 [CT]to1nou * Seagate <AWP> [T]crisby
 [T]tiziaN <AK-47> [CT]Ex6TenZ-BALLISTIX
 [CT]mistou * Cooler Master <Five-SeveN (HS)> [T]syrsoNR
@@ -262,4 +305,10 @@ Round finished: winnerSide=CT ; score=13:15
 [T]crisby <AK-47 (HS)> [CT]Ex6TenZ-BALLISTIX
 [T]keev <Tec-9> [CT]to1nou * Seagate
 Round finished: winnerSide=T  ; score=16:13
+Chat - [CT]xms*ASUS ♥ /F/ says: gg
+Chat - [CT]ALEX * Intel says: gg
+Chat - [CT]to1nou * Seagate says: gg
+Chat - [CT]Ex6TenZ-BALLISTIX says: wp
+Chat - [T]tiziaN says: gg
+Chat - [T]syrsoNR says: gggg
 ```

examples/print-events/print_events.go

@@ -52,6 +52,11 @@ func main() {
 		}
 	})
 
+	// Register handler for chat messages to print them
+	p.RegisterEventHandler(func(e events.ChatMessageEvent) {
+		fmt.Printf("Chat - %s says: %s\n", formatPlayer(e.Sender), e.Text)
+	})
+
 	// Parse to end
 	err = p.ParseToEnd()
 	checkError(err)

game_events.go

@@ -487,10 +487,10 @@ func (p *Parser) handleUserMessage(um *msg.CSVCMsg_UserMessage) {
 		}
 
 		p.eventDispatcher.Dispatch(events.SayTextEvent{
-			EntityIndex: int(st.EntIdx),
-			IsChat:      st.Chat,
-			IsChatAll:   st.Textallchat,
-			Text:        st.Text,
+			EntIdx:    int(st.EntIdx),
+			IsChat:    st.Chat,
+			IsChatAll: st.Textallchat,
+			Text:      st.Text,
 		})
 
 	case msg.ECstrike15UserMessages_CS_UM_SayText2:
@@ -500,9 +500,8 @@ func (p *Parser) handleUserMessage(um *msg.CSVCMsg_UserMessage) {
 			p.eventDispatcher.Dispatch(events.ParserWarnEvent{Message: fmt.Sprintf("Failed to decode SayText2 message: %s", err.Error())})
 		}
 
-		sender := p.gameState.playersByUserID[int(st.EntIdx)]
 		p.eventDispatcher.Dispatch(events.SayText2Event{
-			Sender:    sender,
+			EntIdx:    int(st.EntIdx),
 			IsChat:    st.Chat,
 			IsChatAll: st.Textallchat,
 			MsgName:   st.MsgName,
@@ -513,6 +512,15 @@ func (p *Parser) handleUserMessage(um *msg.CSVCMsg_UserMessage) {
 		case "Cstrike_Chat_All":
 			fallthrough
 		case "Cstrike_Chat_AllDead":
+			var sender *common.Player
+			for _, pl := range p.gameState.playersByUserID {
+				// This could be a problem if the player changed his name
+				// as the name is only set initially and never updated
+				if pl.Name == st.Params[0] {
+					sender = pl
+				}
+			}
+
 			p.eventDispatcher.Dispatch(events.ChatMessageEvent{
 				Sender:    sender,
 				Text:      st.Params[1],

sendtables/propdecoder.go

@@ -290,17 +290,15 @@ func (propertyDecoder) decodeArray(fProp *flattenedPropEntry, reader *bit.BitRea
 		numBits++
 	}
 
-	nElements := int(reader.ReadInt(numBits))
-
-	res := make([]PropertyValue, 0, nElements)
+	res := make([]PropertyValue, int(reader.ReadInt(numBits)))
 
 	tmp := &Property{
 		entry: &flattenedPropEntry{prop: fProp.arrayElementProp},
 	}
 
-	for i := 0; i < nElements; i++ {
+	for i := range res {
 		propDecoder.decodeProp(tmp, reader)
-		res = append(res, tmp.value)
+		res[i] = tmp.value
 	}
 
 	return res