Added escape key as mouse mode toggle to make it easier to exit game

- updated readme with new controls and new screenshot

README.md

@@ -17,9 +17,12 @@ To install and run from source the following are required:
     * `[path/to/raycaster-go]$ go run raycast.go`
 
 ## Controls
-* Use the mouse to rotate and pitch view
-* Move and strafe using WASD or Arrow Keys
+* Press `Escape` key to toggle mouse cursor capture (or hold `CTRL`)
+* Move the mouse to rotate and pitch view
+* Move and strafe using `WASD` or `Arrow Keys`
+* Hold `Shift` key to move faster
+* Hold `ALT` key to enter mouse move mode (vertical mouse moves position instead of pitch)
+* Click left mouse button to spawn projectile
 * Hold `C` key for crouch position
-* Hold Spacebar for jump position
-* Hold `CTRL` key to release mouse cursor capture
-* While mouse cursor released, left/right mouse click currently used for visual/console debugging
+* Hold `Z` key for prone position
+* Hold `Spacebar` for jump position

engine/game.go

@@ -51,8 +51,12 @@ type Game struct {
 	//--define camera and renderer--//
 	camera *raycaster.Camera
 
-	mouseMode      raycaster.MouseMode
-	mouseX, mouseY int
+	mouseMode       raycaster.MouseMode
+	mouseModeToggle bool
+	mouseX, mouseY  int
+
+	// keep track of certain key presses for debounce protection
+	debouncedKeys map[ebiten.Key]int
 
 	crosshairs *model.Crosshairs
 
@@ -121,6 +125,8 @@ func NewGame() *Game {
 	g.mouseMode = raycaster.MouseModeMove
 	g.mouseX, g.mouseY = math.MinInt32, math.MinInt32
 
+	g.debouncedKeys = make(map[ebiten.Key]int, 8)
+
 	//--init camera and renderer--//
 	g.camera = raycaster.NewCamera(g.width, g.height, texWidth, g.mapObj, g.slices, g.levels, g.floorLvl, g.spriteLvls, g.tex)
 	g.camera.SetFloorTexture(getTextureFromFile("floor.png"))
@@ -453,6 +459,30 @@ func (g *Game) Update() error {
 	return nil
 }
 
+func (g *Game) debounceInput(key ebiten.Key, duration int) {
+	g.debouncedKeys[key] = duration
+}
+
+func (g *Game) updatedDebounces() {
+	for key, duration := range g.debouncedKeys {
+		duration--
+		g.debouncedKeys[key] = duration
+
+		if duration <= 0 {
+			delete(g.debouncedKeys, key)
+		}
+	}
+}
+
+func (g *Game) isDebouncedInput(key ebiten.Key) bool {
+	if value, ok := g.debouncedKeys[key]; ok {
+		if value > 0 {
+			return true
+		}
+	}
+	return false
+}
+
 func (g *Game) handleInput() {
 	forward := false
 	backward := false
@@ -468,7 +498,20 @@ func (g *Game) handleInput() {
 		g.player.WeaponCooldown -= 1 / float64(ebiten.MaxTPS())
 	}
 
+	// update any currently debounced inputs
+	g.updatedDebounces()
+
 	switch {
+	case ebiten.IsKeyPressed(ebiten.KeyEscape):
+		if g.mouseMode != raycaster.MouseModeCursor {
+			ebiten.SetCursorMode(ebiten.CursorModeVisible)
+			g.mouseMode = raycaster.MouseModeCursor
+			g.mouseModeToggle = true
+			g.debounceInput(ebiten.KeyEscape, 30)
+		} else if !g.isDebouncedInput(ebiten.KeyEscape) {
+			g.mouseModeToggle = false
+		}
+
 	case ebiten.IsKeyPressed(ebiten.KeyControl):
 		if g.mouseMode != raycaster.MouseModeCursor {
 			ebiten.SetCursorMode(ebiten.CursorModeVisible)
@@ -482,7 +525,7 @@ func (g *Game) handleInput() {
 			g.mouseX, g.mouseY = math.MinInt32, math.MinInt32
 		}
 
-	case g.mouseMode != raycaster.MouseModeLook:
+	case g.mouseMode != raycaster.MouseModeLook && !g.mouseModeToggle:
 		ebiten.SetCursorMode(ebiten.CursorModeCaptured)
 		g.mouseMode = raycaster.MouseModeLook
 		g.mouseX, g.mouseY = math.MinInt32, math.MinInt32