snake-game-notebook.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": 4,
   "id": "91c609a0-c484-4fe4-945d-a1d819b4f9ad",
   "metadata": {},
   "outputs": [],
   "source": [
    "import pygame, sys, time, random\n",
    "from pygame.surfarray import array3d\n",
    "\n",
    "## Sets up colors for the game env using RGB Codes\n",
    "\n",
    "BLACK = pygame.Color(0, 0, 0)\n",
    "WHITE = pygame.Color(255, 255, 255)\n",
    "RED = pygame.Color(255, 0, 0)\n",
    "BLUE = pygame.Color(0, 0, 255) \n",
    "\n",
    "\n",
    "class SnakeEnv():\n",
    "    \n",
    "    def __init__(self,frame_size_x,frame_size_y):\n",
    "        '''\n",
    "        Defines the initial game window size\n",
    "        '''\n",
    "        self.frame_size_x = frame_size_x\n",
    "        self.frame_size_y = frame_size_y\n",
    "        self.game_window = pygame.display.set_mode((self.frame_size_x, self.frame_size_y))\n",
    "        self.reset()\n",
    "    \n",
    "    def reset(self):\n",
    "        '''\n",
    "        Resets the game, along with the default snake size and spawning food.\n",
    "        '''\n",
    "        self.game_window.fill(BLACK)\n",
    "        self.snake_pos = [200, 300]\n",
    "        self.snake_body = [[200, 250], [200-10, 250], [200-(2*10), 250]]\n",
    "        self.food_pos = self.spawn_food()\n",
    "        self.food_spawn = True\n",
    "\n",
    "        self.direction = \"RIGHT\"\n",
    "        self.action = self.direction\n",
    "        self.score = 0\n",
    "        self.steps = 0\n",
    "        print(\"Game Reset.\")\n",
    "    \n",
    "    def change_direction(self,action,direction):\n",
    "        '''\n",
    "        Changes direction based on action input. \n",
    "        Checkes to make sure snake can't go back on itself.\n",
    "        '''\n",
    "        \n",
    "        if action == 'UP' and direction != 'DOWN':\n",
    "            direction = 'UP'\n",
    "        if action == 'DOWN' and direction != 'UP':\n",
    "            direction = 'DOWN'\n",
    "        if action == 'LEFT' and direction != 'RIGHT':\n",
    "            direction = 'LEFT'\n",
    "        if action == 'RIGHT' and direction != 'LEFT':\n",
    "            direction = 'RIGHT'\n",
    "            \n",
    "        return direction\n",
    "    \n",
    "    def move(self,direction,snake_pos):\n",
    "        '''\n",
    "        Updates snake_pos list to reflect direction change.\n",
    "        '''\n",
    "            \n",
    "        if direction == 'UP':\n",
    "            snake_pos[1] -= 10\n",
    "        if direction == 'DOWN':\n",
    "            snake_pos[1] += 10\n",
    "        if direction == 'LEFT':\n",
    "            snake_pos[0] -= 10\n",
    "        if direction == 'RIGHT':\n",
    "            snake_pos[0] += 10\n",
    "            \n",
    "        return snake_pos\n",
    "   \n",
    "    \n",
    "    def eat(self):\n",
    "        '''\n",
    "        Returns Boolean indicating if Snake has \"eaten\" the white food square\n",
    "        '''\n",
    "        return self.snake_pos[0] == self.food_pos[0] and self.snake_pos[1] == self.food_pos[1]\n",
    "\n",
    "   \n",
    "    def spawn_food(self):\n",
    "        '''\n",
    "        Spawns food in a random location on window size\n",
    "        '''\n",
    "        return [random.randrange(1, (self.frame_size_x//10)) * 10, random.randrange(1, (self.frame_size_y//10)) * 10]\n",
    "    \n",
    "    \n",
    "    def human_step(self,event):\n",
    "        '''\n",
    "        Takes human keyboard event and then returns it as an action string\n",
    "        '''\n",
    "        \n",
    "        action = None\n",
    "        \n",
    "        if event.type == pygame.QUIT:\n",
    "            pygame.quit()\n",
    "            sys.exit()\n",
    "        ################################################ \n",
    "        ########## CONVERT KEYPRESS TO DIRECTION ###### \n",
    "        ############################################## \n",
    "        elif event.type == pygame.KEYDOWN:\n",
    "            \n",
    "            if event.key == pygame.K_UP:\n",
    "                action = 'UP'\n",
    "            if event.key == pygame.K_DOWN:\n",
    "                action = 'DOWN'\n",
    "            if event.key == pygame.K_LEFT:\n",
    "                action = 'LEFT'\n",
    "            if event.key == pygame.K_RIGHT:\n",
    "                action = 'RIGHT'\n",
    "            # Esc -> Create event to quit the game\n",
    "            if event.key == pygame.K_ESCAPE:\n",
    "                pygame.event.post(pygame.event.Event(pygame.QUIT))\n",
    "                \n",
    "        return action\n",
    "    \n",
    "    \n",
    "    \n",
    "    def display_score(self,color, font, size):\n",
    "        '''\n",
    "        Updates the score in top left\n",
    "        '''\n",
    "        score_font = pygame.font.SysFont(font, size)\n",
    "        score_surface = score_font.render('Score : ' + str(self.score), True, color)\n",
    "        score_rect = score_surface.get_rect()\n",
    "        score_rect.midtop = (self.frame_size_x/10, 15)\n",
    "        self.game_window.blit(score_surface, score_rect)\n",
    "        \n",
    "    def game_over(self):\n",
    "        '''\n",
    "        Checks if the snake has touched the bounding box or itself\n",
    "        '''\n",
    "        \n",
    "        # TOUCH BOX\n",
    "        if self.snake_pos[0] < 0 or self.snake_pos[0] > self.frame_size_x-10:\n",
    "            self.end_game()\n",
    "        if self.snake_pos[1] < 0 or self.snake_pos[1] > self.frame_size_y-10:\n",
    "            self.end_game()\n",
    "\n",
    "        # TOUCH OWN BODY\n",
    "        for block in self.snake_body[1:]:\n",
    "            if self.snake_pos[0] == block[0] and self.snake_pos[1] == block[1]:\n",
    "                self.end_game()\n",
    " \n",
    "\n",
    "\n",
    "    def end_game(self):\n",
    "        '''\n",
    "        \n",
    "        '''\n",
    "        message = pygame.font.SysFont('arial', 45)\n",
    "        message_surface = message.render('Game has Ended.', True, RED)\n",
    "        message_rect = message_surface.get_rect()\n",
    "        message_rect.midtop = (self.frame_size_x/2, self.frame_size_y/4)\n",
    "        self.game_window.fill(BLACK)\n",
    "        self.game_window.blit(message_surface, message_rect)\n",
    "        self.display_score(RED, 'times', 20)\n",
    "        pygame.display.flip()\n",
    "        time.sleep(3)\n",
    "        pygame.quit()\n",
    "        sys.exit()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "id": "5b98a619-c1e9-4714-9737-ef27d02ed21f",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Game Reset.\n"
     ]
    },
    {
     "ename": "SystemExit",
     "evalue": "",
     "output_type": "error",
     "traceback": [
      "An exception has occurred, use %tb to see the full traceback.\n",
      "\u001b[0;31mSystemExit\u001b[0m\n"
     ]
    }
   ],
   "source": [
    "snake_env = SnakeEnv(600,600)\n",
    "\n",
    "# This is technically a FPS Refresh rate\n",
    "# Higher number means faster refresh, thus faster snake movement, meaning harder game play\n",
    "difficulty = 10\n",
    "\n",
    "\n",
    "# FPS (frames per second) controller\n",
    "fps_controller = pygame.time.Clock()\n",
    "\n",
    "# Checks for errors encountered\n",
    "check_errors = pygame.init()\n",
    "\n",
    "\n",
    "# Initialise game window\n",
    "pygame.display.set_caption('Snake Eater') \n",
    "\n",
    "\n",
    "\n",
    "# Main logic\n",
    "while True:\n",
    "    \n",
    "    # Check Input from Human Step \n",
    "    for event in pygame.event.get():\n",
    "        snake_env.action = snake_env.human_step(event)\n",
    "   \n",
    "    # Check for Direction change based on action\n",
    "    snake_env.direction = snake_env.change_direction(snake_env.action,snake_env.direction)\n",
    "\n",
    "\n",
    "    #Update Snake Position\n",
    "    snake_env.snake_pos = snake_env.move(snake_env.direction,snake_env.snake_pos)\n",
    "\n",
    "\n",
    "    # Check to see if we ate some food\n",
    "    snake_env.snake_body.insert(0, list(snake_env.snake_pos))\n",
    "    if snake_env.eat():\n",
    "        snake_env.score += 1\n",
    "        snake_env.food_spawn = False\n",
    "    else:\n",
    "        snake_env.snake_body.pop()\n",
    "\n",
    "    # Check to see if we need to spawn new food \n",
    "    if not snake_env.food_spawn:\n",
    "        snake_env.food_pos = snake_env.spawn_food()\n",
    "    snake_env.food_spawn = True\n",
    "\n",
    "    # Draw the Snake\n",
    "    snake_env.game_window.fill(BLACK)\n",
    "    for pos in snake_env.snake_body:\n",
    "        pygame.draw.rect(snake_env.game_window, BLUE, pygame.Rect(pos[0], pos[1], 10, 10))\n",
    "        \n",
    "    # Draw Food\n",
    "    pygame.draw.rect(snake_env.game_window, WHITE, pygame.Rect(snake_env.food_pos[0], snake_env.food_pos[1], 10, 10))\n",
    "\n",
    "    # Check if we lost\n",
    "    snake_env.game_over()\n",
    "    \n",
    "\n",
    "\n",
    "    snake_env.display_score(WHITE, 'consolas', 20)\n",
    "    # Refresh game screen\n",
    "    pygame.display.update()\n",
    "    # Refresh rate\n",
    "    fps_controller.tick(difficulty)\n",
    "    img = array3d(snake_env.game_window)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "ad86647b-8cd6-4e2a-8e04-ffedfa29179f",
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.8.12"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}