v0.2

- Replace `finished` event with `finished_players`
- Add `in_progress` event
- Use player ID as origin in more cases

Author: juho05

README.md

@@ -29,10 +29,10 @@ Prerequisites:
 
 ```sh
 # Download image
-docker pull codegameproject/hoverrace:0.1
+docker pull codegameproject/hoverrace:0.2
 
 # Run container
-docker run -d -p <port-on-host-machine>:8080 --name hoverrace codegameproject/hoverrace:0.1
+docker run -d -p <port-on-host-machine>:8080 --name hoverrace codegameproject/hoverrace:0.2
 ```
 
 ## Event Flow
@@ -45,7 +45,7 @@ docker run -d -p <port-on-host-machine>:8080 --name hoverrace codegameproject/ho
 6. Send a `throttle` event to begin moving.
 7. The `hovercrafts` event is sent repeatedly to all players to update them on the state of all hovercrafts.
 8. The `checkpoints` event is sent again when you cross a checkpoint.
-9. The `finished` event is sent to all players when a player crosses the finish line. The game keeps going until all players have finished.
+9. The `finished_players` event is sent to all players when a player crosses the finish line. It contains all of the players that have finished the race. The game keeps going until all players have finished.
 10. Send a `ready` event if you want to play again.
 
 ## Building

events.cge

@@ -5,6 +5,9 @@ version 0.3
 // The game begins once at least 2 players have joined and all players have sent the `ready` event.
 event start {}
 
+// The `in_progress` event is sent to sockets which connect to the game while it's running.
+event in_progress {}
+
 // The `countdown` counts down from 5. When the value reaches 0 a `start` event will be sent instead of the `countdown` event.
 event countdown {
 	// The current value of the countdown (5-1).
@@ -45,12 +48,10 @@ event hovercrafts {
 	time: int64
 }
 
-// The `finished` event is sent when a player crosses the finish line.
-event finished {
-	// The place which the player has reached.
-	place: int,
-	// The amount of time in milliseconds the player needed to finish the race.
-	duration: int64
+// The `finished_players` event contains a list of players that have finished the race.
+event finished_players {
+	// A list of players that have finished the race sorted by their placement.
+	players: list<finished_player>
 }
 
 // A hovercraft is a circle with a diameter of 1 unit.
@@ -67,6 +68,16 @@ type hovercraft {
 	checkpoints: int
 }
 
+// `finished_player` represents an entry in the final ranking.
+type finished_player {
+	// The ID of the player.
+	id: string,
+	// The place, the player has reached.
+	place: int,
+	// The amount of time in milliseconds the player needed to finish the race.
+	duration: int64
+}
+
 // One unit equals the width of the hovercrafts and checkpoints.
 type vec {
 	// left to right

hoverrace/event_definitions.go

@@ -9,6 +9,12 @@ const StartEvent cg.EventName = "start"
 type StartEventData struct {
 }
 
+// The `in_progress` event is sent to sockets which connect to the game while it's running.
+const InProgressEvent cg.EventName = "in_progress"
+
+type InProgressEventData struct {
+}
+
 // The `countdown` counts down from 5. When the value reaches 0 a `start` event will be sent instead of the `countdown` event.
 const CountdownEvent cg.EventName = "countdown"
 
@@ -62,14 +68,12 @@ type HovercraftsEventData struct {
 	Time int64 `json:"time"`
 }
 
-// The `finished` event is sent when a player crosses the finish line.
-const FinishedEvent cg.EventName = "finished"
+// The `finished_players` event contains a list of players that have finished the race.
+const FinishedPlayersEvent cg.EventName = "finished_players"
 
-type FinishedEventData struct {
-	// The place which the player has reached.
-	Place int `json:"place"`
-	// The amount of time in milliseconds the player needed to finish the race.
-	Duration int64 `json:"duration"`
+type FinishedPlayersEventData struct {
+	// A list of players that have finished the race sorted by their placement.
+	Players []FinishedPlayer `json:"players"`
 }
 
 // A hovercraft is a circle with a diameter of 1 unit.
@@ -86,6 +90,16 @@ type Hovercraft struct {
 	Checkpoints int `json:"checkpoints"`
 }
 
+// `finished_player` represents an entry in the final ranking.
+type FinishedPlayer struct {
+	// The ID of the player.
+	Id string `json:"id"`
+	// The place, the player has reached.
+	Place int `json:"place"`
+	// The amount of time in milliseconds the player needed to finish the race.
+	Duration int64 `json:"duration"`
+}
+
 // One unit equals the width of the hovercrafts and checkpoints.
 type Vec struct {
 	// left to right

hoverrace/game.go

@@ -14,7 +14,7 @@ type Game struct {
 	hovercrafts     map[string]Hovercraft
 	checkpoints     []Vec
 	finishLine      Vec
-	finishedPlayers int
+	finishedPlayers []FinishedPlayer
 	running         bool
 	startTime       time.Time
 }
@@ -23,9 +23,11 @@ const targetFrameTime time.Duration = 1 * time.Second / 30
 
 func NewGame(cgGame *cg.Game) *Game {
 	game := &Game{
-		cg:          cgGame,
-		players:     make(map[string]*Player),
-		hovercrafts: make(map[string]Hovercraft),
+		cg:              cgGame,
+		players:         make(map[string]*Player),
+		hovercrafts:     make(map[string]Hovercraft),
+		finishedPlayers: make([]FinishedPlayer, 0),
+		checkpoints:     make([]Vec, 0, 10),
 	}
 	game.cg.OnPlayerJoined = game.onPlayerJoined
 	game.cg.OnPlayerLeft = game.onPlayerLeft
@@ -76,6 +78,18 @@ func (g *Game) onPlayerJoined(cgPlayer *cg.Player) {
 	g.hovercrafts[cgPlayer.Id] = Hovercraft{}
 
 	g.positionHovercrafts()
+
+	readyPlayers := make([]string, 0, len(g.players))
+	for _, p := range g.players {
+		if p.ready {
+			readyPlayers = append(readyPlayers, p.id)
+		}
+	}
+	if len(readyPlayers) > 0 {
+		cgPlayer.Send("server", ReadyPlayersEvent, ReadyPlayersEventData{
+			Players: readyPlayers,
+		})
+	}
 }
 
 func (g *Game) onPlayerLeft(player *cg.Player) {
@@ -93,7 +107,7 @@ func (g *Game) onPlayerLeft(player *cg.Player) {
 		}
 		g.start()
 	} else {
-		if g.finishedPlayers == len(g.players) {
+		if len(g.finishedPlayers) == len(g.players) {
 			g.finish()
 		}
 	}
@@ -102,37 +116,46 @@ func (g *Game) onPlayerLeft(player *cg.Player) {
 
 func (g *Game) onPlayerSocketConnected(player *cg.Player, socket *cg.Socket) {
 	if len(g.checkpoints) > 0 {
-		g.cg.Send("server", HovercraftsEvent, HovercraftsEventData{
+		socket.Send("server", HovercraftsEvent, HovercraftsEventData{
 			Hovercrafts: g.hovercrafts,
 			Time:        time.Now().UnixMilli(),
 		})
 
 		p := g.players[player.Id]
-		p.cg.Send("server", CheckpointsEvent, CheckpointsEventData{
+		socket.Send("server", CheckpointsEvent, CheckpointsEventData{
 			Checkpoints: p.checkpoints,
 			FinishLine:  g.finishLine,
 		})
 	}
 
+	readyPlayers := make([]string, 0, len(g.players))
+	for _, p := range g.players {
+		if p.ready {
+			readyPlayers = append(readyPlayers, p.id)
+		}
+	}
+	if len(readyPlayers) > 0 {
+		socket.Send("server", ReadyPlayersEvent, ReadyPlayersEventData{
+			Players: readyPlayers,
+		})
+	}
+
 	if !g.running {
 		return
 	}
 
-	socket.Send("server", StartEvent, StartEventData{})
+	socket.Send("server", InProgressEvent, InProgressEventData{})
 
-	for _, player := range g.players {
-		if player.finished {
-			socket.Send(player.id, FinishedEvent, FinishedEventData{
-				Place:    player.place,
-				Duration: player.duration,
-			})
-		}
+	if len(g.finishedPlayers) > 0 {
+		socket.Send("server", FinishedPlayersEvent, FinishedPlayersEventData{
+			Players: g.finishedPlayers,
+		})
 	}
 }
 
 func (g *Game) onSpectatorConnected(socket *cg.Socket) {
 	if len(g.checkpoints) > 0 {
-		g.cg.Send("server", HovercraftsEvent, HovercraftsEventData{
+		socket.Send("server", HovercraftsEvent, HovercraftsEventData{
 			Hovercrafts: g.hovercrafts,
 			Time:        time.Now().UnixMilli(),
 		})
@@ -143,19 +166,28 @@ func (g *Game) onSpectatorConnected(socket *cg.Socket) {
 		})
 	}
 
+	readyPlayers := make([]string, 0, len(g.players))
+	for _, p := range g.players {
+		if p.ready {
+			readyPlayers = append(readyPlayers, p.id)
+		}
+	}
+	if len(readyPlayers) > 0 {
+		socket.Send("server", ReadyPlayersEvent, ReadyPlayersEventData{
+			Players: readyPlayers,
+		})
+	}
+
 	if !g.running {
 		return
 	}
 
-	socket.Send("server", StartEvent, StartEventData{})
+	socket.Send("server", InProgressEvent, InProgressEventData{})
 
-	for _, player := range g.players {
-		if player.finished {
-			socket.Send(player.id, FinishedEvent, FinishedEventData{
-				Place:    player.place,
-				Duration: player.duration,
-			})
-		}
+	if len(g.finishedPlayers) > 0 {
+		socket.Send("server", FinishedPlayersEvent, FinishedPlayersEventData{
+			Players: g.finishedPlayers,
+		})
 	}
 }
 
@@ -201,7 +233,7 @@ func (g *Game) handleReady(playerId string) {
 		}
 	}
 
-	g.cg.Send("server", ReadyPlayersEvent, ReadyPlayersEventData{
+	g.cg.Send(playerId, ReadyPlayersEvent, ReadyPlayersEventData{
 		Players: readyPlayers,
 	})
 
@@ -232,7 +264,7 @@ func (g *Game) handleThrottle(playerId string, event cg.Event) {
 }
 
 func (g *Game) start() {
-	g.finishedPlayers = 0
+	g.finishedPlayers = g.finishedPlayers[:0]
 	g.createCheckpoints()
 
 	for _, player := range g.players {
@@ -289,11 +321,11 @@ func (g *Game) positionHovercrafts() {
 
 func (g *Game) finish() {
 	g.running = false
+	g.checkpoints = g.checkpoints[:0]
 }
 
 func (g *Game) createCheckpoints() {
-	g.checkpoints = make([]Vec, 10)
-
+	g.checkpoints = g.checkpoints[:cap(g.checkpoints)]
 	for i := range g.checkpoints {
 		g.checkpoints[i] = Vec{
 			X: rand.Float64()*50*2 - 50,

hoverrace/player.go

@@ -19,8 +19,6 @@ type Player struct {
 	ready bool
 
 	finished bool
-	place    int
-	duration int64
 
 	checkpoints []Vec
 
@@ -133,15 +131,16 @@ outer:
 
 	if len(p.checkpoints) == 0 && math.Abs(p.game.finishLine.Sub(p.pos).MagnitudeSquared()) <= 1 {
 		p.finished = true
-		p.game.finishedPlayers++
-		p.place = p.game.finishedPlayers
-		p.duration = time.Now().Sub(p.game.startTime).Milliseconds()
-		p.game.cg.Send(p.id, FinishedEvent, FinishedEventData{
-			Place:    p.place,
-			Duration: p.duration,
+		p.game.finishedPlayers = append(p.game.finishedPlayers, FinishedPlayer{
+			Id:       p.id,
+			Place:    len(p.game.finishedPlayers) + 1,
+			Duration: time.Now().Sub(p.game.startTime).Milliseconds(),
+		})
+		p.game.cg.Send(p.id, FinishedPlayersEvent, FinishedPlayersEventData{
+			Players: p.game.finishedPlayers,
 		})
 
-		if p.game.finishedPlayers == len(p.game.players) {
+		if len(p.game.finishedPlayers) == len(p.game.players) {
 			p.game.finish()
 		}
 	}

main.go

@@ -31,7 +31,7 @@ func main() {
 	server := cg.NewServer("hoverrace", cg.ServerConfig{
 		DisplayName:             "Hover Race",
 		Description:             "Race against other hovercrafts from checkpoint to checkpoint.",
-		Version:                 "0.1",
+		Version:                 "0.2",
 		RepositoryURL:           "https://github.com/code-game-project/hoverrace",
 		WebsocketTimeout:        1 * time.Minute,
 		MaxPlayersPerGame:       10,