Small updates

Author: alexanderstephan

.gitignore

@@ -0,0 +1,24 @@
+gobra
+
+# 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

cmd/main.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"flag"
-	"fmt"
 	"gobra/internal/gameplay"
 	"os"
 	"os/signal"
@@ -24,8 +23,7 @@ func main() {
 	signal.Notify(sigs, syscall.SIGINT, syscall.SIGTERM)
 	go func() {
 		<-sigs
-		gameplay.Run = false // TODO: Cancel context
+		gameplay.Run = false // TODO: Cancellable context
 	}()
-	fmt.Println(cfg.Vim)
 	gameplay.Start(&cfg)
 }

go.mod

@@ -9,5 +9,9 @@ require (
 
 require (
 	github.com/ebitengine/purego v0.4.0 // indirect
+	github.com/hajimehoshi/oto v1.0.1 // indirect
+	golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8 // indirect
+	golang.org/x/image v0.0.0-20190227222117-0694c2d4d067 // indirect
+	golang.org/x/mobile v0.0.0-20190415191353-3e0bab5405d6 // indirect
 	golang.org/x/sys v0.7.0 // indirect
 )

go.sum

@@ -1,10 +1,21 @@
 github.com/ebitengine/purego v0.4.0 h1:RQVuMIxQPQ5iCGEJvjQ17YOK+1tMKjVau2FUMvXH4HE=
 github.com/ebitengine/purego v0.4.0/go.mod h1:ah1In8AOtksoNK6yk5z1HTJeUkC1Ez4Wk2idgGslMwQ=
+github.com/hajimehoshi/oto v1.0.1 h1:8AMnq0Yr2YmzaiqTg/k1Yzd6IygUGk2we9nmjgbgPn4=
+github.com/hajimehoshi/oto v1.0.1/go.mod h1:wovJ8WWMfFKvP587mhHgot/MBr4DnNy9m6EepeVGnos=
 github.com/hajimehoshi/oto/v2 v2.4.1 h1:iTfZSulqdmQ5Hh4tVyVzNnK3aA4SgjbDapSM0YH3Lc4=
 github.com/hajimehoshi/oto/v2 v2.4.1/go.mod h1:guyF8uIgSrchrKewS1E6Xyx7joUbKOi4g9W7vpcYBSc=
 github.com/rthornton128/goncurses v0.0.0-20231014161942-82671379df88 h1:bNvZ7P4l4rvg1O3qNDRJ4FNgKASMoG+V7OIpu4SIkgA=
 github.com/rthornton128/goncurses v0.0.0-20231014161942-82671379df88/go.mod h1:AHlKFomPTwmO7H2vL8d7VNrQNQmhMi/DBhDnHRhjbCo=
 github.com/rthornton128/goncurses v0.0.0-20240804152857-da6485a3b6d7 h1:HRzMcsVbf0rNRrRX/h43syyiRAJFbJFpZFQEUhBJPAo=
 github.com/rthornton128/goncurses v0.0.0-20240804152857-da6485a3b6d7/go.mod h1:AHlKFomPTwmO7H2vL8d7VNrQNQmhMi/DBhDnHRhjbCo=
+golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8 h1:idBdZTd9UioThJp8KpM/rTSinK/ChZFBE43/WtIy8zg=
+golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
+golang.org/x/image v0.0.0-20190227222117-0694c2d4d067 h1:KYGJGHOQy8oSi1fDlSpcZF0+juKwk/hEMv5SiwHogR0=
+golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js=
+golang.org/x/mobile v0.0.0-20190415191353-3e0bab5405d6 h1:vyLBGJPIl9ZYbcQFM2USFmJBK6KI+t+z6jL0lbwjrnc=
+golang.org/x/mobile v0.0.0-20190415191353-3e0bab5405d6/go.mod h1:E/iHnbuqvinMTCcRqshq8CkpyQDoeVncDDYHnLhea+o=
+golang.org/x/sys v0.0.0-20190312061237-fead79001313/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20190429190828-d89cdac9e872/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.7.0 h1:3jlCCIQZPdOYu1h8BkNvLz8Kgwtae2cagcG/VamtZRU=
 golang.org/x/sys v0.7.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=

internal/gameplay/controls.go

@@ -54,7 +54,6 @@ func initKeybindings(isVim bool) {
 		keyUp = 'k'
 		keyRight = 'l'
 	} else {
-		fmt.Println(" is not Vim")
 		keyLeft = 'a'
 		keyUp = 'w'
 		keyDown = 's'

internal/gameplay/gameboard.go

@@ -12,7 +12,6 @@ import (
 	gc "github.com/rthornton128/goncurses"
 )
 
-// Trackers
 var (
 	globalScore int
 	startTime   time.Time
@@ -54,7 +53,6 @@ type Screen struct {
 	rows, cols int
 }
 
-// Logo
 func drawBorder(stdscr *gc.Window) {
 	stdscr.ColorOn(3)
 	stdscr.Box(gc.ACS_VLINE, gc.ACS_HLINE)
@@ -71,46 +69,29 @@ func drawLogo(stdscr *gc.Window, rows, cols int) {
 
 func initColors() {
 	// Set up colors.
-	if err := gc.InitPair(1, gc.C_GREEN, gc.C_BLACK); err != nil {
-		log.Fatal("InitPair failed: ", err)
-	}
-
-	if err := gc.InitPair(2, gc.C_RED, gc.C_BLACK); err != nil {
-		log.Fatal("InitPair failed: ", err)
-	}
-
-	if err := gc.InitPair(3, gc.C_YELLOW, gc.C_BLACK); err != nil {
-		log.Fatal("InitPair failed: ", err)
-	}
-
-	if err := gc.InitPair(4, gc.C_MAGENTA, gc.C_BLACK); err != nil {
-		log.Fatal("InitPair failed: ", err)
-	}
-
-	if err := gc.InitPair(5, gc.C_BLACK, gc.C_BLACK); err != nil {
-		log.Fatal("InitPair failed: ", err)
-	}
-
-	if err := gc.InitPair(6, gc.C_WHITE, gc.C_BLACK); err != nil {
-		log.Fatal("InitPair failed: ", err)
-	}
+	tools.Check(gc.InitPair(1, gc.C_GREEN, gc.C_BLACK))
+	tools.Check(gc.InitPair(2, gc.C_RED, gc.C_BLACK))
+	tools.Check(gc.InitPair(3, gc.C_YELLOW, gc.C_BLACK))
+	tools.Check(gc.InitPair(4, gc.C_MAGENTA, gc.C_BLACK))
+	tools.Check(gc.InitPair(5, gc.C_BLACK, gc.C_BLACK))
+	tools.Check(gc.InitPair(6, gc.C_WHITE, gc.C_BLACK))
 }
 
-// InitFood initializes the foods position.
+// printFood prints the symbol for food at a given position.
 func printFood(stdscr *gc.Window, newFood *Food, rows, cols int) {
 	stdscr.ColorOn(2)
 	stdscr.MoveAddChar(newFood.y, newFood.x, foodChar)
 	stdscr.ColorOff(2)
 }
 
-// InitFood initializes the foods position
+// InitFood initializes the foods position.
 func initFood(stdscr *gc.Window, myFood *Food, rows, cols int) {
 	if myFood.y == 0 && myFood.x == 0 {
 		for !testFoodCollision(stdscr, myFood, rows, cols) {
 			myFood.y = rand.Intn(rows)
 			myFood.x = rand.Intn(cols)
 		}
-		// Start timer for score
+		// Start the timer for the score calculation.
 		startTime = time.Now()
 	}
 }
@@ -268,7 +249,7 @@ func calcBoardSize(stdscr *gc.Window) {
 }
 
 func SetupGameBoard() *gc.Window {
-	// Setup stdscr buffer
+	// Setup stdscr buffer.
 	stdscr, err := gc.Init()
 	calcBoardSize(stdscr)
 	if err != nil {
@@ -283,10 +264,8 @@ func SetupGameBoard() *gc.Window {
 		log.Fatal("Require a color capable terminal")
 	}
 
-	// Initalize use of color
-	if err := gc.StartColor(); err != nil {
-		log.Fatal(err)
-	}
+	// Initalize the use of color.
+	tools.Check(gc.StartColor())
 
 	gc.Echo(false)
 	gc.Cursor(0)    // Hide cursor

internal/gameplay/gobra.go

@@ -88,11 +88,11 @@ func Start(cfg *Config) {
 
 	var scoreLength int
 	for Run {
-		// Clear screen
+		// Clear the screen.
 		stdscr.Refresh()
 		stdscr.Erase()
 
-		// Draw box around the screen (for collision detection)
+		// Draw box around the screen (for collision detection).
 		// TODO: Do we need to redraw everything?
 		drawBorder(stdscr)
 
@@ -111,35 +111,35 @@ func Start(cfg *Config) {
 			stdscr.MovePrint(7, 1, rune(stdscr.MoveInChar(0, 0)))
 		}
 
-		// setSnakeDir returns false when the user presses q to exit -> interrupt loop
+		// setSnakeDir returns false when the user presses q to exit -> interrupt loop.
 		if !HandleKeys(input, stdscr, &newFood) {
 			break
 		}
 
-		// Determine food position if not set yet
+		// Determine the food position if not set yet.
 		initFood(stdscr, &newFood, screen.rows, screen.cols)
 
 		//stdscr.Refresh()
 
-		// Display snake (alive or dead)
+		// Display the snake (alive or dead).
 		handleSnake(stdscr, screen.rows, screen.cols)
 
-		// Handle collisions
+		// Handle collisions.
 		if !handleCollisions(stdscr, &newFood, screen.rows, screen.cols) && cfg.Sound {
 			sound.Play(sound.FreqA, 250*time.Millisecond)
 		}
 
-		// Check if snake hit boundaries, if desired ports the snake to the other side of the screen
+		// Check if snake hit boundaries, if desired ports the snake to the other side of the screen.
 		boundaryCheck(cfg.NoBounds, screen.rows, screen.cols)
 
-		// Render food symbol
+		// Render food symbol.
 		printFood(stdscr, &newFood, screen.rows, screen.cols)
 
-		// Overwrite border once again
+		// Overwrite border once again.
 		drawBorder(stdscr)
 		scoreLength = len(strconv.Itoa(globalScore))
 
-		// Write score to border
+		// Write score to border.
 		stdscr.ColorOn(4)
 		stdscr.MovePrint(0, (screen.cols/2)-(scoreLength/2), globalScore)
 		stdscr.ColorOff(4)
@@ -153,13 +153,13 @@ func Start(cfg *Config) {
 		}
 
 		stdscr.ColorOff(3)
-		// Refresh changes in screen buffer
+		// Refresh changes in screen buffer.
 		stdscr.Refresh()
-		// Flush characters that have changed
+		// Flush characters that have changed.
 		tools.Check(gc.Update())
 	}
 
-	gc.End() // Restore previous terminal state
+	gc.End() // Restore previous terminal state.
 }
 
 // MoveSnake updates the snake's position based on its current direction.

internal/sound/sound.go

@@ -17,7 +17,7 @@ var (
 	bitDepthInBytes = flag.Int("bitdepthinbytes", 2, "bit depth in bytes")
 )
 
-const FreqA = 300 // sound frequency
+const FreqA = 300 // This is the frequency of the generated sound.
 
 type sineWave struct {
 	freq   float64