✨ add snake game sample

Author: yuanyu90221

.github/workflows/go.yml

@@ -0,0 +1,26 @@
+name: Go
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  build_and_test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup go-task
+        uses: pnorton5432/setup-task@v1
+        with:
+          task-version: 3.29.1
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: 'stable'
+          check-latest: true
+      - name: Task Build for mage
+        run: task build-gg

.gitignore

@@ -0,0 +1,28 @@
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work
+go.work.sum
+
+# env file
+.env
+bin
+gg
+mage

README.md

@@ -0,0 +1,197 @@
+# golang-sample-with-snake-game
+
+This repository is learn how to use ebiten to build a snake game
+
+## game logic
+
+```golang
+package internal
+
+import (
+	"image/color"
+	"math/rand"
+	"time"
+
+	"github.com/hajimehoshi/ebiten/v2"
+	"github.com/hajimehoshi/ebiten/v2/text/v2"
+	"github.com/hajimehoshi/ebiten/v2/vector"
+)
+
+var (
+	dirUp           = Point{x: 0, y: -1}
+	dirDown         = Point{x: 0, y: 1}
+	dirLeft         = Point{x: -1, y: 0}
+	dirRight        = Point{x: 1, y: 0}
+	MplusFaceSource *text.GoTextFaceSource
+)
+
+const (
+	gameSpeed    = time.Second / 6
+	ScreenWidth  = 640
+	ScreenHeight = 480
+	gridSize     = 20
+)
+
+type Point struct {
+	x, y int
+}
+
+type Game struct {
+	snake         []Point
+	direction     Point
+	lastUpdate    time.Time
+	food          Point
+	randGenerator *rand.Rand
+	gameOver      bool
+}
+
+func (g *Game) Update() error {
+	if g.gameOver {
+		return nil
+	}
+	// handle key
+	if ebiten.IsKeyPressed(ebiten.KeyW) {
+		g.direction = dirUp
+	} else if ebiten.IsKeyPressed(ebiten.KeyS) {
+		g.direction = dirDown
+	} else if ebiten.IsKeyPressed(ebiten.KeyA) {
+		g.direction = dirLeft
+	} else if ebiten.IsKeyPressed(ebiten.KeyD) {
+		g.direction = dirRight
+	}
+	// slow down
+	if time.Since(g.lastUpdate) < gameSpeed {
+		return nil
+	}
+	g.lastUpdate = time.Now()
+
+	g.updateSnake(&g.snake, g.direction)
+	return nil
+}
+
+// isBadCollision - check if snake is collision
+func (g Game) isBadCollision(
+	newHead Point,
+	snake []Point,
+) bool {
+	// check if out of bound
+	if newHead.x < 0 || newHead.y < 0 ||
+		newHead.x >= ScreenWidth/gridSize || newHead.y >= ScreenHeight/gridSize {
+		return true
+	}
+	// is newhead collision
+	for _, snakeBody := range snake {
+		if snakeBody == newHead {
+			return true
+		}
+	}
+	return false
+}
+
+// updateSnake - update snake with direction
+func (g *Game) updateSnake(snake *[]Point, direction Point) {
+	head := (*snake)[0]
+
+	newHead := Point{
+		x: head.x + direction.x,
+		y: head.y + direction.y,
+	}
+
+	// check collision for snake
+	if g.isBadCollision(newHead, *snake) {
+		g.gameOver = true
+		return
+	}
+	// check collision with food
+	if newHead == g.food {
+		*snake = append(
+			[]Point{newHead},
+			*snake...,
+		)
+		g.SpawnFood()
+	} else {
+		*snake = append(
+			[]Point{newHead},
+			(*snake)[:len(*snake)-1]...,
+		)
+	}
+
+}
+
+// drawGameOverText - draw game over text on screen
+func (g *Game) drawGameOverText(screen *ebiten.Image) {
+	face := &text.GoTextFace{
+		Source: MplusFaceSource,
+		Size:   48,
+	}
+	title := "Game Over!"
+	w, h := text.Measure(title,
+		face,
+		face.Size,
+	)
+	op := &text.DrawOptions{}
+	op.GeoM.Translate(ScreenWidth/2-w/2, ScreenHeight/2-h/2)
+	op.ColorScale.ScaleWithColor(color.White)
+	text.Draw(
+		screen,
+		title,
+		face,
+		op,
+	)
+}
+
+// Draw - handle screen update
+func (g *Game) Draw(screen *ebiten.Image) {
+	for _, p := range g.snake {
+		vector.DrawFilledRect(
+			screen,
+			float32(p.x*gridSize),
+			float32(p.y*gridSize),
+			gridSize,
+			gridSize,
+			color.White,
+			true,
+		)
+	}
+	vector.DrawFilledRect(
+		screen,
+		float32(g.food.x*gridSize),
+		float32(g.food.y*gridSize),
+		gridSize,
+		gridSize,
+		color.RGBA{255, 0, 0, 255},
+		true,
+	)
+	if g.gameOver {
+		g.drawGameOverText(screen)
+	}
+}
+
+func (g *Game) Layout(outsideWidth, outsideHeight int) (int, int) {
+	return ScreenWidth, ScreenHeight
+}
+
+// SpawnFood - generate new food
+func (g *Game) SpawnFood() {
+	g.food = Point{
+		x: g.randGenerator.Intn(ScreenWidth / gridSize),
+		y: g.randGenerator.Intn(ScreenHeight / gridSize),
+	}
+}
+
+// NewGame - create Game
+func NewGame() *Game {
+	return &Game{
+		snake: []Point{{
+			x: ScreenWidth / gridSize / 2,
+			y: ScreenHeight / gridSize / 2,
+		}},
+		direction:     Point{x: 1, y: 0},
+		randGenerator: rand.New(rand.NewSource(time.Now().UnixNano())),
+	}
+}
+```
+
+## game screen
+
+![snake-game](snake-game.png)

Taskfile.yml

@@ -0,0 +1,42 @@
+version: '3'
+
+dotenv: ['.env']
+
+tasks:
+  default:
+    cmds:
+      - echo "DB_URL=$DB_URL"
+    silent: true
+  
+  # build:
+  #   cmds:
+  #     - CGO_ENABLED=0 GOOS=linux go build -o bin/main cmd/main.go
+  #   silent: true
+  # run:
+  #   cmds:
+  #     - ./bin/main
+  #   deps:
+  #     - build
+  #   silent: true
+
+  build-mage:
+    cmds:
+      - CGO_ENABLED=0 GOOS=linux go build -o ./mage mage-tools/mage.go
+    silent: true
+  
+  build-gg:
+    cmds:
+      - ./mage -d mage-tools -compile ../gg
+    deps:
+      - build-mage
+    silent: true
+
+  coverage:
+    cmds:
+      - go test -v -cover ./...
+    silent: true
+  test:
+    cmds:
+      - go test -v ./...
+    silent: true
+  

cmd/game-window-sample/main.go

@@ -0,0 +1,38 @@
+package main
+
+import (
+	"bytes"
+	"log"
+
+	"github.com/hajimehoshi/ebiten/v2"
+	"github.com/hajimehoshi/ebiten/v2/examples/resources/fonts"
+	"github.com/hajimehoshi/ebiten/v2/text/v2"
+	"github.com/leetcode-golang-classroom/golang-sample-with-snake-game/internal"
+)
+
+// MustSetupFonts - setup font source
+func MustSetupFonts() {
+	source, err := text.NewGoTextFaceSource(
+		bytes.NewReader(
+			fonts.MPlus1pRegular_ttf,
+		),
+	)
+	if err != nil {
+		log.Fatal(err)
+	}
+	// setup font source
+	internal.MplusFaceSource = source
+}
+
+func main() {
+	// setup font
+	MustSetupFonts()
+	game := internal.NewGame()
+	game.SpawnFood()
+	// setup window size
+	ebiten.SetWindowSize(internal.ScreenWidth, internal.ScreenHeight)
+	ebiten.SetWindowTitle("Snake")
+	if err := ebiten.RunGame(game); err != nil {
+		log.Fatal(err)
+	}
+}

go.mod

@@ -0,0 +1,20 @@
+module github.com/leetcode-golang-classroom/golang-sample-with-snake-game
+
+go 1.24.0
+
+require (
+	github.com/hajimehoshi/ebiten/v2 v2.8.6
+	github.com/magefile/mage v1.15.0
+)
+
+require (
+	github.com/ebitengine/gomobile v0.0.0-20240911145611-4856209ac325 // indirect
+	github.com/ebitengine/hideconsole v1.0.0 // indirect
+	github.com/ebitengine/purego v0.8.0 // indirect
+	github.com/go-text/typesetting v0.2.0 // indirect
+	github.com/jezek/xgb v1.1.1 // indirect
+	golang.org/x/image v0.20.0 // indirect
+	golang.org/x/sync v0.8.0 // indirect
+	golang.org/x/sys v0.25.0 // indirect
+	golang.org/x/text v0.18.0 // indirect
+)

go.sum

@@ -0,0 +1,28 @@
+github.com/ebitengine/gomobile v0.0.0-20240911145611-4856209ac325 h1:Gk1XUEttOk0/hb6Tq3WkmutWa0ZLhNn/6fc6XZpM7tM=
+github.com/ebitengine/gomobile v0.0.0-20240911145611-4856209ac325/go.mod h1:ulhSQcbPioQrallSuIzF8l1NKQoD7xmMZc5NxzibUMY=
+github.com/ebitengine/hideconsole v1.0.0 h1:5J4U0kXF+pv/DhiXt5/lTz0eO5ogJ1iXb8Yj1yReDqE=
+github.com/ebitengine/hideconsole v1.0.0/go.mod h1:hTTBTvVYWKBuxPr7peweneWdkUwEuHuB3C1R/ielR1A=
+github.com/ebitengine/purego v0.8.0 h1:JbqvnEzRvPpxhCJzJJ2y0RbiZ8nyjccVUrSM3q+GvvE=
+github.com/ebitengine/purego v0.8.0/go.mod h1:iIjxzd6CiRiOG0UyXP+V1+jWqUXVjPKLAI0mRfJZTmQ=
+github.com/go-text/typesetting v0.2.0 h1:fbzsgbmk04KiWtE+c3ZD4W2nmCRzBqrqQOvYlwAOdho=
+github.com/go-text/typesetting v0.2.0/go.mod h1:2+owI/sxa73XA581LAzVuEBZ3WEEV2pXeDswCH/3i1I=
+github.com/go-text/typesetting-utils v0.0.0-20240317173224-1986cbe96c66 h1:GUrm65PQPlhFSKjLPGOZNPNxLCybjzjYBzjfoBGaDUY=
+github.com/go-text/typesetting-utils v0.0.0-20240317173224-1986cbe96c66/go.mod h1:DDxDdQEnB70R8owOx3LVpEFvpMK9eeH1o2r0yZhFI9o=
+github.com/hajimehoshi/bitmapfont/v3 v3.2.0 h1:0DISQM/rseKIJhdF29AkhvdzIULqNIIlXAGWit4ez1Q=
+github.com/hajimehoshi/bitmapfont/v3 v3.2.0/go.mod h1:8gLqGatKVu0pwcNCJguW3Igg9WQqVXF0zg/RvrGQWyg=
+github.com/hajimehoshi/ebiten/v2 v2.8.6 h1:Dkd/sYI0TYyZRCE7GVxV59XC+WCi2BbGAbIBjXeVC1U=
+github.com/hajimehoshi/ebiten/v2 v2.8.6/go.mod h1:cCQ3np7rdmaJa1ZnvslraVlpxNb3wCjEnAP1LHNyXNA=
+github.com/jezek/xgb v1.1.1 h1:bE/r8ZZtSv7l9gk6nU0mYx51aXrvnyb44892TwSaqS4=
+github.com/jezek/xgb v1.1.1/go.mod h1:nrhwO0FX/enq75I7Y7G8iN1ubpSGZEiA3v9e9GyRFlk=
+github.com/magefile/mage v1.15.0 h1:BvGheCMAsG3bWUDbZ8AyXXpCNwU9u5CB6sM+HNb9HYg=
+github.com/magefile/mage v1.15.0/go.mod h1:z5UZb/iS3GoOSn0JgWuiw7dxlurVYTu+/jHXqQg881A=
+github.com/pierrec/lz4/v4 v4.1.21 h1:yOVMLb6qSIDP67pl/5F7RepeKYu/VmTyEXvuMI5d9mQ=
+github.com/pierrec/lz4/v4 v4.1.21/go.mod h1:gZWDp/Ze/IJXGXf23ltt2EXimqmTUXEy0GFuRQyBid4=
+golang.org/x/image v0.20.0 h1:7cVCUjQwfL18gyBJOmYvptfSHS8Fb3YUDtfLIZ7Nbpw=
+golang.org/x/image v0.20.0/go.mod h1:0a88To4CYVBAHp5FXJm8o7QbUl37Vd85ply1vyD8auM=
+golang.org/x/sync v0.8.0 h1:3NFvSEYkUoMifnESzZl15y791HH1qU2xm6eCJU5ZPXQ=
+golang.org/x/sync v0.8.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
+golang.org/x/sys v0.25.0 h1:r+8e+loiHxRqhXVl6ML1nO3l1+oFoWbnlu2Ehimmi34=
+golang.org/x/sys v0.25.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/text v0.18.0 h1:XvMDiNzPAl0jr17s6W9lcaIhGUfUORdGCNsuLmPG224=
+golang.org/x/text v0.18.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=