Merge pull request #331 from markus-wa/v3

v3.0.0

Author: markus-wa

.github/workflows/ci.yml

@@ -6,7 +6,7 @@ jobs:
   ci:
     strategy:
       matrix:
-        go-version: [1.11.x, 1.18.x]
+        go-version: [1.18.x]
 
     runs-on: ubuntu-latest
 
@@ -36,9 +36,8 @@ jobs:
         # install 7zip for decompressing test demos
         sudo apt-get install -y p7zip-full
 
-        # Install interface generator - go 1.11 doesn't allow specifying a version with go get or go install, so we need to manually git clone
-        git clone https://github.com/vburenin/ifacemaker /tmp/ifacemaker
-        pushd /tmp/ifacemaker && git checkout v1.1.0 && go install . && popd
+        # Install interface generator
+        go install github.com/vburenin/[email protected]
 
         # Fetch refs for linter
         git config remote.origin.fetch +refs/heads/*:refs/remotes/origin/*

.github/workflows/protobuf.yml

@@ -26,7 +26,7 @@ jobs:
         if: env.PROTOBUFS_CHANGED == 'true'
         uses: actions/setup-go@v2
         with:
-          go-version: 1.14.x
+          go-version: 1.18.x
 
       - name: Install Protobuf tools
         if: env.PROTOBUFS_CHANGED == 'true'
@@ -43,14 +43,14 @@ jobs:
         if: env.PROTOBUFS_CHANGED == 'true'
         run: |
             cd pkg/demoinfocs/msg
-            sed -i '1s/^/option go_package = "msg";\n\n/' proto/cstrike15_usermessages.proto
-            sed -i '1s/^/option go_package = "msg";\n\n/' proto/cstrike15_gcmessages.proto
-            sed -i '1s/^/option go_package = "msg";\n\n/' proto/engine_gcmessages.proto
-            sed -i '1s/^/option go_package = "msg";\n\n/' proto/netmessages.proto
-            sed -i '1s/^/option go_package = "msg";\n\n/' proto/steammessages.proto
+            sed -i '1s/^/option go_package = "github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs/msg";\n\n/' proto/cstrike15_usermessages.proto
+            sed -i '1s/^/option go_package = "github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs/msg";\n\n/' proto/cstrike15_gcmessages.proto
+            sed -i '1s/^/option go_package = "github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs/msg";\n\n/' proto/engine_gcmessages.proto
+            sed -i '1s/^/option go_package = "github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs/msg";\n\n/' proto/netmessages.proto
+            sed -i '1s/^/option go_package = "github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs/msg";\n\n/' proto/steammessages.proto
 
             export PATH=/tmp/protoc/bin:$PATH
-            protoc -I=proto --gogofaster_out=Mgoogle/protobuf/descriptor.proto=github.com/gogo/protobuf/protoc-gen-gogo/descriptor:. proto/*.proto
+            ./generate.sh
 
       - name: Commit changes
         if: env.PROTOBUFS_CHANGED == 'true'

.golangci.yml

@@ -64,4 +64,4 @@ linters-settings:
     disabled-checks:
       - ifElseChain
   gci:
-    local-prefixes: github.com/markus-wa/demoinfocs-golang/v2
+    local-prefixes: github.com/markus-wa/demoinfocs-golang/v3

README.md

@@ -4,7 +4,7 @@ A blazing fast, feature complete and production ready Go library for parsing and
 
 [![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://vshymanskyy.github.io/StandWithUkraine)
 
-[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs?tab=doc)
+[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs?tab=doc)
 [![Build Status](https://img.shields.io/github/workflow/status/markus-wa/demoinfocs-golang/CI/master?style=flat-square)](https://github.com/markus-wa/demoinfocs-golang/actions)
 [![codecov](https://img.shields.io/codecov/c/github/markus-wa/demoinfocs-golang?style=flat-square)](https://codecov.io/gh/markus-wa/demoinfocs-golang)
 [![Go Report](https://goreportcard.com/badge/github.com/markus-wa/demoinfocs-golang?style=flat-square)](https://goreportcard.com/report/github.com/markus-wa/demoinfocs-golang)
@@ -25,7 +25,7 @@ If you have been enjoying this library and are considering donating, please chec
 
 ## Go Get
 
-	go get -u github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs
+	go get -u github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs
 
 ## Table of Contents
 
@@ -49,7 +49,7 @@ If you have been enjoying this library and are considering donating, please chec
 
 ## Requirements
 
-This library requires at least `go 1.11` to run.
+This library requires at least `go 1.18` to run.
 You can download the latest version of Go [here](https://golang.org/).
 
 ## Quickstart Guide
@@ -66,7 +66,7 @@ go mod init github.com/<YOUR_GITHUB_USER>/my-project
 # the module name (github.com/<YOUR_GITHUB_USER>/my-project) can always be changed later
 # you can also put example.com/my-project or anything else if you don't plan to publish your project
 
-go get -u github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs
+go get -u github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs
 ```
 
 3. Create a `main.go` file with the example below
@@ -88,8 +88,8 @@ import (
 	"log"
 	"os"
 
-	dem "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs"
-	events "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/events"
+	dem "github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs"
+	events "github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs/events"
 )
 
 func main() {
@@ -146,24 +146,24 @@ Check out the [examples](examples) folder for more examples, like [how to genera
 
 ### Documentation
 
-The full API documentation is available here on [pkg.go.dev](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs).
+The full API documentation is available here on [pkg.go.dev](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs).
 
 ## Features
 
-* Game events (kills, shots, round starts/ends, footsteps etc.) - [docs](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/events?tab=doc) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/print-events)
-* Tracking of game-state (players, teams, grenades, ConVars etc.) - [docs](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs?tab=doc#GameState)
-* Grenade projectiles / trajectories - [docs](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs?tab=doc#GameState.GrenadeProjectiles) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/nade-trajectories)
-* Access to entities, server-classes & data-tables - [docs](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/sendtables?tab=doc#ServerClasses) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/entities)
-* Access to all net-messages - [docs](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs?tab=doc#NetMessageCreator) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/net-messages)
-* Chat & console messages <sup id="achat1">1</sup> - [docs](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/events?tab=doc#ChatMessage) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/print-events)
-* Matchmaking ranks (official MM demos only) - [docs](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/events?tab=doc#RankUpdate)
+* Game events (kills, shots, round starts/ends, footsteps etc.) - [docs](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs/events?tab=doc) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/print-events)
+* Tracking of game-state (players, teams, grenades, ConVars etc.) - [docs](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs?tab=doc#GameState)
+* Grenade projectiles / trajectories - [docs](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs?tab=doc#GameState.GrenadeProjectiles) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/nade-trajectories)
+* Access to entities, server-classes & data-tables - [docs](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs/sendtables?tab=doc#ServerClasses) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/entities)
+* Access to all net-messages - [docs](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs?tab=doc#NetMessageCreator) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/net-messages)
+* Chat & console messages <sup id="achat1">1</sup> - [docs](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs/events?tab=doc#ChatMessage) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/print-events)
+* Matchmaking ranks (official MM demos only) - [docs](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs/events?tab=doc#RankUpdate)
 * Full POV demo support <sup id="achat1">2</sup>
-* Support for encrypted net-messages (if the [decryption key](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2@master/pkg/demoinfocs#ParserConfig) is provided)
+* Support for encrypted net-messages (if the [decryption key](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v3@master/pkg/demoinfocs#ParserConfig) is provided)
 * JavaScript (browser / Node.js) support via WebAssembly - [example](https://github.com/markus-wa/demoinfocs-wasm)
 * [Easy debugging via build-flags](#debugging)
 * Built with performance & concurrency in mind
 
-1. <small id="f1">In MM demos the chat is encrypted, so [`ParserConfig.NetMessageDecryptionKey`](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2@master/pkg/demoinfocs#ParserConfig) needs to be set - see also [`MatchInfoDecryptionKey()`](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v2@master/pkg/demoinfocs#MatchInfoDecryptionKey).</small>
+1. <small id="f1">In MM demos the chat is encrypted, so [`ParserConfig.NetMessageDecryptionKey`](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v3@master/pkg/demoinfocs#ParserConfig) needs to be set - see also [`MatchInfoDecryptionKey()`](https://pkg.go.dev/github.com/markus-wa/demoinfocs-golang/v3@master/pkg/demoinfocs#MatchInfoDecryptionKey).</small>
 2. <small id="f2">Better than some other parsers at the time of writing.</small>
 
 ## Performance / Benchmarks
@@ -229,7 +229,7 @@ If your project is using this library feel free to submit a PR or send a message
 You can use the build tag `debugdemoinfocs` (i.e. `go test -tags debugdemoinfocs -v`) to print out debugging information - such as game events or unhandled demo-messages - during the parsing process.<br>
 Side-note: The tag isn't called `debug` to avoid naming conflicts with other libs (and underscores in tags don't work, apparently).
 
-To change the default debugging behavior, Go's `ldflags` parameter can be used. Example for additionally printing out all server-classes with their properties: `-ldflags="-X 'github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs.debugServerClasses=YES'"`
+To change the default debugging behavior, Go's `ldflags` parameter can be used. Example for additionally printing out all server-classes with their properties: `-ldflags="-X 'github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs.debugServerClasses=YES'"`
 
 Check out `debug_on.go` for any other settings that can be changed.
 
@@ -281,14 +281,9 @@ After adding it to your `PATH` you can use `scripts/generate-interfaces.sh` to u
 
 Should you need to re-generate the protobuf generated code in the `msg` package, you will need the following tools:
 
-- The latest protobuf generator (`protoc`) from your package manager or https://github.com/google/protobuf/releases
-
-- And `protoc-gen-gogofaster` from [gogoprotobuf](https://github.com/gogo/protobuf) to generate code for go.
-
-		go get -u github.com/gogo/protobuf/protoc-gen-gogofaster
-
-[//]: # "The go get above needs two tabs so it's displayed a) as part of the last list entry and b) as a code-block"
-[//]: # "Oh and don't try to move these comments above it either"
+```
+go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
+```
 
 Make sure both are inside your `PATH` variable.
 

assets/maps/README.md

@@ -1,17 +1,10 @@
 package examples
 
 import (
-	"encoding/json"
 	"flag"
-	"fmt"
-	"image"
 	"io"
 	"io/ioutil"
-	"net/http"
 	"os"
-
-	"github.com/golang/geo/r2"
-	"github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/metadata"
 )
 
 // DemoPathFromArgs returns the value of the -demo command line flag.
@@ -58,57 +51,3 @@ func RedirectStdout(f func()) {
 
 	os.Stdout = old
 }
-
-type mapMetadata struct {
-	PosX  float64 `json:"pos_x,string"`
-	PosY  float64 `json:"pos_y,string"`
-	Scale float64 `json:"scale,string"`
-}
-
-// GetMapMetadata fetches metadata for a specific map version from
-// `https://radar-overviews.csgo.saiko.tech/<map>/<crc>/info.json`.
-// Panics if any error occurs.
-func GetMapMetadata(name string, crc uint32) metadata.Map {
-	url := fmt.Sprintf("https://radar-overviews.csgo.saiko.tech/%s/%d/info.json", name, crc)
-
-	resp, err := http.Get(url)
-	checkError(err)
-
-	defer resp.Body.Close()
-
-	var data map[string]mapMetadata
-
-	err = json.NewDecoder(resp.Body).Decode(&data)
-	checkError(err)
-
-	mapInfo, ok := data[name]
-	if !ok {
-		panic(fmt.Sprintf("failed to get map info.json entry for %q", name))
-	}
-
-	return metadata.Map{
-		Name: name,
-		PZero: r2.Point{
-			X: mapInfo.PosX,
-			Y: mapInfo.PosY,
-		},
-		Scale: mapInfo.Scale,
-	}
-}
-
-// GetMapMetadata fetches metadata for a specific map version from
-// `https://radar-overviews.csgo.saiko.tech/<map>/<crc>/info.json`.
-// Panics if any error occurs.
-func GetMapRadar(name string, crc uint32) image.Image {
-	url := fmt.Sprintf("https://radar-overviews.csgo.saiko.tech/%s/%d/radar.png", name, crc)
-
-	resp, err := http.Get(url)
-	checkError(err)
-
-	defer resp.Body.Close()
-
-	img, _, err := image.Decode(resp.Body)
-	checkError(err)
-
-	return img
-}

assets/maps/de_ancient.jpg

@@ -6,8 +6,8 @@ import (
 	"log"
 	"os"
 
-	dem "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs"
-	"github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/events"
+	dem "github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs"
+	"github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs/events"
 )
 
 func checkErr(err error) {

assets/maps/de_cache.jpg

@@ -5,10 +5,10 @@ import (
 	_ "image/jpeg"
 	"os"
 
-	ex "github.com/markus-wa/demoinfocs-golang/v2/examples"
-	demoinfocs "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs"
-	events "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/events"
-	st "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/sendtables"
+	ex "github.com/markus-wa/demoinfocs-golang/v3/examples"
+	demoinfocs "github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs"
+	events "github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs/events"
+	st "github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs/sendtables"
 )
 
 // Run like this: go run entities.go -demo /path/to/demo.dem

assets/maps/de_canals.jpg

@@ -6,15 +6,14 @@ import (
 	"image/jpeg"
 	"os"
 
-	heatmap "github.com/dustin/go-heatmap"
-	schemes "github.com/dustin/go-heatmap/schemes"
 	r2 "github.com/golang/geo/r2"
+	heatmap "github.com/markus-wa/go-heatmap/v2"
+	schemes "github.com/markus-wa/go-heatmap/v2/schemes"
 
-	ex "github.com/markus-wa/demoinfocs-golang/v2/examples"
-	demoinfocs "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs"
-	events "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/events"
-	metadata "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/metadata"
-	"github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/msg"
+	ex "github.com/markus-wa/demoinfocs-golang/v3/examples"
+	demoinfocs "github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs"
+	events "github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs/events"
+	"github.com/markus-wa/demoinfocs-golang/v3/pkg/demoinfocs/msg"
 )
 
 const (
@@ -42,16 +41,16 @@ func main() {
 	checkError(err)
 
 	var (
-		mapMetadata metadata.Map
+		mapMetadata ex.Map
 		mapRadarImg image.Image
 	)
 
 	p.RegisterNetMessageHandler(func(msg *msg.CSVCMsg_ServerInfo) {
 		// Get metadata for the map that the game was played on for coordinate translations
-		mapMetadata = ex.GetMapMetadata(header.MapName, msg.MapCrc)
+		mapMetadata = ex.GetMapMetadata(header.MapName, msg.GetMapCrc())
 
 		// Load map overview image
-		mapRadarImg = ex.GetMapRadar(header.MapName, msg.MapCrc)
+		mapRadarImg = ex.GetMapRadar(header.MapName, msg.GetMapCrc())
 	})
 
 	// Register handler for WeaponFire, triggered every time a shot is fired

assets/maps/de_cbble.jpg

@@ -4,7 +4,7 @@ import (
 	"os"
 	"testing"
 
-	"github.com/markus-wa/demoinfocs-golang/v2/examples"
+	"github.com/markus-wa/demoinfocs-golang/v3/examples"
 )
 
 // Just make sure the example runs