Add print-kills example

Author: markus-wa

examples/print-kills/README.md

@@ -0,0 +1,234 @@
+# Printing kills
+
+This example shows how to use the library to print out all kills including attackers, weapons, headshots, wallbangs & victims.
+
+## Running the example
+
+`go run printkills.go -demo /path/to/demo`
+
+<details>
+<summary>Sample output</summary>
+
+```
+[T]xms*ASUS ♥ /F/ <AK-47 (HS)> [CT]crisby
+[CT]tiziaN <USP-S (HS)> [T]Ex6TenZ-BALLISTIX
+[CT]tiziaN <USP-S> [T]mistou * Cooler Master
+[CT]tiziaN <USP-S (HS)> [T]ALEX * Intel
+[T]xms*ASUS ♥ /F/ <Glock-18 (HS)> [CT]tiziaN
+[T]to1nou * Seagate <Glock-18 (HS)> [CT]kzy LJ∼
+[T]to1nou * Seagate <Glock-18> [CT]crisby
+[T]to1nou * Seagate <USP-S (HS)> [CT]syrsoNR
+[CT]keev <USP-S (HS)> [T]to1nou * Seagate
+[CT]keev <USP-S (HS)> [T]xms*ASUS ♥ /F/
+[T]Ex6TenZ-BALLISTIX <Desert Eagle (HS)> [CT]syrsoNR
+[CT]kzy LJ∼ <FAMAS (HS)> [T]ALEX * Intel
+[CT]crisby <UMP-45 (HS)> [T]to1nou * Seagate
+[CT]kzy LJ∼ <FAMAS> [T]Ex6TenZ-BALLISTIX
+[CT]kzy LJ∼ <FAMAS (HS)> [T]xms*ASUS ♥ /F/
+[CT]keev <UMP-45> [T]mistou * Cooler Master
+[CT]crisby <UMP-45 (HS)> [T]to1nou * Seagate
+[CT]kzy LJ∼ <FAMAS (HS)> [T]Ex6TenZ-BALLISTIX
+[CT]crisby <USP-S> [CT]kzy LJ∼
+[CT]crisby <USP-S (HS)> [T]xms*ASUS ♥ /F/
+[T]mistou * Cooler Master <Glock-18 (HS)> [CT]crisby
+[CT]syrsoNR <M4A1> [T]ALEX * Intel
+[CT]syrsoNR <M4A1 (HS)> [T]mistou * Cooler Master
+[T]Ex6TenZ-BALLISTIX <AK-47> [CT]crisby
+[CT]syrsoNR <M4A1 (HS) (WB)> [T]Ex6TenZ-BALLISTIX
+[CT]kzy LJ∼ <FAMAS> [T]mistou * Cooler Master
+[T]to1nou * Seagate <AWP> [CT]kzy LJ∼
+[T]ALEX * Intel <AK-47 (HS)> [CT]syrsoNR
+[T]ALEX * Intel <AK-47> [T]xms*ASUS ♥ /F/
+[CT]tiziaN <M4A1> [T]ALEX * Intel
+[CT]keev <Desert Eagle> [T]to1nou * Seagate
+[T]to1nou * Seagate <AK-47 (HS)> [CT]syrsoNR
+[CT]crisby <M4A1> [T]to1nou * Seagate
+[T]xms*ASUS ♥ /F/ <AK-47 (HS)> [CT]crisby
+[CT]kzy LJ∼ <M4A1 (HS)> [T]xms*ASUS ♥ /F/
+[CT]kzy LJ∼ <M4A1 (HS)> [T]mistou * Cooler Master
+[T]Ex6TenZ-BALLISTIX <AK-47> [CT]kzy LJ∼
+[CT]tiziaN <AK-47> [T]ALEX * Intel
+[CT]keev <AWP> [T]Ex6TenZ-BALLISTIX
+[CT]keev <AWP> [T]mistou * Cooler Master
+[T]Ex6TenZ-BALLISTIX <Tec-9 (HS)> [CT]keev
+[T]Ex6TenZ-BALLISTIX <Tec-9 (HS)> [CT]tiziaN
+[T]xms*ASUS ♥ /F/ <Desert Eagle (HS) (WB)> [CT]crisby
+[T]ALEX * Intel <AWP> [CT]syrsoNR
+[T]mistou * Cooler Master <AK-47 (HS)> [CT]syrsoNR
+[CT]keev <AWP> [T]xms*ASUS ♥ /F/
+[T]Ex6TenZ-BALLISTIX <AK-47> [CT]crisby
+[CT]keev <AWP (HS)> [T]to1nou * Seagate
+[CT]kzy LJ∼ <M4A1 (HS)> [T]ALEX * Intel
+[CT]keev <AWP> [T]Ex6TenZ-BALLISTIX
+[CT]kzy LJ∼ <M4A1> [T]mistou * Cooler Master
+[T]xms*ASUS ♥ /F/ <Tec-9> [CT]keev
+[CT]tiziaN <M4A1 (HS)> [T]mistou * Cooler Master
+[T]Ex6TenZ-BALLISTIX <AK-47> [CT]syrsoNR
+[T]to1nou * Seagate <AK-47> [CT]tiziaN
+[CT]kzy LJ∼ <AK-47 (HS)> [T]mistou * Cooler Master
+[T]ALEX * Intel <AK-47> [CT]syrsoNR
+[CT]tiziaN <p250> [T]Ex6TenZ-BALLISTIX
+[T]to1nou * Seagate <AWP> [CT]tiziaN
+[T]ALEX * Intel <AK-47> [CT]keev
+[CT]crisby <M4A1> [T]xms*ASUS ♥ /F/
+[CT]crisby <M4A1> [T]to1nou * Seagate
+[CT]crisby <M4A1 (HS)> [T]ALEX * Intel
+[CT]tiziaN <M4A1 (HS)> [T]xms*ASUS ♥ /F/
+[T]Ex6TenZ-BALLISTIX <Tec-9 (HS)> [CT]tiziaN
+[T]to1nou * Seagate <AK-47> [CT]crisby
+[T]ALEX * Intel <AK-47 (HS)> [CT]syrsoNR
+[T]mistou * Cooler Master <Tec-9 (HS)> [CT]keev
+[T]to1nou * Seagate <AK-47 (HS)> [CT]kzy LJ∼
+[CT]crisby <p250 (HS)> [T]to1nou * Seagate
+[T]xms*ASUS ♥ /F/ <AK-47 (HS)> [CT]crisby
+[CT]kzy LJ∼ <M4A1> [T]xms*ASUS ♥ /F/
+[CT]kzy LJ∼ <M4A1 (HS)> [T]ALEX * Intel
+[CT]keev <AWP> [T]Ex6TenZ-BALLISTIX
+[CT]keev <AWP> [T]mistou * Cooler Master
+[CT]kzy LJ∼ <M4A1> [T]xms*ASUS ♥ /F/
+[CT]kzy LJ∼ <M4A1 (HS)> [T]Ex6TenZ-BALLISTIX
+[T]to1nou * Seagate <AWP> [CT]kzy LJ∼
+[CT]tiziaN <FAMAS (HS)> [T]ALEX * Intel
+[T]to1nou * Seagate <AWP> [CT]tiziaN
+[CT]keev <AWP (HS) (WB)> [T]to1nou * Seagate
+[CT]crisby <M4A1> [T]mistou * Cooler Master
+[CT]kzy LJ∼ <M4A1> [T]ALEX * Intel
+[T]to1nou * Seagate <Tec-9 (HS)> [CT]crisby
+[CT]tiziaN <M4A1> [T]mistou * Cooler Master
+[CT]tiziaN <M4A1 (HS)> [T]Ex6TenZ-BALLISTIX
+[T]to1nou * Seagate <Tec-9 (HS)> [CT]tiziaN
+[CT]syrsoNR <AK-47 (WB)> [T]to1nou * Seagate
+[CT]keev <USP-S (HS)> [T]xms*ASUS ♥ /F/
+[CT]tiziaN <M4A1 (HS)> [T]mistou * Cooler Master
+[T]xms*ASUS ♥ /F/ <Tec-9> [CT]tiziaN
+[CT]syrsoNR <AK-47> [T]ALEX * Intel
+[T]to1nou * Seagate <Tec-9> [CT]syrsoNR
+[CT]crisby <M4A1 (HS)> [T]to1nou * Seagate
+[CT]crisby <M4A1 (HS)> [T]xms*ASUS ♥ /F/
+[T]Ex6TenZ-BALLISTIX <Galil AR> [CT]kzy LJ∼
+[CT]crisby <M4A1 (HS)> [T]Ex6TenZ-BALLISTIX
+[T]Ex6TenZ-BALLISTIX <AK-47> [CT]tiziaN
+[CT]keev <Tec-9 (HS)> [T]mistou * Cooler Master
+[T]xms*ASUS ♥ /F/ <AK-47> [CT]syrsoNR
+[T]Ex6TenZ-BALLISTIX <AK-47> [CT]keev
+[CT]crisby <M4A1 (HS)> [T]Ex6TenZ-BALLISTIX
+[CT]crisby <M4A1 (HS)> [T]ALEX * Intel
+[T]to1nou * Seagate <AK-47> [CT]kzy LJ∼
+[T]xms*ASUS ♥ /F/ <AK-47> [CT]crisby
+[CT]mistou * Cooler Master <P2000 (HS)> [T]tiziaN
+[CT]mistou * Cooler Master <P2000 (HS)> [T]syrsoNR
+[CT]mistou * Cooler Master <P2000 (HS)> [T]keev
+[CT]xms*ASUS ♥ /F/ <USP-S (HS)> [T]crisby
+[CT]ALEX * Intel <USP-S (HS)> [T]kzy LJ∼
+[T]tiziaN <Desert Eagle (HS)> [CT]Ex6TenZ-BALLISTIX
+[CT]mistou * Cooler Master <M4A1 (HS)> [T]kzy LJ∼
+[CT]ALEX * Intel <FAMAS> [T]syrsoNR
+[T]crisby <Desert Eagle (HS)> [CT]ALEX * Intel
+[CT]to1nou * Seagate <FAMAS (HS)> [T]crisby
+[T]keev <Desert Eagle> [CT]to1nou * Seagate
+[CT]mistou * Cooler Master <M4A1 (HS)> [T]tiziaN
+[T]keev <FAMAS (WB)> [CT]mistou * Cooler Master
+[T]keev <FAMAS> [CT]xms*ASUS ♥ /F/
+[CT]mistou * Cooler Master <Five-SeveN> [T]tiziaN
+[T]syrsoNR <AK-47> [CT]mistou * Cooler Master
+[T]kzy LJ∼ <AK-47 (HS)> [CT]xms*ASUS ♥ /F/
+[CT]to1nou * Seagate <Five-SeveN (HS)> [T]crisby
+[T]syrsoNR <AK-47 (HS)> [CT]ALEX * Intel
+[CT]to1nou * Seagate <Five-SeveN (HS)> [T]syrsoNR
+[CT]Ex6TenZ-BALLISTIX <Five-SeveN (HS)> [T]kzy LJ∼
+[CT]to1nou * Seagate <Five-SeveN> [T]keev
+[T]crisby <Tec-9 (HS)> [CT]xms*ASUS ♥ /F/
+[CT]mistou * Cooler Master <FAMAS (HS)> [T]kzy LJ∼
+[CT]mistou * Cooler Master <FAMAS> [T]crisby
+[T]syrsoNR <Tec-9 (HS)> [CT]Ex6TenZ-BALLISTIX
+[CT]to1nou * Seagate <AK-47 (HS)> [T]tiziaN
+[CT]ALEX * Intel <M4A1> [T]syrsoNR
+[CT]to1nou * Seagate <AK-47> [T]keev
+[T]kzy LJ∼ <Desert Eagle (HS)> [CT]mistou * Cooler Master
+[CT]Ex6TenZ-BALLISTIX <M4A1> [T]tiziaN
+[CT]to1nou * Seagate <AK-47> [T]syrsoNR
+[CT]Ex6TenZ-BALLISTIX <M4A1> [T]crisby
+[CT]to1nou * Seagate <AK-47> [T]keev
+[CT]ALEX * Intel <M4A1> [T]kzy LJ∼
+[T]keev <AWP> [CT]mistou * Cooler Master
+[T]tiziaN <AK-47 (HS)> [CT]xms*ASUS ♥ /F/
+[CT]Ex6TenZ-BALLISTIX <M4A1> [T]tiziaN
+[CT]to1nou * Seagate <AK-47> [T]syrsoNR
+[CT]Ex6TenZ-BALLISTIX <M4A1> [T]kzy LJ∼
+[CT]Ex6TenZ-BALLISTIX <M4A1 (HS)> [T]keev
+[T]crisby <AK-47> [CT]to1nou * Seagate
+[CT]Ex6TenZ-BALLISTIX <M4A1> [T]crisby
+[CT]to1nou * Seagate <AWP> [T]syrsoNR
+[T]keev <AK-47 (HS)> [CT]Ex6TenZ-BALLISTIX
+[T]kzy LJ∼ <AK-47> [CT]xms*ASUS ♥ /F/
+[CT]ALEX * Intel <AK-47> [T]keev
+[T]kzy LJ∼ <AK-47 (HS)> [CT]ALEX * Intel
+[T]crisby <AK-47 (HS)> [CT]to1nou * Seagate
+[CT]mistou * Cooler Master <AWP (WB)> [T]kzy LJ∼
+[T]syrsoNR <AK-47> [CT]ALEX * Intel
+[T]syrsoNR <AK-47 (HS)> [CT]xms*ASUS ♥ /F/
+[CT]Ex6TenZ-BALLISTIX <M4A1> [T]syrsoNR
+[CT]Ex6TenZ-BALLISTIX <M4A1> [T]tiziaN
+[CT]mistou * Cooler Master <AWP> [T]kzy LJ∼
+[T]crisby <AK-47> [CT]to1nou * Seagate
+[CT]Ex6TenZ-BALLISTIX <M4A1> [T]crisby
+[CT]Ex6TenZ-BALLISTIX <P2000> [T]keev
+[CT]syrsoNR <World> [CT]syrsoNR
+[CT]ALEX * Intel <World> [CT]ALEX * Intel
+[CT]tiziaN <World> [CT]tiziaN
+tiziaN <World> tiziaN
+[CT]tiziaN <World> [CT]tiziaN
+[CT]ALEX * Intel <World> [CT]ALEX * Intel
+[T]crisby <World> [T]crisby
+crisby <World> crisby
+crisby <World> crisby
+crisby <World> crisby
+[T]tiziaN <World> [T]tiziaN
+crisby <World> crisby
+[CT]mistou * Cooler Master <World> [CT]mistou * Cooler Master
+[T]keev <World> [T]keev
+[T]crisby <World> [T]crisby
+[CT]mistou * Cooler Master <AWP> [T]tiziaN
+[T]crisby <p250> [CT]mistou * Cooler Master
+[T]keev <Tec-9> [T]crisby
+[T]keev <AWP> [T]crisby
+[T]keev <AWP> [CT]ALEX * Intel
+[T]crisby <AWP> [T]crisby
+[T]crisby <AWP> [T]crisby
+[T]keev <AWP> [T]crisby
+[T]tiziaN <AK-47> [T]keev
+[CT]mistou * Cooler Master <Five-SeveN (HS)> [T]keev
+[CT]mistou * Cooler Master <Five-SeveN (HS)> [T]tiziaN
+[T]keev <Tec-9> [CT]mistou * Cooler Master
+[T]keev <Desert Eagle> [T]keev
+[T]keev <Desert Eagle (HS)> [T]keev
+[CT]ALEX * Intel <AK-47 (HS)> [T]tiziaN
+[T]keev <M4A1> [T]keev
+[T]crisby <Tec-9 (HS)> [T]keev
+[T]keev <AK-47 (HS)> [CT]ALEX * Intel
+[CT]mistou * Cooler Master <AWP> [T]crisby
+[T]keev <AK-47> [CT]mistou * Cooler Master
+[T]keev <Galil AR> [T]keev
+[T]keev <AWP> [T]keev
+[T]keev <AK-47 (HS)> [T]keev
+[T]keev <AK-47 (HS)> [T]keev
+[T]tiziaN <Galil AR (HS)> [T]keev
+[CT]ALEX * Intel <FAMAS> [T]tiziaN
+[CT]ALEX * Intel <FAMAS (HS)> [T]keev
+[CT]mistou * Cooler Master <Five-SeveN (HS)> [T]keev
+[CT]ALEX * Intel <FAMAS (HS)> [T]keev
+[T]crisby <AK-47> [CT]ALEX * Intel
+[CT]mistou * Cooler Master <AK-47 (HS)> [T]crisby
+[T]keev <AK-47> [T]keev
+[T]keev <FAMAS> [T]keev
+[T]keev <FAMAS> [T]crisby
+[T]keev <FAMAS (HS)> [T]tiziaN
+[T]keev <p250> [T]keev
+[CT]mistou * Cooler Master <AWP> [T]keev
+[T]tiziaN <Galil AR (HS)> [CT]mistou * Cooler Master
+[T]crisby <AK-47 (HS) (WB)> [T]keev
+[T]keev <Tec-9 (HS)> [CT]ALEX * Intel
+[T]crisby <AK-47 (HS)> [T]keev
+[T]keev <Tec-9> [T]keev
+```
+</details>

examples/print-kills/printkills.go

@@ -0,0 +1,58 @@
+package main
+
+import (
+	"fmt"
+	"log"
+	"os"
+
+	dem "github.com/markus-wa/demoinfocs-golang"
+	common "github.com/markus-wa/demoinfocs-golang/common"
+	events "github.com/markus-wa/demoinfocs-golang/events"
+	ex "github.com/markus-wa/demoinfocs-golang/examples"
+)
+
+// Run like this: go run printkills.go -demo /path/to/demo.dem
+func main() {
+	f, err := os.Open(ex.DemoPathFromArgs())
+	defer f.Close()
+	checkError(err)
+
+	p := dem.NewParser(f)
+
+	// Parse header
+	_, err = p.ParseHeader()
+	checkError(err)
+
+	// Register handler on kill events
+	p.RegisterEventHandler(func(e events.PlayerKilledEvent) {
+		var hs string
+		if e.IsHeadshot {
+			hs = " (HS)"
+		}
+		var wallBang string
+		if e.PenetratedObjects > 0 {
+			wallBang = " (WB)"
+		}
+		fmt.Printf("%s <%v%s%s> %s\n", formatPlayer(e.Killer), e.Weapon.Weapon, hs, wallBang, formatPlayer(e.Victim))
+	})
+
+	// Parse to end
+	err = p.ParseToEnd()
+	checkError(err)
+}
+
+func formatPlayer(p *common.Player) string {
+	switch p.Team {
+	case common.TeamTerrorists:
+		return "[T]" + p.Name
+	case common.TeamCounterTerrorists:
+		return "[CT]" + p.Name
+	}
+	return p.Name
+}
+
+func checkError(err error) {
+	if err != nil {
+		log.Fatal(err)
+	}
+}

examples/print-kills/printkills_test.go

@@ -0,0 +1,13 @@
+package main
+
+import (
+	"os"
+	"testing"
+)
+
+// Just make sure the example runs
+func TestPrintKills(t *testing.T) {
+	os.Args = []string{"cmd", "-demo", "../../cs-demos/default.dem"}
+
+	main()
+}